Data Catalog API-Methoden Knowledge Catalog zuordnen

Data Catalog wurde eingestellt. Wenn Sie programmatische Workflows, Skripts, Clientbibliotheken oder Terraform-Konfigurationen von Data Catalog zu Knowledge Catalog migrieren, müssen Sie Ihren Code aktualisieren, um die Dataplex API zu verwenden.

Dieses Dokument enthält eine umfassende Zuordnung von Data Catalog-Ressourcen, ‑Funktionen und ‑API-Methoden zu ihren Entsprechungen in der Dataplex API.

Eine detaillierte Anleitung zur Migration finden Sie unter Von Data Catalog auf Knowledge Catalog umstellen. Die API-Referenzdokumentation finden Sie in der REST-Dokumentation zur Dataplex API und in der RPC-Dokumentation zur Dataplex API.

Ressourcenzuordnung

In der folgenden Tabelle wird beschrieben, wie Ressourcen in Data Catalog Ressourcen in Knowledge Catalog entsprechen:

Data Catalog-Ressource Knowledge Catalog-Ressource Beschreibung
Öffentliche Tag-Vorlage Aspekttyp (global) Tag-Vorlagen sind regionale Ressourcen in Data Catalog, die regionsübergreifend verwendet werden können. Sie entsprechen global Aspekt typen in Knowledge Catalog.
Öffentliches Tag Optionaler Aspekt Öffentliche Tags entsprechen optionalen Aspekten, die an einen Eintrag oder Spalte in Knowledge Catalog angehängt sind.
Eintragsgruppe Eintragsgruppe Eintragsgruppen dienen in beiden Diensten als Organisations- und Sicherheitscontainer. Für Google Cloud Quellen werden systemeigene Eintragsgruppen wie @bigquery automatisch pro Projekt eingerichtet.
Benutzerdefinierter Eintrag Benutzerdefinierter Eintrag (mit erforderlichen Aspekten) Standardeigenschaften für benutzerdefinierte Einträge werden als erforderliche Aspekte definiert durch den EntryType des benutzerdefinierten Eintrags.
Systemeintrag (Google Cloud) Systemeintrag (mit erforderlichen Aspekten) Metadaten, die integrierte Entitäten beschreiben (z. B. Schema für BigQuery-Tabellen), werden in erforderlichen Aspekten von systemdefinierten Aspekttypen erfasst.
Unternehmensglossare Unternehmensglossare Taxonomien von Geschäftsbegriffen, die den geschäftlichen Kontext im gesamten Unternehmen standardisieren.

Funktionsvergleich

In der folgenden Tabelle werden die Funktionen zur Metadatenverwaltung von Knowledge Catalog und Data Catalog verglichen:

Funktion Knowledge Catalog Data Catalog
Unterstützte Google Cloud Quellen Alle unter Unterstützte Google Cloud Quellen beschriebenen Quellen. Alle in der Data Catalog-Dokumentation beschriebenen Quellen.
Aufnahme benutzerdefinierter Quellen

Aufnahme in benutzerdefinierte Einträge mit einer verwalteten Struktur, die durch Eintragstypen definiert wird.

Benutzerdefinierte Einträge und Eintragsgruppen aus Data Catalog sind in Knowledge Catalog unter dem generic Eintragstyp verfügbar.

Aufnahme in generische benutzerdefinierte Einträge.
Metadatenanreicherung

Erfasst mit Unternehmensglossaren, Aspekten und Aspekttypen.

Eintragslinks werden unterstützt. Sie können Aspekte direkt an Eintrags Links anhängen.

Erfasst mit Unternehmensglossaren, Tags und Tag-Vorlagen.

Eintragslinks werden nicht unterstützt.

Eintragslinks Unterstützt. Mit integrierten Typen wie synonym, definition, related, und schema-join können Sie Einträge und Spalten verknüpfen. Nicht verfügbar.
Feeds für Metadatenänderungen Benachrichtigungen über Metadatenänderungen in nahezu Echtzeit, die an Pub/Sub gestreamt werden. Nicht verfügbar.
Suchen Die Suche wird in allen unterstützten Google Cloud Quellen, benutzerdefinierten Einträgen, Aspekten und migrierten Data Catalog-Inhalten innerhalb derselben Organisation und desselben VPC Service Controls-Perimeters durchgeführt. Die Suche wird in unterstützten Quellen, benutzerdefinierten Einträgen und Tags erstellt in Data Catalog durchgeführt.
Data Lineage Ruft Eintragsdetails für Asset-Knoten mit der Dataplex API ab. Zeigt angehängte Aspekte in der Google Cloud Console an. Ruft Eintragsdetails mit der Data Catalog API ab.
Unternehmensglossare Ermöglicht das Erstellen von Taxonomien von Geschäftsbegriffen und das Verknüpfen dieser mit Daten-Assets (Einträgen) und Spalten. Ermöglicht das Verknüpfen von Begriffen mit Spalten.

Data Catalog API-Methoden Knowledge Catalog zuordnen

