Note
此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。
Databricks CLI 的使用须遵守 Databricks 许可和 Databricks 隐私声明，包括任何数据使用规定。
catalogs
CLI 中的命令组允许你在 Unity 目录中管理目录。 目录是 Unity 目录的三级命名空间的第一层。 它用于组织数据资产。 请参阅什么是 Unity Catalog？。
databricks 目录的创建
如果调用方是元存储管理员或具有 CREATE_CATALOG 权限，请在父元存储中创建新的目录实例。
databricks catalogs create NAME [flags]
Arguments
NAME
目录的名称
选项
--comment string
用户自由填写的文本说明
--connection-name string
与外部数据源的连接的名称
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件
--provider-name string
增量共享提供程序的名称
--share-name string
共享提供程序下的共享名称
--storage-root string
目录内托管表的存储根 URL
Examples
下面的例子创建一个名为sales的目录：
databricks catalogs create sales
以下示例创建包含注释的目录：
databricks catalogs create sales --comment "Sales data catalog"
databricks 目录删除
删除与提供的名称匹配的目录。 调用方必须是元存储管理员或目录的所有者。
databricks catalogs delete NAME [flags]
Arguments
NAME
目录的名称
选项
--force
即使目录非空也强制删除
Examples
以下示例删除名为 sales 的目录：
databricks catalogs delete sales
以下示例强制删除非空目录：
databricks catalogs delete sales --force
databricks 目录获取
获取元存储中指定的目录。 调用方必须是元存储管理员、目录的所有者或为其 USE_CATALOG 帐户设置了权限的用户。
databricks catalogs get NAME [flags]
Arguments
NAME
目录的名称
选项
--include-browse
是否在响应中包含主体只能访问其选择性元数据的目录
Examples
以下示例获取有关名为 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
基于先前查询转到下一页的不透明分页令牌
Examples
以下示例列出所有目录：
databricks catalogs list
以下示例列出最多 10 个结果的目录：
databricks catalogs list --max-results 10
以下示例列出了目录，包括仅供浏览的目录：
databricks catalogs list --include-browse
Databricks 目录更新
更新与提供的名称匹配的目录。 调用方必须是目录的所有者或元存储管理员（更改目录的所有者字段时）。
databricks catalogs update NAME [flags]
Arguments
NAME
目录的名称
选项
--comment string
用户自由填写的文本说明
--enable-predictive-optimization EnablePredictiveOptimization
是否应为此对象及其下的对象启用预测优化。 支持的值：DISABLE、ENABLE、INHERIT
--isolation-mode CatalogIsolationMode
当前安全对象是可从所有工作区访问还是从特定工作区集访问。 支持的值：ISOLATED、OPEN
--json JSON
包含请求正文的内联 JSON 字符串或 @path 到 JSON 文件
--new-name string
目录的新名称
--owner string
目录的当前所有者的用户名
Examples
以下示例更新目录的注释：
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 字符串
如适用，要使用的捆绑包目标