本文說明如何建立及管理面向類型,以及如何使用面向註解項目。
Dataplex Universal Catalog 會透過一組切面描述項目。您可以使用切面和切面類型,透過額外的中繼資料描述項目。
詳情請參閱「關於 Dataplex Universal Catalog 中的資料目錄管理」。
切面
切面能擷取項目內的中繼資料。為項目新增層面,可為需要使用資產的人提供有意義的背景資訊。您可以使用構面來儲存業務中繼資料 (例如資料分類) 和技術中繼資料 (例如結構定義)。
系統會將各方面視為項目資源的一部分,而非個別資源。修改切面時,必須修改含有該切面的項目。
您可以在項目層級指定各方面,用於說明項目,也可以在資料欄層級指定各方面,用於說明項目中的資料欄。
每個層面都是層面類型的例項。切面類型會定義切面的範本。每個切面類型都包含一組欄位。建立層面時,您必須提供這些欄位的值。
每個項目最多只能有一個相關聯的面向,且每個面向類型只能有一個。每個層面類型可與多個項目資料欄相關聯。
切面類別
這些層面可分為以下幾類:
必要切面:建立項目時必須提供的切面。 這類切面由特定項目的項目類型定義。屬於項目類型的所有項目,一律必須具備該項目類型定義的所有必要切面。
Dataplex Universal Catalog 會管理系統項目的必要切面 (例如結構定義)。
注意事項:
您只能將必要面向與項目建立關聯,無法與項目的資料欄建立關聯。
你無法從項目中刪除必要面向。
您可以讀取系統項目的必要層面,但無法修改。
選用切面:您可以將選用切面與項目或項目資料欄建立關聯。您可以在建立項目時填入選用切面,也可以稍後更新項目。
填寫選填項目後,可以刪除這些項目。
切面類型
切面類型是可重複使用的資源,可提供切面範本。
切面類型類別
屬性類型可分為下列幾類:
自訂切面類型:您在 Dataplex Universal Catalog 中建立的切面類型。
系統切面類型:Dataplex Universal Catalog 提供、使用及管理的切面類型。
系統切面類型可進一步分為可重複使用和受限類型。下表說明系統切面類型類別,以及 Dataplex Universal Catalog 為每個類別提供的切面類型清單:
系統切面類型類別 說明 Dataplex Universal Catalog 提供的切面類型 可重複使用的系統切面類型 您可以使用這些切面類型建立或修改切面。 contacts
data-quality-scorecard
generic
overview
schema
usage
受限的系統切面類型 Dataplex Universal Catalog 會管理這些切面類型。
您可以讀取這些切面類型下的切面,但無法建立或編輯這些切面類型下的切面。包括但不限於: analytics-hub
aspecttype-aspect
bigquery-dataset
bigquery-table
cloudsql-database
cloudsql-instance
cloudsql-table
entrygroup-aspect
entrytype-aspect
sensitive-data-protection-profile
storage
storage-bucket
storage-folder
自訂切面類型可以是全域或區域。您可以在特定區域位置或以全域資源的形式,建立自訂層面類型。
全域切面類型可用於在任何區域建立項目的切面。 全域切面類型的內容會複製到所有區域。區域切面類型用於為同一區域中的項目建立切面。
切面類型的位置會影響其適用範圍。 詳情請參閱「專案和位置限制」。
系統切面類型一律為全域類型。系統層面類型會儲存在專案 ID 為 655216118709
的 Google 管理專案中。例如:projects/655216118709/locations/global/aspectTypes/schema
。
事前準備
建立及管理面向類型和面向之前,請先完成本節所述工作。
必要的角色
如要取得建立及管理切面類型和切面所需的權限,請要求管理員在資源上授予下列 IAM 角色:
-
在 Dataplex Universal Catalog 中,對中繼資料資源擁有完整權限,包括切面類型:
Dataplex Catalog 管理員 (
roles/dataplex.catalogAdmin
) -
在 Dataplex Universal Catalog 中建立及管理中繼資料資源,包括切面類型:
Dataplex Catalog 編輯者 (
roles/dataplex.catalogEditor
) -
自訂切面類型的完整權限 (除了使用切面類型建立或編輯項目的權限):
Dataplex 切面類型擁有者 (
roles/dataplex.aspectTypeOwner
) -
查看與切面類型相關聯的切面類型和 IAM 政策:
Dataplex Catalog 檢視者 (
roles/dataplex.catalogViewer
) -
使用切面類型建立及修改具備相應切面的項目:
Dataplex 切面類型使用者 (
roles/dataplex.aspectTypeUser
) -
新增部分系統切面類型的切面,例如
schema
、overview
、contacts
: Dataplex 項目擁有者 (roles/dataplex.entryOwner
)
如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。
詳情請參閱「Dataplex Universal Catalog IAM 角色」。
啟用 API
在 Dataplex Universal Catalog 專案中啟用 Dataplex API。
建立切面類型
控制台
在 Google Cloud 控制台中,前往 Dataplex Universal Catalog 的「Catalog」(目錄) 頁面。
依序點選「切面類型和標記範本」>「自訂」分頁標籤。
按一下「建立切面類型 (Dataplex Catalog)」。
在「Create aspect type」(建立構面類型) 視窗中,輸入下列資訊:
- 選用:在「顯示名稱」欄位中,輸入構面類型名稱。
- 在「Aspect type ID」(構面類型 ID) 欄位中,輸入構面類型的專屬 ID。
- 選用:在「說明」欄位中,輸入面向類型的說明。
- 在「位置」欄位中,選取該面向類型的地點。 建立後即無法修改層面類型的位置。
選用:定義切面類型的範本。
在「範本」部分中,按一下「新增欄位」。在「New field」(新增欄位) 區段中,輸入下列內容:
- 在「名稱」欄位中輸入名稱。
- 選用:在「顯示名稱」欄位中輸入顯示名稱。
- 選用:在「說明」欄位中輸入說明。
在「類型」欄位中,選取欄位的資料類型。系統會根據您的選擇,顯示下一組欄位和選項:
如果選取「文字」做為資料類型,請按照下列步驟操作:
- 在「文字類型」欄位中,選取文字類型。
- 在「文字值」欄位中,提供文字欄位的提示。如要新增提示,請按一下「新增值」,然後輸入提示。 您可以為文字欄位新增多個提示。
- 按一下 [完成]。
如果選取「Enum」Enum做為資料類型,請新增列舉值:
- 按一下「新增列舉值」。
- 在「Value」(值) 欄位中,輸入列舉值。您可以新增多個列舉值。
- 按一下 [完成]。
如果選取「陣列」做為資料類型,請在「陣列項目」部分定義陣列中顯示的項目類型:
- 按一下「新增陣列項目」。
- 在「Name」(名稱) 欄位中,輸入陣列項目的名稱。
- 選用:在「顯示名稱」欄位中,輸入陣列項目的顯示名稱。
- 選用:在「說明」欄位中,輸入陣列項目的說明。
在「類型」欄位中,選取陣列項目的資料類型。
系統會根據您的選擇,顯示下一組欄位和選項。這些選項與本節其他地方所述的「文字」、「列舉」、「對應」、「陣列」和「記錄」資料類型選項類似。
按一下 [完成]。
如果您選取「地圖」做為資料類型,請在「地圖值」部分定義地圖中顯示的值類型:
- 按一下「新增對應值」。
- 在「名稱」欄位中,輸入地圖名稱。
- 選用:在「顯示名稱」欄位中,輸入地圖的顯示名稱。
- 選用:在「說明」欄位中輸入地圖說明。
在「類型」欄位中,選取地圖的資料類型。
系統會根據您的選擇,顯示下一組欄位和選項。這些選項與本節其他地方所述的「文字」、「列舉」、「對應」、「陣列」和「記錄」資料類型選項類似。
按一下 [完成]。
如果選取「記錄」做為資料類型,請輸入下列資訊:
- 在「記錄 ID」欄位中,輸入其他記錄欄位可參照這筆記錄的專屬 ID。請參閱本文件的「使用記錄 ID 和記錄參照欄位的範例」一節。
- 選用:如要從這個範本新增其他記錄的參照,請使用「記錄參照」欄位。建立方面類型後,就無法修改這項設定。請參閱本文件的「使用記錄 ID 和記錄參照欄位的範例」一節。
在「記錄欄位」部分,您可以定義具有多個巢狀欄位的複雜物件。如要這麼做,請點選「新增記錄欄位項目」,然後指定下列項目:
在「Name」(名稱) 欄位中,輸入記錄欄位的名稱。
選用:在「顯示名稱」欄位中,輸入記錄欄位的顯示名稱。
選用:在「說明」欄位中,輸入記錄欄位的說明。
在「類型」欄位中選取資料類型。
系統會根據您的選擇,顯示下一組欄位和選項。這些選項與本節稍早針對「Text」(文字)、「Enum」(列舉)、「Map」(對應)、「Array」(陣列) 和「Record」(記錄) 資料類型說明的選項類似。
按一下 [完成]。
如要將這類型的屬性設為必填欄位,請選取「必填」。如要進一步瞭解必要和選用層面,請參閱本文件的層面類別一節。
按一下 [完成]。
如要新增多個欄位,請按一下「新增欄位」,然後重複上述步驟。
選用:在「標籤」部分,以鍵/值組合的形式為資源新增任意標籤:
- 按一下「新增標籤」。
- 在「Key」欄位中輸入金鑰。
- 在「Value」(值) 欄位中,輸入金鑰的值。
- 如要新增更多標籤,請按一下「新增標籤」並重複上述步驟。
按一下 [儲存]。
gcloud
如要建立切面類型,請使用 gcloud dataplex aspect-types create
指令。
REST
如要建立切面類型,請使用 aspectType.create
方法。
建立面向類型後,即可在項目中新增面向。
使用記錄 ID 和記錄參照欄位的範例
您可以使用「記錄 ID」和「記錄參照」欄位進行遞迴參照。以下範例說明如何使用這些欄位:
假設有一個名為 Employee
的層面類型,包含下列欄位:
- 名稱 (類型:
Text
) - 開始日期 (類型:
Date & time
) - 職稱 (類型:
Text
) - 目前地址 (類型:
Record
) - 永久地址 (類型:
Record
)
「現居地址」和「永久地址」這兩個地址欄位屬於相同的資料類型 Record
。為避免重複,您可以在定義這些欄位時,設定「記錄 ID」和「記錄參照」值。
定義「Current address」(目前地址) 欄位時,您可以將「Record ID」(記錄 ID) 指定為 address-field
。對於「永久地址」,您可以為「記錄參照」指定相同的值 (address-field
)。例如:
- 名稱 (類型:
Text
) - 開始日期 (類型:
Date & time
) - 職稱 (類型:
Text
) - 目前地址 (類型:
Record
,記錄 ID:address-field
) - 永久地址 (類型:
Record
,記錄參考資料:address-field
)
這樣一來,您就不必複製其他地址的欄位。
在項目中新增切面
建立切面類型後,即可建立該類型的切面。如要為項目新增面向,必須更新項目,因為面向會儲存在項目中。
注意事項:
- 您可以將方面新增至項目或項目的資料欄。
- 您只能編輯自訂項目的必要方面。您無法刪除必要切面。
- 您可以編輯及刪除自訂項目和系統項目的選填部分。
控制台
在 Google Cloud 控制台中,前往 Dataplex Universal Catalog 的「Search」(搜尋) 頁面。
在「選擇搜尋平台」選單中,選取「Dataplex Catalog」做為搜尋模式。
搜尋要新增面向的項目,然後按一下該項目。系統會開啟項目詳細資料頁面。
如要為項目新增層面,請按照下列步驟操作:
- 按一下 [Details] (詳細資料) 分頁標籤。
- 如要為項目新增必要或選用層面,請在「標記和層面」部分中,按一下相應類別的「新增」
如果所選項目的項目類型未定義任何必要切面,就無法新增必要切面。
。 - 搜尋並選取要新增的面向。
- 在「新增構面」視窗中,輸入欄位值。
- 按一下 [儲存]。
如要為項目欄新增層面,請按照下列步驟操作:
- 在項目詳細資料頁面中,按一下「結構定義」分頁標籤。
- 選取要新增層面的資料欄。
- 按一下「新增面向」。
- 搜尋並選取要新增的面向。
- 在「新增構面」視窗中,輸入欄位值。
- 按一下 [儲存]。
gcloud
如要為項目或項目的資料欄新增層面,請使用 gcloud dataplex entries update
指令。
REST
如要將層面新增至項目或項目的資料欄,請使用 entry.patch
方法。
如果項目和相應切面類型位於不同 Google Cloud 機構,系統就不支援在項目中建立及使用切面。
管理項目的現有層面
本節說明如何更新及刪除項目的現有面向。
更新切面
您可以編輯自訂項目和系統項目的選填部分。 您只能編輯自訂項目的必要方面。
控制台
在 Google Cloud 控制台中,前往 Dataplex Universal Catalog 的「Search」(搜尋) 頁面。
在「選擇搜尋平台」選單中,選取「Dataplex Catalog」做為搜尋模式。
搜尋要更新層面的項目,然後按一下該項目。
系統會開啟項目詳細資料頁面。
按一下 [Details] (詳細資料) 分頁標籤。
在「標記和特徵」部分,展開要更新的特徵或標記,然後按一下「編輯」
。在「編輯面向」視窗中,更新必填欄位。
按一下 [儲存]。
gcloud
如要更新項目或項目資料欄的層面,請使用 gcloud dataplex entries update
指令。
REST
如要更新項目或項目欄的層面,請使用 entry.update
方法。
刪除切面
控制台
在 Google Cloud 控制台中,前往 Dataplex Universal Catalog 的「Search」(搜尋) 頁面。
在「選擇搜尋平台」選單中,選取「Dataplex Catalog」做為搜尋模式。
搜尋要刪除特定面向的項目,然後按一下該項目。
系統會開啟項目詳細資料頁面。
按一下 [Details] (詳細資料) 分頁標籤。
在「標記和方面」部分中,展開要刪除的方面或標記,然後依序按一下
「刪除」。按一下「確認」。
gcloud
如要刪除項目的層面,請使用 gcloud dataplex entries update
指令。
REST
如要刪除項目的層面,請使用 entry.update
方法。
管理切面類型
本節說明如何查看、更新及刪除面向類型。
查看可用切面類型和標記範本的清單
控制台
在 Google Cloud 控制台中,前往 Dataplex Universal Catalog 的「Catalog」(目錄) 頁面。
按一下「切面類型和標記範本」分頁標籤。
這個頁面會列出所有可用的 Dataplex Universal Catalog 切面類型和 Data Catalog 標記範本。
如要查看自訂切面類型和標記範本,請按一下「自訂」分頁標籤。在「自訂」分頁中,「目錄來源」欄會顯示資源所在位置,也就是 Dataplex Universal Catalog 或 Data Catalog。
如要查看系統層面類型,請按一下「系統」分頁標籤。
如要進一步瞭解自訂和系統層面類型,請參閱本文的「層面類型類別」一節。
選用:如要查看所選專案中的長寬比類型和代碼範本清單,請按一下「自訂」分頁標籤,然後將「顯示所有專案」切換鈕設為關閉位置。
「顯示所有專案的資源」切換鈕預設為開啟,清單會列出所選機構的 Dataplex Universal Catalog 資源,以及您可存取的所有機構的 Data Catalog 資源。
gcloud
如要列出所有可用的切面類型,請使用 gcloud dataplex aspect-types list
指令。
REST
如要列出所有可用的切面類型,請使用 aspectTypes.list
方法。
查看切面類型或標記範本的詳細資料
控制台
在 Google Cloud 控制台中,前往 Dataplex Universal Catalog 的「Catalog」(目錄) 頁面。
按一下「切面類型和標記範本」分頁標籤。
如要查看 Dataplex Universal Catalog 切面類型的詳細資料,請按一下該切面類型。系統會開啟切面類型詳細資料頁面,您可以在這裡存取詳細資料,例如顯示名稱、切面類型 ID、說明、專案 ID、位置、標籤、建立日期和上次修改日期。
- 如要查看所選層面類型的結構,請按一下「範本」分頁標籤。
- 如要查看最近建立的 10 個相關項目清單,請按一下「範例項目」分頁標籤。
- 如要搜尋所有相關項目,請按一下「在搜尋結果顯示所有相關項目」。只有在至少有一個相關項目時,才會顯示這個按鈕。
如要查看 Data Catalog 標記範本的詳細資料,請按一下該標記範本。資料目錄會開啟標記範本詳細資料頁面,您可以在這裡存取顯示名稱、範本 ID、專案 ID、位置、可見度和標籤等詳細資料。
gcloud
如要取得構面類型的詳細資料,請使用 gcloud dataplex aspect-types describe
指令。
REST
如要取得切面類型的詳細資料,請使用 aspectTypes.get
方法。
更新切面類型
您可以更新切面類型的顯示名稱、說明、範本欄位和標籤。您無法刪除範本中的現有欄位。
建立方面類型後,就無法更新方面類型 ID 和位置。
控制台
在 Google Cloud 控制台中,前往 Dataplex Universal Catalog 的「Catalog」(目錄) 頁面。
按一下「切面類型和標記範本」分頁標籤。
按一下要更新的面向類型。
在「Aspect type details」(構面類型詳細資料) 頁面中,按一下「Edit」(編輯)。
視需要編輯顯示名稱、說明、範本欄位和標籤。
選用:如要將某個欄位標示為已淘汰,請按照下列步驟操作:
- 在「範本」部分,展開欄位。
- 選取「已淘汰」。
- 在「淘汰原因」欄位中,輸入淘汰所選欄位的原因。
- 按一下 [完成]。
按一下 [儲存]。
gcloud
如要更新切面類型,請使用 gcloud dataplex aspect-types update
指令。
REST
如要更新切面類型,請使用 aspectTypes.patch
方法。
刪除切面類型
控制台
在 Google Cloud 控制台中,前往 Dataplex Universal Catalog 的「Catalog」(目錄) 頁面。
按一下「切面類型和標記範本」分頁標籤。
按一下要刪除的層面類型。
在「Aspect type details」(構面類型詳細資料) 頁面中,按一下「Delete」(刪除)。系統提示時,請確認。
gcloud
如要刪除構面類型,請使用 gcloud dataplex aspect-types delete
指令。
REST
如要刪除現有的切面類型,請使用 aspectTypes.delete
方法。
後續步驟
- 瞭解如何在 Dataplex Universal Catalog 中搜尋資料資產。
- 瞭解如何管理項目及擷取自訂來源。
- 瞭解如何將中繼資料匯入 Dataplex Universal Catalog。
- 進一步瞭解 Dataplex Universal Catalog 中的中繼資料管理。
- 進一步瞭解如何從 Data Catalog 遷移至 Dataplex Universal Catalog。