Note
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 The Databricks CLI is in Public Preview.
Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.
The clean-rooms
command group within the Databricks CLI allows you to manage clean rooms. 清理室使用增量共享和无服务器计算提供安全且隐私保护的环境,让多个参与方可以协同处理敏感数据,而无需直接访问彼此的数据。 请参阅什么是 Azure Databricks Clean Rooms?。
databricks 清理室创建
使用指定的协作者创建新的干净房间。 此方法是异步的;clean_room字段中返回的名称字段可用于使用 get 方法轮询干净房间状态。 此方法返回时,清理室将处于状态 PROVISIONING
,仅填充了名称、所有者、注释、created_at和状态。 进入状态后 ACTIVE
,干净的房间将可用。
调用方必须是元存储管理员或具有 CREATE_CLEAN_ROOM
元存储的权限。
databricks clean-rooms create [flags]
Arguments
None
选项
--comment string
对干净房间的评论。
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
--name string
清洁室的名称。
--owner string
这是本地清理室安全对象的所有者的 Databricks 用户名,用于权限管理。
Examples
以下示例使用名称和所有者创建一个干净的房间:
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-room create-output-catalog
创建干净房间的输出目录。
databricks clean-rooms create-output-catalog CLEAN_ROOM_NAME [flags]
Arguments
CLEAN_ROOM_NAME
清洁室的名称。
选项
--catalog-name string
Unity 目录中输出目录的名称。
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
Examples
以下示例为干净房间创建输出目录:
databricks clean-rooms create-output-catalog my-clean-room --catalog-name "my_output_catalog"
databricks 清理会议室删除
删除干净房间。 删除后,将从元存储中删除清理室。 如果其他协作者尚未删除清理室,则它们仍将在其元存储中具有清理室,但它将处于 DELETED 状态,并且不能对其执行除删除以外的任何作。
databricks clean-rooms delete NAME [flags]
Arguments
NAME
清洁室的名称。
选项
Examples
以下示例删除一个干净的房间:
databricks clean-rooms delete my-clean-room
databricks 清理室获取
获取指定其名称的干净房间的详细信息。
databricks clean-rooms get NAME [flags]
Arguments
NAME
清洁室的名称。
选项
Examples
以下示例获取干净房间的详细信息:
databricks clean-rooms get my-clean-room
以下示例使用特定配置文件获取干净房间的详细信息:
databricks clean-rooms get analytics-clean-room --profile production
databricks 清理会议室列表
列出元存储的所有干净房间。 仅返回调用方有权访问的干净房间。
databricks clean-rooms list [flags]
Arguments
None
选项
--page-size int
要返回的最大干净房间数(即页面长度)。
--page-token string
不透明分页令牌根据上一个查询转到下一页。
Examples
以下示例列出了所有可访问的干净房间:
databricks clean-rooms list
以下示例列出具有特定页面大小的干净房间:
databricks clean-rooms list --page-size 10
databricks 清理室更新
更新干净房间。 调用方必须是清理室的所有者、拥有 MODIFY_CLEAN_ROOM
权限或元存储管理员。
当调用方是元存储管理员时,只能 owner
更新字段。
databricks clean-rooms update NAME [flags]
Arguments
NAME
清洁室的名称。
选项
--json JSON
内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。
Examples
以下示例使用 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
Global flags
--debug
是否启用调试日志记录。
-h
或 --help
显示 Databricks CLI、相关命令组或相关命令的帮助。
--log-file
字符串
一个字符串,表示要将输出日志写入到的文件。 如果未指定此标志,则默认会将输出日志写入到 stderr。
--log-format
格式
日志格式类型或 text
json
。 默认值是 text
。
--log-level
字符串
一个表示日志格式级别的字符串。 如果未指定,则禁用日志格式级别。
-o, --output
类型
命令输出类型或 text
json
。 默认值是 text
。
-p, --profile
字符串
用于运行命令的文件中配置文件 ~/.databrickscfg
的名称。 如果未指定此标志,则如果存在,则使用命名 DEFAULT
的配置文件。
--progress-format
格式
显示进度日志的格式: default
、 append
、 inplace
或 json
-t, --target
字符串
如果适用,要使用的捆绑包目标