查看 Knowledge Catalog 洞察資料

您可以使用 Knowledge Catalog 搜尋及管理 Firestore 資源。這個平台可儲存、管理及存取中繼資料。您可以使用 Knowledge Catalog 分析 Firestore 中繼資料，並協助完成下列工作：

  • 分析，包括依附元件和是否適合用途
  • 變更管理
  • 漸進式結構定義更新

新舊 Firestore 資料庫預設會啟用 Knowledge Catalog，並自動擷取下列中繼資料：

資源 類型 欄位
資料庫 控制層
  • 版本
  • 模式
  • 位置 (包括多個區域)
  • 專案 ID
  • 資料庫名稱
  • 建立時間
資料庫結構定義 資料層
  • 名稱
  • 集合
  • 欄位 - 資料類型
  • 結構定義

事前準備

  • 如果尚未啟用，請啟用 Knowledge Catalog API。

    啟用 API 時所需的角色

    如要啟用 API，您必須具備 serviceusage.services.enable 權限。如果您建立了專案，可能已透過「擁有者」角色 (roles/owner) 取得這項權限。否則，您可以透過「服務使用情形管理員」角色 (roles/serviceusage.serviceUsageAdmin) 取得這項權限。瞭解如何授予角色。

    啟用 API

如要搭配 Firestore 使用 Knowledge Catalog 洞察資料，請先建立 Firestore 資料庫。詳情請參閱「建立及管理資料庫」。

存取搜尋結果所需的角色

如要在 Knowledge Catalog 中搜尋及查看 Firestore 中繼資料，主體必須具備查看 Firestore 資源的權限，包括 dataplex.projects.search 權限。

如要授予主體 (例如使用者、群組或服務帳戶) 這些權限，請在包含 Firestore 資源的專案中，指派「Cloud Datastore 檢視者」(roles/datastore.viewer) IAM 角色。

Knowledge Catalog 作業 Firestore 資源 所需角色或權限
搜尋 Firestore 資源 資料庫 datastore.databases.getMetadata
資料庫結構定義 datastore.schemas.get

如要進一步瞭解如何授予角色，請參閱「管理存取權」。如要進一步瞭解 Firestore IAM 角色，請參閱「Firestore 角色和權限」。

搜尋項目所需的角色

如要在專案搜尋項目，至少須具備該專案的其中一個 IAM 角色：

系統會檢查搜尋結果的權限，與所選專案無關。詳情請參閱「使用 Knowledge Catalog 搜尋資料資產」。

中繼資料探索類型

Knowledge Catalog 中繼資料探索是自動程序，會掃描已連線的資料來源 (例如 Firestore)，找出資料資產 (例如集合和資料庫)，並將結構定義、說明和位置等技術中繼資料擷取到 Knowledge Catalog 目錄。這項程序會定期執行，確保目錄與來源系統保持同步。

Knowledge Catalog 支援關鍵字和自然語言搜尋。

  • 關鍵字搜尋功能可讓您使用特定關鍵字、篩選條件和定義的語法尋找資源。舉例來說，您可以輸入 system=Firestore AND type=Database 查看所有 Firestore 資料庫。
  • 自然語言搜尋 (搶先版) 會運用 AI 理解語意查詢，您可以使用日常用語尋找資源，不必再使用複雜的語法。例如，你可以輸入 List all Firestore databases related to sales 等查詢。

詳情請參閱「Knowledge Catalog 的搜尋語法」。

範例：探索 Firestore 產品素材資源集合群組結構定義

如要瞭解中繼資料探索程序，請考慮名為 user-firestore-database 的 Firestore 資料庫。在這個資料庫中，您有一個名為 user-schema 的產品素材資源集合群組結構定義。

探索完成後，您可以在Google Cloud 控制台的 Knowledge Catalog 頁面中搜尋這些資產 - user-firestore-database和 user-schema，也可以使用 Knowledge Catalog API 搜尋。接著，您可以查看資產詳細資料，並新增其他業務或營運中繼資料。

使用層面充實中繼資料

切面類型是可重複使用的資源，可做為切面的範本。切面類型可協助您避免重複作業和不完整的切面。您可以使用 Knowledge Catalog 建立所需的切面類型。

建立自訂切面類型後，即可將切面附加至 Firestore 資源。將層面附加至資源可讓您執行下列操作：

  • 在資產中新增商家中繼資料
  • 依業務中繼資料和其他自訂中繼資料搜尋資產

如要進一步瞭解如何建立切面類型，以及將切面附加至 Firestore，請參閱「管理切面及豐富中繼資料」。

搜尋 Firestore 資產

在 Google Cloud 控制台使用 Knowledge Catalog 搜尋頁面，搜尋 Firestore 資產。

  1. 前往 Knowledge Catalog 的「Search」(搜尋) 頁面。

    前往「搜尋」

  2. 在「篩選器」面板中，按一下「系統」，然後選取「Firestore」。

  3. 選用。在「型別別名」中，選取一或多個下列型別別名，即可將搜尋結果篩選為特定類型的 Firestore 資產：

    • 資料庫
    • 資料庫結構定義
    • 其他

