メインコンテンツまでスキップ

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

備考

プレビュー

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

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

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

テーブルパス :このシステムテーブルは 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

構造体

イベントタイプのメタデータ 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

完了したノートブック実行メタデータを参照してください

clean_room_assets_updated_metadata

構造体

イベントタイプのメタデータ CLEAN_ROOM_ASSETS_UPDATED

{ "added_assets": [{ "data_object_type": "TABLE", "name": "sales", "catalog": "demo"}], "updated_assets":[], "removed_assets": [] }

delete_output_schema_metadata

構造体

イベントタイプのメタデータ 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"

Monitor クリーンルーム 課金利用

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

サンプル クエリ

次のサンプルクエリは、アカウント内のクリーンルームのアクティビティを把握するのに役立ちます。

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

:central_clean_room_id を、クリーンルームの詳細パネルの [Central Id ] の横にある中央のクリーンルーム ID に置き換えます。

SQL
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] に、コラボレーターのエイリアスを入力します。 デフォルトでは、2つの可能なエイリアスは、クリーンルームの作成者に creator 、相手に collaborator です。

SQL
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

クリーンルームの関連するすべての協力者をリストアップ

SQL
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'

最も遅いノートブックの実行を一覧表示する

SQL
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

すべてのノートブックの成功実行率

SQL
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パラメータには、指定したテーブル名を入力します。

SQL
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