Aspekte verwalten und Metadaten anreichern

In diesem Dokument wird beschrieben, wie Sie Aspekttypen erstellen und verwalten und Einträge mit Aspekten annotieren.

Dataplex Catalog beschreibt die Einträge nach einer Reihe von Aspekten. Mithilfe von Aspekten und Aspekttypen können Sie Ihre Einträge mit zusätzlichen Metadaten beschreiben.

Weitere Informationen finden Sie in der Dataplex Catalog-Übersicht.

Aspekte

Mit Aspekten können Sie Metadaten in Einträgen erfassen. Hinzufügen von Aspekten zu einem Eintrag liefert für alle, die das Asset verwenden müssen, einen aussagekräftigen Kontext. Sie können Aspekte verwenden, um Geschäftsmetadaten (z. B. Datenklassifizierung) und technische Metadaten (z. B. Schema) zu speichern.

Aspekte werden als Teile der Eintragsressource und nicht als separate Aspekte betrachtet Ressourcen. Wenn Sie einen Aspekt ändern, müssen Sie den Eintrag mit den Aspekt berücksichtigen.

Sie können Aspekte für die Beschreibung eines Eintrags auf Einstiegsebene oder auf Spaltenebene zum Beschreiben einer Spalte in einem Eintrag.

Jeder Aspekt ist eine Instanz eines Aspekttyps. Ein Aspekttyp definiert eine Vorlage für seine Aspekte. Jeder Aspekttyp enthält eine Reihe von Feldern. Wenn Sie Aspekte erstellen, müssen Sie Werte für diese Felder angeben.

Jedem Eintrag kann höchstens ein Aspekt zugeordnet sein. und zwar pro Aspekttyp. Es können mehrere Aspekte mit Eintragsspalten verknüpft sein und zwar pro Aspekttyp.

Kategorien von Aspekten

Aspekte sind wie folgt kategorisiert:

  • Erforderliche Aspekte: Aspekte, die beim Erstellen eines Eintrags obligatorisch sind. Diese Aspekte werden durch den Eintragstyp eines bestimmten Eintrags definiert. Alle Einträge, die zu einem Eintragstyp gehören, müssen immer alle erforderlichen Aspekte haben, die für diesen Eintragstyp definiert sind.

    Dataplex verwaltet die erforderlichen Aspekte (z. B. das Schema) für Systemeinträge.

    Wichtige Hinweise:

    • Sie können erforderliche Aspekte nur mit Einträgen verknüpfen und nicht mit den Spalten eines Eintrags.

    • Sie können die erforderlichen Aspekte aus einem Eintrag nicht löschen.

    • Sie können die erforderlichen Aspekte von Systemeinträgen lesen, sie aber nicht ändern.

  • Optionale Aspekte: Sie können optionale Aspekte mit Einträgen oder mit Eintragsspalten. Sie können optionale Aspekte entweder beim Eintragen oder später durch Aktualisieren des Eintrags.

    Sie können optionale Aspekte löschen, nachdem sie eingefügt wurden.

Aspekttypen

Aspekttypen sind wiederverwendbare Ressourcen, die Vorlagen für Aspekte bereitstellen.

Kategorien von Aspekttypen

Aspekttypen sind so kategorisiert:

  • Benutzerdefinierte Aspekttypen: Aspekttypen, die Sie in Dataplex-Katalog.

  • Systemaspekttypen: Aspekttypen, die Dataplex bereitstellt, verwendet, und verwaltet.

    Systemaspekttypen werden weiter in wiederverwendbar und eingeschränkt unterteilt. In der folgenden Tabelle werden die Kategorien von Systemaspekttypen und die Liste der Aspekttypen beschrieben, die Dataplex für jede der Kategorien bereitstellt:

    Kategorie des Systemaspekttyps Beschreibung Von Dataplex bereitgestellte Aspekttypen
    Wiederverwendbarer Systemaspekttyp Sie können diese Aspekttypen verwenden, um Aspekte zu erstellen oder zu ändern.
    • generic
    • storage
    Typ des eingeschränkten Systemaspekts Dataplex verwaltet diese Aspekttypen.
    Sie können Aspekte unter diesen Aspekttypen lesen, aber keine Elemente erstellen oder bearbeiten Aspekte unter diesen Aspekttypen.
    • bigquery-connection
    • bigquery-dataset
    • bigquery-model
    • bigquery-routine
    • bigquery-table
    • bigquery-view
    • cloudsql-database
    • cloudsql-instance
    • cloudsql-schema
    • cloudsql-table
    • cloudsql-view
    • storage
    • sql-access
    • storage-bucket
    • storage-folder

    Sie können benutzerdefinierte Aspekttypen an einem bestimmten regionalen Standort oder als globale Ressource. Systemaspekttypen sind immer global. Der Standort eines wirkt sich auf den Umfang seiner Anwendbarkeit aus. Weitere Informationen finden Sie unter Projekt- und Standorteinschränkungen.

