Knowledge Catalog-Insights ansehen

Sie können mit Knowledge Catalog nach Ihren Firestore-Ressourcen suchen und sie verwalten. Knowledge Catalog ist eine Plattform zum Speichern, Verwalten und Zugreifen auf Ihre Metadaten. Mit Knowledge Catalog können Sie Ihre 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 Firestore-Datenbanken aktiviert und ruft automatisch die folgenden Metadaten ab:

Ressource Typ Felder
Datenbank Steuerungsebene
  • Version
  • Modi
  • Standort (einschließlich Multi-Regionen)
  • Projekt-ID
  • Datenbankname
  • Erstellt am
Datenbankschema Datenebene
  • Name
  • Sammlung
  • Feld – Datentyp(en)
  • Schema

Hinweis

Wenn Sie Knowledge Catalog-Insights mit Firestore verwenden möchten, benötigen Sie zuerst eine Firestore-Datenbank. Weitere Informationen finden Sie unter Datenbanken erstellen und verwalten.

Erforderliche Rollen für den Zugriff auf Suchergebnisse

Wenn Prinzipale in Knowledge Catalog nach Firestore-Metadaten suchen und sie ansehen möchten, benötigen sie Berechtigungen zum Aufrufen von Firestore-Ressourcen, einschließlich der Berechtigung dataplex.projects.search.

Weisen Sie Prinzipale wie Nutzer, Gruppen oder Dienstkonten die Cloud Datastore-Betrachter (roles/datastore.viewer) IAM-Rolle für das Projekt zu, das die Firestore Ressourcen enthält, um ihnen diese Berechtigungen zu gewähren.

Knowledge Catalog-Vorgang Firestore-Ressource Erforderliche Rollen oder Berechtigungen
Nach 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 Firestore-IAM-Rollen finden Sie unter Firestore-Rollen und -Berechtigungen.

Erforderliche Rollen für die Suche nach Einträgen

Wenn Sie nach Einträgen suchen möchten, benötigen Sie mindestens eine der folgenden IAM-Rollen für das Projekt, das für die Suche verwendet wird:

Die Berechtigungen für Suchergebnisse werden unabhängig vom ausgewählten Projekt geprüft. Weitere Informationen finden Sie unter Mit Knowledge Catalog nach Datenassets suchen.

Arten der Metadatenerkennung

Die Metadatenerkennung von Knowledge Catalog ist ein automatisierter Prozess, bei dem verbundene Datenquellen wie Firestore gescannt werden, um Datenassets 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 zu synchronisieren.

Knowledge Catalog unterstützt die Keyword- und die Suche 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=Database eingeben, um alle Firestore-Datenbanken aufzurufen.
  • Bei der Suche in natürlicher Sprache (Vorschau) wird KI verwendet, um semantische Abfragen zu verstehen. So können Sie Ressourcen in Alltagssprache finden, ohne dass eine komplexe Syntax erforderlich ist. Sie können beispielsweise Abfragen wie List all Firestore databases related to sales eingeben.

Weitere Informationen finden Sie unter Suchsyntax für Knowledge Catalog.

Beispiel: Schema einer Firestore-Sammlungsgruppe ermitteln

Um den Prozess der Metadatenerkennung zu verstehen, sehen wir uns eine Firestore-Datenbank mit dem Namen user-firestore-database an. In dieser Datenbank haben Sie ein Sammlungsgruppenschema mit dem Namen user-schema.

Nach Abschluss der Erkennung können Sie auf der Knowledge Catalog-Seite der Google Cloud Konsole oder mit der Knowledge Catalog API nach diesen Assets suchen: user-firestore-database und user-schema. Anschließend können Sie Details zu den Assets aufrufen 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 lassen sich doppelte Arbeit und unvollständige Aspekte vermeiden. Sie können mit Knowledge Catalog die benötigten Aspekttypen erstellen.

Nachdem Sie benutzerdefinierte Aspekttypen erstellt haben, können Sie Ihren Firestore-Ressourcen Aspekte zuweisen. Wenn Sie Ihren Ressourcen Aspekte zuweisen, haben Sie folgende Möglichkeiten:

  • Den Assets geschäftliche Metadaten hinzufügen
  • Anhand von geschäftlichen Metadaten und anderen benutzerdefinierten Metadaten nach Assets suchen

Weitere Informationen zum Erstellen von Aspekttypen und zum Zuweisen von Aspekten zu Firestore, siehe Aspekte verwalten und Metadaten anreichern.

Nach Firestore-Assets suchen

Verwenden Sie die Knowledge Catalog-Suchseite in der Google Cloud Konsole um nach Firestore-Assets zu suchen.

  1. Rufen Sie die Seite Suchen im Knowledge Catalog auf.

    Zur Suche

  2. Klicken Sie im Bereich Filter auf Systeme und wählen Sie dann Firestore aus.

  3. Optional. Unter Typ-Aliase können Sie die Suchergebnisse nach einem bestimmten Typ von Firestore-Asset filtern, indem Sie einen oder mehrere der folgenden Typ-Aliase auswählen:

    • Datenbank
    • Datenbankschema
    • Sonstiges

