external-metadata 命令组

注释

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

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

external-metadata Databricks CLI 中的命令组包含用于注册和管理 Unity 目录中外部系统的元数据的命令。

databricks external-metadata create-external-metadata

如果调用方是元存储管理员或具有 CREATE_EXTERNAL_METADATA 权限，请在父元存储中创建新的外部元数据对象。 默认情况下，在创建时向所有帐户用户授予 BROWSE 。

databricks external-metadata create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE [flags]

Arguments

NAME

    外部元数据对象的名称。

SYSTEM_TYPE

    外部系统的类型。 支持的值：AMAZON_REDSHIFT、、AZURE_SYNAPSE、CONFLUENTDATABRICKSGOOGLE_BIGQUERYKAFKALOOKERMICROSOFT_FABRICMICROSOFT_SQL_SERVERMONGODBMYSQLORACLEOTHERPOSTGRESQLPOWER_BISALESFORCESAPSERVICENOWSNOWFLAKESTREAM_NATIVE、TABLEAU。。 TERADATAWORKDAY

ENTITY_TYPE

    外部系统中实体的类型。

选项

--description string

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

--json JSON

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

--owner string

    外部元数据对象的所有者。

--url string

    与外部元数据对象关联的 URL。

全局标志

示例

以下示例为 Snowflake 表创建外部元数据对象：

databricks external-metadata create-external-metadata my_snowflake_table SNOWFLAKE TABLE --description "Production sales table" --url "https://example.snowflakecomputing.com/table/sales"

以下示例使用 JSON 创建外部元数据对象：

databricks external-metadata create-external-metadata tableau_dashboard TABLEAU DASHBOARD --json '{"description": "Sales dashboard", "owner": "user@example.com"}'

以下示例使用 JSON 文件创建外部元数据对象：

databricks external-metadata create-external-metadata bigquery_dataset GOOGLE_BIGQUERY DATASET --json @external-metadata.json

databricks external-metadata delete-external-metadata

删除与提供的名称匹配的外部元数据对象。 调用方必须是元存储管理员、外部元数据对象的所有者或具有 MANAGE 权限的用户。

databricks external-metadata delete-external-metadata NAME [flags]

Arguments

NAME

    要删除的外部元数据对象的名称。

选项

全局标志

示例

以下示例删除外部元数据对象：

databricks external-metadata delete-external-metadata my_snowflake_table

databricks external-metadata get-external-metadata

获取元存储中的指定外部元数据对象。 调用方必须是元存储管理员、外部元数据对象的所有者或具有 BROWSE 权限的用户。

databricks external-metadata get-external-metadata NAME [flags]

Arguments

NAME

    要获取的外部元数据对象的名称。

选项

全局标志

示例

以下示例获取外部元数据对象：

databricks external-metadata get-external-metadata my_snowflake_table

databricks external-metadata list-external-metadata

列出元存储中的外部元数据对象。 如果调用方是元存储管理员，将检索所有外部元数据对象。 否则，将只检索调用方具有 BROWSE 的外部元数据对象。 不能保证数组中元素的特定排序。

databricks external-metadata list-external-metadata [flags]

选项

--page-size int

    每个页面要返回的外部元数据对象的最大数目。

--page-token string

    用于检索下一页结果的令牌。

全局标志

示例

以下示例列出所有外部元数据对象：

databricks external-metadata list-external-metadata

以下示例列出具有分页的外部元数据对象：

databricks external-metadata list-external-metadata --page-size 10

databricks external-metadata update-external-metadata

更新与提供的名称匹配的外部元数据对象。 调用方只能在一个请求中更新所有者或其他元数据字段。 调用方必须是元存储管理员、外部元数据对象的所有者或具有 MODIFY 权限的用户。 如果调用方正在更新所有者，他们还必须具有 MANAGE 权限。

databricks external-metadata update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE [flags]

Arguments

NAME

    外部元数据对象的名称。

UPDATE_MASK

    字段掩码必须是单个字符串，多个字段用逗号分隔（无空格）。 字段路径是相对于资源对象而言的，通过点（.）来导航子字段（例如，author.given_name）。 不允许对序列或映射字段中的元素进行规范，因为只能指定整个集合字段。 字段名称必须与资源字段名称完全匹配。

    星号 （*） 字段掩码指示完全替换。 建议始终显式列出要更新的字段，避免使用通配符，因为如果 API 将来发生更改，可能会导致意外结果。

SYSTEM_TYPE

    外部系统的类型。 支持的值：AMAZON_REDSHIFT、、AZURE_SYNAPSE、CONFLUENTDATABRICKSGOOGLE_BIGQUERYKAFKALOOKERMICROSOFT_FABRICMICROSOFT_SQL_SERVERMONGODBMYSQLORACLEOTHERPOSTGRESQLPOWER_BISALESFORCESAPSERVICENOWSNOWFLAKESTREAM_NATIVE、TABLEAU。。 TERADATAWORKDAY

ENTITY_TYPE

    外部系统中实体的类型。

选项

--description string

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

--json JSON

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

--owner string

    外部元数据对象的所有者。

--url string

    与外部元数据对象关联的 URL。

全局标志

示例

以下示例更新外部元数据对象的说明：

databricks external-metadata update-external-metadata my_snowflake_table "description" SNOWFLAKE TABLE --description "Updated production sales table"

以下示例更新外部元数据对象的所有者：

databricks external-metadata update-external-metadata my_snowflake_table "owner" SNOWFLAKE TABLE --owner "newowner@example.com"

以下示例使用 JSON 更新外部元数据对象：

databricks external-metadata update-external-metadata my_snowflake_table "description,url" SNOWFLAKE TABLE --json '{"description": "Latest sales data", "url": "https://example.snowflakecomputing.com/table/sales_v2"}'

全局标志

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

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

  • Last updated on