Sie können Ihre Cloud Firestore-Ressourcen mit Knowledge Catalog suchen und verwalten. Dies ist eine Plattform zum Speichern, Verwalten und Abrufen Ihrer Metadaten. Mit Knowledge Catalog können Sie Ihre Cloud Firestore-Metadaten analysieren und Aufgaben wie die folgenden ausführen:
- Analyse, einschließlich Abhängigkeiten und Eignung für einen Anwendungsfall
- Änderungsmanagement
- Schemaentwicklung
Knowledge Catalog ist standardmäßig für neue und vorhandene Cloud Firestore-Datenbanken aktiviert und ruft automatisch die folgenden Metadaten ab:
| Ressource | Typ | Felder |
|---|---|---|
| Datenbank | Steuerungsebene |
|
| Datenbankschema | Datenebene |
|
Hinweis
Aktivieren Sie die Knowledge Catalog API (dataplex.googleapis.com).
- Bevor Sie APIs aktivieren können, benötigen Sie die IAM-Rolle „Service Usage-Administrator“ (
roles/serviceusage.serviceUsageAdmin), die die Berechtigungserviceusage.services.enableenthält. Informationen zum Zuweisen von Rollen - Informationen zum Aktivieren einer API finden Sie unter APIs aktivieren.
Wenn Sie Knowledge Catalog-Statistiken mit Cloud Firestore verwenden möchten, benötigen Sie zuerst eine Cloud Firestore-Datenbank. Weitere Informationen finden Sie unter Datenbanken erstellen und verwalten.
Erforderliche Rollen für den Zugriff auf Suchergebnisse
Wenn Hauptkonten in Knowledge Catalog nach Cloud Firestore-Metadaten suchen und diese aufrufen möchten, benötigen sie Berechtigungen zum Aufrufen von Cloud Firestore-Ressourcen, einschließlich der Berechtigung dataplex.projects.search.
Wenn Sie Hauptkonten wie Nutzern, Gruppen oder Dienstkonten diese Berechtigungen gewähren möchten, weisen Sie ihnen die IAM-Rolle Cloud Datastore-Betrachter (roles/datastore.viewer) für das Projekt zu, das die Cloud Firestore-Ressourcen enthält.
| Knowledge Catalog-Vorgang | Cloud Firestore-Ressource | Erforderliche Rollen oder Berechtigungen |
|---|---|---|
| Nach Cloud Firestore-Ressourcen suchen | Datenbank | datastore.databases.getMetadata |
| Datenbankschema | datastore.schemas.get |
Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten. Weitere Informationen zu Cloud Firestore-IAM-Rollen finden Sie unter Cloud Firestore-Rollen und -Berechtigungen.
Erforderliche Rollen für die Suche nach Einträgen
Um nach Einträgen zu suchen, benötigen Sie mindestens eine der folgenden IAM-Rollen für das Projekt, das für die Suche verwendet wird:
- Dataplex Catalog Admin (
roles/dataplex.catalogAdmin) - Dataplex Catalog Editor (
roles/dataplex.catalogEditor) - Dataplex Catalog Viewer (
roles/dataplex.catalogViewer)
Berechtigungen für Suchergebnisse werden unabhängig vom ausgewählten Projekt geprüft. Weitere Informationen finden Sie unter Mit Knowledge Catalog nach Daten-Assets suchen.
Arten der Metadatenerkennung
Die Metadatenerkennung von Knowledge Catalog ist ein automatisierter Prozess, bei dem verbundene Datenquellen wie Cloud Firestore gescannt werden, um Daten-Assets wie Sammlungen und Datenbanken zu identifizieren und ihre technischen Metadaten wie Schemas, Beschreibungen und Standorte in den Knowledge Catalog-Katalog zu extrahieren. Dieser Prozess wird regelmäßig ausgeführt, um den Katalog mit den Quellsystemen synchron zu halten.
Suche nach Keywords und in natürlicher Sprache
Knowledge Catalog unterstützt die Suche nach Keywords und in natürlicher Sprache.
- Mit der Keyword-Suche können Sie Ressourcen mithilfe bestimmter Keywords, Filter und einer definierten Syntax finden. Sie können beispielsweise
system=Firestore AND type=Databaseeingeben, um alle Cloud Firestore-Datenbanken aufzurufen. - Die Suche in natürlicher Sprache (Vorabversion) verwendet KI, um semantische Abfragen zu verstehen. Sie können Ressourcen in natürlicher Sprache finden, ohne komplexe Syntax verwenden zu müssen. Sie können beispielsweise Abfragen wie
List all Firestore databases related to saleseingeben.
Weitere Informationen finden Sie unter Suchsyntax für Knowledge Catalog.
Beispiel: Schema einer Cloud Firestore-Sammlungsgruppe ermitteln
Um den Prozess der Metadatenermittlung zu verstehen, betrachten wir eine Cloud Firestore-Datenbank mit dem Namen user-firestore-database. In dieser Datenbank haben Sie ein Sammlungsgruppenschema mit dem Namen user-schema.
Nach Abschluss der Erkennung können Sie auf der Seite „Knowledge Catalog“ der Google Cloud Console oder mithilfe der Knowledge Catalog API nach diesen Assets (user-firestore-database und user-schema) suchen.
Anschließend können Sie sich Details zu den Assets ansehen und sie mit zusätzlichen geschäftlichen oder betrieblichen Metadaten anreichern.
Metadaten mit Aspekten anreichern
Aspekttypen sind wiederverwendbare Ressourcen, die Sie als Vorlagen für Aspekte verwenden können. Mit Aspekttypen können Sie doppelte Arbeit und unvollständige Aspekte vermeiden. Mit Knowledge Catalog können Sie die erforderlichen Aspekttypen erstellen.
Nachdem Sie benutzerdefinierte Aspekttypen erstellt haben, können Sie Ihren Cloud Firestore-Ressourcen Aspekte hinzufügen. Wenn Sie Ihren Ressourcen Aspekte zuweisen, haben Sie folgende Möglichkeiten:
- Fügen Sie den Assets geschäftliche Metadaten hinzu.
- Sie können anhand von geschäftlichen Metadaten und anderen benutzerdefinierten Metadaten nach Assets suchen.
Weitere Informationen zum Erstellen von Aspekttypen und zum Anhängen von Aspekten an Cloud Firestore finden Sie unter Aspekte verwalten und Metadaten anreichern.
Nach Cloud Firestore-Assets suchen
Verwenden Sie die Knowledge Catalog-Suchseite in der Google Cloud Console, um nach Cloud Firestore-Assets zu suchen.
Rufen Sie im Knowledge Catalog die Seite Suchen auf.
Klicken Sie im Bereich Filter auf Systeme und wählen Sie dann Firestore aus.
Optional. Unter Typ-Aliasse können Sie die Suchergebnisse nach einem bestimmten Typ von Cloud Firestore-Asset filtern, indem Sie einen oder mehrere der folgenden Typ-Aliasse auswählen:
- Datenbank
- Datenbankschema
- Sonstiges
Keyword-Suche über Anfragen ausführen
Sie können das Suchfeld im Knowledge Catalog verwenden, um Suchanfragen mit Keywords auszuführen. Sie können beispielsweise system=Firestore AND type=Database eingeben, um alle Cloud Firestore-Datenbanken aufzurufen.
Weitere Informationen finden Sie unter Suchsyntax für Knowledge Catalog.
Wenn Sie alle Cloud Firestore-Assets aufrufen möchten, geben Sie system=Firestore ein. Sie können bestimmte Keywords eingeben. So rufen Sie beispielsweise alle Cloud Firestore-Datenbanken auf:
system=Firestore AND type=Database
Sie können auch Klammern und die logischen Operatoren AND und OR für komplexe Ausdrücke verwenden. Weitere Informationen zu den Ausdrücken, die Sie im Suchfeld verwenden können, finden Sie unter Suchsyntax für Knowledge Catalog.
Sie können Suchanfragen für bestimmte Cloud Firestore-Assets direkt in das Suchfeld eingeben. Der Abfragestring hat folgendes Format:
type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"
Ersetzen Sie Folgendes:
QUERY_STRING: Verwenden Sie die folgende Liste, um einen Abfragestring basierend auf dem Typ des Cloud Firestore-Assets zu identifizieren, das Sie abfragen möchten:firestore-databasefirestore-schema
Eine Beispielabfrage könnte etwa so aussehen:
type="projects/1234567890/locations/global/entryTypes/firestore-schema"
Nach Aspekttyp suchen
Knowledge Catalog umfasst einige integrierte Aspekttypen, die Sie für Suchvorgänge nutzen können.
So suchen Sie nach Aspekttyp:
- Klicken Sie im Bereich Aspekte auf das Menü Weitere Aspekttypen hinzufügen.
- Geben Sie
Firestoreein und wählen Sie dann einen oder mehrere der folgenden Aspekttypen aus, um die Suchergebnisse auf diesen Typ zu beschränken.- Cloud Firestore Datenbank
- Cloud Firestore Schema
- Klicken Sie auf OK.
- Klicken Sie in der Ergebnistabelle auf den Namen des Assets, um die Metadaten für dieses Asset aufzurufen.
- Optional: Assets optimieren oder ansehen. Sie haben folgende Möglichkeiten:
- Wenn Sie eine RTF-Beschreibung des Assets hinzufügen möchten, klicken Sie unter Übersicht auf Hinzufügen .
- Wenn Sie dem Asset einen Aspekt hinzufügen möchten, klicken Sie unter Aspekte auf Hinzufügen .
- Wenn Sie die Mitgliedsdatenbanken für eine Instanz aufrufen möchten, klicken Sie auf den Tab Eintragsliste und dann auf Alle untergeordneten Einträge in der Suche anzeigen.
- Unter Details zum Eintrag sehen Sie alle Details des Assets. Klicken Sie auf den Namen des Eintrags, um weitere Einträge aufzurufen.
Suche in natürlicher Sprache in Cloud Firestore
Die Suche in natürlicher Sprache (Vorabversion) verwendet KI, um semantische Abfragen zu verstehen. Sie können Ressourcen in natürlicher Sprache finden, ohne komplexe Syntax verwenden zu müssen. Sie können beispielsweise Abfragen wie List all Firestore collections related to sales eingeben.
Weitere Informationen finden Sie unter Suchsyntax für Knowledge Catalog.
Syntaxsuche in Cloud Firestore
Mit der Keyword-Suche können Sie Ressourcen mithilfe bestimmter Keywords, Filter und einer definierten Syntax finden. Sie können beispielsweise system=Firestore AND type=Database eingeben, um alle Cloud Firestore-Datenbanken aufzurufen.
Weitere Informationen finden Sie unter Suchsyntax für Knowledge Catalog.
Beispielworkflow: Von der Datenbank zum Schema aufschlüsseln
So schlüsseln Sie eine Datenbank nach einem Schema auf:
Rufen Sie im Knowledge Catalog die Seite Suchen auf.
Wählen Sie im Bereich Filter die Option Systeme und dann Firestore aus. Alternativ können Sie
system=Firestorein das Suchfeld eingeben.Wählen Sie eine Datenbank aus.
Klicken Sie auf der Seite Firestore-Details auf den Tab Eintragsliste und dann auf Alle untergeordneten Einträge in der Suche anzeigen.
Klicken Sie auf der Seite Firestore-Datenbankdetails auf den Tab Eintragsliste und dann auf Alle untergeordneten Einträge in der Suche anzeigen. Knowledge Catalog zeigt die Sammlungsgruppen in der Datenbank an.
Wählen Sie den Namen einer Sammlungsgruppe aus und klicken Sie dann auf der Seite Details zur Sammlungsgruppe auf Schema, um das Schema aufzurufen.
Optional: Wenn Sie einer Datenbank einen Aspekttyp hinzufügen möchten, klicken Sie auf den Button Aspekt hinzufügen.
Preise
Für das Speichern von technischen Cloud Firestore-Metadaten in Knowledge Catalog fallen keine Gebühren an. Für API-Aufrufe und die zusätzliche Anreicherung von Geschäftsmetadaten gelten die Standardpreise für Knowledge Catalog. Weitere Informationen finden Sie auf der Preisseite für Knowledge Catalog.
Beschränkungen
- Abfrageergebnisse werden abgeschnitten,nachdem 10.000 Sammlungsgruppen aufgenommen wurden.
- Bei der Batchaufnahme kann es bis zu 48 Stunden dauern, bis Aktualisierungen Ihrer Datenbank in Knowledge Catalog angezeigt werden.
- Während der Live-Aufnahme kann es bis zu 5 Minuten dauern, bis Aktualisierungen Ihrer Datenbank in Knowledge Catalog angezeigt werden.
- Sammlungsgruppen werden während der Live-Aufnahme nicht aktualisiert.
- Sammlungsgruppenschemas werden während der Live-Aufnahme aktualisiert. Diese Aktualisierung umfasst jedoch nur die ersten 100 primitiven Felder auf oberster Ebene in alphabetischer Reihenfolge. Die restlichen Schemainformationen werden 24 bis 48 Stunden nach der Liveaufnahme aktualisiert.
- Der Extraktionsvorgang kann einige Minuten dauern.
Nächste Schritte
- Data Catalog-Verwaltung in Knowledge Catalog
- Identity and Access Management-Rollen für Knowledge Catalog