パラメータを使用すると、クエリのフィルターや計算で使用する値を、実行時に毎回指定することができます。実行時にこれらの値を設定することで、実行するたびに、アカウント、地域、期間など、異なるコンテキストでクエリを使用することができます。
特定のクエリで使用するカスタムパラメータを作成したり、ワークスペース所有者(Workspace Owner)が複数のクエリで使用するグローバルパラメータを作成したりできます。
クエリのカスタムパラメータを作成する
クエリのパラメータはビルダーでも SQLエディターでも設定できます。パラメータを作成すると、そのパラメータをクエリ内の複数のフィルターや計算で使用することができます。
ステップ1:パラメータを作成する
- [パラメータ]パネルで[追加]をクリックし、[新しいパラメータの作成]を選択します。
- パラメータを識別しやすくするために、英数文字のみでスペースを含まない 一意の名前を入力します。
- [フィルターのタイプ]で、テキストや整数など、フィルターに使用するデータのタイプを選択します。
ステップ2:パラメータの値を設定する
クエリが実行されるとき、そのパラメータはデータタイプに基づいた自由形式の値を承認することも、特定の値のリストから選択することもできます。
- フリーフォームの値を承認するには、デフォルト(該当する場合)を入力して[作成]をクリックします。
- 特定の値のリストを提供する手順は次の通りです。
- 有効ピックリスト.
- パラメータに複数の値を設定するには、Multi-Selectボックスをチェックします。
- [リストオプション]から、選択肢となる値を入力します。それぞれの値の入力後に Enter キーを押します。
注: 日付またはタイムスタンプパラメータの場合、各オプションを
YYYY-MM-dd
書式で入力する。 - パラメータの任意のデフォルト値を選択し、Accept をクリックする。
注: 複数選択可能な パラメータでは、少なくとも1つのデフォルト値を選択する。
- [作成]をクリックして終了します。
ステップ3:クエリでパラメータを使用する
パラメータの値をクエリに適用し、フィルターまたは計算で使用する手順は次の通りです。
- ビルダーのパラメータに基づいてフィルターの値を設定するには、[フィルターのプロパティ]の右パネルからフィルターを定義する際に値を選択します。
注: 複数選択 パラメータについては、[リストに含まれる] または[リストに含まれない] のフィルター演算子 をフィルター タブで選択します。
- SQLエディターでフィルターと共にパラメータを使用したり、計算時にその値を参照する場合は、SQL文中のコロン( :)の後にその名前を入力します(例::ReportingPeriod)。
クエリ内でグローバルパラメータを使用する
ワークスペース所有者は、複数のクエリで使用される共通の値について、グローバル・パラメータ を構成できます。クエリでグローバル・パラメータを使用するには:
- [パラメータ]パネルで[追加]をクリックし、[グローバルパラメータを選択]を選択します。
- クエリ内で使用するグローバルパラメータを選択し、[追加]をクリックします。
- グローバルパラメータを編集するには、目的のパラメータを選択し、クエリに対する必要に応じてその名前、または値を更新します。
注: 分析の一貫性を確保するために、ワークスペース所有者はグローバル パラメータをロックして、その値を編集できないようにすることができます。
-
グローバルパラメータの値をクエリに適用し、フィルターまたは計算で使用する手順は次の通りです。
- ビルダーのパラメータに基づいてフィルターの値を設定するには、[フィルターのプロパティ]の右パネルからフィルターを定義する際に値を選択します。
注: 複数選択 パラメータについては、[リストに含まれる] または[リストに含まれない] のフィルター演算子 をフィルター タブで選択します。
- SQLエディターでパラメータを参照するには、SQL文中でコロン(:)の後にその名前を入力します。(例 :ReportingPeriod)
- 計算のSQL文中でパラメータの値を参照するには、[パラメータ]のメニューから目的のパラメータを選択します。
- ビルダーのパラメータに基づいてフィルターの値を設定するには、[フィルターのプロパティ]の右パネルからフィルターを定義する際に値を選択します。
クエリパラメータを編集する
パラメータの詳細を調整または管理する手順は次の通りです。
- パラメータパネルから、編集するパラメータを選択します。
- 必要に応じて、パラメータの名前、データタイプ、または値を編集します。
- [適用]をクリックします。
クエリパラメータを削除する
パラメータが不要になった場合は、クエリから削除することができます。パラメータパネルから、パラメータの削除 をクリックし、保存 をクリックする。