search

databricks / databricks-cli

(Legacy) Command Line Interface for Databricks
Other
386 stars 234 forks source link

Please read this before opening a new issue #661

Open pietern opened 1 year ago

pietern commented 1 year ago

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.

The Python-based CLI (this repo) will not receive new feature work but will continue to receive critical bug fixes and maintenance. We might cut a 0.18 version to drop Python 2 support but otherwise, nothing new is planned here.

The new CLI is built from an API specification and because of this any updates for the API are automatically propagated into the CLI, as opposed to having to manually mirror all changes.

For users who have been using this repository as a sort-of Python SDK (by importing databricks_cli.sdk), we have built a proper Python SDK with API coverage generated similar to the new CLI.

Both the new CLI and SDKs support all authentication mechanisms supported by the platform instead of only personal access token (PAT) based auth in this repository. You can read more about this in the SDK README or in our documentation (differs per cloud with authentication options are available):

alexott commented 1 year ago

It looks like people doesn't read this - maybe it makes sense to create an issue template where it will be explained?