Databricks CLI とは何ですか?
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、 Databricks ライセンス および Databricks プライバシー通知(使用データのプロビジョニングを含む)が適用されます。
Databricks CLI (コマンドラインインターフェイス) を使用すると、ローカルターミナルまたは自動化スクリプトから Databricks プラットフォームを操作できます。また、Webターミナルを使用して、 ワークスペース内から DatabricksCLIコマンドを実行することもできます。Databricks「Databricks Webターミナルの実行 シェル コマンド」を参照してください。
Databricks CLI の認証をインストールして構成するには、「 Databricks CLI のインストールまたは更新 」および 「Databricks CLI の認証」を参照してください。
Databricks CLI ソースは、databricks/CLI GitHub リポジトリで公開されています。
従来の Databricks CLI ユーザー向けの情報
- Databricksでは、レガシーDatabricks CLIに対するサポートや新機能の追加は予定しておりません。
- レガシ Databricks CLIの詳細については、「 Databricks CLI (レガシ)」を参照してください。
- Databricks CLI バージョン 0.18 以前から Databricks CLI バージョン 0.205 以降に移行するには、「 Databricks CLI の移行」を参照してください。
Databricks CLI はどのように機能しますか?
CLIはDatabricks REST APIをラップしており、Databricksアカウントやワークスペースオブジェクトに関する情報を変更したり要求したりするためのエンドポイントを提供しています。「Databricks REST APIリファレンス」を参照してください。
たとえば、ワークスペース内の個々のクラスターに関する情報を印刷するには、次のようにCLIを実行します。
databricks clusters get 1234-567890-a12bcde3
curl
での同等の操作は次のとおりです。
curl --request GET "https://${DATABRICKS_HOST}/api/2.0/clusters/get" \
--header "Authorization: Bearer ${DATABRICKS_TOKEN}" \
--data '{ "cluster_id": "1234-567890-a12bcde3" }'
例: Databricks ジョブを作成する
次の例では、CLI 使用してDatabricksジョブを作成します。このジョブには、ジョブタスクが1つあります。このタスクでは、指定されたDatabricksノートブックを実行します。このノートブックは、wheel
という名前のPyPIパッケージの特定のバージョンに依存しています。このタスクを実行するため、PYSPARK_PYTHON
という名前の環境変数をエクスポートするジョブクラスターがこのジョブにより一時的に作成されます。ジョブの実行が終了すると、このクラスターも終了になります。
databricks jobs create --json '{
"name": "My hello notebook job",
"tasks": [
{
"task_key": "my_hello_notebook_task",
"notebook_task": {
"notebook_path": "/Workspace/Users/someone@example.com/hello",
"source": "WORKSPACE"
},
"libraries": [
{
"pypi": {
"package": "wheel==0.41.2"
}
}
],
"new_cluster": {
"spark_version": "13.3.x-scala2.12",
"node_type_id": "i3.xlarge",
"num_workers": 1,
"spark_env_vars": {
"PYSPARK_PYTHON": "/databricks/python3/bin/python3"
}
}
}
]
}'
次のステップ
- CLI をインストールして使用を開始する方法については、 Databricks CLI のチュートリアルを参照してください。
- チュートリアルをスキップして CLI のみをインストールするには、「 Databricks CLI のインストールまたは更新」を参照してください。
- CLI と Databricks アカウントおよびワークスペースとの間の認証を設定するには、「 Databricks CLI の認証」を参照してください。
- 構成プロファイルを使用して、CLI 設定の関連グループをすばやく切り替えるには、「 Databricks CLI の構成プロファイル」を参照してください。
- CLI の基本的な使用方法については、「 Databricks CLI の基本的な使用方法」を参照してください。
- CLI コマンドのヘルプについては、「 Databricks CLI コマンド」を参照してください。