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. Sie können Ihre Einträge mithilfe von Aspekten und Aspekttypen mit zusätzlichen Metadaten beschreiben.

Weitere Informationen finden Sie in der Übersicht zu Dataplex-Katalog.

Aspekte

Mithilfe von Aspekten können Sie Metadaten in Einträgen erfassen. Das Hinzufügen von Aspekten zu einem Eintrag hilft, jedem, der das Asset verwenden muss, einen aussagekräftigen Kontext zu liefern. Sie können Aspekte verwenden, um geschäftliche Metadaten (z. B. Datenklassifizierung) und technische Metadaten (z. B. Schema) zu speichern.

Aspekte werden als Teile der Eintragsressource und nicht als separate Ressourcen betrachtet. Wenn Sie einen Aspekt ändern, muss auch der Eintrag geändert werden, der den Aspekt enthält.

Sie können Aspekte zum Beschreiben eines Eintrags auf der Eintragsebene und zum Beschreiben einer Spalte in einem Eintrag auf Spaltenebene angeben.

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 maximal ein Aspekt pro Aspekttyp zugeordnet sein. Sie können mehrere Aspekte mit Eintragsspalten pro Aspekttyp verknüpfen.

Kategorien von Aspekten

Aspekte sind wie folgt kategorisiert:

  • Erforderliche Aspekte: Aspekte, die bei der Erstellung eines Eintrags obligatorisch sind. Solche 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 durch diesen Eintragstyp definiert werden.

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

    Wichtige Hinweise:

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

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

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

  • Optionale Aspekte: Sie können optionale Aspekte mit Einträgen oder Eintragspalten verknüpfen. Sie können optionale Aspekte entweder beim Erstellen des Eintrags oder später festlegen, indem Sie den Eintrag aktualisieren.

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

Aspekttypen

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

Kategorien von Aspekttypen

Aspekttypen sind so kategorisiert:

  • Benutzerdefinierte Aspekttypen: Aspekttypen, die Sie in Dataplex Catalog erstellen.

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

    Systemaspekttypen werden weiter in die Kategorien wiederverwendbar und eingeschränkt kategorisiert. 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
    Eingeschränkter Systemaspekttyp Dataplex verwaltet diese Aspekttypen.
    Sie können Aspekte unter diesen Aspekttypen lesen, aber keine Aspekte unter diesen Aspekttypen erstellen oder bearbeiten.
    • 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

    Verwenden Sie nicht die Systemaspekttypen overview, contacts und schema.

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

Hinweise

Bevor Sie Aspekttypen und Aspekte erstellen und verwalten, führen Sie die in diesem Abschnitt beschriebenen Aufgaben aus.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für die Ressource zu gewähren, um die Berechtigungen zu erhalten, die Sie zum Erstellen und Verwalten von Aspekttypen und Aspekten benötigen:

  • Vollständiger Satz von Berechtigungen für alle Dataplex Catalog-Ressourcen, einschließlich Aspekttypen: Dataplex Catalog-Administrator (roles/dataplex.catalogAdmin)
  • Alle Dataplex Catalog-Ressourcen erstellen und verwalten, einschließlich der Aspekttypen: Dataplex Catalog-Bearbeiter (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)
  • Zugehörige Aspekttypen und IAM-Richtlinien ansehen: Dataplex Catalog-Betrachter (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 verwalten.

Möglicherweise können Sie 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 Dataplex-Seite 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 Aspekttyp ein.
    2. Geben Sie im Feld Aspekttyp-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. Geben Sie im Abschnitt Neues Feld 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 als Datentyp Text 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 mehrere Hinweise für ein Textfeld 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 als Datentyp Array ausgewählt haben, definieren Sie im Abschnitt Arrayelement die Elementtypen, die im Array vorhanden sein sollen:

        1. Klicken Sie auf Array-Element hinzufügen.
        2. Geben Sie im Feld Name einen Namen für die Arrayelemente ein.
        3. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen für die Arrayelemente ein.
        4. Optional: Geben Sie im Feld Beschreibung eine Beschreibung für die Arrayelemente ein.
        5. Wählen Sie im Feld Typ einen Datentyp für die Arrayelemente aus.

          Abhängig von Ihrer Auswahl werden die nächsten Felder und Optionen angezeigt. Sie ähneln den Optionen, die an anderer Stelle in diesem Abschnitt für die Datentypen Text, Enum, Map, Array und Record beschrieben werden.

        6. Klicken Sie auf Fertig.

      • Wenn Sie als Datentyp Map ausgewählt haben, definieren Sie im Abschnitt Map value die Typen der Werte, die in der Karte vorhanden sein sollen:

        1. Klicken Sie auf Kartenwert hinzufügen.
        2. Geben Sie im Feld Name einen Namen für die Karte ein.
        3. Optional: Geben Sie im Feld Anzeigename einen Anzeigenamen für die Karte ein.
        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.

          Abhängig von Ihrer Auswahl werden die nächsten Felder und Optionen angezeigt. Sie ähneln den Optionen, die an anderer Stelle in diesem Abschnitt für die Datentypen Text, Enum, Map, Array und Record beschrieben werden.

        6. Klicken Sie auf Fertig.

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

        1. Geben Sie in das Feld Record ID (Eintrags-ID) eine eindeutige ID ein, mit der in anderen Eintragsfeldern auf diesen Eintrag verwiesen werden kann. Weitere Informationen finden Sie in diesem Dokument im Abschnitt Beispiel für die Verwendung der Felder „Eintrags-ID“ und „Eintragsreferenz“.
        2. Optional: Wenn Sie einen Verweis auf einen anderen Datensatz aus dieser Vorlage hinzufügen möchten, verwenden Sie das Feld Eintragsverweis. Sie können dies nach dem Erstellen des Aspekttyps nicht mehr ändern. Weitere Informationen finden Sie in diesem Dokument im Abschnitt Beispiel für die Verwendung der Felder „Eintrags-ID“ und „Eintragsreferenz“.
        3. Im Abschnitt Eintragsfelder können Sie ein komplexes Objekt mit mehreren verschachtelten Feldern definieren. Klicken Sie dazu auf Eintragsfeldelement 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 Display name (Anzeigename) einen Anzeigenamen für das Eintragsfeld ein.
          3. Optional: Geben Sie im Feld Description (Beschreibung) eine Beschreibung für das Eintragsfeld ein.
          4. Wählen Sie im Feld Typ einen Datentyp aus.

            Abhängig von Ihrer Auswahl werden die nächsten Felder und Optionen angezeigt. Sie ähneln den Optionen, die weiter oben in diesem Abschnitt für die Datentypen Text, Enum, Map, Array und Record beschrieben wurden.

        4. Klicken Sie auf Fertig.

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

    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 den Ressourcen beliebige Labels als Schlüssel/Wert-Paare hinzu:

    1. Klicken Sie auf Label hinzufügen.
    2. Geben Sie im Feld Schlüssel einen Schlüssel ein.
    3. Geben Sie in das 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 die Methode aspectType.create, um einen neuen Aspekttyp zu erstellen.

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

Für rekursive Verweise können Sie die Felder Eintrags-ID und Eintragsreferenz verwenden. 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)
  • Ständige Anschrift (Typ:Record)

