# パラメータ

<figure><img src="https://1959197998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvyRvOrlY46GCAFYEPPGZ%2Fuploads%2Fgit-blob-946760a0986b88cd9e1382b3fbde4202e0301d19%2Fparameters.png?alt=media" alt=""><figcaption></figcaption></figure>

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

## 主な機能

* 動的なノートブックとレポート:
  * ノートブックとレポートをダイナミックかつインタラクティブにします。
* [様々な種類のパラメータ](https://docs.codatum.jp/data-exploration/parameter-overview/parameter-types):
  * 多様な入力ウィジェットとデータ型から選択できます。
* [エスケープ処理と動的な参照の生成](https://docs.codatum.jp/data-exploration/parameter-overview/escape-and-dynamic-reference):
  * パラメータがSQL内のどのようなコンテキストで使用されるかに応じて、エスケープ処理が変わります。
* 2種類のスコープ:
  * ノートブック全体で使用するパラメータか、ページごとに使用するパラメータかを選択できます。
* パラメータの上書き:
  * SQLをチェインさせる際にパラメータを上書きすることで、きめ細かな制御が可能です。

## 使用方法

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

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

```sql
SELECT {{param1}}
```

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

```sql
SELECT 'val1'
```

## パラメータのスコープ

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

* `ノートブック共通`
  * ノートブックのすべてのページで共有されるパラメータ
  * パラメータ定義はノートブック全体で共有されますが、値は各ページで保持されます
* `ページ固有`
  * 各ページに固有のパラメータ

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

## パラメータの上書き

<figure><img src="https://1959197998-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvyRvOrlY46GCAFYEPPGZ%2Fuploads%2Fgit-blob-19d5bd154cf2d335bd2f2ffb172186a1d44aebac%2FCleanShot%202024-07-03%20at%2018.00.30%402x.png?alt=media" alt=""><figcaption></figcaption></figure>

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

* ページをまたいでSQLをチェインさせる際に、各ページで固有のパラメータを設定する。
* 同じベースSQLから派生した異なるSQLで異なるパラメータを使用する。

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

## パラメータ値の同期

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

詳細については、[ノートブックバージョン](https://github.com/codatum/support-site-gitbook/blob/main/ja/data-exploration/parameter/notebook/version.md)を参照してください。

## レポート機能のノートブック共通パラメータ

設定したパラメータは、レポートのページ間で同期することができます。

レポート機能において同期設定を有効にすると、ノートブック共通のパラメータの値を変更したときに、任意のページ間で変更が同期されます。なお、ページ固有パラメータは連動しません。

詳細については、[レポート](https://docs.codatum.jp/sharing/report)を参照してください。


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.codatum.jp/data-exploration/parameter-overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
