Data Catalog API-Methoden Knowledge Catalog zuordnen

Data Catalog wurde eingestellt. Wenn Sie programmatische Arbeitsabläufe, Skripts, Clientbibliotheken oder Terraform-Konfigurationen von Data Catalog zu Knowledge Catalog migrieren, müssen Sie Ihren Code aktualisieren, damit die Dataplex API verwendet wird.

In diesem Dokument finden Sie 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 Dataplex API-REST-Dokumentation und der Dataplex API-RPC-Dokumentation.

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 regionenübergreifend verwendet werden können. Sie entsprechen global-Aspekttypen in Knowledge Catalog.
Öffentliches Tag Optionaler Aspekt Öffentliche Tags entsprechen optionalen Aspekten, die an einen Eintrag oder eine Spalte in Knowledge Catalog angehängt sind.
Eintragsgruppe Eintragsgruppe Eintragssammlungen dienen in beiden Diensten als Organisations- und Sicherheitscontainer. Für Google Cloud -Quellen werden automatisch Systemeingabegruppen wie @bigquery pro Projekt eingerichtet.
Benutzerdefinierter Eintrag Benutzerdefinierter Eintrag (mit erforderlichen Aspekten) Standardmäßige benutzerdefinierte Eintragsattribute werden als erforderliche Aspekte modelliert, die durch die EntryType des benutzerdefinierten Eintrags definiert werden.
Eintrag „System“ (Google Cloud) Systemeintrag (mit erforderlichen Aspekten) Metadaten, die integrierte Entitäten (z. B. Schema für BigQuery-Tabellen) beschreiben, 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 in Unterstützte Quellen Google Cloud beschriebenen Quellen. Alle in der Data Catalog-Dokumentation beschriebenen Quellen.
Aufnahme benutzerdefinierter Quellen

Aufnahme in benutzerdefinierte Einträge mit einer durch Eintragstypen definierten Struktur.

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

Aufnahme in generische benutzerdefinierte Einträge.
Metadatenanreicherung

Erfasst mithilfe von Unternehmensglossaren, Aspekten und Aspekttypen.

Eintrag-Links werden unterstützt. Sie können Aspekte direkt an Eintragslinks 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 Quasi-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 durchgeführt, die in Data Catalog erstellt wurden.
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 über die Data Catalog API ab.
Unternehmensglossare Damit können Sie Taxonomien von Geschäftsbegriffen erstellen und sie sowohl Daten-Assets (Einträgen) als auch Spalten zuordnen. Ermöglicht es, Begriffen Spalten zuzuordnen.

Data Catalog API-Methoden Knowledge Catalog zuordnen

In den folgenden Tabellen finden Sie 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 Eintragungsgruppen ist in beiden Diensten einheitlich:

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 von Einträgen, 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 Quellsystemberechtigungen 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:Wenn Sie lookupEntry verwenden möchten, müssen Sie den Namen des Eintrags angeben. Wenn Sie einen BigQuery-SQL-Namen, einen voll qualifizierten Namen oder einen Namen einer verknüpften Ressource in einen Eintrag umwandeln 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. Wenn Sie alle Aspekte für einen einzelnen Eintrag aktualisieren möchten, verwenden Sie UpdateEntry.

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

Hinweis:Bei der Suche in searchEntries wird die Organisation des Anrufers durchsucht. Organisationsübergreifende Suchanfragen müssen für jede Organisation separat gestellt 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

Tag-Vorlagenfelder entsprechen dem Inhalt des Felds metadata_template in einem Aspekttyp. Verwenden Sie UpdateAspectType mit dem 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 Tag-Vorlagenfelder

Ändern Sie die Enumerationswerte, 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 werden direkt in ihren übergeordneten Einträgen oder Eintragslinks gekapselt und 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:Wenn Sie Aspekte in der Antwort filtern möchten, verwenden Sie die Parameter views, aspect_types und paths.

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 werden nicht geändert und erfordern keine Migration. Sie werden weiterhin über den datacatalog.googleapis.com-Endpunkt (Policy Tag Manager-Dienst) bereitgestellt. Die Data Catalog API (datacatalog.googleapis.com) muss in Projekten, in denen die BigQuery-Zugriffssteuerung auf Spaltenebene oder die dynamische Datenmaskierung verwendet wird, aktiviert bleiben.

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 Aspekttypen (die Entsprechungen zu privaten Tags und privaten Tag-Vorlagen in Data Catalog) ist nicht vorhanden. Für alle benutzerdefinierten Aspekttypen unterliegen die IAM-Berechtigungen (Identity and Access Management) 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.
  • Berechtigungsübertragung: Wenn Sie benutzerdefinierte Eintragsgruppen, benutzerdefinierte Einträge, Tag-Vorlagen und Tags aus Data Catalog in Knowledge Catalog importieren, werden die ursprünglichen Berechtigungen nicht übertragen. Sie müssen IAM-Berechtigungen für die importierten Ressourcen konfigurieren. Einen detaillierten Vergleich der alten und neuen Berechtigungen finden Sie unter IAM-Berechtigungen zwischen Data Catalog und Knowledge Catalog zuordnen.
  • Ergebnisse von Sensitive Data Protection-Prüfungen: Das direkte Senden von Ergebnissen von Sensitive Data Protection-Prüfungen an Knowledge Catalog wird nicht unterstützt. Senden Sie stattdessen die Prüfungsergebnisse an Data Catalog und übertragen Sie die Ergebnisse an Knowledge Catalog.
  • Projektübergreifende Auflistung: Das Auflisten von Eintragstypen, Eintragstyp-Links und Aspekttypen über Projekte hinweg in einem einzelnen API-Aufruf wird nicht unterstützt. Anfragen müssen auf ein einzelnes Projekt beschränkt sein.
  • Administratorsuche: Die Administratorsuche (vollständige Trefferquote) wird nicht unterstützt. Stattdessen können Sie Metadaten nach Cloud Storage exportieren und mit BigQuery abfragen.

Nächste Schritte

Leitfaden

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

Konzept

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

Referenz

Sehen Sie sich die REST API-Referenzdokumentation für den Dataplex Catalog-Dienst an.

Referenz

Sehen Sie sich die gRPC API-Referenzdokumentation für den Dataplex Catalog-Dienst an.