Description

# Databricks SDK for Python (Beta) [](https://pypistats.org/packages/databricks-sdk) [](https://github.com/databricks/databricks-sdk-py/blob/main/LICENSE) [](https://snyk.io/advisor/python/databricks-sdk)  [](https://codecov.io/gh/databricks/databricks-sdk-py) []([https://codecov.io/github/databricks/databricks-sdk-py](https://github.com/databricks/databricks-sdk-py)) [Beta](https://docs.databricks.com/release-notes/release-types.html): This SDK is supported for production use cases, but we do expect future releases to have some interface changes; see [Interface stability](#interface-stability). We are keen to hear feedback from you on these SDKs. Please [file issues](https://github.com/databricks/databricks-sdk-py/issues), and we will address them. | See also the [SDK for Java](https://github.com/databricks/databricks-sdk-java) | See also the [SDK for Go](https://github.com/databricks/databricks-sdk-go) | See also the [Terraform Provider](https://github.com/databricks/terraform-provider-databricks) | See also cloud-specific docs ([AWS](https://docs.databricks.com/dev-tools/sdk-python.html), [Azure](https://learn.microsoft.com/en-us/azure/databricks/dev-tools/sdk-python), [GCP](https://docs.gcp.databricks.com/dev-tools/sdk-python.html)) | See also the [API reference on readthedocs](https://databricks-sdk-py.readthedocs.io/en/latest/) The Databricks SDK for Python includes functionality to accelerate development with [Python](https://www.python.org/) for the Databricks Lakehouse. It covers all public [Databricks REST API](https://docs.databricks.com/dev-tools/api/index.html) operations. The SDK's internal HTTP client is robust and handles failures on different levels by performing intelligent retries. ## Contents - [Getting started](#getting-started) - [Code examples](#code-examples) - [Authentication](#authentication) - [Long-running operations](#long-running-operations) - [Paginated responses](#paginated-responses) - [Retries](#retries) - [Single-sign-on with OAuth](#single-sign-on-sso-with-oauth) - [User Agent Request Attribution](#user-agent-request-attribution) - [Error handling](#error-handling) - [Logging](#logging) - [Integration with `dbutils`](#interaction-with-dbutils) - [Interface stability](#interface-stability) ## Getting started<a id="getting-started"></a> 1. Please install Databricks SDK for Python via `pip install databricks-sdk` and instantiate `WorkspaceClient`: ```python from databricks.sdk import WorkspaceClient w = WorkspaceClient() for c in w.clusters.list(): print(c.cluster_name) ``` Databricks SDK for Python is compatible with Python 3.7 _(until [June 2023](https://devguide.python.org/versions/))_, 3.8, 3.9, 3.10, and 3.11. **Note:** Databricks Runtime starting from version 13.1 includes a bundled version of the Python SDK. It is highly recommended to upgrade to the latest version which you can do by running the following in a notebook cell: ```python %pip install --upgrade databricks-sdk ``` followed by ```python dbutils.library.restartPython() ``` ## Code examples<a id="code-examples"></a> The Databricks SDK for Python comes with a number of examples demonstrating how to use the library for various common use-cases, including * [Using the SDK with OAuth from a webserver](https://github.com/databricks/databricks-sdk-py/blob/main/examples/flask_app_with_oauth.py) * [Using long-running operations](https://github.com/databricks/databricks-sdk-py/blob/main/examples/starting_job_and_waiting.py) * [Authenticating a client app using OAuth](https://github.com/databricks/databricks-sdk-py/blob/main/examples/local_browser_oauth.py) These examples and more are located in the [`examples/` directory of the Github repository](https://github.com/databricks/databricks-sdk-py/tree/main/examples). Some other examples of using the SDK include: * [Unity Catalog Automated Migration](https://github.com/databricks/ucx) heavily relies on Python SDK for working with Databricks APIs. * [ip-access-list-analyzer](https://github.com/alexott/databricks-playground/tree/main/ip-access-list-analyzer) checks & prunes invalid entries from IP Access Lists. ## Authentication<a id="authentication"></a> If you use Databricks [configuration profiles](https://docs.databricks.com/dev-tools/auth.html#configuration-profiles) or Databricks-specific [environment variables](https://docs.databricks.com/dev-tools/auth.html#environment-variables) for [Databricks authentication](https://docs.databricks.com/dev-tools/auth.html), the only code required to start working