clean-rooms 命令组

Note

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。

Databricks CLI 的使用须遵守 Databricks 许可Databricks 隐私声明,包括任何数据使用规定。

clean-rooms CLI 中的命令组允许管理清理室。 洁净室利用“Delta Sharing”和无服务器计算,提供一个安全且保护隐私的环境,让多个参与方可以在不直接访问彼此数据的情况下,协同处理敏感企业数据。 请参阅什么是 Azure Databricks Clean Rooms?

创建databricks洁净室

使用指定的协作者创建新的干净房间。 此方法是异步的;clean_room字段中返回的名称字段可用于使用 get 方法轮询干净房间状态。 此方法返回时,洁净室将处于 PROVISIONING 状态,仅填充名称、所有者、注释、创建时间和状态。 一旦进入 ACTIVE 状态,洁净室将可使用。

调用方必须是元存储管理员或具有 CREATE_CLEAN_ROOM 元存储的权限。

databricks clean-rooms create [flags]

Arguments

None

选项

--comment string

    洁净室的注释。

--json JSON

    包含请求正文的内联 JSON 字符串或 @path 到 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-rooms create-output-catalog

创建洁净室的输出目录。

databricks clean-rooms create-output-catalog CLEAN_ROOM_NAME [flags]

Arguments

CLEAN_ROOM_NAME

    清洁室的名称。

选项

--catalog-name string

    Unity Catalog 中输出目录的名称。

--json JSON

    包含请求正文的内联 JSON 字符串或 @path 到 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 文件。

全局标志

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

全局标志

--debug

  是否启用调试日志记录。

-h--help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串,表示要将输出日志写入到的文件。 如果未指定此标志,则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型,textjson。 默认值是 text

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定,则禁用日志格式级别。

-o, --output 类型

    命令输出类型为textjson。 默认值是 text

-p, --profile 字符串

     ~/.databrickscfg 文件中用于运行命令的配置文件的名称。 如果未指定此标志,则如果存在,将使用名为 DEFAULT 的配置文件。

--progress-format 格式

    显示进度日志的格式: defaultappendinplacejson

-t, --target 字符串

    如适用,要使用的捆绑包目标