クリーンルームイベントシステムテーブルリファレンス

プレビュー

このシステムテーブルはパブリックプレビュー段階です。テーブルにアクセスするには、 system カタログでスキーマを有効にする必要があります。詳細については、「システムテーブルスキーマを有効にする」を参照してください。

クリーンルームイベントテーブルは、あなたまたはあなたの協力者がクリーンルーム(パブリックプレビュー)で行ったアクションをアカウントに記録します。この表には、アカウント全体の地域データが含まれています。

クリーンルームの詳細については、Databricksクリーンルームとはを参照してください。

テーブルパス:このシステムテーブルは clean_room_eventsにあります。

クリーンルームイベントシステムテーブルスキーマ

クリーンルームイベントシステムテーブルは次のスキーマを使用します。

列名	データ型	説明	例
`account_id`	文字列	Databricksアカウントの ID	`7af234db-66d7-4db3` `-bbf0-956098224879`
`metastore_id`	文字列	Unity Catalogメタストアの ID	`5a31ba44-bbf4-4174` `-bf33-e1fa078e6765`
`event_id`	文字列	クリーンルームイベントのID	`db52a413-7a0a-4d49` `-b742-7ae5f06bc4b2`
`clean_room_name`	文字列	イベントに関連付けられたクリーンルームの名前	`market-analysis`
`central_clean_room_id`	文字列	中央クリーンルームのID	`e01b6a78-1336-47e1` `-b63d-3e49aa5b627`
`initiator_global_metastore_id`	文字列	イベントを開始したコラボレーターのグローバルメタストア ID	`aws:us-west-2:ec22936d` `-cd29-4421-a88a-883fb356776a`
`event_time`	timestamp	イベントが発生したタイムスタンプ	`2023-01-01T01:01:01.123`
`event_type`	文字列	イベントの種類。ログに記録されたクリーンルームイベントを参照してください。	`CLEAN_ROOM_CREATED`
`clean_room_created_metadata`	構造体	イベントタイプのメタデータ `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`	構造体	イベントタイプのメタデータ `CLEAN_ROOM_DELETED`	`{` `"central_clean_room_id": "af0d4563-2267-412c-9d4a` `-8a59c4895c18"` `}`
`run_notebook_started_metadata`	構造体	イベントタイプのメタデータ `RUN_NOTEBOOK_STARTED`	`{` `"notebook_name": "market analysis",` `"notebook_checksum": "7072696E7468656C6C6F776F7264",` `"run_id": "TaskRunId-634124444694206"` `}`
`run_notebook_completed_metadata`	構造体	イベントタイプのメタデータ `RUN_NOTEBOOK_COMPLETED`	`{` `"notebook_name": "market analysis",` `"run_id": "TaskRunId-634124444694206",` `"state": "SUCCESS",` `"duration_in_seconds": 156` `}`
`clean_room_assets_updated`	構造体	イベントタイプのメタデータ `CLEAN_ROOM_ASSETS_UPDATED`	`{` `"added_assets": [{` `"data_object_type": "TABLE",` `"name": "sales",` `"catalog": "demo"}],` `"updated_assets":[],` `"removed_assets": []` `}`

ログに記録されたクリーンルームイベント

このシステムテーブルは次のイベントを記録します。

CLEAN_ROOM_CREATED: ユーザーが新しいクリーンルームを作成する
CLEAN_ROOM_DELETED:ユーザーがクリーンルームを削除します
RUN_NOTEBOOK_STARTED: ユーザーがクリーンルームでノートブックの実行を開始する
RUN_NOTEBOOK_COMPLETED: ノートブックの実行が完了しました。実行が成功したかどうかを確認するには、 run_notebook_completed_metadataを確認してください。
CLEAN_ROOM_ASSETS_UPDATED:クリーンルームのアセットが更新されます。これには、アセットの追加、更新、削除などが含まれます。

monitor clean room 課金利用

クリーンルームの使用状況とコストの詳細については、central_clean_room_id列を使用してこのテーブルをbilling.usageテーブルと結合できます。billing.usageテーブルでは、クリーンルームの使用状況はusage_metadata.central_clean_room_idキーを使用して属性化されます。

サンプルクエリ

次のサンプルクエリは、アカウント内のクリーンルーム活動に関する知識を得るのに役立ちます。

指定したクリーンルームからのすべてのイベントを一覧表示します
指定したコラボレーターによって開始されたすべてのイベントを一覧表示します
クリーンルームの関連するすべての協力者をリストアップ
最も遅いノートブックの実行を一覧表示する
各ノートブックの成功実行率
指定したテーブルがクリーンルームに追加されたすべてのイベントを一覧表示します

指定したクリーンルームからのすべてのイベントを一覧表示します

注：

<clean_room_name>を指定したクリーンルーム名に置き換えてください。

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 clean_room_name = '<clean_room_name>'
ORDER BY event_time DESC

指定したコラボレーターによって開始されたすべてのイベントを一覧表示します

注：

<collaborator global metastore ID> をコラボレーターのグローバルメタストア ID (共有識別子とも呼ばれます) に置き換えます。

SELECT
 clean_room_name, 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 = '<collaborator global metastore ID>'
 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

指定したテーブルがクリーンルームに追加されたすべてのイベントを一覧表示します

注：

テーブル名 default.sales を指定したテーブル名に置き換えます。

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 = 'default.sales')
ORDER BY clean_room_name, event_time DESC