Codatum Docs

Appearance

ジョブラベル ベータ ​

概要 ​

Codatum がデータウェアハウスへ発行するSQLに、実行元（どのノートブック / レポート / 保存済みクエリ / 署名付き埋め込みから実行されたか）を示すメタデータを付与します。コネクション画面での設定項目はありません（実行時に自動付与）。

INFO

この機能はベータです。仕様は予告なく変更される場合があります。

付与対象 / 対象外 ​

  • 付与対象: ノートブックのセル実行 / 保存済みクエリ / レポート / 署名付き埋め込み / Codatum CLI や AIエージェントなどからのアドホック SQL 実行
  • 対象外: 内部メタデータ取得系（DryRun・スキーマ取得・データプレビュー等）

cdm_source_type（Snowflake / SQL コメントでは source_type）が unknown のときは、ノートブック・保存済みクエリ・レポート・署名付き埋め込みのいずれの ID も付いていない実行です（例: Codatum CLI のアドホック SQL）。CLI からノートブック上の SQL を実行する場合は notebook になります。

cdm_actor_type / actor_type は実行主体です。CLI は PAT のため通常 user（BigQuery）/ USER（Snowflake・SQL コメント）です。api_key は主に署名付き埋め込み（ワークスペース APIキー）です。

実行元の優先順位 ​

主たる実行元 ID は 1つだけ付与されます。優先順位は次のとおりです。

レポート > 署名付き埋め込み > ノートブック > 保存済みクエリ

レポート実行時はノートブック ID ではなくレポート ID が載ります。いずれの ID もない場合は unknown です。

BigQuery（ジョブラベル） ​

ラベルキー内容
source常に codatum
cdm_source_typenotebook / query / report / signed_embed / unknown
cdm_<source_type>_id主たる実行元 ID（例: cdm_notebook_id / cdm_report_id）
cdm_workspace_idワークスペース ID
cdm_connection_idコネクション ID
cdm_actor_typeuser / workflow / api_key / admin / system（BigQuery のラベル値は小文字）

INFORMATION_SCHEMA.JOBS のラベルから参照できます。

sql
SELECT
  job_id,
  creation_time,
  total_bytes_billed,
  (SELECT value FROM UNNEST(labels) WHERE key = 'cdm_source_type') AS source_type,
  (SELECT value FROM UNNEST(labels) WHERE key = 'cdm_notebook_id') AS notebook_id,
  (SELECT value FROM UNNEST(labels) WHERE key = 'cdm_report_id') AS report_id
FROM `region-us`.INFORMATION_SCHEMA.JOBS
WHERE creation_time > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 7 DAY)
  AND EXISTS (SELECT 1 FROM UNNEST(labels) WHERE key = 'source' AND value = 'codatum')

region-us は対象データセットのリージョンに合わせて変更してください。

Snowflake（QUERY_TAG） ​

同等の実行元情報を QUERY_TAG（JSON）として付与します。QUERY_HISTORY の QUERY_TAG を参照してください。

キー内容
source常に codatum
source_typenotebook / query / report / signed_embed / unknown
notebook_id / query_id / report_id / signed_embed_id主たる実行元 ID（いずれか1つ）
workspace_idワークスペース ID
connection_idコネクション ID
actor_type実行主体の種別（例: USER）。Snowflake / SQL コメントでは大文字

Redshift / Databricks（SQL 先頭コメント） ​

実行する SQL の先頭コメントとして付与します。実行履歴の SQL 本文から参照してください。

形式の例は次のとおりです。

sql
/* codatum source_type=notebook notebook_id=... workspace_id=... connection_id=... actor_type=USER */
SELECT ...

キーの意味は Snowflake の QUERY_TAG と同じです。

利用例 ​

  • テーブル棚卸し: どのノートブック / レポートがどのテーブルを参照しているかを機械的に取得します
  • コスト分析: 課金額の大きいSQLやスローなSQLを特定し、発行元のノートブック / レポートを逆引きします

© Codatum Inc.