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