Hinweis

Bevor Sie Aspekte und Aspekttypen erstellen und verwalten, müssen Sie die in diesem Abschnitt beschriebenen Aufgaben ausführen.

Erforderliche Rollen

So erhalten Sie die Berechtigungen, die Sie zum Erstellen und Verwalten von Aspekttypen und Aspekten benötigen: bitten Sie Ihren Administrator, Ihnen folgende IAM-Rollen für die Ressource:

  • Vollständiger Satz von Berechtigungen für alle Dataplex Catalog-Ressourcen, einschließlich Aspekttypen: Dataplex-Katalogadministrator (roles/dataplex.catalogAdmin)
  • Alle Dataplex Catalog-Ressourcen einschließlich Aspekttypen erstellen und verwalten: Dataplex Catalog Editor (roles/dataplex.catalogEditor)
  • Vollständiger Satz von Berechtigungen für benutzerdefinierte Aspekttypen (mit Ausnahme von Berechtigungen zum Verwenden von Aspekttypen zum Erstellen oder Bearbeiten von Einträgen): Inhaber von Dataplex-Aspekttypen (roles/dataplex.aspectTypeOwner)
  • Sie können sich die zugehörigen Aspekttypen und IAM-Richtlinien ansehen: Dataplex Catalog Viewer (roles/dataplex.catalogViewer)
  • Verwenden Sie Aspekttypen, um Einträge mit den entsprechenden Aspekten zu erstellen und zu ändern: Dataplex-Aspekttyp-Nutzer (roles/dataplex.aspectTypeUser)
  • Fügen Sie Aspekte einiger Systemaspekttypen hinzu, z. B. schema, overview, contacts: Inhaber von Dataplex-Einträgen (roles/dataplex.entryOwner)

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Weitere Informationen finden Sie unter Dataplex-IAM-Rollen

API aktivieren

Aktivieren Sie die Dataplex API in Ihrem Dataplex-Projekt.

API aktivieren

Aspekttyp erstellen

