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

Uploaded Source

Built Distribution

databricks_cli-0.17.4-py2-none-any.whl (147.8 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for databricks-cli-0.17.4.tar.gz
Algorithm Hash digest
SHA256 bc0c4dd082f033cb6d7978cacaca5261698efe3a4c70f52f98762c38db925ce0
MD5 48474faed50e684a5a97c0be88b41e98
BLAKE2b-256 ca18be4b07af8cf405e60b665e8edc9bf310a6328fdbea5aca5504ed26907d12

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for databricks_cli-0.17.4-py2-none-any.whl
Algorithm Hash digest
SHA256 bbd57bc21c88ac6d1f8f0b250db986e500490c4d3cb69664229384632eaeed81
MD5 f02412bdedbe99952f042e921690de5a
BLAKE2b-256 587d4bd6e5dc4420fb5dbb5ae895c1d9934fc0c9e77d9c5dc010725195f093a7

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