借助条目链接导出实用程序,您可以将条目链接(术语库术语与数据资产之间的关系)从 Knowledge Catalog(原 Dataplex Universal Catalog)提取到 Google 表格中。然后,您可以审核现有链接、备份元数据或准备用于批量更新的模板。
准备工作
在将条目链接导出到 Google 表格之前,请先完成以下前提条件。
设置服务账号
如需运行导出实用程序,您必须设置一个服务账号,该账号具有访问 Google Sheets API 和模拟用户凭证所需的权限:
确定或创建服务账号。
在运行导入实用程序的项目中选择现有服务账号或创建新服务账号。如需了解详情,请参阅创建服务账号。 记下服务账号邮箱(例如
SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com)。配置服务账号模拟。
如需在本地运行导出实用程序脚本,您的用户账号必须有权模拟服务账号。向您的用户账号授予服务账号的 Service Account Token Creator 角色 (
roles/iam.serviceAccountTokenCreator)。如需了解详情,请参阅管理对服务账号的访问权限。
向服务账号
Editor授予对 Google 表格的访问权限。打开要用于导入流程的 Google 表格,点击共享,然后将服务账号电子邮件地址添加为
Editor。此权限使服务账号能够从您的工作表中读取数据或向其中写入数据。
所需的角色
为确保服务账号具有将条目链接导出到 Google 表格所需的权限,请让您的管理员为服务账号授予以下 IAM 角色:
- 针对项目的 Dataplex Administrator (
roles/dataplex.admin) - 针对项目的 Dataplex Catalog Admin (
roles/dataplex.catalogAdmin) - 针对项目的 Dataplex Catalog Editor (
roles/dataplex.catalogEditor)
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
您的管理员还可以通过自定义角色或其他预定义角色向服务账号授予所需的权限。
启用 API
如需导出条目链接,请在项目中启用以下 API:
启用 API 所需的角色
如需启用 API,您需要拥有 serviceusage.services.enable 权限。如果您创建了项目,则可能已经通过 Owner 角色 (roles/owner) 拥有此权限。否则,您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获得此权限。了解如何授予角色。
设置 Git 代码库
克隆 dataplex-labs 代码库:
git clone https://github.com/GoogleCloudPlatform/dataplex-labs.git cd dataplex-labs/dataplex-quickstart-labs/00-resources/scripts/python/business-glossary-import/dataplex-glossary/export
安装依赖项
安装所需的 Python 依赖项:
pip3 install -r requirements.txt cd dataplex-glossary
如果您在安装软件包时遇到任何问题,请设置新的 Python 开发环境。
进行身份验证并配置服务账号模拟
初始化 Google Cloud CLI,并使用应用默认凭据 (ADC) 通过服务账号模拟进行身份验证:
# Set your service account email address SA_EMAIL="SERVICE_ACCOUNT_EMAIL" # Authenticate ADC using service account impersonation and required scopes gcloud init gcloud auth login gcloud auth application-default login \ --impersonate-service-account="${SA_EMAIL}" \ --scopes="https://www.googleapis.com/auth/spreadsheets"
将 SERVICE_ACCOUNT_EMAIL 替换为服务账号电子邮件 ID。 例如:
SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
设置用于导出的目标 Google 表格
创建一个空白 Google 表格或使用现有表格。导出脚本会写入第一个工作表。确保您已向服务账号 Editor 授予对 Google 表格的访问权限。
设置环境变量
设置以下环境变量:
# Set your glossary URL export GLOSSARY_URL="GLOSSARY_URL" # Set your Google Sheet URL export SPREADSHEET_URL="GOOGLE_SHEET_URL" # Set the project ID export USER_PROJECT="USER_PROJECT"
将条目链接导出到 Google 表格
如需将术语表中的条目链接导出到 Google 表格,请运行以下脚本:
cd export python3 entrylinks-export.py \ --glossary-url="$GLOSSARY_URL" \ --spreadsheet-url="$SPREADSHEET_URL" \ --user-project="$USER_PROJECT"
您可以在本地执行路径中的 logs/ 目录中查看执行日志。这些日志可帮助您审核转移过程,并识别跳过的条目或格式警告。
验证导出的条目链接数据
导出脚本会使用以下列填充 Google 表格:
| 列标题 | 说明 |
|---|---|
entry_link_type |
条目链接的类型(definition、related 或 synonym)。 |
source_entry |
来源条目的完整资源路径。 |
target_entry |
目标条目的完整资源路径。 |
source_path |
定义链接的列或字段路径。 |
后续步骤
- NH: 了解如何管理业务术语库。
- 了解如何从 Google 表格导入条目链接。
- 了解如何将术语表导出到 Google 表格。
- 详细了解元数据管理。