Console

  1. Rufen Sie in der Google Cloud Console die Seite Dataplex-Katalog auf.

    Zum Katalog

  2. Klicken Sie auf den Tab Aspekttypen > Benutzerdefiniert.

  3. Geben Sie im Abschnitt Details Folgendes ein:

    1. Optional: Geben Sie im Feld Anzeigename einen Namen für den Aspekt ein. Typ.
    2. Geben Sie im Feld Aspect-Typ-ID eine eindeutige ID für den Aspekttyp ein.
    3. Optional: Geben Sie im Feld Beschreibung eine Beschreibung für den Aspekttyp ein.
    4. Wählen Sie im Feld Ort einen Ort für den Aspekttyp aus. Sie können die Position eines Aspekttyps nach dem Erstellen nicht mehr ändern.

  4. Optional: Definieren Sie eine Vorlage für Ihren Aspekttyp.

    Klicken Sie unter Vorlagen auf Feld hinzufügen. Gehen Sie im Abschnitt Neues Feld so vor: geben Sie Folgendes ein:

    1. Geben Sie im Feld Name einen Namen ein.
    2. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen ein.
    3. Optional: Geben Sie im Feld Beschreibung eine Beschreibung ein.

    4. Wählen Sie im Feld Typ einen Datentyp für das Feld aus. Je nach Auswahl werden die nächsten Felder und Optionen angezeigt:

      • Wenn Sie Text als Datentyp ausgewählt haben, gehen Sie so vor:

        1. Wählen Sie im Feld Texttyp die gewünschte Textart aus.
        2. Geben Sie im Feld Textwerte einen Hinweis für das Textfeld ein. Klicken Sie dazu auf Wert hinzufügen und geben Sie den Hinweis ein. Sie können einem Textfeld mehrere Hinweise hinzufügen.
        3. Klicken Sie auf Fertig.

      • Wenn Sie als Datentyp Enum ausgewählt haben, fügen Sie einen enum-Wert hinzu:

        1. Klicken Sie auf Enum-Wert hinzufügen.
        2. Geben Sie im Feld Wert einen ENUM-Wert ein. Sie können mehrere enum-Werte hinzufügen.
        3. Klicken Sie auf Fertig.

      • Wenn Sie Array als Datentyp ausgewählt haben, definieren Sie im Abschnitt Arrayelement die Arten von Elementen, die im Array vorhanden sein sollen:

        1. Klicken Sie auf Arrayelement hinzufügen.
        2. Geben Sie im Feld Name einen Namen für die Arrayelemente ein.
        3. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen ein. für die Array-Elemente.
        4. Optional: Geben Sie in das Feld Beschreibung eine Beschreibung für Array-Elemente.

        5. Wählen Sie im Feld Typ einen Datentyp für die Arrayelemente aus.

          Basierend auf Ihrer Auswahl werden die nächsten Felder und Optionen angezeigt werden. Sie ähneln den für die Datentypen Text, Enum, Map, Array und Record (Aufnehmen) an anderer Stelle in diesem Abschnitt.

        6. Klicken Sie auf Fertig.

      • Wenn Sie als Datentyp Karte ausgewählt haben, geben Sie im Feld Kartenwert -Abschnitt, definieren Sie die Typen von Werten, die in der Zuordnung vorhanden sein sollen:

        1. Klicken Sie auf Zuordnungswert hinzufügen.
        2. Geben Sie im Feld Name einen Namen für die Karte ein.
        3. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen ein. für die Karte.
        4. Optional: Geben Sie im Feld Beschreibung eine Beschreibung für die Karte ein.

        5. Wählen Sie im Feld Typ einen Datentyp für die Karte aus.

          Basierend auf Ihrer Auswahl werden die nächsten Felder und Optionen angezeigt werden. Sie ähneln den für die Datentypen Text, Enum, Map, Array und Record (Aufnehmen) an anderer Stelle in diesem Abschnitt.

        6. Klicken Sie auf Fertig.

      • Wenn Sie Eintrag als Datentyp ausgewählt haben, geben Sie Folgendes ein:

        1. Geben Sie im Feld Eintrags-ID eine eindeutige ID ein, mit der andere Eintragsfelder auf diesen Eintrag verweisen können. Weitere Informationen finden Sie im Abschnitt Beispiel für die Verwendung der Felder „Eintrags-ID“ und „Eintragsreferenz“ dieses Dokuments.
        2. Optional: Wenn Sie einen Verweis auf einen anderen Datensatz aus verwenden Sie das Feld Record Reference (Eintragsverweis). Sie können diesen Wert nicht mehr ändern, nachdem Sie den Aspekttyp erstellt haben. Weitere Informationen finden Sie unter Beispiel für die Verwendung der Felder „Eintrags-ID“ und „Eintragsverweis“ dieses Dokuments.

        3. Im Bereich Eintragsfelder können Sie ein komplexes Objekt definieren. mit mehreren verschachtelten Feldern. Klicken Sie dazu auf Eintragselement für Feld hinzufügen und geben Sie Folgendes an:

          1. Geben Sie im Feld Name einen Namen für das Eintragsfeld ein.
          2. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen für das Datensatzfeld ein.
          3. Optional: Geben Sie in das Feld Beschreibung eine Beschreibung für das Feld „Record“ (Eintrag) ein.

          4. Wählen Sie im Feld Typ einen Datentyp aus.

            Basierend auf Ihrer Auswahl werden die nächsten Felder und Optionen angezeigt werden. Sie ähneln den für die Datentypen Text, Enum, Map, Array und Record weiter.

        4. Klicken Sie auf Fertig.

    5. Wenn das Feld für einen Aspekt dieses Typs obligatorisch sein soll, wählen Sie Erforderlich aus. Weitere Informationen zu erforderlichen und optionalen Aspekten finden Sie im Abschnitt Kategorien von Aspekten dieses Dokuments.

    6. Klicken Sie auf Fertig.

    7. Wenn Sie mehrere Felder hinzufügen möchten, klicken Sie auf Feld hinzufügen und wiederholen Sie die vorherigen Schritte.

  5. Optional: Fügen Sie im Abschnitt Labels beliebige Labels als Schlüssel/Wert-Paare hinzu. Paaren zu Ihren Ressourcen:

    1. Klicken Sie auf Label hinzufügen.
    2. Geben Sie im Feld Schlüssel einen Schlüssel ein.
    3. Geben Sie im Feld Wert einen Wert für den Schlüssel ein.
    4. Wenn Sie weitere Labels hinzufügen möchten, klicken Sie auf Label hinzufügen und wiederholen Sie die Schritte.

  6. Klicken Sie auf Speichern.

