クリーン ルーム イベント システム テーブル リファレンス
重要
このシステム テーブルは パブリック プレビュー にあります。 テーブルにアクセスするには、 system
カタログでスキーマを有効にすることが必要です。 詳細については、「システム テーブル スキーマを有効にする」を参照してください。
[クリーン ルーム イベント] テーブルには、自分または共同作業者がアカウントのクリーン ルームで実行したアクションが記録されます。 このテーブルには、自分のアカウント全体からのリージョンに関するデータが含まれます。
クリーン ルームについて詳しくは、「Azure Databricks Clean Rooms とは」をご覧ください。
テーブル パス: このシステム テーブルは、 system.access.clean_room_events
にあります。
クリーン ルーム イベント システム テーブルのスキーマ
クリーン ルーム イベント システム テーブルでは、次のスキーマが使われます。
列名 | データ型 | 説明 | 例 |
---|---|---|---|
account_id |
string | Databricks アカウントの ID | 7af234db-66d7-4db3 -bbf0-956098224879 |
metastore_id |
string | Unity Catalog メタストアの ID | 5a31ba44-bbf4-4174 -bf33-e1fa078e6765 |
event_id |
string | クリーン ルーム イベントの ID | db52a413-7a0a-4d49 -b742-7ae5f06bc4b2 |
clean_room_name |
string | イベントに関連付けられているクリーン ルームの名前 | market-analysis |
central_clean_room_id |
string | 中央クリーン ルームの ID | e01b6a78-1336-47e1 -b63d-3e49aa5b627 |
initiator_global_metastore_id |
string | イベントを開始したコラボレーターのグローバル メタストア ID | aws:us-west-2:ec22936d -cd29-4421-a88a-883fb356776a |
event_time |
タイムスタンプ(時刻印) | イベントが発生したときのタイムスタンプ | 2023-01-01T01:01:01.123 |
event_type |
string | イベントの種類。 記録されたクリーンルームイベントをご覧ください。 | CLEAN_ROOM_CREATED |
clean_room_created_metadata |
struct | イベントの種類 CLEAN_ROOM_CREATED のメタデータ |
{ "collaborators": [ {"collaborator_global_metastore_id": "aws:us-west-2:ec22936d-cd29-4421-a88a-883fb356776a"}, {"collaborator_global_metastore_id": "azure:wesus:”3be05a26-5a83-478c-8428-9ef9aa67b5d0"}] } |
clean_room_deleted_metadata |
struct | イベントの種類 CLEAN_ROOM_DELETED のメタデータ |
{ "central_clean_room_id": "af0d4563-2267-412c-9d4a -8a59c4895c18" } |
run_notebook_started_metadata |
struct | イベントの種類 RUN_NOTEBOOK_STARTED のメタデータ |
{ "notebook_name": "market analysis", "notebook_checksum": "7072696E7468656C6C6F776F7264", "run_id": "TaskRunId-634124444694206" } |
run_notebook_completed_metadata |
struct | イベントの種類 RUN_NOTEBOOK_COMPLETED のメタデータ |
完成したノートブックの実行メタデータを参照してください |
clean_room_assets_updated_metadata |
struct | イベントの種類 CLEAN_ROOM_ASSETS_UPDATED のメタデータ |
{ "added_assets": [{ "data_object_type": "TABLE", "name": "sales", "catalog": "demo"}], "updated_assets":[], "removed_assets": [] } |
delete_output_schema_metadata |
struct | イベントの種類 DELETE_OUTPUT_SCHEMA のメタデータ |
{ "name": "output_schema_55555", "owner_global_metastore_id": "aws:us-west-2:555555-55...", "action": "DELETE" expire_time: "2025-01-14T15:28:19.000Z" } |
initiator_collaborator_alias |
string | イベントを開始したコラボレーターのエイリアス。 UI を使用して作成されたクリーン ルームの場合、値は creator または collaborator です。 API を使用して作成されたクリーン ルームの場合、これらは作成時に指定されたカスタム値です。 |
creator |
クリーンルームのイベントが記録される
このシステム テーブルには、次のイベントがログされます。
CLEAN_ROOM_CREATED
: ユーザーが新しいクリーン ルームを作成します。CLEAN_ROOM_DELETED
: ユーザーがクリーン ルームを削除します。RUN_NOTEBOOK_STARTED
: ユーザーは、クリーン ルームでノートブックの実行を開始します。RUN_NOTEBOOK_COMPLETED
: ノートブックの実行が完了した。run_notebook_completed_metadata
を確認して、実行が成功したかどうかを確認します。CLEAN_ROOM_ASSETS_UPDATED
: クリーン ルームの資産が更新された。 これは、資産の追加、更新、または削除です。DELETE_OUTPUT_SCHEMA
: 出力スキーマの有効期限が切れ、削除されます。 出力スキーマの有効期限が切れると削除が行われるため、このイベントの種類のinitiator_global_metastore_id
は常にsystem
されます。
重複レコードを防ぐために、コラボレーターが同じメタストアに属しているクリーン ルームのイベントごとに 1 つのレコードのみが生成されます。 コラボレーターが別々のメタストアに属しているクリーン ルームでは、コラボレーターごとに一意のレコードが生成されます。
ノートブック実行の完了メタデータ スキーマ
run_notebook_completed_metadata
列には、RUN_NOTEBOOK_COMPLETED
イベントのメタデータ情報が含まれています。 ノートブックの実行によって 出力テーブル 作成された場合、情報は output_schema
構造体を使用してログに記録されます。
run_notebook_completed_metadata
列では、次のスキーマを使用します。
notebook_name: "example_notebook"
run_id: "TaskRunId-55555129818570"
state: "SUCCESS"
duration_in_seconds: 120
output_schema:
name: "output_schema_123450129818570"
owner_global_metastore_id: "aws:us-west-2:55555e-55bc-55a5-55ab-555d5ec16013"
action: "CREATE"
expire_time: "2025-01-14T15:28:19.000Z"
assets_added:
0:
name: "important_data"
data_object_type: "TABLE"
クリーン ルームの課金対象使用量を監視
クリーン ルームの使用状況とコストの詳細については、billing.usage
列を使用して、このテーブルを central_clean_room_id
テーブルと結合ができます。 billing.usage
テーブルでは、クリーン ルームの使用状況はusage_metadata.central_clean_room_id
キーを使用して帰属しています。
サンプル クエリ
次のサンプル クエリは、アカウントでのクリーン ルーム アクティビティに関する分析情報を得るのに役立ちます。
- 指定したクリーン ルームのすべてのイベントを一覧表示する
- 指定したコラボレーターによって開始されたすべてのイベントを一覧表示する
- クリーン ルームに関連するすべてのコラボレーターを一覧表示する
- 最も遅いノートブックの実行を一覧表示する
- すべてのノートブックの成功した実行の割合
- 指定したテーブルがクリーン ルームに追加されたすべてのイベントを一覧表示する
指定したクリーン ルームのすべてのイベントを一覧表示する
:central_clean_room_id
を中央クリーンルームIDに置き換えます。このIDはクリーンルームの詳細パネルで、の中央IDの横に表示されます。
SELECT
event_time, initiator_global_metastore_id, event_type,
CASE
WHEN event_type = 'CLEAN_ROOM_CREATED' THEN to_json(clean_room_created_metadata)
WHEN event_type = 'CLEAN_ROOM_DELETED' THEN to_json(clean_room_deleted_metadata)
WHEN event_type = 'RUN_NOTEBOOK_STARTED' THEN to_json(run_notebook_started_metadata)
WHEN event_type = 'RUN_NOTEBOOK_COMPLETED' THEN to_json(run_notebook_completed_metadata)
WHEN event_type = 'CLEAN_ROOM_ASSETS_UPDATED' THEN to_json(clean_room_assets_updated_metadata)
ELSE ""
END AS event_metadata
FROM system.access.clean_room_events
WHERE central_clean_room_id = :central_clean_room_id
ORDER BY event_time DESC
指定したコラボレーターによって開始されたすべてのイベントを一覧表示する
:initiator_global_metastore_id
パラメーターには、コラボレーターのグローバル メタストア ID (共有識別子とも呼ばれます) を入力します。 :collaborator_alias
の場合は、コラボレーターのエイリアスを入力します。 既定では、クリーンルームの作成者には creator
、もう一方の当事者には collaborator
の2つのエイリアスが割り当てられます。
SELECT
clean_room_name, central_clean_room_id, event_type, event_time,
CASE
WHEN event_type = 'CLEAN_ROOM_CREATED' THEN to_json(clean_room_created_metadata)
WHEN event_type = 'CLEAN_ROOM_DELETED' THEN to_json(clean_room_deleted_metadata)
WHEN event_type = 'RUN_NOTEBOOK_STARTED' THEN to_json(run_notebook_started_metadata)
WHEN event_type = 'RUN_NOTEBOOK_COMPLETED' THEN to_json(run_notebook_completed_metadata)
WHEN event_type = 'CLEAN_ROOM_ASSETS_UPDATED' THEN to_json(clean_room_assets_updated_metadata)
ELSE ""
END AS event_metadata
FROM system.access.clean_room_events
WHERE initiator_global_metastore_id = :initiator_global_metastore_id AND (initiator_collaborator_alias = :collaborator_alias OR initiator_collaborator_alias IS NULL)
ORDER BY clean_room_name, event_time DESC
クリーン ルームに関連するすべてのコラボレーターを一覧表示する
SELECT DISTINCT explode(transform(clean_room_created_metadata.collaborators, x -> x.collaborator_global_metastore_id)) AS collaborator
FROM system.access.clean_room_events
WHERE event_type = 'CLEAN_ROOM_CREATED'
最も遅いノートブックの実行を一覧表示する
SELECT
clean_room_name,
run_notebook_completed_metadata.notebook_name AS notebook_name,
run_notebook_completed_metadata.duration_in_seconds AS duration_in_seconds,
run_notebook_completed_metadata.run_id AS run_id
FROM system.access.clean_room_events
WHERE event_type = 'RUN_NOTEBOOK_COMPLETED'
AND run_notebook_completed_metadata.state = 'SUCCESS'
AND run_notebook_completed_metadata.duration_in_seconds IS NOT NULL
ORDER BY duration_in_seconds DESC
各ノートブックの実行成功率
SELECT
clean_room_name,
run_notebook_completed_metadata.notebook_name AS notebook_name,
ROUND(COUNT(CASE WHEN run_notebook_completed_metadata.state = 'SUCCESS' THEN 1 END) * 1.0 / COUNT(*) * 100) AS success_rate
FROM system.access.clean_room_events
WHERE event_type = 'RUN_NOTEBOOK_COMPLETED'
GROUP BY clean_room_name, notebook_name
ORDER BY clean_room_name, notebook_name
指定したテーブルがクリーン ルームに追加されたすべてのイベントを一覧表示する
:table_name_string
パラメーターには、指定したテーブル名を入力します。
SELECT
clean_room_name,
initiator_global_metastore_id,
event_time,
clean_room_assets_updated_metadata
FROM
system.access.clean_room_events
WHERE
event_type = 'CLEAN_ROOM_ASSETS_UPDATED'
AND exists(
clean_room_assets_updated_metadata.added_assets,
item -> item.data_object_type = 'TABLE'
AND item.name = :table_name_string
)
ORDER BY
clean_room_name,
event_time DESC