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