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