Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
pipelines 内の コマンド グループを使用すると、パイプラインに関する詳細を作成、編集、削除、開始、および表示できます。
「Lakeflow Spark 宣言型パイプライン」を参照してください。
databricks パイプライン作成
要求された構成に基づいて新しいデータ処理パイプラインを作成します。 成功した場合、このコマンドは新しいパイプラインの ID を返します。
databricks pipelines create [flags]
Arguments
None
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
databricksのパイプラインを削除
パイプラインを削除します。
databricks pipelines delete PIPELINE_ID [flags]
Arguments
PIPELINE_ID
削除するパイプライン。
オプション
databricks パイプラインを取得する
パイプラインを取得します。
databricks pipelines get PIPELINE_ID [flags]
Arguments
PIPELINE_ID
取得するパイプライン。
オプション
databricks パイプラインの get-update
アクティブなパイプラインから更新プログラムを取得します。
databricks pipelines get-update PIPELINE_ID UPDATE_ID [flags]
Arguments
PIPELINE_ID
パイプラインの ID。
UPDATE_ID
更新プログラムの ID。
オプション
databricks pipelines の list-pipeline-events コマンド（パイプラインイベントの一覧表示）
パイプラインのイベントを取得します。
databricks pipelines list-pipeline-events PIPELINE_ID [flags]
Arguments
PIPELINE_ID
イベントを取得先のパイプライン。
オプション
--filter string
結果のサブセットを選択する条件。SQL に似た構文を使用して表されます。
--max-results int
1 ページで返されるエントリの最大数。
--page-token string
前の呼び出しによって返されたページトークン。
databricks パイプライン リスト表示
Delta Live Tables システムで定義されているパイプラインを一覧表示します。
databricks pipelines list-pipelines [flags]
Arguments
None
オプション
--filter string
指定した条件に基づいて結果のサブセットを選択します。
--max-results int
1 ページで返されるエントリの最大数。
--page-token string
前の呼び出しによって返されたページトークン。
databricks パイプラインのリスト更新
アクティブなパイプラインの更新を一覧表示します。
databricks pipelines list-updates PIPELINE_ID [flags]
Arguments
PIPELINE_ID
更新プログラムを返すパイプライン。
オプション
--max-results int
1 ページで返されるエントリの最大数。
--page-token string
前の呼び出しによって返されたページトークン。
--until-update-id string
存在する場合は、この update_id を含む更新まで返します。
databricks パイプラインの start-update
パイプラインの新しい更新を開始します。 パイプラインのアクティブな更新プログラムが既にある場合、要求は失敗し、アクティブな更新プログラムは実行されたままです。
databricks pipelines start-update PIPELINE_ID [flags]
Arguments
PIPELINE_ID
アップデートを開始するためのパイプライン。
オプション
--cause StartUpdateCause
サポートされている値: [API_CALL、JOB_TASK、RETRY_ON_FAILURE、SCHEMA_CHANGE、SERVICE_UPGRADE、USER_ACTION]
--full-refresh
true の場合、この更新プログラムは実行前にすべてのテーブルをリセットします。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--validate-only
true の場合、この更新ではパイプライン ソース コードの正確性のみが検証されますが、データセットの具体化や発行は行われません。
databricks パイプラインを停止します
アクティブな更新を取り消して、パイプラインを停止します。 パイプラインにアクティブな更新がない場合、この要求は処理されません。
databricks pipelines stop PIPELINE_ID [flags]
Arguments
PIPELINE_ID
停止するパイプライン。
オプション
--no-wait
IDLE 状態に達するのを待たない
--timeout duration
IDLE 状態に達するまでの最大時間 (既定は 20 m0s)
databricks パイプラインの更新
指定された構成でパイプラインを更新します。
databricks pipelines update PIPELINE_ID [flags]
Arguments
PIPELINE_ID
このパイプラインの一意識別子。
オプション
--allow-duplicate-names
false の場合、名前が変更され、別のパイプラインの名前と競合した場合、デプロイは失敗します。
--budget-policy-id string
このパイプラインの予算ポリシー。
--catalog string
このパイプラインからデータを発行する先の、Unity Catalog のカタログ。
--channel string
使用するバージョンを指定する Lakeflow Spark 宣言パイプライン リリース チャネル。
--continuous
パイプラインが継続的かトリガーされるか。
--development
パイプラインが開発モードかどうか。
--edition string
パイプライン製品エディション。
--expected-last-modified int
存在する場合は、編集前のパイプライン設定の最終変更時刻。
--id string
このパイプラインの一意識別子。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--name string
このパイプラインのわかりやすい識別子。
--photon
このパイプラインに対して Photon が有効になっているかどうか。
--pipeline-id string
このパイプラインの一意識別子。
--schema string
テーブルの読み取りまたはパブリッシュ先の既定のスキーマ (データベース)。
--serverless
このパイプラインに対してサーバーレス コンピューティングが有効になっているかどうか。
--storage string
チェックポイントとテーブルを格納するための DBFS ルート ディレクトリ。
--target string
このパイプラインにテーブルを追加するターゲット スキーマ (データベース)。
databricks パイプラインの get-permission-levels
パイプラインのアクセス許可レベルを取得します。
databricks pipelines get-permission-levels PIPELINE_ID [flags]
Arguments
PIPELINE_ID
アクセス許可を取得または管理するパイプライン。
オプション
databricks パイプラインの get-permissions
パイプラインのアクセス許可を取得します。 パイプラインは、ルート オブジェクトからアクセス許可を継承できます。
databricks pipelines get-permissions PIPELINE_ID [flags]
Arguments
PIPELINE_ID
アクセス許可を取得または管理するパイプライン。
オプション
databricks パイプラインの set-permissions
パイプラインのアクセス許可を設定します。
オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。 指定されていない場合は、すべての直接アクセス許可を削除します。 オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。
databricks pipelines set-permissions PIPELINE_ID [flags]
Arguments
PIPELINE_ID
アクセス許可を取得または管理するパイプライン。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
databricks パイプラインの権限を更新する
パイプラインのアクセス許可を更新します。 パイプラインは、ルート オブジェクトからアクセス許可を継承できます。
databricks pipelines update-permissions PIPELINE_ID [flags]
Arguments
PIPELINE_ID
アクセス許可を取得または管理するパイプライン。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
グローバル フラグ
--debug
デバッグ ログを有効にするかどうかを指定します。
-h または --help
Databricks CLI、または関連コマンド グループ、または関連コマンドのヘルプの表示。
--log-file 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット