Wyświetlanie statystyk Knowledge Catalog

Możesz wyszukiwać zasoby Cloud Firestore i zarządzać nimi za pomocą Knowledge Catalog, czyli platformy do przechowywania metadanych, zarządzania nimi i uzyskiwania do nich dostępu. Możesz używać Knowledge Catalog do analizowania metadanych Cloud Firestore i wykonywania takich zadań jak:

  • Analiza, w tym zależności i przydatność w danym przypadku użycia
  • Zarządzanie zmianą
  • Ewolucja schematu

Knowledge Catalog jest domyślnie włączony w nowych i istniejących bazach danychCloud Firestore i automatycznie pobiera te metadane:

Zasób Typ Pola
Baza danych Platforma sterująca
  • Wersja
  • Tryby
  • Lokalizacja (w tym wiele regionów)
  • Identyfikator projektu
  • Nazwa bazy danych
  • Czas utworzenia
Schemat bazy danych Platforma danych
  • Nazwa
  • Kolekcja
  • Pole – typy danych
  • Schemat

Zanim zaczniesz

Włącz interfejs Knowledge Catalog API (dataplex.googleapis.com).

Aby korzystać ze statystyk Knowledge Catalog w Cloud Firestore, musisz najpierw mieć bazę danych Cloud Firestore. Więcej informacji znajdziesz w artykule Tworzenie baz danych i zarządzanie nimi.

Wymagane role do uzyskiwania dostępu do wyników wyszukiwania

Aby wyszukiwać i wyświetlać metadane Cloud Firestore w Knowledge Catalog, podmioty zabezpieczeń muszą mieć uprawnienia do wyświetlania zasobów Cloud Firestore, w tym uprawnienie dataplex.projects.search.

Aby przyznać podmiotom zabezpieczeń, takim jak użytkownicy, grupy lub konta usługi, te uprawnienia, przypisz im rolę Wyświetlający Cloud Datastore (roles/datastore.viewer) w projekcie zawierającym zasoby Cloud Firestore.

Operacja Knowledge Catalog Cloud Firestore zasób Wymagane role lub uprawnienia
Wyszukaj zasoby Cloud Firestore Baza danych datastore.databases.getMetadata
Schemat bazy danych datastore.schemas.get

Więcej informacji o przyznawaniu ról znajdziesz w artykule Zarządzanie dostępem. Więcej informacji o rolach Cloud Firestore znajdziesz w artykule Cloud Firestore role i uprawnienia.

Wymagane role do wyszukiwania wpisów

Aby wyszukiwać wpisy, potrzebujesz co najmniej 1 z tych ról uprawnień w projekcie, który jest używany do wyszukiwania:

Uprawnienia do wyników wyszukiwania są sprawdzane niezależnie od wybranego projektu. Więcej informacji znajdziesz w artykule Wyszukiwanie zasobów danych za pomocą Knowledge Catalog.

Rodzaje wykrywania metadanych

Wykrywanie metadanych w Knowledge Catalog to automatyczny proces, który skanuje połączone źródła danych, takie jak Cloud Firestore, aby identyfikować zasoby danych (np. kolekcje i bazy danych) i wyodrębniać ich metadane techniczne, takie jak schematy, opisy i lokalizacje, do katalogu Knowledge Catalog. Ten proces jest uruchamiany okresowo, aby katalog był zsynchronizowany z systemami źródłowymi.

Knowledge Catalog obsługuje wyszukiwanie słów kluczowych i w języku naturalnym.

  • Wyszukiwanie słów kluczowych umożliwia znajdowanie zasobów za pomocą określonych słów kluczowych, filtrów i zdefiniowanej składni. Możesz na przykład wpisać system=Firestore AND type=Database, aby wyświetlić wszystkie bazy danych Cloud Firestore.
  • Wyszukiwanie w języku naturalnym (wersja testowa) wykorzystuje AI do rozpoznawania zapytań semantycznych. Umożliwia znajdowanie zasobów za pomocą języka naturalnego, co eliminuje konieczność stosowania złożonej składni. Możesz na przykład wpisać zapytania takie jak:List all Firestore databases related to sales

Więcej informacji znajdziesz w artykule Składnia wyszukiwania w Knowledge Catalog.

