將 Data Catalog API 方法對應至 Knowledge Catalog

Data Catalog 已淘汰。如果您要將程式輔助工作流程、指令碼、用戶端程式庫或 Terraform 設定從 Data Catalog 遷移至 Knowledge Catalog,請務必更新程式碼,改用 Dataplex API。

本文全面對應 Data Catalog 資源、功能和 API 方法,以及 Dataplex API 中的對等項目。

如需逐步遷移程序,請參閱「從 Data Catalog 轉移至 Knowledge Catalog」。如需 API 參考文件,請參閱 Dataplex API REST 說明文件Dataplex API 遠端程序呼叫 (RPC) 說明文件

資源對應

下表說明 Data Catalog 中的資源如何對應至 Knowledge Catalog 中的資源:

Data Catalog 資源 Knowledge Catalog 資源 說明
公開代碼範本 切面類型 (global) 標記範本是 Data Catalog 中的區域資源,可用於各個區域。這些項目對應於 Knowledge Catalog 中的global切面類型。
公開標記 選用切面 公開標記對應至附加至 Knowledge Catalog 項目或資料欄的選用切面。
項目群組 項目群組 在兩項服務中,項目群組都可做為組織和安全容器。對於 Google Cloud 來源,系統會為每個專案自動建立系統項目群組,例如 @bigquery
自訂項目 自訂項目 (含必要切面) 標準自訂項目屬性會以自訂項目 EntryType 定義的必要切面為模型。
系統 (Google Cloud) 項目 系統項目 (含必要切面) 描述內建實體 (例如 BigQuery 資料表的 Schema) 的中繼資料,會擷取至系統定義的必要層面類型層面。
組織詞彙 組織詞彙 業務用語分類,在整個企業中標準化業務背景。

功能比較

下表比較 Knowledge Catalog 和 Data Catalog 的中繼資料管理功能:

功能 Knowledge Catalog Data Catalog
支援的 Google Cloud 來源 支援的 Google Cloud 來源中說明的所有來源。 Data Catalog 說明文件中所述的所有來源。
自訂來源攝入

根據項目類型定義的受管理結構,將資料擷取到自訂項目。

Data Catalog 自訂項目和項目群組會以 generic 項目類型顯示在 Knowledge Catalog 中。

擷取至一般自訂項目。
中繼資料充實

使用業務詞彙、切面和切面類型擷取。

支援進入連結。您可以直接將切面附加至項目連結。

使用業務詞彙表、標記和標記範本擷取。

不支援項目連結。

項目連結 支援。內建型別 (例如 synonymdefinitionrelatedschema-join) 可讓您連結項目和資料欄。 不適用。
中繼資料變更動態饋給 近乎即時的元資料變更通知會串流至 Pub/Sub。 不適用。
搜尋 系統會在同一個機構和 VPC Service Controls 範圍內,對所有支援的 Google Cloud 來源、自訂項目、層面和遷移的 Data Catalog 內容執行搜尋。 搜尋範圍涵蓋 Data Catalog 中建立的支援來源、自訂項目和標記。
資料歷程 使用 Dataplex API 擷取資產節點的項目詳細資料。 在 Google Cloud 控制台中顯示附加的構面。 使用 Data Catalog API 擷取項目詳細資料。
組織詞彙 可讓您建立業務字詞的分類,並將其與資料資產 (項目) 和資料欄建立關聯。 可將字詞與資料欄建立關聯。

將 Data Catalog API 方法對應至 Knowledge Catalog

下表提供 Data Catalog API (google.cloud.datacatalog.v1) 和 Dataplex API (google.cloud.dataplex.v1.CatalogService) 的方法對應。

項目群組

這兩項服務的項目群組概念一致:

Data Catalog API 方法 Dataplex API 方法
projects.locations.entryGroups.create (REST)
CreateEntryGroup (RPC)
projects.locations.entryGroups.create (REST)
CreateEntryGroup (RPC)
projects.locations.entryGroups.get (REST)
GetEntryGroup (RPC)
projects.locations.entryGroups.get (REST)
GetEntryGroup (RPC)
projects.locations.entryGroups.patch (REST)
UpdateEntryGroup (RPC)
projects.locations.entryGroups.patch (REST)
UpdateEntryGroup (RPC)
projects.locations.entryGroups.delete (REST)
DeleteEntryGroup (RPC)
projects.locations.entryGroups.delete (REST)
DeleteEntryGroup (RPC)
projects.locations.entryGroups.list (REST)
ListEntryGroups (RPC)
projects.locations.entryGroups.list (REST)
ListEntryGroups (RPC)

實體

這兩項服務都使用項目概念來代表資料資產:

