パラメータ

SQLブロックからパラメータを参照すると、パラメータの値によって動的にSQLを生成できます。パラメータを定義すると、ドキュメントページやグリッドページの上部に入力フォームが表示されます。グリッドページでは、入力フォームをタイルとしても配置できます。

ノートブック上のパラメータの値と実行結果は、閲覧中のユーザー間で同期されます。ユーザーごとに独立させたい場合は、バージョンやレポートを利用します。

主な機能

• スコープ: ノートブック共通 / ページ固有
• 種類とデータ型
• SQLでの利用パターン
• エスケープと動的参照
• 相対日付
• 動的な選択肢の生成
• URLからの指定
• グリッドページへの配置

作成・管理

1. メインエリア上部 の パラメータ を開きます
2. パラメータを追加 からスコープ（ノートブック共通 / ページ固有）と種類を選びます
3. SQLブロック内で /param/ と入力し、候補からパラメータを選択します

選択すると、パラメータ参照が SQL 内に埋め込まれます。表示はパラメータのラベルです。

例えば、ラベルが param1 の文字列パラメータに val1 を入力した場合、次の SQL は実行時に 'val1' へ展開されます。

-- SQLブロック上の表示
SELECT {{param1}}

-- 生成されるSQL
SELECT 'val1'

TIP

上記の {{param1}} は説明用の表記です。画面上ではラベル付きの参照チップとして表示されます。

パラメータごとに次の操作ができます。

操作	説明
設定	種類ごとの入力フォーム設定（種類とデータ型）を編集します
デフォルト値	リセット時に適用する値を設定します。日付系では相対日付も選べます
デフォルト値にリセット	そのパラメータの現在値をデフォルト値へ戻します
削除	パラメータ定義を削除します。SQLブロックなどから参照中のパラメータは削除できません

パラメータフォームでは、使用中 と すべて表示 で表示を切り替えられます。

表示	説明
使用中	選択中のページの SQL などから参照されているパラメータだけを表示します
すべて表示	参照の有無にかかわらず、定義済みのパラメータをすべて表示します

リセット ボタンで、表示中のパラメータをまとめてデフォルト値へ戻せます。

グリッドページでは、パラメータをタイルとして配置できます。SQL などから参照されているパラメータは、ページ上部のパラメータフォームとタイルの両方で値を変更できます。

パラメータのスコープ

パラメータには次の2つのスコープがあります。いずれのスコープでも、値はページごとに保持されます。

スコープ	説明
ノートブック共通	ノートブック内のすべてのページでパラメータ定義が共有されます。値は各ページで保持されます。
ページ固有	選択中のページ内でのみ有効なパラメータ定義です。値も選択中のページでのみ保持されます。

複数のページから参照する SQLブロックで使う場合は ノートブック共通、そのページだけで使う場合は ページ固有 を選びます。例えば、ドキュメントページで作成したチャートをグリッドページで参照する場合、チャートのデータソースとなる SQLブロックではノートブック共通のパラメータを使います。

値の展開とデフォルト値

SQL へ埋め込まれるのは、各ページに保持されているパラメータの値です。

• デフォルト値は、リセット（または個別の デフォルト値にリセット）を実行したときにパラメータの値へ書き込まれます
• 値が未設定（入力フォームが空の状態）のパラメータは、種類ごとのゼロ値で展開されます
• ゼロ値は SQL として有効な型ごとの値になるため、値が未設定でも多くの場合 SQL はエラーになりません。値が未設定の場合に、任意の絞り込みにする書き方はSQLでの利用パターンを参照してください

日付のデフォルト値に相対日付を設定した場合、リセットのたびにその時点の日付が現在値へ書き込まれます。適用タイミングの詳細は相対日付を参照してください。

パラメータの上書き

SQLブロックを参照する際に（SQLブロックをチェインする際に）、参照先 SQL 内のパラメータ依存を切り離したい場合があります。例えば次のようなケースです。

• ページをまたいで SQL をチェインし、各ページで固有のパラメータを参照したい場合
• 同じベース SQL から派生した別 SQL で、異なるパラメータを参照したい場合

SQLブロック参照（グリッドページのクエリ実行結果・チャートも含む）にカーソルを合わせると表示されるポップアップで、内部のパラメータ参照を上書きできます。上書き方法は次のとおりです。

方法	説明
他のパラメータで上書き	同じ型の別パラメータの値で置き換えます
固定値で上書き	固定値を指定します
上書きしない	展開規則に従います（ノートブック共通は参照元ページの値など）

挿入方法や展開時の設定（()で囲まない / 末尾にエイリアスを付与）は SQLブロックの参照 を参照してください。

パラメータ値の同期

ノートブックでは、パラメータ値と実行結果はユーザー間で同期されます。同時編集を避けたい場合はバージョンを利用してください。

バージョンやインタラクティブレポートでは、パラメータ変更はユーザー間で同期されず、変更したユーザーにのみ反映されます。これらの機能ではパラメータ変更が URL にも同期されます（URLからの指定）。

レポートのページ間同期

レポート公開時に パラメータの変更をページ間で同期 を有効にすると、ノートブック共通パラメータの変更が公開ページ間で同期されます。ページ固有パラメータは連動しません。詳細はレポートを参照してください。