Appearance
クエリ ベータ
概要
クエリは、コネクション 単位で再利用する SQL を保存する機能です。複数のノートブックから同じ SQL を参照したり、クエリ画面で直接実行したりできます。グローバルナビ > クエリ から利用します。導線は ナビゲーション を参照してください。
専用のリソースロールはありません。操作可否は紐づくコネクションの権限に準じます。詳細は クエリの権限 を参照してください。
INFO
この機能はベータです。仕様は予告なく変更される場合があります。
主な機能
- SQL の保存と実行: クエリ画面で編集・保存し、実行 から SQL を発行できます
- フォルダによる整理: コネクション配下でクエリを整理します(ノートブックのフォルダ とは別系統です)
- ノートブック連携: SQLブロックからの SQLを保存、および
/による保存済みクエリの参照ができます(SQLブロック) - カタログ の クエリ タブ: メタデータ(説明・タグ・カラム・参照・人気度など)を確認・編集できます
- ワークフロー: 保存済みクエリをスケジュール実行できます
- タグ: クエリタグを付与できます。定義はワークスペース設定で管理します
作成
クエリ画面から
- グローバルナビ > クエリ を開きます
- クエリを作成 をクリックします(下書きが開き、コネクションを選択できます)
- SQL を編集し、保存 で名前・コネクション・フォルダを指定して本保存します
左ツリーのコネクションまたはフォルダから クエリを作成 すると、その位置に空のクエリを直接作成できます。フォルダの作成・移動も左ツリーから行えます。
ノートブックから
- ノートブックの SQLブロック右上メニューから SQLを保存 を選びます
- 名前・コネクション・フォルダを指定して保存します
保存時の挙動は次のとおりです。
- 他の SQLブロック参照・保存済みクエリ参照は、展開済みの SQL 文字列として保存されます
- パラメータは、その時点の値に置き換えて保存されます
- 説明には、元ノートブックへのリンク(
Source notebook: ...)が自動で入ります - 直近の実行結果がある場合、カラム情報も保存できます
編集・実行・管理
| 操作 | 説明 |
|---|---|
| 保存 / 名前を付けて保存... | SQL・名前などを更新します。別名保存もできます |
| 実行 | 紐づくコネクションの認証情報で SQL を実行します |
| スター | 一覧の スター タブやクイック検索向けに付与・解除します |
| 説明・タグ | クエリ詳細、または カタログ から編集します |
| カラム | 説明やタグを付与できます(実行結果のカラム情報を基に管理します) |
| ノートブックを作成 | 当該クエリを含むノートブックを新規作成します |
| 移動・削除 | 左ツリーや詳細メニューから行います。移動は同一コネクション内のみです |
| 履歴 | 過去バージョンを閲覧できます(復元操作はありません) |
本保存後は、所属コネクションを変更できません。コネクションを変えたい場合は、名前を付けて保存... などで別クエリとして作り直してください。
ノートブックとの連携
- 参照: SQLブロックで
/を入力し、保存済クエリ から挿入します。実行時は参照先の SQL が展開されます - 保存: SQLを保存 では、参照やパラメータは展開・置換された固定 SQL になります(ライブ参照は残りません)
ノートブック側の詳細は SQLブロック を参照してください。
制約
- 保存済みクエリ本体には、パラメータの埋め込みや他の保存済みクエリへの参照はできません(クエリ画面の SQL エディタには挿入手段がありません)
- 所属コネクションの変更はできません(本保存後)
- クエリ・フォルダの移動は同一コネクション内に限ります
- フォルダの階層は最大 5 です(制約と上限値)
- フォルダを削除すると、配下のクエリも削除されます
- クエリ数の上限はプランにより異なります(制約と上限値。グローバルナビ > ワークスペース設定 > 使用量 で確認できます)
- コネクションを削除 すると、関連する保存済みクエリも削除されます
権限
操作ごとの条件は クエリの権限 を参照してください。閲覧はコネクションの読み取り系、作成・更新・削除・実行・フォルダ操作はコネクションの実行権限が必要です。