Data Catalog API 方法 Dataplex API 方法
projects.locations.entryGroups.entries.create (REST)
CreateEntry (RPC)
projects.locations.entryGroups.entries.create (REST)
CreateEntry (RPC)
projects.locations.entryGroups.entries.get (REST)
GetEntry (RPC)
projects.locations.entryGroups.entries.get (REST)
GetEntry (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

注意:您也可以使用 projects.locations.modifyEntry (REST) 和 ModifyEntry (RPC) 方法,透過來源系統權限更新系統項目,而非目錄權限。

projects.locations.entryGroups.entries.delete (REST)
DeleteEntry (RPC)
projects.locations.entryGroups.entries.delete (REST)
DeleteEntry (RPC)
projects.locations.entryGroups.entries.list (REST)
ListEntries (RPC)
projects.locations.entryGroups.entries.list (REST)
ListEntries (RPC)
entries.lookup (REST)
LookupEntry (RPC)
projects.locations.lookupEntry (REST)
LookupEntry (RPC)

注意:如要使用 lookupEntry,請務必提供項目名稱。如要將 BigQuery SQL 名稱、完整名稱或連結的資源名稱轉換為項目名稱,請先呼叫 projects.locations.searchEntries (REST) 或 SearchEntries (RPC)。

projects.locations.entryGroups.entries.modifyEntryContacts (REST)
ModifyEntryContacts (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

注意:使用 update_mask 時,只能修改 contacts 方面。

projects.locations.entryGroups.entries.modifyEntryOverview (REST)
ModifyEntryOverview (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

注意:使用 update_mask 時,只能修改 overview 方面。

projects.locations.entryGroups.entries.tags.reconcile (REST)
ReconcileTags (RPC)
projects.locations.metadataJobs.create (REST)
CreateMetadataJob (RPC)、
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

注意:使用 CreateMetadataJob 和匯入工作類型,即可批次匯入多個項目的中繼資料內容。如要更新單一項目的所有層面,請使用 UpdateEntry

catalog.search (REST)
SearchCatalog (RPC)
projects.locations.searchEntries (REST)
SearchEntries (RPC)

注意: searchEntries 會在來電者的機構中搜尋。如要跨機構搜尋,必須為每個機構分別發出要求。

標記範本和切面類型

切面類型是 Data Catalog 標記範本的後繼產品:

Data Catalog API 方法 Dataplex API 方法
projects.locations.tagTemplates.create (REST)
CreateTagTemplate (RPC)
projects.locations.aspectTypes.create (REST)
CreateAspectType (RPC)
projects.locations.tagTemplates.get (REST)
GetTagTemplate (RPC)
projects.locations.aspectTypes.get (REST)
GetAspectType (RPC)
projects.locations.tagTemplates.patch (REST)
UpdateTagTemplate (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)
projects.locations.tagTemplates.delete (REST)
DeleteTagTemplate (RPC)
projects.locations.aspectTypes.delete (REST)
DeleteAspectType (RPC)
catalog.search (REST) with type=tag_template
SearchCatalog (RPC) with type=tag_template
projects.locations.aspectTypes.list (REST)
ListAspectTypes (RPC)

代碼範本欄位

代碼範本欄位會對應至切面類型中 metadata_template 欄位的內容。使用 UpdateAspectType 和修改後的 metadata_template 建立、更新、重新命名或刪除欄位:

Data Catalog API 方法 Dataplex API 方法
projects.locations.tagTemplates.fields.create (REST)
CreateTagTemplateField (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)
projects.locations.tagTemplates.fields.patch (REST)
UpdateTagTemplateField (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)
projects.locations.tagTemplates.fields.rename (REST)
RenameTagTemplateField (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)
projects.locations.tagTemplates.fields.delete (REST)
DeleteTagTemplateField (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)

代碼範本欄位列舉值

如要修改列舉值,請更新相應切面類型中的 metadata_template 欄位:

Data Catalog API 方法 Dataplex API 方法
projects.locations.tagTemplates.fields.enumValues.rename (REST)
RenameTagTemplateFieldEnumValue (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)

標記和切面

切面是 Data Catalog 標記的後繼功能。構面會直接封裝在父項項目或項目連結中,並使用 UpdateEntry 方法搭配 update_mask 管理:

Data Catalog API 方法 Dataplex API 方法
projects.locations.entryGroups.entries.tags.create (REST)
CreateTag (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)
projects.locations.entryGroups.entries.tags.list (REST)
ListTags (RPC)
projects.locations.entryGroups.entries.get (REST)
GetEntry (RPC)

注意:如要篩選回應中的層面,請使用 viewsaspect_typespaths 參數。

projects.locations.entryGroups.entries.tags.patch (REST)
UpdateTag (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)
projects.locations.entryGroups.entries.tags.delete (REST)
DeleteTag (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

政策標記和分類

政策標記和分類的 API 不會變更,因此不需要遷移。

Knowledge Catalog 不支援的功能

下列 Data Catalog 行為和功能在 Knowledge Catalog 中不支援或運作方式不同:

  • 私人切面類型:Dataplex Catalog 沒有私人切面和私人切面類型 (對應至 Data Catalog 中的私人標記和私人標記範本) 的概念。所有自訂構面類型都受專案和項目群組的 Identity and Access Management 權限控管。
  • 政策標記搜尋:目錄搜尋不支援使用 policytagpolicytagid 述詞搜尋政策標記。
  • 權限轉移:將 Data Catalog 自訂項目群組、自訂項目、標記範本和標記匯入 Knowledge Catalog 時,系統不會轉移這些資源的原始權限。您必須為匯入的資源設定 IAM 權限。如要詳細比較舊版和替代權限,請參閱「對應 Data Catalog 和 Knowledge Catalog 的 IAM 權限」。
  • Sensitive Data Protection 檢查結果:系統不支援將 Sensitive Data Protection 檢查結果直接傳送至 Knowledge Catalog。請改為將檢查結果傳送至 Data Catalog,然後將結果轉移至 Knowledge Catalog。
  • 跨專案類型列舉:系統不支援在單一 API 呼叫中,列舉跨專案的項目類型、項目連結類型和面向類型;要求必須限定於單一專案。
  • 管理員搜尋:系統不支援管理員搜尋 (完整回溯)。請改為將中繼資料匯出至 Cloud Storage,並使用 BigQuery 查詢。

後續步驟

指南

逐步指南,說明如何遷移標記範本、自訂項目和工作流程。

概念

瞭解 Knowledge Catalog 彈性中繼模型和 Active Context Graph。

參考資料

瀏覽 Dataplex Catalog 服務的 REST API 參考文件。

參考資料

瀏覽 Dataplex Catalog 服務的 gRPC API 參考文件。