Przykład: odkrywanie schematu grupy kolekcji Cloud Firestore

Aby zrozumieć proces wykrywania metadanych, rozważmy Cloud Firestorebazę danych o nazwie user-firestore-database. W tej bazie danych masz schemat grupy kolekcji o nazwie user-schema.

Po zakończeniu wykrywania możesz wyszukiwać te zasoby – user-firestore-database i user-schema – na stronie Knowledge Catalog w konsoli Google Cloud lub za pomocą interfejsu Knowledge Catalog API. Następnie możesz wyświetlić szczegóły dotyczące komponentów i wzbogacić je o dodatkowe metadane biznesowe lub operacyjne.

Wzbogacanie metadanych za pomocą aspektów

Typy aspektów to zasoby wielokrotnego użytku, których możesz używać jako szablonów aspektów. Typy aspektów pomagają uniknąć powielania pracy i niekompletnych aspektów. Za pomocą Knowledge Catalog możesz tworzyć potrzebne typy aspektów.

Po utworzeniu niestandardowych typów aspektów możesz dołączyć aspekty do zasobówCloud Firestore. Dołączanie aspektów do zasobów umożliwia:

  • Dodawanie metadanych firmy do komponentów
  • Wyszukiwanie zasobów według metadanych biznesowych i innych metadanych niestandardowych

Więcej informacji o tworzeniu typów aspektów i dołączaniu aspektów do Cloud Firestore znajdziesz w artykule Zarządzanie aspektami i wzbogacanie metadanych.

Wyszukiwanie zasobów Cloud Firestore

Użyj strony wyszukiwania Knowledge Catalog w konsoli Google Cloud, aby wyszukać zasoby Cloud Firestore.

  1. Otwórz stronę Wyszukiwanie w usłudze Knowledge Catalog.

    Otwórz wyszukiwarkę

  2. W panelu Filtry kliknij Systemy, a następnie wybierz Firestore.

  3. Opcjonalnie. W sekcji Aliasy typów możesz filtrować wyniki wyszukiwania, aby wyświetlić określony typ komponentu Cloud Firestore, wybierając jeden lub więcej z tych aliasów typów:

    • Baza danych
    • Schemat bazy danych
    • Inne

W polu wyszukiwania w Knowledge Catalog możesz wykonywać zapytania z wyszukiwaniem słów kluczowych. Możesz na przykład wpisać system=Firestore AND type=Database, aby wyświetlić wszystkie bazy danych Cloud Firestore.

Więcej informacji znajdziesz w artykule Składnia wyszukiwania w Knowledge Catalog.

Aby wyświetlić wszystkie komponenty Cloud Firestore, wpisz system=Firestore. Możesz wpisać konkretne słowa kluczowe. Aby na przykład wyświetlić wszystkie bazy danych Cloud Firestore:

system=Firestore AND type=Database

W przypadku złożonych wyrażeń możesz też używać nawiasów i operatorów logicznych ANDOR. Więcej informacji o wyrażeniach, których możesz używać w polu wyszukiwania, znajdziesz w artykule Składnia wyszukiwania w Knowledge Catalog.

W polu wyszukiwania możesz bezpośrednio wpisywać zapytania dotyczące konkretnych zasobów Cloud Firestore. Format ciągu zapytania jest następujący:

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

Zastąp następujące elementy:

  • QUERY_STRING: skorzystaj z tej listy, aby określić ciąg zapytania na podstawie typu komponentu Cloud Firestore, o który chcesz wysłać zapytanie:

    • firestore-database
    • firestore-schema

Przykładowe zapytanie może wyglądać tak:

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

Wyszukiwanie według typu aspektu

Knowledge Catalog zawiera kilka wbudowanych typów aspektów, których możesz używać do wyszukiwania.

