Skip to main content

A command line interface for Databricks with Unity Catalog extensions

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.

This -uc variant of databricks-cli includes commands for interacting with the Unity Catalog API using the unity-catalog command. This UC functionality is in the process of being merged to the mainline databricks-cli module and is available here for early access.

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-uc-0.16.3.13.tar.gz (70.3 kB view details)

Uploaded Source

Built Distribution

databricks_cli_uc-0.16.3.13-py2-none-any.whl (138.9 kB view details)

Uploaded Python 2

File details

Details for the file databricks-cli-uc-0.16.3.13.tar.gz.

File metadata

  • Download URL: databricks-cli-uc-0.16.3.13.tar.gz
  • Upload date:
  • Size: 70.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.8.2 requests/2.26.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/2.7.16

File hashes

Hashes for databricks-cli-uc-0.16.3.13.tar.gz
Algorithm Hash digest
SHA256 b0853584118f62dfa5c15c1ed254ec9e96a879527a442caf834c702aada69407
MD5 b028e6b33a5ddde4f239d87e4bd99f65
BLAKE2b-256 7ffc1a64cc504106e4bc1011432641fd52186f9d45fee6b48e372d36b771a9a1

See more details on using hashes here.

File details

Details for the file databricks_cli_uc-0.16.3.13-py2-none-any.whl.

File metadata

  • Download URL: databricks_cli_uc-0.16.3.13-py2-none-any.whl
  • Upload date:
  • Size: 138.9 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.8.2 requests/2.26.0 setuptools/44.1.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/2.7.16

File hashes

Hashes for databricks_cli_uc-0.16.3.13-py2-none-any.whl
Algorithm Hash digest
SHA256 7cecb86180d97bc6f414e864628cd642007ab86f86ea4d62209aa91561c2a3ae
MD5 4150e6998cbc5717e28a9373c836a392
BLAKE2b-256 d4f05e984a6bb128203c2383b4e343684a00665f3881db6fb1d3d9a52ef1e693

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