Skip to main content

A command line interface for Databricks

Project description

Build status https://codecov.io/gh/databricks/databricks-cli/branch/main/graph/badge.svg

The Databricks Command Line Interface (CLI) is an open source tool which provides an easy to use interface to the Databricks platform. The CLI is built on top of the Databricks REST APIs.

Note: This CLI is under active development and is released as an experimental client. This means that interfaces are still subject to change.

If you’re interested in contributing to the project please reach out. In addition, please leave bug reports as issues on our GitHub project.

Requirements

  • Python Version > 2.7.9 or > 3.6

Installation

To install simply run pip install --upgrade databricks-cli

Then set up authentication using username/password or authentication token. Credentials are stored at ~/.databrickscfg.

  • databricks configure (enter hostname/username/password at prompt)

  • databricks configure --token (enter hostname/auth-token at prompt)

Multiple connection profiles are also supported with databricks configure --profile <profile> [--token]. The connection profile can be used as such: databricks workspace ls --profile <profile>.

To test that your authentication information is working, try a quick test like databricks workspace ls.

Known Issues

AttributeError: 'module' object has no attribute 'PROTOCOL_TLSv1_2'

The Databricks web service requires clients speak TLSV1.2. The built in version of Python for MacOS does not have this version of TLS built in.

To use the Databricks CLI you must install a version of Python that has ssl.PROTOCOL_TLSv1_2. For MacOS, the easiest way may be to install Python with Homebrew.

Using Docker

# build image
docker build -t databricks-cli .

# run container
docker run -it databricks-cli

# run command in docker
docker run -it databricks-cli fs --help

Documentation

For the latest CLI documentation, see

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

databricks-cli-0.17.2.tar.gz (81.3 kB view details)

Uploaded Source

Built Distribution

databricks_cli-0.17.2-py2-none-any.whl (143.9 kB view details)

Uploaded Python 2

File details

Details for the file databricks-cli-0.17.2.tar.gz.

File metadata

  • Download URL: databricks-cli-0.17.2.tar.gz
  • Upload date:
  • Size: 81.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for databricks-cli-0.17.2.tar.gz
Algorithm Hash digest
SHA256 16bda8def2fd8e361e8f355a016841bc1b8a87da25047f5339acf559fa55f1fb
MD5 6dc943bc551d940c46ae53aa5a65966b
BLAKE2b-256 30aa098399e3a438ec04a8d0af551f1f55e05ca7265fe2a1d02e4c9439570f22

See more details on using hashes here.

File details

Details for the file databricks_cli-0.17.2-py2-none-any.whl.

File metadata

File hashes

Hashes for databricks_cli-0.17.2-py2-none-any.whl
Algorithm Hash digest
SHA256 cdcc073df0c79efc12f3220f8b76d3247aed88624338eb531c381123601bf36d
MD5 85085c2adfea3f038c4cd7fe1b9d02c6
BLAKE2b-256 cf6a06aa58144b6f1c19a4e411f9b931e7cc697c9aa41b5e9cf6cd5463a1a70a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page