Suchsyntax für Dataplex Catalog

In diesem Dokument wird die Syntax für Dataplex-Suchanfragen beschrieben. Bevor Sie dieses Dokument lesen, sollten Sie die Konzepte von Dataplex Catalog wie Dateneinträge, Aspekte, Aspekttypen, Eintragsgruppen und Eintragstypen kennen. Weitere Informationen finden Sie unter Dataplex-Katalog – Übersicht

So starten Sie eine Dataplex Catalog-Suchabfrage in der Rufen Sie in der Google Cloud Console die Dataplex-Seite Suche auf und Wählen Sie Dataplex Catalog als Suchmodus aus.

Zur Suche

Weitere Informationen finden Sie unter Suchen Sie in Dataplex Catalog nach Daten-Assets.

In der einfachsten Form besteht eine Dataplex Catalog-Suchanfrage aus einem einzelnen Prädikat. Ein solches Prädikat kann mit mehreren Metadaten übereinstimmen:

  • Teilstring eines Namens, eines Anzeigenamens oder einer Beschreibung eines Daten-Assets
  • Teilstring des Typs eines Daten-Assets
  • Ein Teilstring eines Spaltennamens (oder verschachtelten Spaltennamens) im Schema eines Datenassets
  • Ein Teilstring einer Projekt-ID
  • String aus einer Übersichtsbeschreibung

Das Prädikat foo stimmt beispielsweise mit den folgenden Entitäten überein:

  • Daten-Asset mit dem Namen „foo.bar“
  • Daten-Asset mit dem Anzeigenamen Foo Bar
  • Datenasset mit der Beschreibung This is the foo script
  • Daten-Asset mit dem genauen Typ „foo“
  • Spalte foo_bar im Schema eines Datenassets
  • Verschachtelte Spalte foo_bar im Schema eines Datenassets
  • Projekt prod-foo-bar
  • Datenasset mit einer Übersicht, die das Wort foo enthält

Qualifizierte Prädikate

Sie können ein Prädikat qualifizieren, indem Sie ihm einen Schlüssel voranstellen, der die Übereinstimmung mit einem bestimmten Metadatenelement:

  • Ein Gleichheitszeichen (=) beschränkt die Suche auf eine genaue Übereinstimmung.
  • Ein Doppelpunkt (:), nachdem der Schlüssel das Prädikat mit einem Teilstring oder Token innerhalb des Werts in den Suchergebnissen vergleicht.

Bei der Tokenisierung wird der Textfluss in eine Reihe von Tokens aufgeteilt, Token, das normalerweise einem einzelnen Wort entspricht.

Beispiel:

  • name:foo zum Auswählen von Entitäten mit Namen, die den Teilstring foo enthalten, z. B. foo1 und barfoo.
  • description:foo zum Auswählen von Entitäten mit dem Token foo in der Beschreibung wie bar und foo.
  • location=foo führt zu Übereinstimmung mit Daten-Assets an einem angegebenen Standort mit foo als Standortnamen.

Die Prädikatsschlüssel type, system, location und orgid unterstützen nur die Qualifizierer für genaue Übereinstimmung (=), nicht Teilstring-Qualifier (:). Beispiel: type=foo oder orgid=number.

Dataplex Catalog unterstützt die folgenden Qualifizierer:

Kennzeichner Beschreibung
name:x Führt zu Übereinstimmung von x mit einem Teilstring der Daten-Asset-ID.
displayname:x Führt zu Übereinstimmung von x mit einem Teilstring des Anzeigenamens des Daten-Assets.
column:x Führt zu Übereinstimmung von x mit einem Teilstring des Spaltennamens (oder des verschachtelten Spaltennamens) im Schema des Datenassets.
description:x Führt zu Übereinstimmung von x mit einem Token in der Beschreibung des Daten-Assets.
label:bar Führt zu Übereinstimmung mit BigQuery-Daten-Assets, die ein Label haben (mit einem Wert) und deren Labelschlüssel bar als Teilstring hat.
label=bar Gleicht BigQuery-Daten-Assets mit einem Label (mit ein Wert) und der Labelschlüssel ist bar als String.
label:bar:x Führt zu Übereinstimmung von x als Teilstring im Wert eines Labels mit Schlüssel bar, das mit einem BigQuery-Daten-Asset verknüpft ist.
label=foo:bar Führt zu Übereinstimmung mit BigQuery-Daten-Assets, deren Schlüssel foo und deren Schlüsselwert bar ist.
label.foo=bar Gleicht BigQuery-Daten-Assets ab, bei denen der Schlüssel gleich foo und der Schlüsselwert ist bar.
label.foo Gleicht BigQuery-Daten-Assets mit einem Label ab, dessen Schlüssel entspricht foo als String.
type=TYPE Führt zu Übereinstimmung mit Datenassets eines bestimmten Eintragstyps oder dessen Typalias.
projectid:bar Führt zu Übereinstimmung mit Datenassets in Google Cloud-Projekten, die bar als Teilstring in der ID enthalten.
parent:x Stimmt mit x als Teilstring des hierarchischen Pfads eines Daten-Asset. Der übergeordnete Pfad ist ein fully_qualified_name der übergeordneten Ressource.
orgid=number Gleicht Daten-Assets in einer Google Cloud-Organisation mit Den genauen ID-Wert von number
system=SYSTEM Gleicht Daten-Assets aus einem angegebenen System ab.
location=LOCATION

Führt zu Übereinstimmung mit Daten-Assets an einem angegebenen Standort mit einem genauen Namen. Beispiel: location=us-central1 stimmt mit Assets überein, die in Iowa gehostet werden.