Nachdem Sie einen Aspekttyp erstellt haben, können Sie den Einträgen Aspekte hinzufügen.

REST

Verwenden Sie zum Erstellen eines neuen Aspekttyps den aspectType.create .

Beispiel für die Verwendung der Felder „Eintrags-ID“ und „Eintragsverweis“

Sie können die Felder Eintrags-ID und Eintragsreferenz für rekursive Referenzen. Das folgende Beispiel zeigt, wie diese Felder verwendet werden:

Sehen Sie sich den Aspekttyp Employee mit den folgenden Feldern an:

  • Name (Typ:Text)
  • Startdatum (Typ:Date & time)
  • Kennzeichnung (Typ:Text)
  • Aktuelle Adresse (Typ:Record)
  • Staatliche Anschrift (Typ:Record)

Die beiden Adressfelder Aktuelle Adresse und Wohnanschrift haben denselben Datentyp Record. Um Duplikate zu vermeiden, können Sie beim Definieren dieser Felder die Werte für Record ID und Record reference festlegen.

Wenn Sie das Feld Aktuelle Adresse definieren, können Sie die Eintrags-ID so angeben: address-field Für die Wohnanschrift können Sie denselben Wert (address-field) für die Referenz des Datensatzes angeben. Beispiel:

  • Name (Typ:Text)
  • Startdatum (Typ:Date & time)
  • Bezeichnung (Typ:Text)
  • Aktuelle Adresse (Typ:Record, Datensatz-ID:address-field)
  • Ständige Anschrift (Typ:Record, Datensatzreferenz:address-field)

So müssen Sie die Felder einer anderen Adresse nicht duplizieren.

Einträgen Aspekte hinzufügen

Nachdem Sie einen Aspekttyp erstellt haben, können Sie Aspekte erstellen. dieses Typs. Wenn Sie einem Eintrag Aspekte hinzufügen möchten, müssen Sie ihn aktualisieren, da Aspekte in Einträgen gespeichert werden.

Wichtige Hinweise:

  • Sie können einem Eintrag oder den Spalten eines Eintrags Aspekte hinzufügen.
  • Sie können die erforderlichen Aspekte nur für benutzerdefinierte Einträge bearbeiten. Die erforderlichen Aspekte können nicht gelöscht werden.

  • Sie können die optionalen Aspekte sowohl für benutzerdefinierte als auch für Systemeinträge bearbeiten und löschen.

