shares 命令组

The shares command group within the Databricks CLI allows you to manage shares in Unity Catalog.

共享是实例化的 shares create容器。 创建后，可以使用迭代方式注册元存储 shares update中定义的现有数据资产集合。 可以在原始名称下注册数据资产，根据原始架构限定，或者提供备用公开的名称。

databricks 共享创建

为数据对象创建新共享。 使用 . 创建 update后，可以添加数据对象。 调用方必须是元存储管理员或具有 CREATE_SHARE 元存储的权限。

databricks shares create NAME [flags]

Arguments

NAME

    共享的名称。

选项

--comment string

    用户提供的自由格式文本说明。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--storage-root string

    共享的存储根 URL。

Global flags

Examples

以下示例创建一个名为 my-analytics-share 注释的共享：

databricks shares create my-analytics-share --comment "Sales analytics data share"

以下示例创建具有特定存储根目录的共享：

databricks shares create my-analytics-share --storage-root "s3://my-bucket/share-data"

databricks 共享删除

从元存储中删除共享。 调用方必须是共享的所有者。

databricks shares delete NAME [flags]

Arguments

NAME

    共享的名称。

选项

Global flags

Examples

以下示例删除名为： 的 my-analytics-share共享：

databricks shares delete my-analytics-share

databricks 共享获取

从元存储获取共享。 调用方必须是元存储管理员或共享的所有者。

databricks shares get NAME [flags]

Arguments

NAME

    共享的名称。

选项

--include-shared-data

    查询要包括在共享中的数据。

Global flags

Examples

以下示例获取有关名为 my-analytics-share 的共享的信息：

databricks shares get my-analytics-share

以下示例获取一个共享，其中包含有关共享数据的详细信息：

databricks shares get my-analytics-share --include-shared-data

databricks 共享列表

列出元存储中的共享。 调用方必须是元存储管理员或共享的所有者。 不能保证数组中元素的特定排序。

databricks shares list [flags]

Arguments

None

选项

--max-results int

    要返回的最大共享数。

--page-token string

    不透明分页令牌根据上一个查询转到下一页。

Global flags

Examples

以下示例列出所有共享：

databricks shares list

databricks 共享更新

使用请求中的更改和数据对象更新共享。 调用方必须是共享或元存储管理员的所有者。

当调用方是元存储管理员时，只能 owner 更新字段。

如果共享名称发生更改， updateShare 则要求调用方是共享的所有者，并且具有 CREATE_SHARE 权限。

如果共享中存在笔记本文件， storage_root 则无法更新该字段。

对于通过此方法添加的每个表，共享所有者还必须对表具有 SELECT 特权。 必须无限期地保留此特权，以便收件人能够访问表。 通常，应使用组作为共享所有者。

表删除 update 不需要其他权限。

databricks shares update NAME [flags]

Arguments

NAME

    共享的名称。

选项

--comment string

    用户提供的自由格式文本说明。

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--new-name string

    共享的新名称。

--owner string

    当前共享所有者的用户名。

--storage-root string

    共享的存储根 URL。

Global flags

Examples

以下示例更新共享的注释：

databricks shares update my-analytics-share --comment "Updated sales analytics data share"

以下示例更改共享的名称：

databricks shares update my-analytics-share --new-name "sales-analytics-share"

以下示例更新共享的所有者：

databricks shares update my-analytics-share --owner "someone@example.com"

以下示例使用 JSON 配置更新共享：

databricks shares update my-analytics-share --json '{
  "comment": "Updated share with new tables",
  "objects": [
    {
      "name": "sales.customers",
      "data_object_type": "TABLE"
    }
  ]
}'

databricks 共享共享权限

从元存储获取数据共享的权限。 调用方必须是元存储管理员或共享的所有者。

databricks shares share-permissions NAME [flags]

Arguments

NAME

    共享的名称。

选项

--max-results int

    要返回的最大权限数。

--page-token string

    不透明分页令牌根据上一个查询转到下一页。

Global flags

Examples

以下示例获取名为 my-analytics-share 的共享的权限：

databricks shares share-permissions my-analytics-share

databricks 共享更新权限

更新元存储中数据共享的权限。 调用方必须是元存储管理员或共享的所有者。

对于新的收件人授予，用户还必须是收件人所有者或元存储管理员。收件人吊销不需要其他权限。

databricks shares update-permissions NAME [flags]

Arguments

NAME

    共享的名称。

选项

--json JSON

    内联 JSON 字符串或 @path 包含请求正文的 JSON 文件的 JSON 文件。

--omit-permissions-list

    Optional.

Global flags

Examples

以下示例向收件人授予权限：

databricks shares update-permissions my-analytics-share --json '{
  "changes": [
    {
      "principal": "recipient-name",
      "add": ["SELECT"]
    }
  ]
}'

以下示例从收件人撤消权限：

databricks shares update-permissions my-analytics-share --json '{
  "changes": [
    {
      "principal": "recipient-name",
      "remove": ["SELECT"]
    }
  ]
}'

Global flags

--debug

  是否启用调试日志记录。

-h 或 --help

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

--log-file 字符串

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

--log-format 格式

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

--log-level 字符串

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

-o, --output 类型

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

-p, --profile 字符串

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

--progress-format 格式

    显示进度日志的格式： default、 append、 inplace或 json

-t, --target 字符串

    如果适用，要使用的捆绑包目标