借助 Knowledge Catalog(以前称为 Dataplex Universal Catalog)中的切面和切面类型,您可以向条目、列和条目链接添加结构化元数据,以描述数据资产及其关系。此上下文可提高数据可发现性,并帮助您对个人身份信息 (PII) 等敏感信息进行分类,以应用数据质量或访问权限政策。
如需了解有关切面架构、系统与自定义切面类型、目标级别和数据驻留限制的概念性信息,请参阅切面和切面类型简介。 如需了解整个元数据元模型的架构概览,请参阅 Knowledge Catalog 中的元数据简介。如果您是首次使用 Knowledge Catalog 元数据,请参阅向 BigQuery 表添加元数据或创建和使用业务术语库快速入门。
准备工作
在创建和管理方面类型及切面之前,请完成本部分中所述的任务。
所需的角色
如需获得创建和管理切面类型及切面所需的权限,请让您的管理员为您授予项目的以下 IAM 角色。您不需要同时拥有所有这些角色;请选择与您的特定工作流匹配的角色或组合:
如需获得创建和管理切面类型及切面所需的权限,请让您的管理员为您授予项目的以下 IAM 角色:
-
如需通过广泛的管理员访问权限管理所有目录资源(包括切面类型和条目),请使用:Dataplex Catalog Admin (
roles/dataplex.catalogAdmin) 或 Dataplex Catalog Editor (roles/dataplex.catalogEditor) -
仅创建和管理自定义切面类型,并为切面类型管理员提供最小权限访问权限:Dataplex Aspect Type Owner (
roles/dataplex.aspectTypeOwner) -
在创建或修改条目时使用切面类型,并为数据管理者提供最小权限访问权限:Dataplex Aspect Type User (
roles/dataplex.aspectTypeUser) -
如需将可重复使用的系统切面类型(例如
schema、contacts和overview)附加到条目和条目链接,请使用:Dataplex Entry and EntryLink Owner (roles/dataplex.entryOwner) -
查看切面类型及其 IAM 政策,但不进行修改:Dataplex Catalog Viewer (
roles/dataplex.catalogViewer)
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
这些预定义角色包含创建和管理切面类型和切面所需的权限。如需查看所需的确切权限,请展开所需权限部分:
所需权限
如需创建和管理切面类型及切面,需要具备以下权限:
-
创建、查看、列出、更新和删除切面类型:
-
dataplex.aspectTypes.create -
dataplex.aspectTypes.get -
dataplex.aspectTypes.list -
dataplex.aspectTypes.update -
dataplex.aspectTypes.delete
-
-
使用切面类型丰富条目:
dataplex.aspectTypes.use -
创建、查看、更新和删除条目及其切面:
-
dataplex.entries.create -
dataplex.entries.get -
dataplex.entries.list -
dataplex.entries.update -
dataplex.entries.delete
-
-
创建、查看、更新和删除条目链接及其切面:
-
dataplex.entryLinks.create -
dataplex.entryLinks.get -
dataplex.entryLinks.list -
dataplex.entryLinks.update -
dataplex.entryLinks.delete
-
如需了解详情,请参阅 Knowledge Catalog IAM 角色。
启用 API
在 Knowledge Catalog 项目中启用 Dataplex API。如果您使用的是新 Google Cloud 项目或已启用 BigQuery API 的项目,则 Dataplex API 默认处于启用状态。
创建自定义切面类型
控制台
如需在 Google Cloud 控制台中创建自定义切面类型,请按照以下子任务操作:
配置基本详情:
定义架构模板:
模板定义了在切面类型中分组的元数据字段的格式和架构。您可以手动定义字段,也可以从模板库中选择一个入门模板(例如数据敏感度、数据治理或数据注入)来加快架构创建速度。例如,选择数据敏感度模板会自动添加布尔值字段
Is Encrypted和Has PII,以及枚举字段PII Type。如需手动定义字段,请执行以下操作:
- 在模板部分中,点击添加字段。
- 在新字段面板中,指定以下内容:
- 名称:字段的标识符。
- 可选:显示名称:人性化的标签。
- 可选:说明:字段的简要说明。
- 类型:选择字段数据类型。支持的类型包括文本、整数、布尔值、日期和时间、双精度、枚举、数组、映射和记录。
- 可选:为必填项:选中此复选框,以便在用户附加此切面时将该字段设为必填字段。
- 点击完成。如需添加更多字段,请点击添加字段,然后重复执行上述步骤。
添加资源标签并保存:
资源标签是任意键值对,可帮助您整理和过滤 Google Cloud 资源。例如,您可以使用
environment: production或team: analytics等标签按环境或团队所有权整理资源。- 在标签部分中,点击添加标签。
- 输入标签键和值。
- 点击保存。
gcloud
如需创建自定义切面类型,请使用 gcloud dataplex aspect-types
create 命令。
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Ruby
Ruby
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Ruby API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
REST
如需创建自定义切面类型,请使用 aspectType.create 方法。
创建自定义切面类型后,您可以向条目添加切面。
使用“记录 ID”和“记录引用”字段的示例
您可以使用记录 ID 和记录引用字段进行递归引用。以下示例展示了如何使用这些字段:
假设一个名为 Employee 的切面类型,其中包含以下字段:
- 名称(类型:
Text) - 开始日期(类型:
Date & time) - 标识(类型:
Text) - 当前地址(类型:
Record) - 永久地址(类型:
Record)
两个地址字段(当前地址和永久地址)的数据类型均为 Record。为避免重复,您可以在定义这些字段时设置记录 ID 和记录引用 值。
定义当前地址字段时,您可以将记录 ID 指定为 address-field。对于永久地址,您可以为记录引用指定相同的值 (address-field)。例如:
- 名称(类型:
Text) - 开始日期(类型:
Date & time) - 标识(类型:
Text) - 当前地址(类型:
Record,记录 ID:address-field) - 永久地址(类型:
Record,记录引用:address-field)
这样一来,您便无需重复其他地址的字段。
向条目添加切面
创建自定义切面类型后,您可以创建该类型的切面。如需向条目添加切面,您必须更新该条目,因为切面存储在条目中。
注意以下限制:
- 您可以向条目或条目列添加切面。
- 您只能修改自定义条目的必需切面。您无法删除必需的切面。
- 您可以修改和删除自定义条目及系统条目的可选切面。
- 当您使用
CREATE OR REPLACE TABLE语句、TRUNCATE TABLE语句或WRITE_TRUNCATE作业替换或重新加载 BigQuery 表时,Knowledge Catalog 会保留条目的用户附加切面。对于保留在架构中的列,列级切面也会保留。但是,如果您使用DROP TABLE语句和CREATE TABLE语句删除并重新创建表,Knowledge Catalog 会创建一个新条目,其中不包含原始表的用户附加切面。如需在重新加载表时保留切面,请使用CREATE OR REPLACE TABLE、TRUNCATE TABLE或WRITE_TRUNCATE。或者,您可以创建 BigQuery 视图并将切面附加到该视图。
控制台
在 Google Cloud 控制台中,前往 Knowledge Catalog 搜索页面。
搜索要向其添加切面的条目,然后点击该条目。系统会打开条目详情页面。
在条目详情页面上,点击详情标签页。
在切面部分中,点击必需的切面或可选切面区域中的 添加。只有在条目类型定义了必需切面的情况下,您才能添加必需切面。
搜索并选择您要添加的切面。
在添加切面窗口中,输入相应字段的值。
点击保存。
如需向条目列添加切面,请执行以下操作:
- 在条目详情页面上,点击架构标签页。
- 选择要向其添加切面的列。
- 点击添加切面。
- 搜索并选择您要添加的切面。
- 在添加切面窗口中,输入相应字段的值。
- 点击保存。
gcloud
如需向条目或条目列添加切面,请使用 gcloud
dataplex entries update 命令。
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
如需向条目对象添加切面,请参阅切面。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
如需向条目对象添加切面,请参阅条目。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Ruby
Ruby
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Ruby API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
如需向条目对象添加切面,请参阅 #required_aspects=。
REST
如需向条目或条目列添加切面,请使用 entry.patch 方法。
不支持在条目中创建和使用切面,因为相应的切面类型和条目位于不同的 Google Cloud 组织中。
附加可重复使用的系统切面类型的切面
Knowledge Catalog 提供了预定义的系统切面类型,您可以将其附加到条目,以捕获标准化元数据。例如,您可以使用这些切面类型来记录所有权联系人、架构定义、使用情况指标和数据质量结果。
一般工作流和载荷规则
附加可重复使用的系统切面类型的切面时,请遵循以下规则:
- 控制台与 CLI/REST:对于没有嵌套字段的切面类型(例如
generic),您可以使用 Google Cloud 控制台、gcloudCLI 或 REST API。对于具有复杂或嵌套结构的切面类型(例如data-quality-scorecard、contacts或data-profile),您必须使用gcloudCLI 或 REST API。 - 载荷结构:
gcloudCLI:直接传递切面映射,以全局切面类型标识符{"dataplex-types.global.<ASPECT_TYPE>": {"data": { ... }}}作为键。- REST API:将切面映射封装在
"aspects"容器对象{"aspects": {"dataplex-types.global.<ASPECT_TYPE>": {"data": { ... }}}}中。
- 覆盖行为:更新切面会替换目标条目或列中该特定切面类型的任何现有数据,而不会合并字段。
以下部分提供了附加常见可重用系统切面的示例和架构,首先是数据质量记分卡。
数据质量计分卡
数据质量计分卡是一个切面,用于提供数据质量摘要,通常基于数据质量扫描或其他流程。您可以将数据质量统计信息摘要图表附加到条目,以提供自定义数据质量信息。为此,请附加系统定义的类型 data-quality-scorecard 的切面。
data-quality-scorecard 方面中的 data 字段可以包含以下字段:
job:可选。一条记录,其中包含有关生成计分卡的作业的详细信息。name:数据质量作业的资源名称。runTime:数据质量作业的运行时间。
score:可选。总体数据质量得分。分数范围为 [0, 100]。status:必填。数据质量统计信息摘要的状态,指明其是否通过了质量阈值(PASS或FAIL)。dimensions:可选。维度结果数组。每个结果都包含:name:维度的名称。可以是ACCURACY、COMPLETENESS、CONSISTENCY、FRESHNESS、UNIQUENESS、VALIDITY或VOLUME,也可以是自定义维度名称。自定义维度名称必须使用大写字母,且长度不得超过 30 个字符。score:维度级总体得分,范围为 [0, 100]。status:维度的状态,指示其是否通过了质量阈值(PASS或FAIL)。
columns:可选。列结果的数组。每个结果都包含:name:列的名称。score:列级总体得分,范围为 [0, 100]。status:列的状态,指示其是否通过了质量阈值(PASS或FAIL)。dimensions:列的维度得分数组。每个维度得分都包含:name:维度的名称。score:维度的得分,范围为 [0, 100]。status:列的维度状态,指示其是否通过了质量阈值(PASS、FAIL、UNKNOWN或NOT_APPLICABLE)。
details(可选映射):提供有关评估的其他上下文的键值对。evaluatedAssetCount(可选整数):已评估的资产数量。
运行命令附加切面时,该命令会替换该特定切面的所有现有数据。例如,如果您使用显示得分为 90 的新文件更新得分为 80 的记分卡,则 80 将被覆盖。它不会合并数据。
如需附加数据质量统计信息,请按以下步骤操作:
gcloud
如需更新条目的切面,请使用 gcloud dataplex entries
update-aspects 命令。
创建包含以下内容的 JSON 文件 (
dq-aspect.json)。{ "dataplex-types.global.data-quality-scorecard": { "data": { "score": 80, "status": "PASS", "dimensions": [ { "name": "completeness", "score": 90, "status": "PASS" }, { "name": "uniqueness", "score": 70, "status": "FAIL" } ], "columns": [ { "name": "col1", "score": 85, "status": "PASS" } ] } } }运行以下命令:
gcloud dataplex entries update-aspects ENTRY_ID \ --location=LOCATION \ --entry-group=ENTRY_GROUP_ID \ --project=PROJECT_ID \ --aspects=dq-aspect.json
执行以下变量替换操作:
ENTRY_ID:条目的 ID,例如example-entryLOCATION:条目的位置,例如us-central1ENTRY_GROUP_ID:条目组的 ID,例如example-entry-groupPROJECT_ID:项目的 ID,例如example-project
REST
如需更新条目的切面,请使用 entry.patch 方法。
创建一个名为
payload.json的文件,并将请求中的 JSON 内容粘贴到其中。{ "aspects": { "dataplex-types.global.data-quality-scorecard": { "data": { "score": 80, "status": "PASS", "dimensions": [ { "name": "completeness", "score": 90, "status": "PASS" }, { "name": "uniqueness", "score": 70, "status": "FAIL" } ], "columns": [ { "name": "col1", "score": 85, "status": "PASS" } ] } } } }在终端中运行以下命令:
curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d @payload.json \ "https://dataplex.googleapis.com/v1/projects/<var>PROJECT_ID</var>/locations/<var>LOCATION</var>/entryGroups/<var>ENTRY_GROUP_ID</var>/entries/<var>ENTRY_ID</var>?updateMask=aspects"替换以下内容:
PROJECT_ID:项目的 ID,例如example-projectLOCATION:条目的位置,例如us-central1ENTRY_GROUP_ID:条目组的 ID,例如example-entry-groupENTRY_ID:条目的 ID,例如example-entry
其他可重复使用的切面类型
以下系统切面类型也可用于条目丰富。以下各部分列出了前置摘要。点击每个可展开的部分,即可查看字段架构和 JSON 载荷示例。
联系人 (dataplex-types.global.contacts)
使用 contacts 方面类型为条目分配所有权、管理权或操作角色。
identities(数组):联系人列表。每个联系人均包含role(例如owner、steward、producer或admin)、name和id(邮箱)。
载荷示例 (REST API):
{ "aspects": { "dataplex-types.global.contacts": { "data": { "identities": [ { "role": "steward", "name": "Jane Doe", "id": "jane.doe@example.com" } ] } } } }
数据分析 (dataplex-types.global.data-profile)
使用 data-profile 方面类型来捕获源数据扫描生成的统计分析结果。如需了解详情,请参阅数据分析简介。
sourceDataInfo(记录):有关扫描的元数据,包括scope(PREVIEW、SAMPLED或ALL)、scannedRows和samplingPercentage。fields(映射):列级统计信息,包括nullness、uniqueness以及针对数值、字符串、日期时间和数组列的类型特定指标。
载荷示例 (REST API):
{ "aspects": { "dataplex-types.global.data-profile": { "data": { "sourceDataInfo": { "scope": "ALL", "scannedRows": 100 }, "fields": { "col1": { "nullness": 0.0, "uniqueness": 0.1, "string": { "length": { "min": 1, "max": 20, "avg": 12.54 } } } } } } } }
通用 (dataplex-types.global.generic)
使用 generic 切面类型捕获自由格式的条目信息和源系统元数据,而无需定义自定义切面架构。
type(字符串):用户指定的条目分类字符串。system(字符串):自定义条目的源系统标识符。
载荷示例 (REST API):
{ "aspects": { "dataplex-types.global.generic": { "data": { "type": "custom-type", "system": "custom-system" } } } }
概览 (dataplex-types.global.overview)
使用 overview 方面类型提供人类可读的富文本文档和有用的外部链接。
content(字符串):支持 HTML 格式的富文本说明。links(数组):外部资源和文档链接,每个链接包含url和title。
载荷示例 (REST API):
{ "aspects": { "dataplex-types.global.overview": { "data": { "content": "This is a rich text description.", "links": [ { "url": "https://example.com", "title": "Example Link" } ] } } } }
架构 (dataplex-types.global.schema)
使用 schema 切面类型来描述数据资产的表格架构、列名称、模式和数据类型。
fields(数组):列列表,每列包含name、dataType、metadataType(例如STRING、BOOLEAN)、mode(NULLABLE、REQUIRED、REPEATED)和可选的description。
载荷示例 (REST API):
{ "aspects": { "dataplex-types.global.schema": { "data": { "fields": [ { "name": "id", "dataType": "string", "metadataType": "STRING", "mode": "REQUIRED" } ] } } } }
使用量 (dataplex-types.global.usage)
使用 usage 切面类型可跟踪使用情况指标、查看次数和时序查询句式。
metrics(数组):消耗指标,每个指标包含name(例如views或reads)和timeSeries数据点,其中包含汇总间隔和值。refreshTime(日期时间):上次计算使用情况指标的时间戳。
载荷示例 (REST API):
{ "aspects": { "dataplex-types.global.usage": { "data": { "metrics": [ { "name": "views", "timeSeries": [ { "interval": "30d", "value": 100 } ] } ], "refreshTime": "2025-01-01T12:00:00Z" } } } }
创建条目链接
您可以通过创建条目链接在两个条目之间建立关系。
条目链接可以是对称的(例如 synonym),也可以是非对称的(例如 definition)。
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
REST
如需创建具有所需切面的条目链接,请使用 entryLinks.create 方法,并在请求正文中包含切面数据。
向条目链接添加切面
如需使用有关条目之间关系的信息来丰富元数据,请向条目链接添加切面。
您可以将条目链接类型配置为需要特定切面。创建此类条目链接时,您必须提供必需的切面。
您可以在创建条目链接时添加这些切面,也可以通过更新现有条目链接来添加这些切面,如下所示:
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
REST
如需更新条目链接,请使用 entryLinks.patch 方法,并在 entryLink 正文中添加切面数据。
请注意,将切面与条目链接搭配使用时存在以下限制:
- 不支持可选切面。
- 不支持数据方面。
- 不支持自定义类型的切面。
- 您只能管理由系统切面类型(例如
schema-join)定义的必需切面。 - 不支持根据切面的内容搜索条目链接。
- 不支持导入或导出条目链接切面。
管理条目的现有切面
本部分介绍了如何更新和删除条目的现有切面。
更新切面
您可以修改自定义条目和系统条目的可选切面。您只能修改自定义条目的必需切面。
对于第一方 (1P) 系统条目(例如 BigQuery 表),您可以使用 modifyEntry API 更新切面。这样,您就可以使用源系统的元数据更新权限(例如 BigQuery Data Editor [roles/bigquery.dataEditor])。
控制台
在 Google Cloud 控制台中,前往 Knowledge Catalog 搜索页面。
搜索要更新其切面的条目,然后点击该条目。
系统会打开条目详情页面。
- 点击详情标签页。
- 在切面部分中,展开要更新的切面,然后点击 修改。
- 在修改切面窗口中,更新必填字段。
- 点击保存。
gcloud
如需更新条目或条目列的切面,请使用 gcloud
dataplex entries update 命令或 gcloud dataplex entries update-aspects。
如需使用 JSON 文件更新切面,请执行以下操作:
gcloud dataplex entries update-aspects ENTRY_ID \ --location=LOCATION \ --entry-group=ENTRY_GROUP_ID \ --project=PROJECT_ID \ --aspects=ASPECTS_JSON_FILE
替换以下内容:
ENTRY_ID:条目的 ID。LOCATION:条目的位置。ENTRY_GROUP_ID:条目组的 ID。PROJECT_ID:项目的 ID。ASPECTS_JSON_FILE:包含切面映射的 JSON 文件的路径。
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Ruby
Ruby
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Ruby API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
REST
如需更新条目或条目列的切面,请使用 entry.patch 方法。
删除切面
控制台
在 Google Cloud 控制台中,前往 Knowledge Catalog 搜索页面。
搜索要删除其切面的条目,然后点击该条目。
系统会打开条目详情页面。
- 点击详情标签页。
- 在切面部分中,展开要删除的切面,然后点击 删除。
- 点击确认。
gcloud
如需删除条目的切面,请使用 gcloud dataplex entries update 命令和 --remove-aspects 标志。
如需删除条目级切面,请执行以下操作:
gcloud dataplex entries update ENTRY_ID \ --location=LOCATION \ --entry-group=ENTRY_GROUP_ID \ --project=PROJECT_ID \ --remove-aspects='ASPECT_TYPE'
如需删除列级切面,请执行以下操作:
gcloud dataplex entries update ENTRY_ID \ --location=LOCATION \ --entry-group=ENTRY_GROUP_ID \ --project=PROJECT_ID \ --remove-aspects='ASPECT_TYPE@Schema.COLUMN_NAME'
替换以下内容:
ENTRY_ID:条目的 ID。LOCATION:条目的位置。ENTRY_GROUP_ID:条目组的 ID。PROJECT_ID:项目的 ID。ASPECT_TYPE:完整切面类型标识符,例如dataplex-types.global.generic或<var>PROJECT_ID</var>.<var>LOCATION</var>.<var>ASPECT_TYPE_ID</var>。COLUMN_NAME:列的名称。
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Ruby
Ruby
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Ruby API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
REST
如需删除条目的切面,请使用 entry.patch 方法。
管理条目链接的现有切面
本部分介绍了如何更新条目链接的现有切面。
更新切面
对于条目链接,您只能更新使用可重复使用的系统切面类型的必需切面。
如需了解详情,请参阅条目链接操作的 IAM 权限。
REST
如需使用所需切面更新条目链接,请使用 entryLinks.patch 方法,并在请求正文中添加切面数据。
删除切面
您无法删除条目链接的必需切面。
管理切面类型
本部分介绍了如何查看切面类型,以及如何更新和删除自定义切面类型。
查看可用切面类型列表
控制台
在 Google Cloud 控制台中,前往 Knowledge Catalog 元数据类型页面。
点击切面类型标签页。
此页面列出了所有可用的 Knowledge Catalog 切面类型。
- 如需查看自定义切面类型,请点击自定义标签页。在自定义标签页中,目录来源列会显示资源在 Knowledge Catalog 中的位置。
如需查看系统切面类型,请点击系统标签页。
如需详细了解自定义切面类型和系统切面类型,请参阅本文档的切面类型的类别部分。
- 可选:如需查看所选项目中的切面类型列表,请点击自定义标签页,然后点击显示所有项目中的切面类型切换开关,将其切换到关闭位置。
显示所有项目中的条目组切换开关默认处于开启状态,并且该列表包含所选组织中的 Knowledge Catalog 资源。
gcloud
如需列出所有可用的切面类型,请使用 gcloud dataplex
aspect-types list 命令。
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Ruby
Ruby
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Ruby API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
REST
如需列出所有可用的切面类型,请使用 aspectTypes.list 方法。
查看切面类型的详细信息
控制台
在 Google Cloud 控制台中,前往 Knowledge Catalog 元数据类型页面。
点击切面类型标签页。
如需查看 Knowledge Catalog 切面类型的详细信息,请点击该切面类型。系统会打开切面类型详情页面,您可以在其中查看显示名称、切面类型 ID、说明、项目 ID、位置、标签、创建日期和上次修改日期等详细信息。
- 如需查看所选切面类型的结构,请点击模板标签页。
- 如需查看最近创建的 10 个相关条目的列表,请点击条目示例标签页。
- 如需搜索所有相关条目,请点击在搜索结果中显示所有相关条目。仅当至少存在一个相关条目时,才会显示此按钮。
gcloud
如需获取切面类型的详细信息,请使用 gcloud dataplex aspect-types
describe 命令。
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Ruby
Ruby
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Ruby API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
REST
如需获取切面类型的详细信息,请使用 aspectTypes.get 方法。
更新自定义切面类型
您可以更新自定义切面类型的显示名称、说明、模板字段和标签。您无法删除模板中的现有字段。
创建切面类型后,您无法更新切面类型 ID 和位置。
控制台
在 Google Cloud 控制台中,前往 Knowledge Catalog 元数据类型页面。
点击切面类型标签页。
点击要更新的切面类型。
在切面类型详细信息页面上,点击修改。
根据需要修改显示名称、说明、模板字段和标签。
可选:如需将切面类型中的某个字段标记为已弃用,请按照以下步骤操作:
- 在模板部分中,展开相应字段。
- 选择已弃用。
- 在弃用原因字段中,输入弃用所选字段的原因。
点击完成。
点击保存。
gcloud
如需更新自定义切面类型,请使用 gcloud dataplex aspect-types
update 命令。
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Ruby
Ruby
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Ruby API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
REST
如需更新自定义切面类型,请使用 aspectTypes.patch 方法。
删除自定义切面类型
控制台
在 Google Cloud 控制台中,前往 Knowledge Catalog 元数据类型页面。
点击切面类型标签页。
点击要删除的切面类型。
在切面类型详细信息页面上,点击删除。在系统提示时确认。
gcloud
如需删除自定义切面类型,请使用 gcloud dataplex aspect-types
delete 命令。
C#
C#
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 C# 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog C# API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Go
Go
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Go 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Go API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Java
Java
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Java 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Java API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Node.js
Node.js
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Node.js 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Node.js API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Python
Python
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Python 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Python API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
Ruby
Ruby
在尝试此示例之前,请按照《Knowledge Catalog 快速入门:使用客户端库》中的 Ruby 设置说明进行操作。 如需了解详情,请参阅 Knowledge Catalog Ruby API 参考文档。
如需向 Knowledge Catalog 进行身份验证,请设置应用默认凭据。如需了解详情,请参阅为本地开发环境设置身份验证。
REST
如需删除现有的自定义切面类型,请使用 aspectTypes.delete 方法。
后续步骤
- 了解如何在 Knowledge Catalog 中搜索资源。
- 了解如何管理条目和注入自定义来源。
- 了解如何将元数据导入 Knowledge Catalog。
- 详细了解 Knowledge Catalog 中的元数据。
- 了解如何建立基础数据上下文。
- 尝试 Knowledge Catalog 应用场景。