Console

  1. Rufen Sie in der Google Cloud Console die Seite der Dataplex-Suche auf.

    Zur Suche

  2. Wählen Sie unter Suchplattform auswählen die Option Dataplex-Katalog als Suchmodus.

  3. Suchen Sie nach dem Eintrag, dem Sie Aspekte hinzufügen möchten, und klicken Sie darauf.

    Die Seite mit den Eintragsdetails wird geöffnet.

  4. So fügen Sie Aspekte zu einem Eintrag hinzu:

    1. Klicken Sie auf der Seite mit den Eintragsdetails auf den Tab Details.
    2. Wenn Sie dem Eintrag erforderliche oder optionale Aspekte hinzufügen möchten, klicken Sie im Abschnitt Aspekte für die jeweilige Kategorie auf  Hinzufügen.
      Sie können die erforderlichen Aspekte nicht hinzufügen, wenn der Eintragstyp der ausgewählten Für den Eintrag sind keine erforderlichen Aspekte definiert.
    3. Suchen Sie nach dem Aspekt, den Sie hinzufügen möchten, und wählen Sie ihn aus.
    4. Geben Sie im Fenster Aspekt hinzufügen die Werte für die Felder ein.
    5. Klicken Sie auf Speichern.

  5. So fügen Sie einer Spalte eines Eintrags Aspekte hinzu:

    1. Klicken Sie auf der Seite mit den Eintragsdetails auf den Tab Schema.
    2. Wählen Sie die Spalten aus, denen Sie Aspekte hinzufügen möchten.
    3. Klicken Sie auf Aspekt hinzufügen.
    4. Suchen Sie nach dem Aspekt, den Sie hinzufügen möchten, und wählen Sie ihn aus.
    5. Geben Sie im Fenster Aspekt hinzufügen die Werte für die Felder ein.
    6. Klicken Sie auf Speichern.

REST

Mit der Methode entry.patch können Sie einem Eintrag oder einer Spalte eines Eintrags Aspekte hinzufügen.

Das Erstellen und Verwenden von Aspekten in einem Eintrag, bei dem sich der jeweilige Aspekttyp und der Eintrag in verschiedenen Google Cloud-Organisationen befinden, wird nicht unterstützt.

Vorhandene Aspekte für einen Eintrag verwalten

In diesem Abschnitt wird beschrieben, wie Sie die vorhandenen Aspekte für einen Eintrag aktualisieren und löschen.

Aspekt aktualisieren

Sie können die optionalen Aspekte sowohl für benutzerdefinierte Einträge als auch für Systemeinträge bearbeiten. Sie können die erforderlichen Aspekte nur für benutzerdefinierte Einträge bearbeiten.

Console

  1. Rufen Sie in der Google Cloud Console die Seite der Dataplex-Suche auf.

    Zur Suche

  2. Wählen Sie unter Suchplattform auswählen die Option Dataplex-Katalog als Suchmodus.

  3. Suchen Sie nach dem Eintrag, dessen Aspekte Sie aktualisieren möchten, und klicken Sie darauf.

    Die Seite mit den Eintragsdetails wird geöffnet.

  4. Klicken Sie auf den Tab Details.

  5. Klicken Sie für den Aspekt, den Sie aktualisieren möchten, auf Bearbeiten.

  6. Aktualisieren Sie im Fenster Aspekt bearbeiten die Pflichtfelder.

  7. Klicken Sie auf Speichern.

REST

Um Aspekte für einen Eintrag oder eine Spalte eines Eintrags zu aktualisieren, verwenden Sie die Methode entry.update .

Aspekt löschen

Console

  1. Rufen Sie in der Google Cloud Console die Seite der Dataplex-Suche auf.

    Zur Suche

  2. Wählen Sie unter Suchplattform auswählen die Option Dataplex Catalog als Suchmodus aus.

  3. Suchen Sie nach dem Eintrag, dessen Aspekte Sie löschen möchten, und klicken Sie auf den Eintrag.

    Die Seite mit den Eintragsdetails wird geöffnet.

  4. Klicken Sie auf den Tab Details.

  5. Klicken Sie für den Aspekt, den Sie löschen möchten, auf Löschen.

  6. Klicken Sie auf Bestätigen.

REST

Um einen Aspekt für einen Eintrag zu löschen, verwenden Sie den entry.update .

Aspekttypen verwalten

In diesem Abschnitt wird beschrieben, wie Sie Aspekttypen aufrufen, aktualisieren und löschen.

Liste der verfügbaren Aspekttypen ansehen

