external-locations 命令组

注释

此信息适用于 Databricks CLI 版本 0.205 及更高版本。 Databricks CLI 目前处于公共预览阶段。

Databricks CLI 的使用须遵守 Databricks 许可Databricks 隐私声明,包括任何数据使用规定。

external-locations Databricks CLI 中的命令组包含用于创建和管理 Unity 目录的外部位置的命令。 请参阅什么是 Unity Catalog 卷?

databricks external-locations create

在元存储中创建新的外部位置条目。 调用方必须是元存储管理员,或者对元存储和关联的存储凭据具有 CREATE_EXTERNAL_LOCATION 权限。

databricks external-locations create NAME URL CREDENTIAL_NAME [flags]

论据

NAME

    外部位置的名称。

URL

    外部位置的路径 URL。

CREDENTIAL_NAME

    用于此位置的存储凭据的名称。

选项

--comment string

    用户提供的自由格式文本说明。

--enable-file-events

    是否在此外部位置启用文件事件。

--fallback

    指示是否为此外部位置启用了回退模式。

--json JSON

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

--read-only

    指示外部存储位置是否为只读。

--skip-validation

    跳过与外部位置关联的存储凭据的验证。

全局标志

例子

以下示例使用注释创建外部位置:

databricks external-locations create my-external-location s3://my-bucket/path my-credential --comment "External location for data lake"

以下示例创建只读外部位置:

databricks external-locations create my-external-location s3://my-bucket/path my-credential --read-only

databricks 外部位置删除

从元存储中删除指定的外部位置。 调用方必须是外部位置的所有者。

databricks external-locations delete NAME [flags]

论据

NAME

    外部位置的名称。

选项

--force

    即使有依赖关系的外部表或挂载,也强制删除。

全局标志

例子

以下示例删除名为 my-external-location 的外部位置:

databricks external-locations delete my-external-location

以下示例强制删除外部位置,即使存在依赖项:

databricks external-locations delete my-external-location --force

获取 databricks 外部位置

从元数据存储获取外部位置。 调用方必须是元存储管理员、外部位置的所有者或对外部位置具有某些权限的用户。

databricks external-locations get NAME [flags]

论据

NAME

    外部位置的名称。

选项

--include-browse

    是否在响应中包含主体只能访问的部分元数据的外部位置。

全局标志

例子

以下示例获取有关名为 my-external-location 的外部位置的信息:

databricks external-locations get my-external-location

以下示例说明如何获取包括浏览元数据的信息:

databricks external-locations get my-external-location --include-browse

databricks 外部位置列表

列出元存储中的外部位置。 调用方必须是元存储管理员、外部位置的所有者或对外部位置具有某种权限的用户。 不能保证数组中元素的特定排序。

databricks external-locations list [flags]

选项

--include-browse

    是否在响应中包含主体只能访问的部分元数据的外部位置。

--max-results int

    要返回的外部位置的最大数目。

--page-token string

    不透明分页令牌根据上一个查询转到下一页。

全局标志

例子

以下示例列出所有外部位置:

databricks external-locations list

以下示例列出了最多 10 个结果的外部位置:

databricks external-locations list --max-results 10

databricks 外部存储位置更新

更新元存储中的外部位置。 调用方必须是外部位置的所有者,或者是元存储管理员。第二种情况下,管理员只能更新外部位置的名称。

databricks external-locations update NAME [flags]

论据

NAME

    外部位置的名称。

选项

--comment string

    用户提供的自由格式文本说明。

--credential-name string

    用于此位置的存储凭据的名称。

--enable-file-events

    是否在此外部位置启用文件事件。

--fallback

    指示是否为此外部位置启用了回退模式。

--force

    即使更改 URL 会使依赖的外部表或装载失效,也强制更新。

--isolation-mode IsolationMode

    支持的值:ISOLATION_MODE_ISOLATEDISOLATION_MODE_OPEN

--json JSON

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

--new-name string

    外部位置的新名称。

--owner string

    外部位置的所有者。

--read-only

    指示外部存储位置是否为只读。

--skip-validation

    跳过与外部位置关联的存储凭据的验证。

--url string

    外部位置的路径 URL。

全局标志

例子

以下示例重命名外部位置:

databricks external-locations update my-external-location --new-name my-renamed-location

下面的示例修改了外部位置的所有者:

databricks external-locations update my-external-location --owner someone@example.com

全局标志

--debug

  是否启用调试日志记录。

-h--help

    显示 Databricks CLI、相关命令组或相关命令的帮助。

--log-file 字符串

    一个字符串,表示要将输出日志写入到的文件。 如果未指定此标志,则默认会将输出日志写入到 stderr。

--log-format 格式

    日志格式类型,textjson。 默认值是 text

--log-level 字符串

    一个表示日志格式级别的字符串。 如果未指定,则禁用日志格式级别。

-o, --output 类型

    命令输出类型为 textjson。 默认值是 text

-p, --profile 字符串

    要用于运行命令的 ~/.databrickscfg 文件中的配置文件名称。 如果未指定此标志,并且存在命名为 DEFAULT 的配置文件,则使用该配置文件。

--progress-format 格式

    显示进度日志的格式: defaultappendinplacejson

-t, --target 字符串

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