BigQuery Omni-Assets unterstützen diesen Qualifier mit dem BigQuery Omni-Standortnamen. location=aws-us-east-1 führt beispielsweise zu einer Übereinstimmung mit BigQuery Omni-Assets in Northern Virginia.

createtime

Findet Datenassets, die an bzw. zu, vor oder nach einem bestimmten Datum oder einer bestimmten Uhrzeit erstellt wurden.

Beispiel:

  • createtime:2019-01-01 führt zu Übereinstimmung mit Datenassets, die am 01.01.2019 erstellt wurden.
  • createtime<2019-02 stimmt mit den erstellten Daten-Assets überein vor 01.02.2019T00:00:00.
  • createtime>2019-02 führt zu Übereinstimmung mit Datenassets, die nach dem 01.02.2019 00:00:00 Uhr erstellt wurden.

Zeitstempelformat: YYYY-MM-DDThh:mm:ss

Alle Zeitstempel müssen in GMT angegeben sein. Zeitzonen werden nicht unterstützt. Teilweise Zeitstempel, Bindestrich (-) Datumstrennzeichen und Schrägstrich (/) Datumstrennzeichen werden unterstützt.

Beispiel:

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22
updatetime

Findet Daten-Assets, die innerhalb, vor oder nach einem bestimmten Datum oder Uhrzeit.

Beispiel:

  • updatetime:2019-01-01 stimmt mit Daten-Assets überein, die aktualisiert wurden am 01.01.2019.
  • updatetime<2019-02 führt zu Übereinstimmung mit Datenassets, die vor dem 01.02.2019 um 00:00:00 Uhr aktualisiert wurden.
  • updatetime>2019-02 Übereinstimmungen mit aktualisierten Daten-Assets nach 01.02.2019T00:00:00.

Zeitstempelformat: YYYY-MM-DDThh:mm:ss

Alle Zeitstempel müssen in GMT angegeben sein. Zeitzonen werden nicht unterstützt. Teilweise Zeitstempel, Bindestrich (-) Datumstrennzeichen und Schrägstrich (/) Datumstrennzeichen werden unterstützt.

Beispiel:

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22
fully_qualified_name:x Führt zu Übereinstimmung von x mit einem Teilstring von fully_qualified_name.
fully_qualified_name=x Stimmt mit x als fully_qualified_name überein.

Verwenden Sie die folgende Abfrage, um anhand der angehängten Aspekte nach Einträgen zu suchen Syntax.

Kennzeichner Beschreibung
aspect:x x stimmt als Teilstring mit dem vollständigen Pfad zum Aspekttyp eines Aspekts überein, der dem Eintrag zugeordnet ist, im Format projectid.location.ASPECT_TYPE_ID.
aspect=x Entspricht x als vollständigen Pfad zum Aspekttyp eines Aspekts, der dem Eintrag zugeordnet ist, im Format projectid.location.ASPECT_TYPE_ID.
aspect:xOPERATORvalue

Sucht nach Feldwerten für Aspekte. Stimmt mit x als Teilstring überein des vollständigen Pfads zum Aspekttyp und Feldnamen eines Aspekts, der an den Eintrag angehängt wird, im Format projectid.location.ASPECT_TYPE_ID.FIELD_NAME

Die Liste der unterstützten Operatoren hängt vom Feldtyp im -Aspekt:

  • String: = (genaue Übereinstimmung) und : (Teilstring)
  • Alle Zahlentypen: =, :, <, >, <=, >=, =>, =<
  • Enum: =
  • Datetime: Wie für Zahlen, aber die zu vergleichenden Werte als Datum- und Uhrzeitangaben statt als Zahlen behandelt
  • Boolesch: =

Nur Felder der obersten Ebene des Aspekts können durchsucht werden.

Beispielsweise stimmen alle folgenden Abfragen mit Einträgen überein, bei denen der Wert des Felds is-enrolled im employee-info Aspekt ist true. Auch andere Einträge, die mit dem Teilstring übereinstimmen, werden zurückgegeben.

  • aspect:example-project.us-central1.employee-info.is-enrolled=true
  • aspect:example-project.us-central1.employee=true
  • aspect:employee=true

Logische Operatoren

Eine Abfrage kann aus mehreren Prädikaten mit logischen Operatoren bestehen. Wenn Sie keinen Operator angeben, wird das logische AND als Operator angenommen. Beispiel: foo bar gibt Entitäten, die sowohl dem Prädikat foo als auch dem Prädikat bar entsprechen.

Logisches AND und logisches OR werden unterstützt. Beispiel: foo OR bar

Ein Prädikat kann mit einem Präfix - (Bindestriche) oder NOT negiert werden. Beispiel: -name:foo gibt Entitäten zurück, deren Namen nicht mit dem Prädikat foo übereinstimmen.

Bei logischen Operatoren wird nicht zwischen Groß- und Kleinschreibung unterschieden. Beispielsweise sind sowohl or als auch OR akzeptabel.

Abgekürzte Syntax

Außerdem ist eine abgekürzte Suchsyntax verfügbar, die | (senkrechter Strich) für OR-Operatoren und , (Komma) für AND-Operatoren verwendet.

Um beispielsweise nach Einträgen in einem von vielen Projekten zu suchen, können Sie den OR verwenden. können Sie die folgende abgekürzte Syntax verwenden:

projectid:(id1|id2|id3|id4)

Die gleiche Suche ohne die abgekürzte Syntax sieht so aus:

projectid:id1 OR projectid:id2 OR projectid:id3 OR projectid:id4

So suchen Sie nach Einträgen mit übereinstimmenden Spaltennamen:

  • AND: column:(name1, name2, name3)
  • ODER: column:(name1|name2|name3)

Diese abgekürzte Syntax funktioniert für die qualifizierte Prädikate mit Ausnahme von label.

Nächste Schritte