catalogs 命令组

catalogs CLI 中的命令组允许你在 Unity 目录中管理目录。 目录是 Unity 目录的三级命名空间的第一层。 它用于组织数据资产。 请参阅什么是 Unity Catalog？。

databricks 目录创建

如果调用方是元存储管理员或具有 CREATE_CATALOG 权限，请在父元存储中创建新的目录实例。

databricks catalogs create NAME [flags]

论据

NAME

    目录名称

选项

--comment string

    用户自由填写的文本说明

--connection-name string

    与外部数据源的连接的名称

--json JSON

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

--provider-name string

    OpenSharing 提供程序的名称

--share-name string

    共享提供程序下共享目录的名称

--storage-root string

    目录中托管表的存储根URL

全局标志

例子

下面的例子创建一个名为sales的目录：

databricks catalogs create sales

以下示例创建包含注释的目录：

databricks catalogs create sales --comment "Sales data catalog"

databricks 目录删除

删除与提供的名称匹配的目录。 调用方必须是元存储管理员或目录的所有者。

databricks catalogs delete NAME [flags]

论据

NAME

    目录的名称

选项

--force

    即使目录不为空，也强制删除

全局标志

例子

以下示例删除一个名为 sales：

databricks catalogs delete sales

以下示例强制删除非空目录：

databricks catalogs delete sales --force

databricks 目录获取

获取元存储中的指定目录。 调用方必须是元存储管理员、目录的所有者或为其 USE_CATALOG 帐户设置了权限的用户。

databricks catalogs get NAME [flags]

论据

NAME

    目录的名称

选项

--include-browse

    是否在主体仅能访问其选择性元数据时的响应中包含目录项

全局标志

例子

以下示例获取有关名为 sales 的目录的信息：

databricks catalogs get sales

以下示例获取目录信息，包括仅供浏览的目录：

databricks catalogs get sales --include-browse

databricks 目录列表

列出元存储中的目录。 如果调用方是元存储管理员，将检索所有目录。 否则，只检索调用方拥有的目录（或者调用方具有 USE_CATALOG 权限的目录）。 不能保证数组中元素的特定排序。

databricks catalogs list [flags]

选项

--include-browse

    是否在主体仅能访问其选择性元数据时的响应中包含目录项

--max-results int

    要返回的最大目录数

--page-token string

    用于基于上一个查询跳转到下一页的不可见分页令牌

全局标志

例子

以下示例列出所有目录：

databricks catalogs list

以下示例列出最多 10 个结果的目录：

databricks catalogs list --max-results 10

以下示例列出了目录，包括仅供浏览的目录：

databricks catalogs list --include-browse

databricks 目录更新

更新与提供的名称匹配的目录。 调用方必须是目录的所有者或元存储管理员（更改目录的所有者字段时）。

databricks catalogs update NAME [flags]

论据

NAME

    目录的名称

选项

--comment string

    用户自由填写的文本说明

--enable-predictive-optimization EnablePredictiveOptimization

    是否应为此对象及其下的对象启用预测优化。 支持的值：DISABLE、ENABLE、INHERIT

--isolation-mode CatalogIsolationMode

    当前安全对象是否可以从所有工作区或一组特定的工作区访问。 支持的值：ISOLATED、OPEN

--json JSON

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

--new-name string

    目录的新名称

--owner string

    目录的当前所有者的用户名

全局标志

例子

以下示例更新目录的注释：

databricks catalogs update sales --comment "Updated sales data catalog"

以下示例重命名目录：

databricks catalogs update sales --new-name sales-prod

以下示例展示了更改目录所有者的方法：

databricks catalogs update sales --owner someone@example.com

以下示例为目录启用预测优化：

databricks catalogs update sales --enable-predictive-optimization ENABLE

全局标志

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

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