Skip to main content

A command line interface for Databricks

Project description

Build Status https://codecov.io/gh/databricks/databricks-cli/branch/master/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.13.1.dev0.tar.gz (54.6 kB view details)

Uploaded Source

Built Distribution

databricks_cli-0.13.1.dev0-py2-none-any.whl (105.6 kB view details)

Uploaded Python 2

File details

Details for the file databricks-cli-0.13.1.dev0.tar.gz.

File metadata

File hashes

Hashes for databricks-cli-0.13.1.dev0.tar.gz
Algorithm Hash digest
SHA256 78d52d8f37f03d6cc410cc59134594767aefef004028f6172f6d10af35082cad
MD5 33ef205d868b587566d5754af4b471d6
BLAKE2b-256 6e9988e26acbbd4950b87b9e2b36c2c0679e392016413661f7783c6422ce7c88

See more details on using hashes here.

File details

Details for the file databricks_cli-0.13.1.dev0-py2-none-any.whl.

File metadata

File hashes

Hashes for databricks_cli-0.13.1.dev0-py2-none-any.whl
Algorithm Hash digest
SHA256 9be4e911c095d28086b20323589425d8ed4a0c50258af453224c63050035ad9c
MD5 a194d73b75d3a73956a83b26e71ddae8
BLAKE2b-256 df3c1f025d6e874d6ab654f48d3fd795ca3df3c50c7c60e2a8b34ba6930c1c29

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