在 Knowledge Catalog (舊稱 Dataplex Universal Catalog) 中,切面和切面類型可讓您將結構化中繼資料新增至項目、資料欄和項目連結,藉此描述資料資產及其關係。這類背景資訊可提高資料發現度,並協助您分類個人識別資訊 (PII) 等機密資訊,以便套用資料品質或存取權政策。
如要瞭解切面結構定義、系統與自訂切面類型、目標層級和資料落地限制的概念,請參閱「關於切面和切面類型」。如需整個中繼資料中繼模型的架構總覽,請參閱「關於 Knowledge Catalog 中的中繼資料」。如果您是首次使用 Knowledge Catalog 中繼資料,請參閱「為 BigQuery 資料表新增中繼資料」或「建立及使用組織詞彙」快速入門導覽課程。
事前準備
建立及管理切面類型和切面前,請先完成本節所述的工作。
必要的角色
如要取得建立及管理切面類型和切面所需的權限,請要求管理員授予您專案的下列 IAM 角色。您不需要同時具備所有角色,只要選擇符合特定工作流程的角色或組合即可:
如要取得建立及管理切面類型和切面所需的權限,請要求管理員授予您專案的下列 IAM 角色:
-
如要以廣泛的管理員權限管理所有目錄資源,包括切面類型和項目:
Dataplex Catalog 管理員 (
roles/dataplex.catalogAdmin) 或 Dataplex Catalog 編輯者 (roles/dataplex.catalogEditor) -
如要僅建立及管理自訂切面類型,並為切面類型管理員提供最小權限存取權:Dataplex 切面類型擁有者 (
roles/dataplex.aspectTypeOwner) -
如要在建立或修改項目時使用切面類型,並為資料管理員提供最小權限存取權:
Dataplex 切面類型使用者 (
roles/dataplex.aspectTypeUser) -
如要將可重複使用的系統切面類型 (例如
schema、contacts和overview) 附加至項目和項目連結:Dataplex 項目和 EntryLink 擁有者 (roles/dataplex.entryOwner) -
如要查看切面類型及其 IAM 政策,但不進行修改:Dataplex Catalog 檢視者 (
roles/dataplex.catalogViewer)
如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。
這些預先定義的角色具備建立及管理切面類型和切面所需的權限。如要查看確切的必要權限,請展開「Required permissions」(必要權限) 部分:
所需權限
必須具備下列權限,才能建立及管理切面類型和切面:
-
建立、查看、列出、更新及刪除切面類型:
-
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 控制台建立自訂切面類型,請按照下列子工作操作:
設定基本詳細資料:
前往 Google Cloud 控制台的 Knowledge Catalog「Metadata types」(中繼資料類型) 頁面。
依序點選「切面類型」>「自訂」分頁標籤,然後點選「建立切面類型」。
在「詳細資料」部分中,輸入以下內容:
- 選用:顯示名稱:使用者容易使用的切面類型名稱。
- Aspect type ID:切面類型的專屬 ID。
- 選用:說明:說明切面類型及其用途。
- 位置:選取切面類型的位置。建立後即無法修改位置。如要瞭解全域和區域位置的取捨,請參閱「自訂切面類型」。
定義結構定義範本:
範本會定義切面類型中分組的中繼資料欄位格式和結構定義。您可以手動定義欄位,也可以從「範本庫」選取入門範本 (例如「資料機密性」、「資料治理」或「資料擷取」),加快建立結構定義。舉例來說,選取「Data Sensitivity」範本會自動新增布林值欄位
Is Encrypted和Has PII,以及列舉欄位PII Type。如要手動定義欄位,請按照下列步驟操作:
- 在「範本」部分,按一下「新增欄位」。
- 在「New field」(新增欄位) 面板中,指定下列項目:
- 名稱:欄位的 ID。
- 選用:顯示名稱:容易使用的標籤。
- 選用:說明:欄位的簡短說明。
- 類型:選取欄位資料類型。支援的類型包括文字、整數、布林值、日期和時間、雙精度浮點數、列舉、陣列、對應和記錄。
- 選用:必填:勾選這個核取方塊,使用者附加這個切面時就必須填寫這個欄位。
- 點按「Done」(完成)。如要新增更多欄位,請按一下「新增欄位」,然後重複上述步驟。
新增資源標籤並儲存:
資源標籤是任意鍵/值組合,可協助您整理及篩選 Google Cloud 資源。舉例來說,您可以使用
environment: production或team: analytics等標籤,依環境或團隊擁有權整理資源。- 在「Labels」(標籤) 專區中,按一下「Add label」(新增標籤)。
- 輸入標籤的「鍵」和「值」。
- 按一下「儲存」。
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
在試用這個範例之前,請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。
如要向 Knowledge Catalog 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
REST
如要建立自訂切面類型,請使用 aspectType.create 方法。
建立自訂切面類型後,即可將切面新增至項目。
使用「記錄 ID」和「記錄參照」欄位的範例
您可以使用「Record ID」(記錄 ID) 和「Record reference」(記錄參照) 欄位進行遞迴參照。以下範例說明如何使用這些欄位:
假設有一個名為 Employee 的切面類型,其中包含下列欄位:
- Name (類型:
Text) - 開始日期 (類型:
Date & time) - Designation (類型:
Text) - 目前地址 (類型:
Record) - 永久地址 (類型:
Record)
「Current address」(現居地址) 和「Permanent address」(永久地址) 這兩個地址欄位屬於相同的資料類型 Record。為避免重複,您可以在定義這些欄位時設定「Record ID」和「Record reference」值。
定義「Current address」(目前地址) 欄位時,您可以將「Record ID」(記錄 ID) 指定為 address-field。在「Permanent address」(永久地址) 部分,您可以為「Record reference」(記錄參照) 指定相同的值 (address-field)。例如:
- Name (類型:
Text) - 開始日期 (類型:
Date & time) - Designation (類型:
Text) - 目前地址 (類型:
Record,記錄 ID:address-field) - 永久地址 (類型:
Record,記錄參考資料:address-field)
這樣一來,您就不必複製另一個地址的欄位。
為項目新增切面
建立自訂切面類型後,即可建立該類型的切面。如要為項目新增切面,您必須更新項目,因為切面會儲存在項目中。
請注意下列限制:
- 您可以將切面新增至項目或項目的資料欄。
- 您只能編輯自訂項目的必要切面。您無法刪除必要面向。
- 您可以編輯及刪除自訂項目和系統項目的選用層面。
- 使用
CREATE OR REPLACE TABLE陳述式、TRUNCATE TABLE陳述式或WRITE_TRUNCATE工作取代或重新載入 BigQuery 資料表時,Knowledge Catalog 會保留項目中由使用者附加的切面。結構定義中保留的資料欄,也會保留資料欄層級 aspect。不過,如果您使用DROP TABLE陳述式和CREATE TABLE陳述式捨棄並重新建立資料表,Knowledge Catalog 會建立新項目,但不會保留原始資料表的使用者附加切面。如要在重新載入表格時保留特定部分,請使用CREATE OR REPLACE TABLE、TRUNCATE TABLE或WRITE_TRUNCATE。或者,您也可以建立 BigQuery 檢視表,並將切面附加至檢視表。
控制台
在 Google Cloud 控制台,前往 Knowledge Catalog 的「Search」(搜尋) 頁面。
搜尋要新增切面的項目,然後按一下該項目。項目詳細資料頁面隨即開啟。
在項目詳細資料頁面,按一下「Details」(詳細資料) 分頁標籤。
在「切面」部分,按一下「必要切面」或「選用切面」區域中的「 新增」。只有在項目類型定義了必要切面時,才能新增必要切面。
搜尋並選取要新增的面向。
在「Add aspect」(新增切面) 視窗中,輸入各欄位的值。
按一下「儲存」。
如要為項目資料欄新增切面,請按照下列步驟操作:
- 在項目詳細資料頁面中,按一下「Schema」(結構定義) 分頁標籤。
- 選取要新增切面的資料欄。
- 點選「新增切面」。
- 搜尋並選取要新增的面向。
- 在「Add aspect」(新增切面) 視窗中,輸入各欄位的值。
- 按一下「儲存」。
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
在試用這個範例之前,請先按照「使用用戶端程式庫的 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:直接傳遞切面圖,並以全域切面類型 ID{"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(選用整數):評估的素材資源數量。
執行指令來附加切面時,系統會取代該特定切面的所有現有資料。舉例來說,如果更新分數為 80 的評量表,並上傳分數為 90 的新檔案,系統會覆寫 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(字串):自訂項目的來源系統 ID。
酬載範例 (REST API):
{ "aspects": { "dataplex-types.global.generic": { "data": { "type": "custom-type", "system": "custom-system" } } } }
總覽 (dataplex-types.global.overview)
使用 overview 類型,提供人類可讀的 RTF 格式文件和實用的外部連結。
content(字串):支援 HTML 格式的 RTF 格式說明。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 資料編輯者 (roles/bigquery.dataEditor))。
控制台
在 Google Cloud 控制台,前往 Knowledge Catalog 的「Search」(搜尋) 頁面。
搜尋要更新切面的項目,然後按一下該項目。
項目詳細資料頁面隨即開啟。
- 點按「Details」(詳細資料) 分頁標籤。
- 在「Aspects」(切面) 部分,展開要更新的切面,然後按一下 「Edit」(編輯)。
- 在「Edit aspect」(編輯切面) 視窗中,更新必填欄位。
- 按一下「儲存」。
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
在試用這個範例之前,請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。
如要向 Knowledge Catalog 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
REST
如要更新項目或項目資料欄的切面,請使用 entry.patch 方法。
刪除切面
控制台
在 Google Cloud 控制台,前往 Knowledge Catalog 的「Search」(搜尋) 頁面。
搜尋要刪除切面的項目,然後按一下該項目。
項目詳細資料頁面隨即開啟。
- 點按「Details」(詳細資料) 分頁標籤。
- 在「Aspects」(切面) 部分,展開要刪除的切面,然後按一下「Delete」(刪除) 。
- 按一下「確認」。
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:完整的切面類型 ID,例如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
在試用這個範例之前,請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。
如要向 Knowledge Catalog 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
REST
如要刪除項目的切面,請使用 entry.patch 方法。
管理項目連結的現有切面
本節說明如何更新項目連結的現有切面。
更新切面
如果是項目連結,您只能更新使用可重複系統切面類型的必要切面。
詳情請參閱「項目連結作業的 IAM 權限」。
REST
如要更新項目連結並加入必要切面,請使用 entryLinks.patch 方法,並在要求主體中加入切面資料。
刪除切面
您無法刪除項目連結的必要切面。
管理切面類型
本節說明如何查看切面類型,以及更新和刪除自訂切面類型。
查看可用切面類型清單
控制台
前往 Google Cloud 控制台的 Knowledge Catalog「Metadata types」(中繼資料類型) 頁面。
按一下「Aspect types」(切面類型) 分頁標籤。
這個頁面列出所有可用的 Knowledge Catalog 切面類型。
- 如要查看自訂切面類型,請按一下「Custom」(自訂) 分頁標籤。在「Custom」(自訂) 分頁中,「Catalog source」(目錄來源) 欄會顯示資源在 Knowledge Catalog 中的位置。
如要查看系統切面類型,請按一下「System」(系統) 分頁標籤。
如要進一步瞭解自訂和系統切面類型,請參閱本文的「切面類型類別」一節。
- 選用:如要查看所選專案中的切面類型清單,請按一下「Custom」(自訂) 分頁標籤,然後將「Show from all projects」(顯示所有專案) 切換鈕設為關閉位置。
「Show from all projects」(顯示所有專案) 切換鈕預設為開啟,清單會列出所選組織的 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
在試用這個範例之前,請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。
如要向 Knowledge Catalog 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
REST
如要列出所有可用的切面類型,請使用 aspectTypes.list 方法。
查看切面類型的詳細資料
控制台
前往 Google Cloud 控制台的 Knowledge Catalog「Metadata types」(中繼資料類型) 頁面。
按一下「Aspect types」(切面類型) 分頁標籤。
如要查看 Knowledge Catalog 切面類型的詳細資料,請按一下該切面類型。切面類型詳細資料頁面隨即開啟,您可以在此查看詳細資料,例如顯示名稱、切面類型 ID、說明、專案 ID、位置、標籤、建立日期和上次修改日期。
- 如要查看所選切面類型的結構,請按一下「Template」(範本) 分頁標籤。
- 如要查看最近建立的 10 個相關項目清單,請按一下「Sample entries」(範例項目) 分頁標籤。
- 如要搜尋所有相關項目,請按一下「在搜尋結果顯示所有相關項目」。只有在至少有一個相關項目時,才會顯示這個按鈕。
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
在試用這個範例之前,請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。
如要向 Knowledge Catalog 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
REST
如要取得切面類型的詳細資料,請使用 aspectTypes.get 方法。
更新自訂切面類型
您可以更新自訂切面類型的顯示名稱、說明、範本欄位和標籤。您無法刪除範本中的現有欄位。
切面類型建立後,即無法更新切面類型 ID 和位置。
控制台
前往 Google Cloud 控制台的 Knowledge Catalog「Metadata types」(中繼資料類型) 頁面。
按一下「Aspect types」(切面類型) 分頁標籤。
按一下要更新的切面類型。
在「Aspect type details」(切面類型詳細資料) 頁面,按一下「Edit」(編輯)。
視需要編輯顯示名稱、說明、範本欄位和標籤。
選用:如要將切面類型中的欄位標示為已淘汰,請按照下列步驟操作:
- 在「Template」(範本) 部分,展開欄位。
- 選取「已淘汰」。
- 在「Deprecation reason」(淘汰原因) 欄位中,輸入淘汰所選欄位的原因。
按一下「完成」。
按一下「儲存」。
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
在試用這個範例之前,請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。
如要向 Knowledge Catalog 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
REST
如要更新自訂切面類型,請使用 aspectTypes.patch 方法。
刪除自訂切面類型
控制台
前往 Google Cloud 控制台的 Knowledge Catalog「Metadata types」(中繼資料類型) 頁面。
按一下「Aspect types」(切面類型) 分頁標籤。
按一下要刪除的切面類型。
在「Aspect type details」(切面類型詳細資料) 頁面中,按一下「Delete」(刪除)。在系統提示時確認刪除。
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
在試用這個範例之前,請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。
如要向 Knowledge Catalog 進行驗證,請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。
REST
如要刪除現有的自訂切面類型,請使用 aspectTypes.delete 方法。
後續步驟
- 瞭解如何在 Knowledge Catalog 中搜尋資源。
- 瞭解如何管理項目及擷取自訂來源。
- 瞭解如何將中繼資料匯入 Knowledge Catalog。
- 進一步瞭解 Knowledge Catalog 中的中繼資料。
- 瞭解如何建立基礎資料情境。
- 參考 Knowledge Catalog 應用實例。