Die folgenden Tabellen enthalten eine Methode-für-Methode-Zuordnung zwischen der Data Catalog API (google.cloud.datacatalog.v1) und der Dataplex API (google.cloud.dataplex.v1.CatalogService).

Eintragsgruppen

Das Konzept der Eintragsgruppen ist in beiden Diensten konsistent:

Data Catalog API-Methode Dataplex API-Methode
projects.locations.entryGroups.create (REST)
CreateEntryGroup (RPC)
projects.locations.entryGroups.create (REST)
CreateEntryGroup (RPC)
projects.locations.entryGroups.get (REST)
GetEntryGroup (RPC)
projects.locations.entryGroups.get (REST)
GetEntryGroup (RPC)
projects.locations.entryGroups.patch (REST)
UpdateEntryGroup (RPC)
projects.locations.entryGroups.patch (REST)
UpdateEntryGroup (RPC)
projects.locations.entryGroups.delete (REST)
DeleteEntryGroup (RPC)
projects.locations.entryGroups.delete (REST)
DeleteEntryGroup (RPC)
projects.locations.entryGroups.list (REST)
ListEntryGroups (RPC)
projects.locations.entryGroups.list (REST)
ListEntryGroups (RPC)

Einträge

Das Konzept der Einträge, die Daten-Assets darstellen, ist in beiden Diensten konsistent:

