volumes 命令组

The volumes command group within the Databricks CLI contains commands to manage volumes in Unity Catalog. 卷提供用于访问、存储、管理、组织和处理文件的功能。 请参阅什么是 Unity Catalog 卷？。

databricks 卷创建

创建新卷。

用户可以创建外部卷或托管卷。 将在指定的外部位置创建外部卷，而托管卷将位于由父架构或父目录或元存储指定的默认位置。

若要成功创建卷，用户必须满足以下条件：

• 调用方必须是元存储管理员，或者是父目录和架构的所有者，或者具有 USE_CATALOG 父目录和 USE_SCHEMA 父架构的特权。
• 调用方必须具有 CREATE VOLUME 父架构的权限。

对于外部卷，还需要满足以下条件：

• 调用方必须具有 CREATE EXTERNAL VOLUME 外部位置的权限。
• 指定的存储位置中没有其他表，也没有现有的卷。 - 指定的存储位置不在其他表的位置、卷或目录或架构下。

databricks volumes create CATALOG_NAME SCHEMA_NAME NAME VOLUME_TYPE [flags]

Arguments

CATALOG_NAME

    架构和卷所在的目录的名称

SCHEMA_NAME

    卷所在的架构的名称

NAME

    卷的名称

VOLUME_TYPE

    卷的类型。 外部卷位于指定的外部位置。 托管卷位于由父架构或父目录或元存储指定的默认位置。 请参阅 托管卷与外部卷。 支持的值： EXTERNAL、 MANAGED

选项

--comment string

    附加到卷的注释。

--json JSON

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

--storage-location string

    云上的存储位置。

Global flags

Examples

以下示例创建托管卷：

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]

Arguments

NAME

    卷的三级（完全限定）名称

选项

Global flags

Examples

以下示例删除卷：

databricks volumes delete my_catalog.my_schema.my_volume

databricks 卷列表

列出父目录和架构下当前元存储的卷。

返回的卷根据调用用户的权限进行筛选。 例如，元存储管理员能够列出所有卷。 常规用户必须是所有者，或者有权 READ VOLUME 在响应中接收卷。 对于后一种情况，调用方还必须是所有者，或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。

不能保证数组中元素的特定排序。

databricks volumes list CATALOG_NAME SCHEMA_NAME [flags]

Arguments

CATALOG_NAME

    目录的标识符

SCHEMA_NAME

    架构的标识符

选项

--include-browse

    是否在主体只能访问其选择性元数据的响应中包含卷。

--max-results int

    要返回的最大卷数（页长度）。

--page-token string

    上一个请求返回的不透明令牌。

Global flags

Examples

以下示例列出目录和架构中的所有卷：

databricks volumes list my_catalog my_schema

读取 databricks 卷

从元存储中获取特定目录和架构的卷。

调用方必须是元存储管理员或卷的所有者（或拥有 READ VOLUME 该卷的权限）。 对于后一种情况，调用方还必须是所有者，或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。

databricks volumes read NAME [flags]

Arguments

NAME

    卷的三级（完全限定）名称

选项

--include-browse

    是否在主体只能访问其选择性元数据的响应中包含卷。

Global flags

Examples

以下示例获取有关卷的信息：

databricks volumes read my_catalog.my_schema.my_volume

以下示例获取卷信息，包括浏览元数据：

databricks volumes read my_catalog.my_schema.my_volume --include-browse

databricks 卷更新

更新指定父目录和架构下的指定卷。

调用方必须是元存储管理员或卷的所有者。 对于后一种情况，调用方还必须是所有者，或者对 USE_CATALOG 父目录和 USE_SCHEMA 父架构具有特权。

目前只能更新卷的名称、所有者或批注。

databricks volumes update NAME [flags]

Arguments

NAME

    卷的三级（完全限定）名称

选项

--comment string

    附加到卷的注释。

--json JSON

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

--new-name string

    卷的新名称。

--owner string

    拥有卷的用户的标识符。

Global flags

Examples

以下示例更新卷的注释：

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

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 字符串

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