clean-rooms コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のコマンドグループclean-roomsを使用すると、クリーンルームを管理できます。クリーンルームは、 Delta Sharing とサーバレス コンピュートを使用して、複数の関係者が互いのデータに直接アクセスすることなく、機密性の高いエンタープライズ データで共同作業できる、安全でプライバシーを保護する環境を提供します。 「Databricks クリーンルームとは」を参照してください。
databricks clean-rooms create
指定された共同作業者で新しいクリーンルームを作成します。このメソッドは非同期です。clean_roomフィールド内の返された名前フィールドは、GETメソッドを使用してクリーンルームのステータスをポーリングするために使用できます。このメソッドが返されると、クリーンルームは PROVISIONING 状態になり、名前、所有者、コメント、created_at、ステータスのみが入力されます。クリーンルームは、 ACTIVE 状態に入ると使用できるようになります。
呼び出し元は、メタストア管理者であるか、メタストアに対する CREATE_CLEAN_ROOM 特権を持っている必要があります。
databricks clean-rooms create [flags]
引数
なし
オプション
--comment string
クリーンルームのコメント。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--name string
クリーンルームの名前。
--owner string
これは Databricks 権限管理のために保護可能なローカル クリーンルームの所有者のユーザー名です。
例
次の例では、名前と所有者を持つクリーンルームを作成します。
databricks clean-rooms create --name "my-clean-room" --owner "someone@example.com"
次の例では、コメントを使用してクリーンルームを作成します。
databricks clean-rooms create --name "analytics-clean-room" --owner "someone@example.com" --comment "Clean room for analytics collaboration"
databricks clean-rooms create-output-catalog
クリーンルームの出力カタログを作成します。
databricks clean-rooms create-output-catalog CLEAN_ROOM_NAME [flags]
引数
CLEAN_ROOM_NAME
クリーンルームの名前。
オプション
--catalog-name string
Unity Catalog の出力カタログの名前。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、クリーンルームの出力カタログを作成します。
databricks clean-rooms create-output-catalog my-clean-room --catalog-name "my_output_catalog"
databricks clean-rooms delete
クリーンルームを削除します。削除後、クリーンルームはメタストアから削除されます。他のコラボレーターがクリーンルームを削除していない場合、メタストアにはクリーンルームが残りますが、クリーンルームはDELETED状態になり、削除以外の操作は実行できません。
databricks clean-rooms delete NAME [flags]
引数
NAME
クリーンルームの名前。
オプション
例
次の例では、クリーンルームを削除します。
databricks clean-rooms delete my-clean-room
databricks clean-rooms get
その名前にちなんでクリーンルームの詳細を取得します。
databricks clean-rooms get NAME [flags]
引数
NAME
クリーンルームの名前。
オプション
例
次の例では、クリーンルームの詳細を取得します。
databricks clean-rooms get my-clean-room
次の例では、特定のプロファイルを使用してクリーンルームの詳細を取得します。
databricks clean-rooms get analytics-clean-room --profile production
databricks clean-rooms list
メタストアのすべてのクリーンルームを一覧表示します。発信者がアクセスできるクリーンルームのみが返されます。
databricks clean-rooms list [flags]
引数
なし
オプション
--page-size int
返すクリーンルームの最大数(つまり、ページの長さ)。
--page-token string
前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。
例
次の例は、アクセス可能なすべてのクリーンルームをリストします。
databricks clean-rooms list
次の例は、特定のページ サイズのクリーンルームを一覧表示します。
databricks clean-rooms list --page-size 10
databricks clean-rooms update
クリーンルームを更新します。呼び出し元は、クリーンルームの所有者であるか、 MODIFY_CLEAN_ROOM 権限を持っているか、メタストア管理者である必要があります。
呼び出し元がメタストア管理者の場合、更新できるのは owner フィールドのみです。
databricks clean-rooms update NAME [flags]
引数
NAME
クリーンルームの名前。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、 JSON 設定を使用してクリーンルームを更新します。
databricks clean-rooms update my-clean-room --json '{"comment": "Updated clean room description"}'
次の例では、クリーンルームの所有者を更新します (メタストア管理者のみ)。
databricks clean-rooms update my-clean-room --json '{"owner": "new-someone@example.com"}'
次の例では、JSON ファイルを使用してクリーンルームを更新します。
databricks clean-rooms update my-clean-room --json @update-config.json
グローバルフラグ
--debug
デバッグログを有効にするかどうか。
-h または --help
Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。
--log-file string
出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。
--log-format format
ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。
--log-level string
ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。
-o, --output タイプ
コマンド出力タイプ text または json。デフォルト値は textです。
-p, --profile string
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format format
進行状況ログを表示する形式: default、 append、 inplace、 json
-t, --target string
該当する場合は、使用するバンドル・ターゲット