將項目連結匯出至 Google 試算表

本文說明如何使用項目連結匯出公用程式,將知識目錄 (舊稱 Dataplex Universal Catalog) 中的項目連結 (詞彙表字詞與資料資產之間的關係) 擷取至 Google 試算表。

你可以將項目連結匯出至 Google 試算表,稽核現有連結、備份中繼資料,或準備批次更新範本。

事前準備

將項目連結匯出至 Google 試算表前,請先完成下列必要條件。

設定服務帳戶

如要執行匯出公用程式,您必須設定服務帳戶,並具備存取 Google Sheets API 和模擬使用者憑證的必要權限:

  1. 找出或建立服務帳戶。

    選取現有服務帳戶,或在執行匯入公用程式的專案中建立新的服務帳戶。詳情請參閱「建立服務帳戶」。記下服務帳戶電子郵件地址 (例如 SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com)。

  2. 設定服務帳戶模擬。

    如要在本機執行匯出公用程式指令碼,您的使用者帳戶必須具備模擬服務帳戶的權限。將服務帳戶的服務帳戶權杖建立者角色 (roles/iam.serviceAccountTokenCreator) 授予使用者帳戶。

    詳情請參閱「管理服務帳戶的存取權」。

  3. 授予服務帳戶 Google 試算表 Editor 存取權。

    開啟要用於匯入程序的 Google 試算表,按一下「共用」,然後將服務帳戶電子郵件地址新增為Editor。這項權限可讓服務帳戶讀取或寫入試算表中的資料。

必要的角色

為確保服務帳戶具備必要權限,能將項目連結匯出至 Google 試算表,請要求管理員將下列 IAM 角色授予服務帳戶:

如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

管理員或許也能透過自訂角色或其他預先定義的角色,授予服務帳戶必要權限。

啟用 API

如要匯出項目連結,請在專案中啟用下列 API:

啟用 API 時所需的角色

如要啟用 API,您需要服務使用情形管理員 IAM 角色 (roles/serviceusage.serviceUsageAdmin),其中包含 serviceusage.services.enable 權限。瞭解如何授予角色

啟用 API

設定 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 試算表或使用現有試算表。匯出指令碼會寫入第一個工作表。確認您已授予服務帳戶 Google 試算表的存取權。Editor

設定環境變數

設定下列環境變數:

# 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 項目連結的類型 (definitionrelatedsynonym)。
source_entry 來源項目的完整資源路徑。
target_entry 目標項目的完整資源路徑。
source_path 定義連結的資料欄或欄位路徑。

後續步驟