查看 Knowledge Catalog 洞察資料

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

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

新建立和現有的 Cloud Firestore 資料庫預設會啟用 Knowledge Catalog，並自動擷取下列中繼資料：

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

事前準備

啟用 Knowledge Catalog API (dataplex.googleapis.com)。
  • 您必須具備 Service Usage 管理員 IAM 角色 roles/serviceusage.serviceUsageAdmin，其中包含 serviceusage.services.enable 權限，才能啟用 API。瞭解如何授予角色。
  • 如要啟用 API，請參閱「啟用 API」。

如要搭配 Cloud Firestore 使用 Knowledge Catalog 深入分析，您必須先建立 Cloud Firestore 資料庫。詳情請參閱「建立及管理資料庫」。

存取搜尋結果所需的角色

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

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

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

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

搜尋項目所需的角色

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

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

中繼資料探索類型

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

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

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

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

範例：探索 Cloud Firestore 集合群組結構定義

如要瞭解中繼資料探索程序，請考慮使用名為 user-firestore-database 的 Cloud Firestore 資料庫。這個資料庫有名為 user-schema 的集合群組結構定義。

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

使用切面充實中繼資料

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

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

  • 將業務中繼資料新增至資產
  • 依業務中繼資料和其他自訂中繼資料搜尋資產

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

搜尋 Cloud Firestore 資產

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

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

    前往「Search」(搜尋) 頁面

  2. 在「篩選器」面板中，依序點選「系統」和「Firestore」。

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

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

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

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

如要查看所有Cloud Firestore資產，請輸入 system=Firestore。您可以輸入特定關鍵字。例如，如要查看所有 Cloud Firestore 資料庫，請執行下列指令：

system=Firestore AND type=Database

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

您可以直接在搜尋欄位中輸入搜尋查詢，找出特定 Cloud Firestore 素材資源。查詢字串的格式如下：

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

更改下列內容：

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

    • firestore-database
    • firestore-schema

查詢範例如下：

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

依切面類型搜尋

Knowledge Catalog 包含一些內建切面類型，可用於執行搜尋。

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

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

在Cloud Firestore使用自然語言搜尋

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

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

在Cloud Firestore中搜尋語法

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

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

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

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

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

    前往「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. 選取集合群組名稱，然後在「Collection group details」(集合群組詳細資料) 頁面中，按一下「Schema」(結構定義) 即可查看結構定義。

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

定價

在 Knowledge Catalog 儲存 Cloud Firestore 技術中繼資料不需付費。API 呼叫和額外的業務中繼資料擴充，則適用標準 Knowledge Catalog 定價。詳情請參閱 Knowledge Catalog 定價頁面。

限制

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

後續步驟