注释
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明,包括任何数据使用规定。
volumes
Databricks CLI 中的命令组包含用于管理 Unity 目录中卷的命令。 卷提供用于访问、存储、管理、组织和处理文件的功能。 请参阅什么是 Unity Catalog 卷?。
创建 databricks 数据卷
创建新卷。
用户可以创建外部卷或管理卷。 将在指定的外部位置创建外部卷,而托管卷将位于由父架构或父目录或元存储指定的默认位置。
若要成功创建卷,用户必须满足以下条件:
- 调用方必须是元存储管理员,或者是父目录和架构的所有者,或者具有
USE_CATALOG父目录和USE_SCHEMA父架构的特权。 - 调用方必须具有
CREATE VOLUME父架构的权限。
对于外部卷,还需要满足以下条件:
- 调用方在外部位置必须具有
CREATE EXTERNAL VOLUME权限。 - 指定的存储位置中没有其他表,也没有现有的卷。 - 指定的存储位置不在其他表的位置、卷、目录或架构下。
databricks volumes create CATALOG_NAME SCHEMA_NAME NAME VOLUME_TYPE [flags]
论据
CATALOG_NAME
架构和卷所在目录的名称
SCHEMA_NAME
卷所在的架构的名称
NAME
卷的名称
VOLUME_TYPE
卷的类型。 外部卷位于指定的外部位置。 托管卷位于由父架构或父目录或元存储指定的默认位置。 请参阅 托管卷与外部卷。 支持的值:EXTERNAL、MANAGED
选项
--comment string
附加到卷的注释。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--storage-location string
云上的存储位置。
例子
以下示例创建一个托管卷:
databricks volumes create my_catalog my_schema my_volume MANAGED
以下示例创建一个带有注释的外部存储卷:
databricks volumes create my_catalog my_schema my_external_volume EXTERNAL --storage-location s3://my-bucket/my-volume --comment "External volume for data processing"
删除 databricks 卷
从指定的父目录和模式中删除一个卷。
调用方必须是元存储管理员或卷的所有者。 对于后一种情况,调用方还必须是所有者,或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。
databricks volumes delete NAME [flags]
论据
NAME
卷的三级(完全限定)名称
选项
例子
以下示例将删除存储卷:
databricks volumes delete my_catalog.my_schema.my_volume
databricks 存储单元列表
列出父目录和架构下当前元存储的卷。
返回的卷根据调用用户的权限进行筛选。 例如,元存储管理员可以列出所有卷。 常规用户必须是卷的所有者,或者拥有READ VOLUME权限,才能在响应中接收卷。 对于后一种情况,调用方还必须是所有者,或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。
不能保证数组中元素的特定排序。
databricks volumes list CATALOG_NAME SCHEMA_NAME [flags]
论据
CATALOG_NAME
目录标识符
SCHEMA_NAME
架构的标识符
选项
--include-browse
是否在响应中包含主体只能访问其部分元数据的卷。
--max-results int
要返回的最大卷数(页长度)。
--page-token string
上一个请求返回的不透明令牌。
例子
以下示例列出目录和架构中的所有卷:
databricks volumes list my_catalog my_schema
读取 databricks 存储卷
从元存储中提取特定目录和模式的 数据卷。
调用方必须是 Metastore 管理员、该卷的所有者或拥有该卷的READ VOLUME权限。 对于后一种情况,调用方还必须是所有者,或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。
databricks volumes read NAME [flags]
论据
NAME
卷的三级(完全限定)名称
选项
--include-browse
是否在响应中包含主体只能访问其部分元数据的卷。
例子
以下示例获取有关存储卷的信息:
databricks volumes read my_catalog.my_schema.my_volume
请按照以下步骤操作: 步骤1:以下示例获取卷信息,包括浏览元数据:
databricks volumes read my_catalog.my_schema.my_volume --include-browse
databricks 卷更新
更新指定父目录和架构下的指定卷。
调用方必须是元存储管理员或卷的所有者。 对于后一种情况,调用方还必须是所有者,或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。
目前只能对卷的名称、所有者或批注进行更新。
databricks volumes update NAME [flags]
论据
NAME
卷的三级(完全限定)名称
选项
--comment string
附加到卷的注释。
--json JSON
内联 JSON 字符串或包含请求正文的 JSON 文件中的 @path。
--new-name string
卷的新名称。
--owner string
拥有卷的用户的标识符。
例子
以下示例更新卷的注释:
databricks volumes update my_catalog.my_schema.my_volume --comment "Updated comment for my volume"
以下示例更改卷的所有者:
databricks volumes update my_catalog.my_schema.my_volume --owner someone@example.com
以下示例重命名卷的名称:
databricks volumes update my_catalog.my_schema.my_volume --new-name my_new_volume_name
全局标志
--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 字符串
如果适用,要使用的捆绑包目标