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 Einträge, Aspekte, Aspekttypen, Eintragsgruppen und Eintragstypen kennen. Weitere Informationen finden Sie in der Dataplex Catalog-Übersicht.

Wenn Sie in derGoogle Cloud -Console eine Dataplex-Katalogsuchabfrage starten möchten, rufen Sie die Seite Dataplex Search auf und wählen Sie als Suchmodus Dataplex Catalog aus.

Zur Suche

Weitere Informationen finden Sie unter Ressourcen im Dataplex Catalog suchen.

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

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

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

  • Ressource mit dem Namen foo.bar
  • Ressource mit dem Anzeigenamen Foo Bar
  • Ressource mit der Beschreibung This is the foo script
  • Ressource mit dem genauen Typ foo
  • Spalte foo_bar im Schema einer Ressource
  • Verschachtelte Spalte foo_bar im Schema einer Ressource
  • Projekt prod-foo-bar
  • Ressource 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 auf ein bestimmtes Metadatenelement einschränkt:

  • 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 unterteilt, wobei jedes Token in der Regel einem einzelnen Wort entspricht.

Beispiel:

  • Mit name:foo werden Entitäten mit Namen ausgewählt, die den Teilstring foo enthalten, z. B. foo1 und barfoo.
  • Mit description:foo werden Entitäten mit dem Token foo in der Beschreibung ausgewählt, z. B. bar und foo.
  • location=foo gleicht Ressourcen an einem angegebenen Standort mit foo als Standortnamen ab.

Die Prädikatsschlüssel type, system, location und orgid unterstützen nur den Qualifier „Stimmt genau überein“ (=), nicht den Qualifier „Teilstring“ (:), z. B. type=foo oder orgid=number.

Dataplex Catalog unterstützt die folgenden Qualifier:

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

Führt zu Übereinstimmung mit Ressourcen 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 Ressourcen, 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 Ressourcen, die am 01.01.2019 erstellt wurden.
  • createtime<2019-02 stimmt mit Ressourcen überein, die vor dem 01.02.2019 00:00:00 erstellt wurden.
  • createtime>2019-02 führt zu Übereinstimmung mit Ressourcen, 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. Teilzeitstempel, das Bindestrich- (-) und das Schrägstrich- (/) Trennzeichen für Datumsangaben 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 Ressourcen, die an bzw. zu, vor oder nach einem bestimmten Datum oder einer bestimmten Uhrzeit aktualisiert wurden.

Beispiel:

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

Zeitstempelformat: YYYY-MM-DDThh:mm:ss

Alle Zeitstempel müssen in GMT angegeben sein. Zeitzonen werden nicht unterstützt. Teilzeitstempel, das Bindestrich- (-) und das Schrägstrich- (/) Trennzeichen für Datumsangaben 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 x stimmt mit fully_qualified_name überein.

Verwenden Sie die folgende Abfragesyntax, um nach Einträgen anhand ihrer verknüpften Aspekte zu suchen.

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

Es wird nach Seitenverhältnis-Feldwerten gesucht. Führt zu Übereinstimmung von x mit einem Teilstring des vollständigen Pfads zum Aspekttyp und zum Feldnamen eines Aspekts, der dem Eintrag zugeordnet ist, im Format projectid.location.ASPECT_TYPE_ID.FIELD_NAME.

Welche Operatoren unterstützt werden, hängt vom Feldtyp im Aspekt ab:

  • String: = (genaue Übereinstimmung) und : (Teilstring)
  • Alle Zahlentypen: =, :, <, >, <=, >=, =>, =<
  • Enum: =
  • Datum/Uhrzeit: Wie bei Zahlen, aber die zu vergleichenden Werte werden als Datum/Uhrzeit statt als Zahlen behandelt.
  • Boolesch: =

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

Beispielsweise werden bei allen folgenden Abfragen Einträge gefunden, bei denen der Wert des Felds is-enrolled im Aspekt employee-info true ist. 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 zurück, 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. Sowohl or als auch OR sind beispielsweise zulässig.

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.

Wenn Sie beispielsweise mit dem Operator OR nach Einträgen in einem der zahlreichen Projekte suchen möchten, 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 alle qualifizierten Prädikate mit Ausnahme von label.

Nächste Schritte