Sie können das Suchfeld in Knowledge Catalog verwenden, um Keyword-Suchanfragen auszuführen. Sie können beispielsweise system=Firestore AND type=Database eingeben, um alle Firestore-Datenbanken aufzurufen.

Weitere Informationen finden Sie unter Suchsyntax für Knowledge Catalog.

Wenn Sie alle Firestore-Assets aufrufen möchten, geben Sie system=Firestore ein. Sie können bestimmte Keywords eingeben. So rufen Sie beispielsweise alle 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 in das Suchfeld eingeben können, finden Sie unter Suchsyntax für Knowledge Catalog.

Sie können Suchanfragen für bestimmte 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 Firestore-Assets zu identifizieren, das Sie abfragen möchten:

    • firestore-database
    • firestore-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:

  1. Klicken Sie im Bereich Aspekte auf das Menü Weitere Aspekttypen hinzufügen.
  2. Geben Sie Firestore ein und wählen Sie dann einen oder mehrere der folgenden Aspekttypen aus, um die Suchergebnisse auf diesen Typ zu beschränken.
    • Firestore-Datenbank
    • Firestore-Schema
  3. Klicken Sie auf OK.
  4. Klicken Sie in der Ergebnistabelle auf den Namen des Assets, um die Metadaten für dieses Asset aufzurufen.
  5. Optional: Sie können Ihre Assets verbessern oder ansehen. Sie haben folgende Möglichkeiten:
    • Wenn Sie eine Rich-Text-Beschreibung des Assets hinzufügen möchten, klicken Sie unter Übersicht auf Hinzufügen .
    • Wenn Sie dem Asset einen Aspekt zuweisen 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 Firestore

Bei der Suche in natürlicher Sprache (Vorschau) wird KI verwendet, um semantische Abfragen zu verstehen. So können Sie Ressourcen in Alltagssprache finden, ohne dass eine komplexe Syntax erforderlich ist. 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 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 Firestore-Datenbanken aufzurufen.

Weitere Informationen finden Sie unter Suchsyntax für Knowledge Catalog.

Beispielworkflow: Von der Datenbank zum Schema

So gelangen Sie von einer Datenbank zu einem Schema:

  1. Rufen Sie die Seite Suchen im Knowledge Catalog auf.

    Zur Suche

  2. Wählen Sie im Bereich Filter die Option Systeme und dann Firestore aus. Alternativ können Sie system=Firestore in das Suchfeld eingeben.

  3. Wählen Sie eine Datenbank aus.

  4. Klicken Sie auf der Seite Firestore-Details auf den Tab Eintragsliste und dann auf Alle untergeordneten Einträge in der Suche anzeigen.

  5. Klicken Sie auf der Seite Firestore-Datenbankdetails auf den Tab Eintragsliste und dann auf Alle untergeordneten Einträge in der Suche anzeigen. In Knowledge Catalog werden die Sammlungsgruppen in der Datenbank angezeigt.

  6. Wählen Sie einen Namen für die Sammlungsgruppe aus und klicken Sie dann auf der Seite Details zur Sammlungsgruppe auf Schema , um das Schema aufzurufen.

  7. Optional: Wenn Sie einer Datenbank einen Aspekttyp hinzufügen möchten, klicken Sie auf die Schaltfläche Aspekt hinzufügen.

Preise

Für das Speichern von technischen Firestore-Metadaten in Knowledge Catalog fallen keine Gebühren an. Für API-Aufrufe und die zusätzliche Anreicherung von geschäftlichen Metadaten gelten die Standardpreise für Knowledge Catalog. Weitere Informationen finden Sie auf der Knowledge Catalog-Preisseite.

Beschränkungen

  • Abfrageergebnisse werden nach der Aufnahme von 10.000 Sammlungsgruppen abgeschnitten.
  • Bei der Batchaufnahme kann es bis zu 48 Stunden dauern, bis Aktualisierungen Ihrer Datenbank in Knowledge Catalog angezeigt werden.
  • Bei der Live-Aufnahme kann es bis zu 5 Minuten dauern, bis Aktualisierungen Ihrer Datenbank in Knowledge Catalog angezeigt werden.
  • Sammlungsgruppen werden bei der Live-Aufnahme nicht aktualisiert.
  • Sammlungsgruppenschemas werden bei der Live-Aufnahme aktualisiert. Diese Aktualisierung umfasst jedoch nur die ersten 100 primitiven Felder der obersten Ebene in alphabetischer Reihenfolge. Die restlichen Schemainformationen werden 24 bis 48 Stunden nach der Live-Aufnahme aktualisiert.
  • Der Extraktionsvorgang kann einige Minuten dauern.

Nächste Schritte