本文档介绍了如何创建和管理切面类型,以及 使用切面为条目添加注释。
Dataplex Catalog 按一组方面描述这些条目。 您可以使用切面和 切面类型。
如需了解详情,请参阅 Dataplex Catalog 概览。
切面
利用切面,您可以捕获条目中的元数据。向条目添加切面 有助于为需要使用该素材资源的任何人提供有意义的背景信息。您可以 使用各个方面来存储业务元数据(例如数据分类),并 技术元数据(例如架构)。
切面被视为条目资源的一部分,而非独立 资源。修改切面时,涉及修改包含 切面。
您可以在条目级别指定切面,也可以指定 列级别,用于描述条目中的列。
每个切面都是切面类型的实例。切面类型定义模板 及其各个方面。每个切面类型都包含一组字段。创建 您必须提供这些字段的值。
对于给定条目,最多只能有一个与该条目相关联的方面, 每个切面类型。您可以有多个与条目列相关联的切面 每个切面类型。
切面类别
各个方面分为以下几类:
必需切面:创建条目时必需的切面。 此类切面由给定条目的条目类型定义。所有条目 属于某个条目类型必须始终具有 都由该条目类型定义
Dataplex 可管理以下各项所需的方面(例如,架构) 系统条目。
请注意以下几点:
您只能将必需的切面与条目相关联,而不能将其与 条目的各列。
您无法从条目中删除必需切面。
您可以读取系统条目的必需方面,但无法修改。
可选切面:您可以将可选切面与条目或 条目列。您可以在输入时填充可选切面 或者稍后通过更新条目来创建。
在填充可选切面后,您可以将其删除。
切面类型
切面类型是可重复使用的资源,为切面提供模板。
切面类型的类别
切面类型分为以下几类:
自定义切面类型:您在 Dataplex Catalog。
系统切面类型:Dataplex 提供、使用、 和管理
系统切面类型进一步分为可重用和受限两类。 下表介绍了系统切面类型的类别,以及 Dataplex 为每个类别提供的切面类型列表:
系统切面类型的类别 说明 Dataplex 提供的切面类型 可重复使用的系统切面类型 您可以使用这些切面类型创建或修改切面。 generic
storage
受限的系统切面类型 Dataplex 管理这些切面类型。
您可以读取这些切面类型下的切面,但无法创建或修改 这些切面类型下的切面。bigquery-connection
bigquery-dataset
bigquery-model
bigquery-routine
bigquery-table
bigquery-view
cloudsql-database
cloudsql-instance
cloudsql-schema
cloudsql-table
cloudsql-view
storage
sql-access
storage-bucket
storage-folder
请勿使用系统切面类型
overview
、contacts
和schema
。您可以在特定区域位置创建自定义切面类型,也可以作为 全球性资源。系统切面类型始终是全局的。容器的 切面类型会影响其适用范围。如需了解详情,请参阅 项目和位置限制条件。
准备工作
在创建和管理切面类型和切面之前,请先完成任务 具体说明。
所需的角色
为了获得创建和管理切面类型和切面所需的权限, 请让管理员授予您 针对资源的以下 IAM 角色:
-
拥有对所有 Dataplex Catalog 资源(包括切面类型)的完整权限:
Dataplex Catalog Admin (
roles/dataplex.catalogAdmin
) -
创建和管理所有 Dataplex Catalog 资源,包括切面类型:
Dataplex Catalog Editor (
roles/dataplex.catalogEditor
) -
针对自定义切面类型的整套权限(使用切面类型创建或修改条目的权限除外):
Dataplex 切面类型所有者 (
roles/dataplex.aspectTypeOwner
) -
查看切面类型和关联的 IAM 政策:
Dataplex Catalog Viewer (
roles/dataplex.catalogViewer
) -
使用切面类型创建和修改具有相应切面的条目:
Dataplex Aspect Type User (
roles/dataplex.aspectTypeUser
) -
添加某些系统切面类型(如
schema
、overview
、contacts
)的切面: Dataplex Entry Owner (roles/dataplex.entryOwner
)
如需详细了解如何授予角色,请参阅管理访问权限。
如需了解详情,请参阅 Dataplex IAM 角色。
启用 API
在 Dataplex 项目中启用 Dataplex API。
创建切面类型
控制台
在 Google Cloud 控制台中,转到 Dataplex Catalog 页面。
依次点击切面类型 > 自定义标签页。
在 Details 部分中,输入以下内容:
- 可选:在显示名称字段中,输入切面的名称 类型。
- 在切面类型 ID 字段中,为切面类型输入一个唯一 ID。
- 可选:在说明字段中,输入 切面类型。
- 在位置字段中,为切面类型选择一个位置。 切面类型创建后,便无法修改其位置。
可选:为切面类型定义模板。
在模板中,点击添加字段。在新字段部分中, 输入以下内容:
- 在名称字段中,输入一个名称。
- 可选:在显示名字段中,输入显示名。
- 可选:在说明字段中,输入说明。
在 Type(类型)字段中,为字段选择数据类型。根据您的 系统会显示下一组字段和选项:
如果您选择了文本作为数据类型,请按以下步骤操作:
- 在文本类型字段中,选择文本类型。
- 在 Text values 字段中,提供文本提示 字段。为此,请点击添加值并输入提示。 您可以为一个文本字段添加多个提示。
- 点击完成。
如果您选择 Enum 作为数据类型,请添加枚举值:
- 点击添加枚举值。
- 在值字段中,输入一个枚举值。您可以添加 多个枚举值。
- 点击完成。
如果您选择 Array 作为数据类型,请在数组项中 部分中,定义要在数组中显示的项目类型:
- 点击添加数组项。
- 在名称字段中,输入数组项的名称。
- 可选:在显示名称字段中,输入显示名称 。
- 可选:在说明字段中,输入以下各项的说明: 数组项。
在类型字段中,选择数组项的数据类型。
根据您的选择,下一组字段和选项 。它们与 数据类型 Text、Enum、Map、Array 和 Record。
点击完成。
如果您选择了映射作为数据类型,请在映射值中 部分,定义要在映射中显示的值的类型:
- 点击添加映射值。
- 在名称字段中,输入地图的名称。
- 可选:在显示名称字段中,输入显示名称 。
- 可选:在说明字段中,输入说明 。
在类型字段中,为地图选择数据类型。
根据您的选择,下一组字段和选项 。它们与 数据类型 Text、Enum、Map、Array 和 Record。
点击完成。
如果您选择 Record 作为数据类型,请输入以下内容:
- 在记录 ID 字段中,输入其他记录的唯一 ID 字段可用来引用此记录。请参阅 “记录 ID”字段和“记录引用”字段的使用示例 部分。
- 可选:如果您想添加对另一条记录的引用, 请使用 Record reference 字段。禁止的行为 您可以在创建切面类型后修改此类型。请参阅 “记录 ID”字段和“记录引用”字段的使用示例 部分。
在 Record fields 部分中,您可以定义复杂对象 其中包含多个嵌套字段为此,请点击 添加记录字段项,然后指定以下内容:
- 在 Name(名称)字段中,为记录字段输入名称。
- 可选:在显示名称字段中,输入显示名称 填写此字段
- 可选:在说明字段中,输入以下各项的说明: 记录字段。
在 Type 字段中,选择一种数据类型。
根据您的选择,下一组字段和选项 。它们与 数据类型 Text、Enum、Map、Array 和 Record。
点击完成。
要将该字段设为此类型的切面的必填字段,请选择 为必填项。如需详细了解必需的切面和 可选切面,请参阅切面的类别 部分。
点击完成。
要添加多个字段,请点击添加字段,然后重复上一步的操作 步骤。
可选:在标签部分中,添加任意标签作为键值对 资源对:
- 点击添加标签。
- 在密钥字段中,输入一个密钥。
- 在值字段中,输入键的值。
- 如需添加更多标签,请点击添加标签,然后重复上述步骤。
点击保存。
创建切面类型后,您可以向条目添加切面。
REST
要创建新的切面类型,请使用
aspectType.create
方法。
使用记录 ID 和记录引用字段的示例
您可以将记录 ID 和记录引用字段用于递归操作 参考。以下示例展示了如何使用这些字段:
假设有一个名为 Employee
的切面类型,其中包含以下字段:
- 名称(类型:
Text
) - 开始日期(类型:
Date & time
) - 名称(类型:
Text
) - 当前地址(类型:
Record
) - 永久地址(类型:
Record
)
当前地址和永久地址这两个地址字段是
数据类型相同 Record
。为避免重复,您可以设置记录 ID
和 Record reference 值。
在定义当前地址字段时,您可以将记录 ID 指定为
address-field
。对于永久地址,您可以指定相同的值
(address-field
) 表示记录参考。例如:
- 名称(类型:
Text
) - 开始日期(类型:
Date & time
) - 名称(类型:
Text
) - 当前地址(类型:
Record
,记录 ID:address-field
) - 永久地址(类型:
Record
,记录参考编号:address-field
)
这样,您就不需要重复填写其他地址的字段。
向条目添加切面
创建切面类型后,您可以创建切面 该类型。如需向条目添加切面,您必须更新该条目,因为切面 都存储在条目中。
请注意以下几点:
- 您可以向条目或条目的列添加切面。
- 您只能修改自定义条目的必需切面。禁止的行为 删除所需的切面
您可以编辑和删除自定义条目和 系统条目。
控制台
在 Google Cloud 控制台中,转到 Dataplex 搜索页面。
在选择搜索平台部分,选择 Dataplex Catalog 作为 搜索模式。
搜索要为其添加切面的条目,然后点击 该条目。
参评资料详情页面即会打开。
如需向条目添加切面,请按以下步骤操作:
- 在条目详情页面上,点击详细信息标签页。
- 如需向条目添加必需切面或可选切面,
在切面部分中,点击
如果所选条目的类型,则无法添加必需切面 条目未定义必需切面。
添加相应的
类别。 - 搜索并选择要添加的切面。
- 在添加切面窗口中,输入各字段的值。
- 点击保存。
如需向条目的列添加切面,请按以下步骤操作:
- 在条目详情页面上,点击架构标签页。
- 选择要添加切面的列。
- 点击添加切面。
- 搜索并选择要添加的切面。
- 在添加切面窗口中,输入各字段的值。
- 点击保存。
REST
要向条目或条目的列添加切面,请使用
entry.patch
方法。
在条目中创建和使用切面,且该条目对应的切面类型和 条目属于不同的 Google Cloud 组织,因此不受支持。
管理条目的现有切面
本部分介绍如何更新和删除 条目。
更新切面
您可以修改自定义条目和系统条目的可选方面。 您只能修改自定义条目的必需切面。
控制台
在 Google Cloud 控制台中,转到 Dataplex 搜索页面。
在选择搜索平台部分,选择 Dataplex Catalog 作为 搜索模式。
搜索要更新其切面的条目,然后 点击相应条目。
参评资料详情页面即会打开。
点击详情标签页。
针对要更新的方面,点击
修改。在修改切面窗口中,更新必填字段。
点击保存。
REST
要更新条目或条目列的方面,请使用
entry.update
方法。
删除切面
控制台
在 Google Cloud 控制台中,转到 Dataplex 搜索页面。
在选择搜索平台部分,选择 Dataplex Catalog 作为 搜索模式。
搜索要删除其切面的条目,并 点击相应条目。
参评资料详情页面即会打开。
点击详情标签页。
对于要删除的切面,点击
删除。点击确认。
REST
要删除条目的切面,请使用
entry.update
方法。
管理切面类型
本部分介绍如何查看、更新和删除切面类型。
查看可用切面类型的列表
控制台
REST
要列出所有可用的切面类型,请使用
aspectTypes.list
方法。
查看切面类型的详细信息
控制台
在 Google Cloud 控制台中,转到 Dataplex Catalog 页面。
点击切面类型标签页。
点击切面类型。
系统将打开切面类型详情页面。您可以查看 显示名称、切面类型 ID、说明、项目 ID、位置、标签 所选切面类型的创建日期和上次修改日期。
要查看所选切面类型的结构,请点击 模板标签页。
如需查看最近创建的 10 个相关条目的列表,请执行以下操作: 点击条目示例标签页。
要搜索所有相关条目,请点击 在 Google 搜索中显示所有相关条目。只有在以下情况下,系统才会显示此按钮: 至少有一个相关条目。
REST
要获取切面类型的详细信息,请使用
aspectTypes.get
方法。
更新切面类型
您可以更新显示名称、说明、模板字段和标签 切面类型。您无法删除模板中的现有字段。
创建 切面类型。
控制台
在 Google Cloud 控制台中,转到 Dataplex Catalog 页面。
点击切面类型标签页。
点击要更新的切面类型。
在切面类型详细信息页面上,点击修改。
修改显示名称、说明、模板字段和标签, 。
可选:如需将切面类型中的字段标记为已弃用,请执行以下操作: 请按以下步骤操作:
- 在模板部分中,展开该字段。
- 选择已废弃。
- 在弃用原因字段中,输入 弃用所选字段。
- 点击完成。
点击保存。
REST
要更新现有切面类型,请使用
aspectTypes.patch
方法。
删除切面类型
控制台
在 Google Cloud 控制台中,转到 Dataplex Catalog 页面。
点击切面类型标签页。
点击要删除的切面类型。
在切面类型详细信息页面上,点击删除。确认时间 。
REST
要删除现有切面类型,请使用
aspectTypes.delete
方法。
后续步骤
- 了解如何在 Dataplex Catalog 中搜索数据资产。
- 了解如何管理条目和注入自定义来源。
- 了解如何将元数据导入 Dataplex。
- 详细了解 Dataplex Catalog。