パラメータ

動的なノートブックとレポートを作成する

ノートブックでパラメータを使用することで、ノートブックやレポートを動的かつインタラクティブにすることができます。これにより、SQLに直接アクセスすることなくパラメータを通じて埋め込まれたSQLを制御し、必要に応じてカスタマイズされた出力を得ることができます。

主な機能

  • 動的なノートブックとレポート:

    • ノートブックとレポートをダイナミックかつインタラクティブにします。

  • 様々な種類のパラメータ:

    • 多様な入力ウィジェットとデータ型から選択できます。

  • エスケープ処理と動的な参照の生成:

    • パラメータがSQL内のどのようなコンテキストで使用されるかに応じて、エスケープ処理が変わります。

  • 2種類のスコープ:

    • ノートブック全体で使用するパラメータか、ページごとに使用するパラメータかを選択できます。

  • パラメータの上書き:

    • SQLをチェインさせる際にパラメータを上書きすることで、きめ細かな制御が可能です。

使用方法

パラメータを作成して、ノートブック内のSQLブロックで/param/{param_name}と入力すると、パラメータへの参照をSQLブロック内に埋め込むことができます。

例えば、param1という名前の文字列パラメータを作成し、値としてval1を入力した場合、以下のSQL:

SELECT {{param1}}

は以下のように変換されます:

SELECT 'val1'

パラメータのスコープ

パラメータには次の2種類のスコープがあります。

  • ノートブック共通

    • ノートブックのすべてのページで共有されるパラメータ

    • パラメータ定義はノートブック全体で共有されますが、値は各ページで保持されます

  • ページ固有

    • 各ページに固有のパラメータ

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

パラメータの上書き

SQLをチェインさせる際に、パラメータの依存関係を切断したい場合があります。例えば:

  • ページをまたいでSQLをチェインさせる際に、各ページで固有のパラメータを設定する。

  • 同じベースSQLから派生した異なるSQLで異なるパラメータを使用する。

SQLブロックでSQLを参照している箇所にカーソルを合わせると表示されるポップアップで、パラメータを上書きできます。

パラメータ値の同期

ノートブックのパラメータ値と実行結果はユーザー間で同期されます。ただし、ノートブックのバージョンやレポートを使用することで、パラメータ値と実行結果の変更がユーザー間で同期されず、値を変更したユーザーにのみ変更が反映されるようになります。

詳細については、ノートブックバージョンを参照してください。

最終更新

役に立ちましたか?