Data Catalog API-Methode Dataplex API-Methode
projects.locations.entryGroups.entries.create (REST)
CreateEntry (RPC)
projects.locations.entryGroups.entries.create (REST)
CreateEntry (RPC)
projects.locations.entryGroups.entries.get (REST)
GetEntry (RPC)
projects.locations.entryGroups.entries.get (REST)
GetEntry (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

Hinweis: Sie können auch die Methoden projects.locations.modifyEntry (REST) und ModifyEntry (RPC) verwenden, um Systemeinträge mit Berechtigungen des Quellsystems anstelle von Katalogberechtigungen zu aktualisieren.

projects.locations.entryGroups.entries.delete (REST)
DeleteEntry (RPC)
projects.locations.entryGroups.entries.delete (REST)
DeleteEntry (RPC)
projects.locations.entryGroups.entries.list (REST)
ListEntries (RPC)
projects.locations.entryGroups.entries.list (REST)
ListEntries (RPC)
entries.lookup (REST)
LookupEntry (RPC)
projects.locations.lookupEntry (REST)
LookupEntry (RPC)

Hinweis:Um lookupEntry zu verwenden, müssen Sie den Eintragsnamen angeben. Wenn Sie einen BigQuery-SQL-Namen, einen voll qualifizierten Namen oder einen verknüpften Ressourcennamen in einen Eintragsnamen übersetzen möchten, rufen Sie zuerst projects.locations.searchEntries (REST) oder SearchEntries (RPC) auf.

projects.locations.entryGroups.entries.modifyEntryContacts (REST)
ModifyEntryContacts (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

Hinweis:Verwenden Sie update_mask, um nur den Aspekt contacts zu ändern.

projects.locations.entryGroups.entries.modifyEntryOverview (REST)
ModifyEntryOverview (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

Hinweis:Verwenden Sie update_mask, um nur den Aspekt overview zu ändern.

projects.locations.entryGroups.entries.tags.reconcile (REST)
ReconcileTags (RPC)
projects.locations.metadataJobs.create (REST)
CreateMetadataJob (RPC),
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

Hinweis:Verwenden Sie CreateMetadataJob mit dem Importjobtyp, um Metadateninhalte für mehrere Einträge im Batch zu importieren. Verwenden Sie UpdateEntry, um alle Aspekte für einen einzelnen Eintrag zu aktualisieren.

catalog.search (REST)
SearchCatalog (RPC)
projects.locations.searchEntries (REST)
SearchEntries (RPC)

Hinweis:searchEntries sucht innerhalb der Organisation des Aufrufers. Suchen über mehrere Organisationen hinweg müssen für jede Organisation separat ausgeführt werden.

Tag-Vorlagen und Aspekttypen

Aspekttypen sind der Nachfolger von Data Catalog-Tag-Vorlagen:

Data Catalog API-Methode Dataplex API-Methode
projects.locations.tagTemplates.create (REST)
CreateTagTemplate (RPC)
projects.locations.aspectTypes.create (REST)
CreateAspectType (RPC)
projects.locations.tagTemplates.get (REST)
GetTagTemplate (RPC)
projects.locations.aspectTypes.get (REST)
GetAspectType (RPC)
projects.locations.tagTemplates.patch (REST)
UpdateTagTemplate (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)
projects.locations.tagTemplates.delete (REST)
DeleteTagTemplate (RPC)
projects.locations.aspectTypes.delete (REST)
DeleteAspectType (RPC)
catalog.search (REST) mit type=tag_template
SearchCatalog (RPC) mit type=tag_template
projects.locations.aspectTypes.list (REST)
ListAspectTypes (RPC)

Felder für Tag-Vorlagen

Felder für Tag-Vorlagen entsprechen dem Inhalt des Felds metadata_template in einem Aspekttyp. Verwenden Sie UpdateAspectType mit der geänderten metadata_template, um Felder zu erstellen, zu aktualisieren, umzubenennen oder zu löschen:

Data Catalog API-Methode Dataplex API-Methode
projects.locations.tagTemplates.fields.create (REST)
CreateTagTemplateField (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)
projects.locations.tagTemplates.fields.patch (REST)
UpdateTagTemplateField (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)
projects.locations.tagTemplates.fields.rename (REST)
RenameTagTemplateField (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)
projects.locations.tagTemplates.fields.delete (REST)
DeleteTagTemplateField (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)

Enum-Werte für Felder für Tag-Vorlagen

Ändern Sie Enum-Werte, indem Sie das Feld metadata_template im entsprechenden Aspekttyp aktualisieren:

Data Catalog API-Methode Dataplex API-Methode
projects.locations.tagTemplates.fields.enumValues.rename (REST)
RenameTagTemplateFieldEnumValue (RPC)
projects.locations.aspectTypes.patch (REST)
UpdateAspectType (RPC)

Tags und Aspekte

Aspekte sind der Nachfolger von Data Catalog-Tags. Aspekte sind direkt in ihren übergeordneten Einträgen oder Eintragslinks enthalten und werden mit der Methode UpdateEntry mit update_mask verwaltet:

Data Catalog API-Methode Dataplex API-Methode
projects.locations.entryGroups.entries.tags.create (REST)
CreateTag (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)
projects.locations.entryGroups.entries.tags.list (REST)
ListTags (RPC)
projects.locations.entryGroups.entries.get (REST)
GetEntry (RPC)

Hinweis:Verwenden Sie die Parameter views, aspect_types und paths, um Aspekte in der Antwort zu filtern.

projects.locations.entryGroups.entries.tags.patch (REST)
UpdateTag (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)
projects.locations.entryGroups.entries.tags.delete (REST)
DeleteTag (RPC)
projects.locations.entryGroups.entries.patch (REST)
UpdateEntry (RPC)

Richtlinien-Tags und ‑Taxonomien

Die APIs für Richtlinien-Tags und ‑Taxonomien ändern sich nicht und müssen nicht migriert werden.

In Knowledge Catalog nicht unterstützte Funktionen

Die folgenden Data Catalog-Verhaltensweisen und ‑Funktionen werden in Knowledge Catalog nicht unterstützt oder funktionieren anders:

  • Private Aspekttypen: Das Konzept privater Aspekte und privater Aspekt typen (die Entsprechungen von privaten Tags und privaten Tag-Vorlagen in Data Catalog) ist nicht vorhanden. Alle benutzerdefinierten Aspekttypen unterliegen den IAM-Berechtigungen für Projekte und Eintragsgruppen.
  • Suche nach Richtlinien-Tags: Die Suche nach Richtlinien-Tags mit den Prädikaten policytag oder policytagid wird in der Katalogsuchfunktion nicht unterstützt.
  • Übertragung von Berechtigungen: Wenn Sie benutzerdefinierte Eintragsgruppen, benutzerdefinierte Einträge, Tag-Vorlagen und Tags aus Data Catalog in Knowledge Catalog importieren, werden ihre ursprünglichen Berechtigungen nicht übernommen. Sie müssen IAM-Berechtigungen konfigurieren für die importierten Ressourcen. Einen detaillierten Vergleich der Legacy- und Ersatzberechtigungen finden Sie unter IAM-Berechtigungen zwischen Data Catalog und Knowledge Catalog zuordnen.
  • Sensitive Data Protection-Prüfergebnisse: Das Senden von Sensitive Data Protection-Prüfergebnissen direkt an Knowledge Catalog wird nicht unterstützt. Senden Sie stattdessen die Überprüfungsergebnisse an Data Catalog und übertragen Sie sie zu Knowledge Catalog.
  • Projektübergreifende Auflistung von Typen: Das Auflisten von Eintragstypen, Eintragslinktypen und Aspekttypen in mehreren Projekten in einem einzigen API-Aufruf wird nicht unterstützt. Anfragen müssen auf ein einzelnes Projekt beschränkt sein.
  • Administratorsuche: Die Administratorsuche (vollständiger Abruf) wird nicht unterstützt. Exportieren Sie stattdessen Metadaten nach Cloud Storage und fragen Sie sie mit BigQuery ab.

Nächste Schritte

Anleitung

Schritt-für-Schritt-Anleitung zum Migrieren von Tag-Vorlagen, benutzerdefinierten Einträgen und Workflows.

Konzept

Informationen zum flexiblen Metamodell und zum Active Context Graph von Knowledge Catalog.

Referenz

Referenzdokumentation zur REST API für den Dataplex Catalog-Dienst.

Referenz

Referenzdokumentation zur gRPC API für den Dataplex Catalog-Dienst.