Lakeflow Designer でパラメーターを使用する
パラメータ は、ビジュアルデータ準備全体に対して定義される名前付き値です。SQLおよびPythonのオペレーターコード、サポートされているオペレーター設定フィールド、およびオペレーターの有効化または無効化を行う式で、パラメーターを参照できます。パラメーターを使用すると、開発環境でのテストカタログや本番運用環境での本番運用カタログなど、異なる環境で同じビジュアルデータ準備を実行できます。
パラメーターの定義
パラメーターを管理するには、左ペイン の[パラメーター] を選択します。各パラメーターには、定義時に設定する値があります。ビジュアルデータの準備がスケジュールに従って、またはジョブとしてランされる場合、その値を上書きできます。本番運用でパラメーター値を上書きするを参照してください。
演算子のパラメーターを参照する
パラメーターを参照する方法は、その使用場所によって異なります。
- SQL演算子 :
:environmentなどの名前付きパラメーターマーカー構文を使用します。名前付きパラメーターマーカーの使用を参照してください。 - Python演算子 ：
dbutils.widgets.get("environment")などのdbutils.widgets.get()を呼び出します。「ウィジェット・ツール（dbutils.widgets）」を参照してください。 - サポートされている演算子構成フィールド : 演算子の構成ペインで、右上隅の パラメーター を選択します。フィールドを選択し、
:source_tableのような式を入力します。サポートされているフィールドは以下のとおりです。- ソース : テーブル 、 ファイルパス 、および ファイル形式 。
- 出力 ： カタログ 、 スキーマ 、 テーブル 、 ビュー 、 ボリューム 、 ファイル名 、および 書き込みモード 。
- 制限 : 制限 。
- Combine ： セット操作 、 Merge戦略 、 名前による結合 、 不足している列を許可 。
SQLまたはPython演算子を開いて編集する場合、Lakeflow Designerは、ソースエディタの上で利用可能なパラメーターを参照する方法の例を表示します。
パラメーターと固定テキストを組み合わせる
ソースまたは出力演算子のパラメーター式で、 :parameter_name を使用して値全体を置き換えます。パラメーターと固定テキストを組み合わせるには、テキストを単一引用符で囲み、 || を使用します。たとえば、次のソース テーブル 式は、完全修飾テーブル名を構成します。
:catalog || '.' || :schema || '.' || :table
パラメーターで演算子を有効または無効にする
パラメーターを使用して、構成された演算子を有効または無効にすることができます。 パラメーター ペインで、 無効 を選択し、Boolean式を入力します。たとえば、:skip_operatorはパラメーターがtrueの場合に演算子を無効にします。無効にした演算子は出力行を生成しません。
演算子を手動で有効または無効にする場合は、 演算子の名前変更、コピー、削除、無効化を参照してください。
本番運用でパラメーター値を上書きする
ランタイムに、ビジュアルデータ準備は対話形式で実行されるかジョブとして実行されるかに関係なく同じ方法でパラメーターを読み取るため、同じファイルがすべての環境で変更なしで機能します。各環境に異なる値を次のように供給します。
- UIでジョブをスケジュールする場合 ：スケジュールのたびにパラメーター値を上書きします。たとえば、同じビジュアルデータ準備を毎日正午に
environmentパラメーターをtestに設定して実行し、午後2時にenvironmentをproductionに設定して再度実行するようにスケジュールします。ジョブとしてスケジュール」を参照してください。 - バンドルを使用してデプロイする場合 : ジョブの
parametersを介してパラメータ値を設定し、バンドルターゲットを使用して環境ごとに異なる値を指定します。バンドルの開発および本番運用ターゲットを使用すると、環境固有の設定を使用して、同じジョブを個別の環境にデプロイできます。宣言型オートメーションバンドルのデプロイモードと宣言型オートメーションバンドルの構成を参照してください。