ジョブ パラメーターの構成
この記事では、ジョブ パラメーターの機能と、 Databricks ワークスペース UI を使用したジョブ パラメーターの構成について説明します。 また、REST API、CLI、および DAB で使用される JSON および YAML 定義にジョブ・パラメーターを追加することもできます。 「ジョブ API」、「Databricks CLI とは」、および「Databricks アセットバンドルとは」を参照してください。
ジョブ パラメーターとは
ジョブ パラメーターは、デフォルトの静的または動的な値でジョブをパラメーター化できるキーと値のペアです。 オプションで、新しい実行をトリガーするときに、ジョブで設定されたパラメーターを上書きできます。 「異なるパラメーターを使用したジョブの実行」を参照してください。
ジョブ・パラメーター・キーには、 _ - .
文字または英数字のみを含めることができます。 パラメーター値は、文字列または動的な値参照として設定されます。 動的値参照とはを参照してください。
注:
任意の有効な JSON をパラメーター値として使用できます。 たとえば、 For each
タスクタイプでは、次のようなリストを解析できます。
[1, 2, 3]
['a', 'b', 'c']
ジョブ パラメーターの追加または編集
ジョブ パラメーター ダイアログを使用して、新しいパラメーターの追加、既存のパラメーターのキーと値の編集、またはパラメーターの削除を行います。
ワークスペース UI でパラメーターを編集するには、次の手順を使用して既存のジョブを選択します。
サイドバーの[ワークフロー]をクリックします。
「名前」列で、ジョブ名をクリックします。
[ジョブの詳細] サイドバーで、[パラメーターの編集] をクリックします。「ジョブ・パラメーター」ダイアログが表示されます。
[キー] フィールドと [値] フィールドを使用してパラメーターを追加または編集します。
をクリックして 、パラメーターを削除します。
[保存] をクリックして、変更を適用します。
注:
{ } をクリックして、使用可能な動的値参照をリストします。リストからオプションを選択して、そのオプションを 「値 」フィールドに挿入します。
ジョブ・パラメーターのプッシュダウン
ジョブ パラメーターは、key-value パラメーターを受け入れるすべてのタスク (次のタスク タイプを含む) に key-value パラメーターとして自動的にプッシュダウンされます。
ノートブック
Python wheel (キーワード引数で設定されている場合のみ)
SQL クエリ、レガシ ダッシュボード、またはファイル
ジョブを実行
タスクに渡されたジョブ パラメーターは、構成されたタスク パラメーターと共に UI のタスク構成に表示されます。
重要
ジョブ・パラメーターは、タスク・パラメーターよりも優先されます。 ジョブ・パラメーターとタスク・パラメーターのキーが同じ場合、ジョブ・パラメーターはタスク・パラメーターをオーバーライドします。
ジョブ・パラメーターへの動的値参照
動的値参照を受け入れるすべてのタスクは、ジョブ・パラメーターにアクセスできます。
動的値参照 {{job.parameters.<name>}}
を使用し、 <name>
をパラメーターを識別する key
に置き換えます。
別のパラメータで今すぐジョブを実行
構成されたジョブ・パラメーターをオーバーライドしたり、異なるパラメーターを使用してジョブを実行するときに新しいジョブ・パラメーターを追加したりできます。 「異なるパラメーターを使用したジョブの実行」を参照してください。
また、ジョブ実行を修復するときに、ジョブ・パラメーターをオーバーライドすることもできます。 失敗したタスクとスキップされたタスクの再実行を参照してください。