Skip to main content

A command line interface for Databricks

Project description

Note

Databricks recommends that you use newer Databricks CLI versions 0.200 and above instead of legacy Databricks CLI versions 0.17 and below (located in this repository). You can find the new CLI at https://github.com/databricks/cli.

If you have been using the code in this repository as a Python SDK for interacting with the Databricks APIs, we recommend you use the new dedicated SDK package that can be found at https://github.com/databricks/databricks-sdk-py.

databricks-cli

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 no longer under active development and has been released as an experimental client.

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.8.tar.gz (85.2 kB view details)

Uploaded Source

Built Distribution

databricks_cli-0.17.8-py2-none-any.whl (150.4 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for databricks-cli-0.17.8.tar.gz
Algorithm Hash digest
SHA256 1d5ef6520ea3ed403d58f24538641bd8eeb163621f5054205fcf643578698579
MD5 e5302f996bb6a51fd748f5c2c9530d1d
BLAKE2b-256 0b5fe032f8679bf4c7f88ac68d285b0caa53bf428127e5e60dd7e6c99585f582

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for databricks_cli-0.17.8-py2-none-any.whl
Algorithm Hash digest
SHA256 dfb7d3aeec17489b6051789bf7321694d875ea487be8652f8f58fabceead7d9e
MD5 2af3dd0f36da1599ba97f36c0968bc14
BLAKE2b-256 afd0d14ec29bef1b012e3585704e1c1396b15fdf6d86b65090177d8f4598a24f

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