Die beiden Adressfelder Aktuelle Adresse und Dauerhafte Adresse haben den gleichen Datentyp Record. Um eine Duplizierung zu vermeiden, können Sie beim Definieren dieser Felder die Werte für die Eintrags-ID und den Datensatzverweis festlegen.

Wenn Sie das Feld Aktuelle Adresse definieren, können Sie die Eintrags-ID als address-field angeben. Bei Ständige Adresse können Sie denselben Wert (address-field) für die Eintragsreferenz angeben. Beispiel:

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

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

Einem Eintrag Aspekte hinzufügen

Nachdem Sie einen Aspekttyp erstellt haben, können Sie Aspekte dieses Typs erstellen. Um einem Eintrag Aspekte hinzuzufügen, müssen Sie den Eintrag 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. Sie können die erforderlichen Aspekte nicht löschen.
  • Sie können die optionalen Aspekte für benutzerdefinierte Einträge und 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 aus.

  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 bei der entsprechenden Kategorie auf Hinzufügen.
      Sie können keine erforderlichen Aspekte hinzufügen, wenn für den Eintragstyp des ausgewählten Eintrags keine erforderlichen Aspekte definiert sind.
    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

Verwenden Sie die Methode entry.patch, um einem Eintrag oder einer Spalte eines Eintrags Aspekte hinzuzufü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 eines Eintrags verwalten

In diesem Abschnitt wird beschrieben, wie Sie die vorhandenen Aspekte eines Eintrags 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 aus.

  3. Suchen Sie nach dem Eintrag, dessen Aspekte Sie aktualisieren 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 aktualisieren möchten, auf Bearbeiten.

  6. Aktualisieren Sie im Fenster Aspekt bearbeiten die Pflichtfelder.

  7. Klicken Sie auf Speichern.

REST

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

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-Katalog 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

Verwenden Sie die Methode entry.update, um einen Aspekt für einen Eintrag zu löschen.

Aspekttypen verwalten

In diesem Abschnitt wird beschrieben, wie Sie Aspekttypen ansehen, 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 in diesem Dokument.

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

  3. Wenn Sie die Liste der Aspekttypen in allen Projekten aufrufen möchten, klicken Sie auf den Tab Benutzerdefiniert und aktivieren Sie die Ein/Aus-Schaltfläche Aus allen Projekten anzeigen.

REST

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

Details eines Aspekttyps 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 Detailseite des Aspekttyps wird geöffnet. Sie können Informationen wie den Anzeigenamen, die Aspekttyp-ID, die Beschreibung, die Projekt-ID, den Standort, 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 anzusehen.

  5. Klicken Sie auf den Tab Beispieleinträge, um die Liste der zehn zuletzt erstellten zusammengehörigen Einträge anzuzeigen.

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

REST

Verwenden Sie die Methode aspectTypes.get, um die Details eines Aspekttyps abzurufen.

Aspekttyp aktualisieren

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

Sie können die ID und den Standort des Aspekttyps nach dem Erstellen des Aspekttyps nicht mehr aktualisieren.

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. Bearbeiten Sie den Anzeigenamen, die Beschreibung, die Vorlagenfelder und die Labels nach Bedarf.

  6. Optional: So markieren Sie ein Feld des Aspekttyps als verworfen:

    1. Maximieren Sie das Feld im Abschnitt Vorlage.
    2. Wählen Sie Ist eingestellt aus.
    3. Geben Sie im Feld Einstellungsgrund einen Grund für die Einstellung des ausgewählten Felds ein.
    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 Sie den Vorgang, wenn Sie dazu aufgefordert werden.

REST

Verwenden Sie die Methode aspectTypes.delete, um einen vorhandenen Aspekttyp zu löschen.

Nächste Schritte