Aby wyszukać według typu aspektu:

  1. W panelu Aspekty kliknij menu Dodaj więcej typów aspektów.
  2. Wpisz Firestore, a następnie wybierz co najmniej jeden z tych typów aspektów, aby ograniczyć wyniki wyszukiwania do tego typu.
    • Cloud Firestore baza danych
    • Cloud Firestore Schemat
  3. Kliknij OK.
  4. W tabeli wyników kliknij nazwę komponentu, aby wyświetlić metadane tego komponentu.
  5. Opcjonalnie: ulepsz lub wyświetl komponenty. Możesz wykonać dowolną z tych czynności:
    • Aby dodać opis zasobu w formacie tekstu sformatowanego, w sekcji Przegląd kliknij Dodaj .
    • Aby dołączyć aspekt do zasobu, w sekcji Aspekty kliknij Dodaj .
    • Aby wyświetlić bazy danych elementów instancji, kliknij kartę Lista wpisów, a następnie Pokaż wszystkie wpisy podrzędne w wyszukiwaniu.
    • W sekcji Szczegóły wpisu możesz wyświetlić pełne szczegóły komponentu. Aby przejść do dodatkowych wpisów, kliknij nazwę wpisu.

Wyszukiwanie w języku naturalnym w Cloud Firestore

Wyszukiwanie w języku naturalnym (wersja testowa) wykorzystuje AI do rozpoznawania zapytań semantycznych. Umożliwia znajdowanie zasobów za pomocą języka naturalnego, co eliminuje konieczność stosowania złożonej składni. Możesz na przykład wpisać zapytania takie jak:List all Firestore collections related to sales

Więcej informacji znajdziesz w artykule Składnia wyszukiwania w Knowledge Catalog.

Wyszukiwanie składni w Cloud Firestore

Wyszukiwanie słów kluczowych umożliwia znajdowanie zasobów za pomocą określonych słów kluczowych, filtrów i zdefiniowanej składni. Możesz na przykład wpisać system=Firestore AND type=Database, aby wyświetlić wszystkie bazy danych Cloud Firestore.

Więcej informacji znajdziesz w artykule Składnia wyszukiwania w Knowledge Catalog.

Przykładowy proces: przechodzenie od bazy danych do schematu

Aby przejść od bazy danych do schematu:

  1. Otwórz stronę Wyszukiwanie w usłudze Knowledge Catalog.

    Otwórz wyszukiwarkę

  2. W panelu Filtry wybierz Systemy, a następnie Firestore. Możesz też wpisać system=Firestore w polu wyszukiwania.

  3. Wybierz bazę danych.

  4. Na stronie Szczegóły Firestore kliknij kartę Lista wpisów, a następnie kliknij Pokaż wszystkie wpisy podrzędne w wyszukiwaniu.

  5. Na stronie Szczegóły bazy danych Firestore kliknij kartę Lista wpisów, a następnie kliknij Pokaż wszystkie wpisy podrzędne w wyszukiwaniu. Knowledge Catalog wyświetla grupy kolekcji w bazie danych.

  6. Wybierz nazwę grupy kolekcji, a następnie na stronie Szczegóły grupy kolekcji kliknij Schemat, aby wyświetlić schemat.

  7. Opcjonalnie: aby dodać typ aspektu do bazy danych, kliknij przycisk Dodaj aspekt.

Ceny

Przechowywanie metadanych technicznych Cloud Firestore w Knowledge Catalog jest bezpłatne. W przypadku wywołań interfejsu API i wzbogacania dodatkowych metadanych firmy obowiązują standardowe ceny Knowledge Catalog. Więcej informacji znajdziesz na stronie z cennikiem Knowledge Catalog.

Ograniczenia

  • Wyniki zapytania są obcinane po przetworzeniu 10 tys. grup zbiorów.
  • Podczas przetwarzania wsadowego odzwierciedlenie zmian w bazie danych w Knowledge Catalog może potrwać do 48 godzin.
  • Podczas przesyłania na żywo uwzględnienie zmian w bazie danych w Knowledge Catalog może potrwać do 5 minut.
  • Grupy kolekcji nie są aktualizowane podczas przesyłania na żywo.
  • Schematy grup kolekcji są aktualizowane podczas przesyłania danych na żywo, ale ta aktualizacja obejmuje tylko pierwsze 100 pól pierwotnych najwyższego poziomu w kolejności alfabetycznej. Pozostałe informacje o schemacie są aktualizowane w ciągu 24–48 godzin od rozpoczęcia przesyłania danych na żywo.
  • Proces wyodrębniania może potrwać kilka minut.

Co dalej?