Console

  1. Rufen Sie in der Google Cloud Console die Dataplex-Seite Katalog auf.

    Zum Katalog

  2. Klicken Sie auf den Tab Aspekttypen.

    Sie können auf die Liste der benutzerdefinierten Aspekt- und Systemaspekttypen zugreifen. Weitere Informationen finden Sie im Abschnitt Kategorien von Aspekttypen dieses Dokuments.

    Auf dem Tab Benutzerdefiniert sind die Aspekttypen mit dem Suffix (Data Catalog) die Tag-Vorlagen, die aus Data Catalog migriert werden.

  3. Um die Liste der Aspekttypen projektübergreifend aufzurufen, klicken Sie auf das Benutzerdefiniert und klicken Sie dann auf die Ein/Aus-Schaltfläche Aus allen Projekten anzeigen, um auf „Ein“.

REST

Verwenden Sie die Methode aspectTypes.list, um alle verfügbaren Aspekttypen aufzulisten.

Details zu einem Aspekttyp ansehen

Console

  1. Rufen Sie in der Google Cloud Console die Dataplex-Seite Katalog auf.

    Zum Katalog

  2. Klicken Sie auf den Tab Aspekttypen.

  3. Klicken Sie auf den Aspekttyp.

    Die Seite mit den Details zum Aspekttyp wird geöffnet. Sie können sich Informationen wie den Anzeigenamen, die ID des Aspekttyps, die Beschreibung, die Projekt-ID, den Speicherort, die Labels, das Erstellungsdatum und das Datum der letzten Änderung des ausgewählten Aspekttyps ansehen.

  4. Klicken Sie auf den Tab Vorlage, um die Struktur des ausgewählten Aspekttyps aufzurufen.

  5. So rufen Sie die Liste der zehn verwandten Einträge auf, die kürzlich erstellt wurden: Klicken Sie auf den Tab Beispieleinträge.

  6. Um nach allen ähnlichen Einträgen zu suchen, klicken Sie auf Alle zugehörigen Einträge in der Google Suche anzeigen Diese Schaltfläche wird nur angezeigt, wenn Es gibt mindestens einen zugehörigen Eintrag.

REST

Um die Details eines Aspekttyps abzurufen, verwenden Sie den aspectTypes.get .

Aspekttyp aktualisieren

Sie können den Anzeigenamen, die Beschreibung, die Vorlagenfelder und die Labels eines Aspekttyps aktualisieren. Vorhandene Felder in einer Vorlage können nicht gelöscht werden.

Sie können die Aspekttyp-ID und den Standort nicht mehr aktualisieren, nachdem Sie den Aspekttyp.

Console

  1. Rufen Sie in der Google Cloud Console die Dataplex-Seite Katalog auf.

    Zum Katalog

  2. Klicken Sie auf den Tab Aspekttypen.

  3. Klicken Sie auf den Aspekttyp, den Sie aktualisieren möchten.

  4. Klicken Sie auf der Seite Details zum Aspekttyp auf Bearbeiten.

  5. Anzeigenamen, Beschreibung, Vorlagenfelder und Labels bearbeiten wie erforderlich.

  6. Optional: So kennzeichnen Sie ein Feld im Aspekttyp als eingestellt:

    1. Maximieren Sie das Feld im Abschnitt Vorlage.
    2. Wählen Sie Is Deprecated (Ist eingestellt) aus.
    3. Geben Sie in das Feld Grund für die Einstellung einen Grund ein. wird das ausgewählte Feld verworfen.
    4. Klicken Sie auf Fertig.

  7. Klicken Sie auf Speichern.

REST

Verwenden Sie die Methode aspectTypes.patch, um einen vorhandenen Aspekttyp zu aktualisieren.

Aspekttyp löschen

Console

  1. Rufen Sie in der Google Cloud Console die Dataplex-Seite Katalog auf.

    Zum Katalog

  2. Klicken Sie auf den Tab Aspekttypen.

  3. Klicken Sie auf den Aspekttyp, den Sie löschen möchten.

  4. Klicken Sie auf der Seite Details zum Aspekttyp auf Löschen. Bestätigen, wann werden.

REST

Verwenden Sie zum Löschen eines vorhandenen Aspekttyps den aspectTypes.delete .

Nächste Schritte