您可以使用 Knowledge Catalog 中的搜尋欄位執行關鍵字搜尋查詢。舉例來說，您可以輸入 system=Firestore AND type=Database 查看所有 Firestore 資料庫。

詳情請參閱「Knowledge Catalog 的搜尋語法」。

如要查看所有 Firestore 資產，請輸入 system=Firestore。你可以輸入特定關鍵字。舉例來說，如要查看所有 Firestore 資料庫：

system=Firestore AND type=Database

您也可以使用括號和邏輯運算子 AND 和 OR，建立複雜的運算式。如要進一步瞭解可在搜尋欄位中使用的運算式，請參閱「Knowledge Catalog 搜尋語法」。

您可以在搜尋欄位中直接輸入特定 Firestore 資產的搜尋查詢。查詢字串的格式如下：

type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"

更改下列內容：

  • QUERY_STRING：根據要查詢的 Firestore 資產類型，使用下列清單找出查詢字串：

    • firestore-database
    • firestore-schema

查詢範例如下：

type="projects/1234567890/locations/global/entryTypes/firestore-schema"

依切面類型搜尋

Knowledge Catalog 內建幾種切面類型，可用於執行搜尋。

如要依面向類型搜尋，請按照下列步驟操作：

  1. 在「Aspects」面板中，按一下「Add more aspect types」選單。
  2. 輸入 Firestore，然後選取下列一或多個層面類型，將搜尋結果限制為該類型。
    • Firestore 資料庫
    • Firestore 結構定義
  3. 按一下 [確定]。
  4. 在結果表格中，按一下資產名稱即可查看該資產的中繼資料。
  5. 選用：強化或查看素材資源。你可以執行下列任一操作：
    • 如要新增資產的 RTF 說明，請在「總覽」中按一下「新增」。
    • 如要將切面附加至資產，請在「切面」中點選「新增」。
    • 如要查看執行個體的成員資料庫，請按一下「項目清單」分頁標籤， 然後按一下「在搜尋中顯示所有子項目」。
    • 在「項目詳細資料」中，查看資產的完整詳細資料。按一下項目名稱，即可深入查看其他項目。

在 Firestore 中進行自然語言搜尋

自然語言搜尋 (搶先版) 會運用 AI 理解語意查詢，您可以使用日常用語尋找資源，不必再使用複雜的語法。例如，你可以輸入 List all Firestore collections related to sales 等查詢。

詳情請參閱「Knowledge Catalog 的搜尋語法」。

在 Firestore 中搜尋語法

關鍵字搜尋功能可讓您使用特定關鍵字、篩選條件和定義的語法尋找資源。舉例來說，您可以輸入 system=Firestore AND type=Database 查看所有 Firestore 資料庫。

詳情請參閱「Knowledge Catalog 的搜尋語法」。

工作流程範例：從資料庫向下鑽研至結構定義

如要從資料庫向下鑽研至結構定義，請按照下列步驟操作：

  1. 前往 Knowledge Catalog 的「Search」(搜尋) 頁面。

    前往「搜尋」

  2. 在「篩選器」面板中，依序選取「系統」和「Firestore」。 或者，在搜尋欄位中輸入 system=Firestore。

  3. 選取資料庫。

  4. 在「Firestore details」(Firestore 詳細資料) 頁面中，按一下「Entry list」(項目清單) 分頁標籤，然後點選「Show all children entries in search」(在搜尋中顯示所有子項目)。

  5. 在「Firestore database details」(Firestore 資料庫詳細資料) 頁面中，按一下「Entry list」(項目清單) 分頁標籤，然後按一下「Show all children entries in search」(在搜尋中顯示所有子項項目)。Knowledge Catalog 會顯示資料庫中的集合群組。

  6. 選取產品素材資源集合群組名稱，然後在「產品素材資源集合群組詳細資料」頁面中，按一下「結構定義」即可查看結構定義。

  7. 選用：如要將層面類型新增至資料庫，請按一下「新增層面」按鈕。

定價

在 Knowledge Catalog 中儲存 Firestore 技術中繼資料不會產生費用。 API 呼叫和額外商業中繼資料擴充功能適用標準 Knowledge Catalog 定價。詳情請參閱「Knowledge Catalog 定價頁面」。

限制

  • 如果擷取的集合群組超過 10,000 個，查詢結果就會遭到截斷。
  • 批次擷取期間，資料庫更新最多可能需要 48 小時才會反映在 Knowledge Catalog 中。
  • 在即時擷取期間，資料庫更新最多可能需要 5 分鐘，才會反映在 Knowledge Catalog 中。
  • 系統不會在即時擷取期間更新集合群組。
  • 系統會在即時擷取期間更新產品素材資源集合群組結構定義，但這項更新只會涵蓋前 100 個頂層原始欄位 (依字母順序排列)。其餘結構定義資訊會在即時擷取後 24 至 48 小時內更新。
  • 擷取程序可能需要幾分鐘才能完成。

後續步驟