jobs コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI 内の jobs コマンド グループを使用すると、ジョブを作成、編集、削除できます。LakeFlowジョブを参照してください。
databricks jobs cancel-all-runs
ジョブのアクティブな実行をすべてキャンセルします。実行は非同期にキャンセルされるため、新しい実行の開始が妨げられることはありません。
databricks jobs cancel-all-runs [flags]
引数
なし
オプション
--all-queued-runs
キューに入れられたすべての実行をキャンセルするためのオプションのブール値パラメーター。
--job-id int
すべての実行をキャンセルするジョブの正規識別子。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
databricks jobs cancel-run
実行をキャンセルします。
ジョブの実行またはタスクの実行を取り消します。実行は非同期に取り消されるため、この要求が完了しても実行されている可能性があります。
databricks jobs cancel-run RUN_ID [flags]
引数
RUN_ID
このフィールドは必須です。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--no-wait
TERMINATED または SKIPPED 状態に達するのを待たないでください。
--timeout duration
TERMINATED または SKIPPED 状態に達するまでの最大時間 (デフォルトは 20m0s)
databricks jobs create
新しいジョブを作成します。
databricks jobs create [flags]
引数
なし
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
databricks jobs delete
ジョブを削除します。
databricks jobs delete JOB_ID [flags]
引数
JOB_ID
削除するジョブの正規識別子。このフィールドは必須です。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
databricks jobs delete-run
非アクティブな実行を削除します。実行がアクティブな場合はエラーを返します。
databricks jobs delete-run RUN_ID [flags]
引数
RUN_ID
削除する実行の ID。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
databricks jobs export-run
ジョブ実行タスクをエクスポートして取得します。
databricks jobs export-run RUN_ID [flags]
引数
RUN_ID
実行の正規識別子。このフィールドは必須です。
オプション
--views-to-export ViewsToExport
エクスポートするビュー。サポートされている値: ALL、 CODE、 DASHBOARDS
databricks jobs get
1 つのジョブの詳細を取得します。
結果内の大きな配列は、100 要素を超えるとページ分割されます。1 つのジョブを要求すると、そのジョブのすべてのプロパティと、配列プロパティの最初の 100 個の要素 (タスク、job_clusters、環境、パラメーター) が返されます。next_page_token フィールドを使用して、より多くの結果を確認し、後続の要求でその値をpage_tokenとして渡します。配列プロパティに 100 を超える要素がある場合、後続の要求で追加の結果が返されます。追加の結果のない配列は、後のページでは空になります。
databricks jobs get JOB_ID [flags]
引数
JOB_ID
情報を取得するジョブの正規識別子。このフィールドは必須です。
オプション
--page-token string
前の GetJob 応答から返されたnext_page_tokenを使用して、ジョブの配列プロパティの次のページを要求します。
databricks jobs get-run
ジョブ実行のメタデータを取得します。
結果内の大きな配列は、100 要素を超えるとページ分割されます。1 回の実行の要求は、その実行のすべてのプロパティと、配列プロパティの最初の 100 個の要素 (タスク、job_clusters、job_parameters、repair_history) を返します。next_page_token フィールドを使用して、より多くの結果を確認し、後続の要求でその値をpage_tokenとして渡します。配列プロパティに 100 を超える要素がある場合、後続の要求で追加の結果が返されます。追加の結果のない配列は、後のページでは空になります。
databricks jobs get-run RUN_ID [flags]
引数
RUN_ID
メタデータを取得する実行の正規識別子。このフィールドは必須です。
オプション
--include-history
応答に修復履歴を含めます。
--include-resolved-values
解決されたパラメーター値を応答に含めます。
--page-token string
前の GetRun 応答から返されたnext_page_tokenを使用して、実行の配列プロパティの次のページを要求します。
databricks jobs get-run-output
1 つのタスク実行の出力とメタデータを取得します。ノートブックタスクが dbutils.ノートブック.exit() を介して値を返す場合 call を呼び出した場合、このコマンドを使用してその値を取得できます。Databricks では、この API は出力の最初の 5 MB を返すように制限されています。より大きな結果を返すには、ジョブの結果をクラウドストレージサービスに保存します。
このコマンドは、 run_id パラメーターが有効であることを検証し、 run_id パラメーターが無効な場合は HTTP 状態コード 400 を返します。実行は 60 日後に自動的に削除されます。60 日を超えて参照する場合は、有効期限が切れる前に古い実行結果を保存する必要があります。
databricks jobs get-run-output RUN_ID [flags]
引数
RUN_ID
実行の正規識別子。
オプション
databricks jobs list
ジョブのリストを取得します。
databricks jobs list [flags]
引数
なし
オプション
--expand-tasks
タスクとクラスターの詳細を応答に含めるかどうか。
--limit int
返すジョブの数。
--name string
正確な (大文字と小文字を区別しない) ジョブ名に基づくリストのフィルター。
--offset int
最後に作成されたジョブを基準にした、返される最初のジョブのオフセット。
--page-token string
前の要求から返されたnext_page_tokenまたはprev_page_tokenを使用して、ジョブの次ページまたは前のページをそれぞれ一覧表示します。
databricks jobs list-runs
ジョブの実行を開始時刻の降順でリストします。
databricks jobs list-runs [flags]
引数
なし
オプション
--active-only
active_onlyが true の場合、アクティブな実行のみが結果に含まれます。それ以外の場合は、アクティブな実行と完了した実行の両方が一覧表示されます。
--completed-only
completed_onlyが true の場合、完了した実行のみが結果に含まれます。それ以外の場合は、アクティブな実行と完了した実行の両方が一覧表示されます。
--expand-tasks
タスクとクラスターの詳細を応答に含めるかどうか。
--job-id int
実行を一覧表示するジョブ。
--limit int
返す実行の数。
--offset int
返される最初の実行のオフセット (最新の実行を基準にした)。
--page-token string
前の要求から返されたnext_page_tokenまたはprev_page_tokenを使用して、実行の次ページまたは前のページをそれぞれ一覧表示します。
--run-type RunType
返す実行の種類。サポートされている値: [JOB_RUN, SUBMIT_RUN, WORKFLOW_RUN]
--start-time-from int
この値 以降に 開始された実行を表示します。
--start-time-to int
この値 以前に 開始された実行を表示します。
databricks jobs repair-run
1 つ以上のジョブタスクを再実行します。タスクは、元のジョブ実行の一部として再実行されます。現在のジョブとタスクの設定が使用され、元のジョブ実行の履歴で表示できます。
databricks jobs repair-run RUN_ID [flags]
引数
RUN_ID
修復する実行のジョブ実行 ID。実行は進行中であってはなりません。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--latest-repair-id int
最新の修復の ID。
--no-wait
TERMINATED または SKIPPED 状態に達するのを待たないでください。
--performance-target PerformanceTarget
サーバレス ジョブのパフォーマンス モード。 サポートされている値: [PERFORMANCE_OPTIMIZED, STANDARD]
--rerun-all-failed-tasks
true の場合、失敗したすべてのタスクを修復します。
--rerun-dependent-tasks
true の場合、rerun_tasks のタスクに依存するすべてのタスクを修復します (以前に成功していた場合でも)。
--timeout duration
TERMINATED または SKIPPED 状態に達するまでの最大時間 (デフォルトは 20m0s)
databricks jobs reset
指定されたジョブのすべての設定を上書きします。databricks jobs update コマンドを使用して、ジョブ設定を部分的に更新します。
databricks jobs reset [flags]
引数
なし
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
databricks jobs run-now
実行ジョブを実行し、トリガーされた実行のrun_idを返します。
databricks jobs run-now JOB_ID [flags]
引数
JOB_ID
実行するジョブの ID
オプション
--idempotency-token string
ジョブ実行要求のべき等性を保証するためのオプションのトークン。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--no-wait
TERMINATED または SKIPPED 状態に達するのを待たないでください。
--performance-target PerformanceTarget
サーバレス ジョブのパフォーマンス モード。 サポートされている値: [PERFORMANCE_OPTIMIZED, STANDARD]
--timeout duration
TERMINATED または SKIPPED 状態に達するまでの最大時間 (デフォルトは 20m0s)
databricks jobs submit
1 回限りの実行を作成してトリガーします。これにより、ジョブを作成せずにワークロードを直接送信できます。
databricks jobs submit [flags]
引数
なし
オプション
--budget-policy-id string
この 1 回限りの実行に使用する予算ポリシーのユーザーが指定した ID。
--idempotency-token string
ジョブ実行要求のべき等性を保証するために使用できるオプションのトークン。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--no-wait
TERMINATED または SKIPPED 状態に達するのを待たないでください。
--run-name string
実行のオプションの名前。
--timeout duration
TERMINATED または SKIPPED 状態に達するまでの最大時間 (デフォルトは 20m0s)
--timeout-seconds int
このジョブの各実行に適用されるオプションのタイムアウト。
databricks jobs update
既存のジョブの特定の設定を追加、更新、または削除します。resetを使用して、すべてのジョブ設定を上書きします。
databricks jobs update JOB_ID [flags]
引数
JOB_ID
更新するジョブの正規識別子。このフィールドは必須です。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
databricks jobs get-permission-levels
ジョブ権限レベルを取得します。
databricks jobs get-permission-levels JOB_ID [flags]
引数
JOB_ID
アクセス許可を取得または管理するジョブ。
オプション
databricks jobs get-permissions
ジョブのアクセス許可を取得します。ジョブは、ルート オブジェクトからアクセス許可を継承できます。
databricks jobs get-permissions JOB_ID [flags]
引数
JOB_ID
アクセス許可を取得または管理するジョブ。
オプション
databricks jobs set-permissions
ジョブの権限を設定します。
オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。指定されていない場合は、すべての直接アクセス許可を削除します。オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。
databricks jobs set-permissions JOB_ID [flags]
引数
JOB_ID
アクセス許可を取得または管理するジョブ。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
databricks jobs update-permissions
ジョブのアクセス許可を更新します。ジョブは、ルート オブジェクトからアクセス許可を継承できます。
databricks jobs update-permissions JOB_ID [flags]
引数
JOB_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
該当する場合は、使用するバンドル・ターゲット