Repolode
databricks

databricks/databricks-sdk-py

Databricks REST APIへPythonコードからプログラムでアクセスできる、Databricksプラットフォーム向けPython SDKです。

スター
577
フォーク
228
未解決の Issue
344
最終コミット
3 日前

これは何?

Databricks SDK for Pythonは、PythonからDatabricksのワークスペースやアカウントを操作するためのクライアントライブラリです。公開されているDatabricks REST APIを網羅し、WorkspaceClientまたはAccountClientオブジェクトを通じて、各サービス(clusters、jobs、reposなど)を型付きクライアントとして提供します。

Databricksネイティブトークン、OAuth、Azure、Google Cloudの認証情報を使った認証に対応し、クラウドプロバイダーやworkspace IDなどの設定も自動的に解決します。HTTPクライアントは、HTTP 429や503の応答など、再試行しても安全なリクエストをジッター付きバックオフで自動再試行します。長時間実行される操作には、リソースが期待する状態になるまで待機するヘルパーが用意されており、ページネーションを伴うリスト取得はPythonイテレーターとして利用できます。

このパッケージはpipでインストールでき、ドキュメントによるとPython 3.8〜3.11に対応しています。また、最近のDatabricks Runtimeバージョンには同梱されています。現在はBeta版であり、今後のリリースでインターフェースが変更される可能性があります。

主な機能

  • 01clusters、jobs、reposなど、Databricks REST APIの各サービスに対応する型付きPythonクライアント。
  • 02Personal Access Token、OAuth、Azure、Google Cloudの認証情報など、複数の認証方式に対応。
  • 03レート制限や一時的な利用不可を示す応答に対し、バックオフを使って自動再試行。
  • 04クラスター作成やジョブ実行など、長時間実行される操作の完了を待つヘルパー。
  • 05Pythonイテレーターによるページネーション処理。
  • 06HTTPリクエストとレスポンスのログ出力およびデバッグ出力を設定可能。

ユースケース

  • Pythonスクリプトからクラスター、ジョブ、ワークスペースの管理を自動化する。
  • ユーザーごとのOAuthログインでDatabricksリソースを操作する社内Webアプリを構築する。
  • ジョブ実行のステータスや履歴を照会する、スケジュール実行のデータパイプラインチェックを行う。
  • Pythonで記述したCI/CDパイプラインからDatabricksリソースを管理する。

クイックスタート

  1. 1

    PyPIからSDKをインストールする

    pip install databricks-sdk
  2. 2

    WorkspaceClientを作成してクラスターを一覧表示する

    from databricks.sdk import WorkspaceClient w = WorkspaceClient() for c in w.clusters.list(): print(c.cluster_name)

使う前に知っておきたいこと

  • APIを呼び出すには、Databricksワークスペースと有効な認証情報が必要です。
  • まだベータ版のため、今後のリリースでインターフェースが変更される可能性があります。

収録されている特集

トピック

よくある質問

databricks-sdk-py とは?
Databricks REST APIへPythonコードからプログラムでアクセスできる、Databricksプラットフォーム向けPython SDKです。 Databricks SDK for Pythonは、PythonからDatabricksのワークスペースやアカウントを操作するためのクライアントライブラリです。公開されているDatabricks REST APIを網羅し、WorkspaceClientまたはAccountClientオブジェクトを通じて、各サービス(clusters、jobs、reposなど)を型付きクライアントとして提供します。
databricks-sdk-py は無料で使えますか?ライセンスは?
databricks-sdk-py は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
databricks-sdk-py は今もメンテナンスされていますか?
活発にメンテナンス中。databricks-sdk-py の最終コミットは 2026年11月5日 です。
databricks-sdk-py は何に使えますか?
Pythonスクリプトからクラスター、ジョブ、ワークスペースの管理を自動化する。 ユーザーごとのOAuthログインでDatabricksリソースを操作する社内Webアプリを構築する。 ジョブ実行のステータスや履歴を照会する、スケジュール実行のデータパイプラインチェックを行う。 Pythonで記述したCI/CDパイプラインからDatabricksリソースを管理する。
databricks-sdk-py のインストール方法は?
PyPIからSDKをインストールする: pip install databricks-sdk WorkspaceClientを作成してクラスターを一覧表示する: from databricks.sdk import WorkspaceClient w = WorkspaceClient() for c in w.clusters.list(): print(c.cluster_name)
databricks-sdk-py はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/databricks/databricks-sdk-py

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト