注释
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。
shares
CLI 中的命令组允许管理 Unity 目录中的共享。
共享是用shares create
实例化的容器。 创建后,可以使用迭代方式注册元存储 shares update
中定义的现有数据资产集合。 可以在原始名称下注册数据资产,根据原始架构限定,或者提供备用公开的名称。
databricks 共享创建
为数据对象创建新共享。 创建后使用update
可以添加数据对象。 调用方必须是元存储管理员或具有 CREATE_SHARE
元存储的权限。
databricks shares create NAME [flags]
论据
NAME
共享的名称。
选项
--comment string
用户提供的自由格式文本说明。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--storage-root string
共享的存储根 URL。
例子
以下示例创建一个名为 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]
论据
NAME
共享的名称。
选项
例子
以下示例删除名为my-analytics-share
的共享:
databricks shares delete my-analytics-share
databricks 股份获取
从元存储获取共享。 调用方必须是元存储管理员或共享的所有者。
databricks shares get NAME [flags]
论据
NAME
共享的名称。
选项
--include-shared-data
查询要包括在共享中的数据。
例子
以下示例获取有关名为 my-analytics-share
的共享的信息:
databricks shares get my-analytics-share
以下示例获取共享数据并包含有关其详细信息:
databricks shares get my-analytics-share --include-shared-data
databricks 共享列表
列出元存储中的共享。 调用方必须是元存储管理员或共享的所有者。 不能保证数组中元素的特定排序。
databricks shares list [flags]
论据
没有
选项
--max-results int
要返回的最大共享数。
--page-token string
不透明分页令牌根据上一个查询转到下一页。
例子
以下示例列出所有共享:
databricks shares list
Databricks 股价更新
将请求中的更改和数据对象更新至共享内容。 调用方必须是共享的所有者或元存储管理员。
当调用方是元存储管理员时,只能更新 owner
字段。
如果共享名称发生更改, updateShare
则要求调用方是共享的所有者,并且具有 CREATE_SHARE
权限。
如果共享中存在笔记本文件, storage_root
则无法更新该字段。
对于通过此方法添加的每个表,共享所有者还必须对表具有 SELECT
特权。 必须一直保持此权限,以便收件人能够访问该表。 最好应使用用户组作为共享所有者。
通过 update
删除表不需要额外的权限。
databricks shares update NAME [flags]
论据
NAME
共享的名称。
选项
--comment string
用户提供的自由格式文本说明。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--new-name string
共享的新名称。
--owner string
当前共享所有者的用户名。
--storage-root string
共享的存储根 URL。
例子
以下示例更新共享的注释:
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]
论据
NAME
共享的名称。
选项
--max-results int
最大返回权限数
--page-token string
不透明分页令牌根据上一个查询转到下一页。
例子
以下示例获取名为 my-analytics-share
的共享的权限:
databricks shares share-permissions my-analytics-share
databricks 共享更新权限
更新元存储中数据共享的权限。 调用方必须是元存储管理员或共享的所有者。
对于授予新的收件人权限,用户还必须是接收者所有者或元存储区管理员。而撤销接收者权限则不需要其他权限。
databricks shares update-permissions NAME [flags]
论据
NAME
共享的名称。
选项
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--omit-permissions-list
可选。
例子
以下示例向收件人授予权限:
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"]
}
]
}'
全局标志
--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
字符串
如果适用,要使用的捆绑包目标