external-lineage 命令组

注释

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

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

external-lineage Databricks CLI 中的命令组包含用于定义和管理 Databricks 对象与外部系统之间的世系关系的命令。

databricks external-lineage create-external-lineage-relationship

在 Databricks 或外部元数据对象与另一个外部元数据对象之间创建外部世系关系。

databricks external-lineage create-external-lineage-relationship SOURCE TARGET [flags]

Arguments

SOURCE

    外部世系关系的源对象。

TARGET

    外部世系关系的目标对象。

选项

--json JSON

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

全局标志

示例

以下示例使用 JSON 创建外部世系关系:

databricks external-lineage create-external-lineage-relationship source_object target_object --json '{"column_mappings": [{"source_column": "id", "target_column": "external_id"}]}'

以下示例使用 JSON 文件创建外部世系关系:

databricks external-lineage create-external-lineage-relationship source_object target_object --json @lineage.json

databricks external-lineage delete-external-lineage-relationship

删除 Databricks 或外部元数据对象与另一个外部元数据对象之间的外部世系关系。

databricks external-lineage delete-external-lineage-relationship [flags]

选项

--json JSON

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

全局标志

示例

以下示例使用 JSON 删除外部世系关系:

databricks external-lineage delete-external-lineage-relationship --json '{"source": "source_object", "target": "target_object"}'

以下示例使用 JSON 文件删除外部世系关系:

databricks external-lineage delete-external-lineage-relationship --json @delete-lineage.json

databricks external-lineage list-external-lineage-relationships

列出给定方向的 Databricks 对象或外部元数据的外部世系关系。

databricks external-lineage list-external-lineage-relationships [flags]

选项

--json JSON

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

--page-size int

    每个页面要返回的外部世系关系的最大数目。

--page-token string

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

全局标志

示例

以下示例使用 JSON 列出外部世系关系:

databricks external-lineage list-external-lineage-relationships --json '{"object": "my_catalog.my_schema.my_table", "direction": "DOWNSTREAM"}'

以下示例列出具有分页的外部世系关系:

databricks external-lineage list-external-lineage-relationships --json '{"object": "my_catalog.my_schema.my_table", "direction": "UPSTREAM"}' --page-size 10

以下示例使用 JSON 文件列出外部世系关系:

databricks external-lineage list-external-lineage-relationships --json @list-lineage.json

databricks external-lineage update-external-lineage-relationship

更新 Databricks 或外部元数据对象与另一个外部元数据对象之间的外部世系关系。

databricks external-lineage update-external-lineage-relationship UPDATE_MASK SOURCE TARGET [flags]

Arguments

UPDATE_MASK

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

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

SOURCE

    外部世系关系的源对象。

TARGET

    外部世系关系的目标对象。

选项

--json JSON

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

全局标志

示例

以下示例使用 JSON 更新外部世系关系:

databricks external-lineage update-external-lineage-relationship "column_mappings" source_object target_object --json '{"column_mappings": [{"source_column": "updated_id", "target_column": "new_external_id"}]}'

以下示例使用 JSON 文件更新外部世系关系:

databricks external-lineage update-external-lineage-relationship "column_mappings" source_object target_object --json @update-lineage.json

全局标志

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

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