pipelines コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI 内の pipelines コマンド グループを使用すると、パイプラインの詳細を作成、編集、削除、開始、表示できます。宣言型パイプラインLakeFlowを参照してください。
databricks pipelines create
要求された構成に基づいて新しいデータ処理パイプラインを作成します。成功した場合、このコマンドは新しいパイプラインの ID を返します。
databricks pipelines create [flags]
引数
なし
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
databricks pipelines delete
パイプラインを削除します。
databricks pipelines delete PIPELINE_ID [flags]
引数
PIPELINE_ID
削除するパイプライン。
オプション
databricks pipelines get
パイプラインを取得します。
databricks pipelines get PIPELINE_ID [flags]
引数
PIPELINE_ID
取得するパイプライン。
オプション
databricks pipelines get-update
アクティブなパイプラインから更新プログラムを取得します。
databricks pipelines get-update PIPELINE_ID UPDATE_ID [flags]
引数
PIPELINE_ID
パイプラインの ID。
UPDATE_ID
更新プログラムの ID。
オプション
databricks pipelines list-pipeline-events
パイプラインのイベントを取得します。
databricks pipelines list-pipeline-events PIPELINE_ID [flags]
引数
PIPELINE_ID
イベントを取得するパイプライン。
オプション
--filter string
結果のサブセットを選択するための基準で、SQL に似た構文を使用して表されます。
--max-results int
1 ページに返されるエントリの最大数。
--page-token string
前の呼び出しによって返されたページ トークン。
databricks pipelines list-pipelines
Delta Live Tables システムで定義されているパイプラインを一覧表示します。
databricks pipelines list-pipelines [flags]
引数
なし
オプション
--filter string
指定した基準に基づいて結果のサブセットを選択します。
--max-results int
1 ページで返されるエントリの最大数。
--page-token string
前の呼び出しによって返されたページ トークン。
databricks pipelines list-updates
アクティブなパイプラインの更新を一覧表示します。
databricks pipelines list-updates PIPELINE_ID [flags]
引数
PIPELINE_ID
更新を返すパイプライン。
オプション
--max-results int
1 ページに返されるエントリの最大数。
--page-token string
前の呼び出しによって返されたページ トークン。
--until-update-id string
存在する場合は、このupdate_idまでの更新を返します。
databricks pipelines start-update
パイプラインの新しい更新を開始します。パイプラインのアクティブな更新プログラムが既にある場合、要求は失敗し、アクティブな更新プログラムは実行されたままになります。
databricks pipelines start-update PIPELINE_ID [flags]
引数
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 pipelines stop
アクティブな更新を取り消して、パイプラインを停止します。パイプラインにアクティブな更新プログラムがない場合、この要求は操作なしです。
databricks pipelines stop PIPELINE_ID [flags]
引数
PIPELINE_ID
停止するパイプライン。
オプション
--no-wait
IDLE 状態に達するのを待たないでください
--timeout duration
IDLE 状態に達するまでの最大時間(デフォルトは 20 分 0 秒)
databricks pipelines update
指定された構成でパイプラインを更新します。
databricks pipelines update PIPELINE_ID [flags]
引数
PIPELINE_ID
このパイプラインの一意の識別子。
オプション
--allow-duplicate-names
false の場合、名前が変更され、別のパイプラインの名前と競合すると、デプロイは失敗します。
--budget-policy-id string
このパイプラインの予算ポリシー。
--catalog string
このパイプラインからデータを発行する Unity Catalog のカタログ。
--channel string
DLT 使用するバージョンを指定する Release チャンネル。
--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 pipelines get-permission-levels
パイプラインのアクセス許可レベルを取得します。
databricks pipelines get-permission-levels PIPELINE_ID [flags]
引数
PIPELINE_ID
アクセス許可を取得または管理するパイプライン。
オプション
databricks pipelines get-permissions
パイプラインのアクセス許可を取得します。パイプラインは、ルート オブジェクトからアクセス許可を継承できます。
databricks pipelines get-permissions PIPELINE_ID [flags]
引数
PIPELINE_ID
アクセス許可を取得または管理するパイプライン。
オプション
databricks pipelines set-permissions
パイプラインのアクセス許可を設定します。
オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。指定されていない場合は、すべての直接アクセス許可を削除します。オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。
databricks pipelines set-permissions PIPELINE_ID [flags]
引数
PIPELINE_ID
アクセス許可を取得または管理するパイプライン。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
databricks pipelines update-permissions
パイプラインのアクセス許可を更新します。パイプラインは、ルート オブジェクトからアクセス許可を継承できます。
databricks pipelines update-permissions PIPELINE_ID [flags]
引数
PIPELINE_ID
アクセス許可を取得または管理するパイプライン。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
グローバルフラグ
--debug
デバッグログを有効にするかどうか。
-h または --help
Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。
--log-file string
出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。
--log-format format
ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。
--log-level string
ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。
-o, --output タイプ
コマンド出力タイプ text または json。デフォルト値は textです。
-p, --profile string
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format format
進行状況ログを表示する形式: default、 append、 inplace、 json
-t, --target string
該当する場合は、使用するバンドル・ターゲット