Suchsyntax für Data Catalog

In diesem Dokument wird die Syntax für Suchanfragen an Cloud Data Catalog beschrieben.

Einfache Prädikate

Eine Suchabfrage umfasst in der einfachsten Form ein einzelnes Prädikat. Beispiel: Das Prädikat foo stimmt mit den folgenden Data Catalog-Entitäten überein:

  • Entität mit der Beschreibung This is the foo script.
  • Eine Entität mit dem Namen foo.bar.

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. Beispiel: name:foo wählt Entitäten aus, deren Namen mit dem Prädikat foo übereinstimmen.

Der Data Catalog unterstützt die folgenden Qualifier:

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 im Schema des Datenassets.
description:x Führt zu Übereinstimmung von x mit einem Token in der Beschreibung des Daten-Assets.
labels:bar Führt zu Übereinstimmung mit BigQuery-Datenassets, die ein Label haben (mit einem Wert) und deren Labelschlüssel bar als Teilstring hat.
labels:bar:x Führt zu Übereinstimmung von x mit einem Token in dem Wert eines bar-Labels, das mit einem BigQuery-Daten-Asset verknüpft ist.
type=<type> Führt zu Übereinstimmung mit Datenassets eines bestimmten Objekttyps oder Subtyps. Subtypen können im folgenden Format hinzugefügt werden: <type>.<sub-type>.
Zu den Typen und Untertypen gehören:
  • type=table führt zu Übereinstimmung mit allen Tabellen.
  • type=dataset führt zu Übereinstimmung mit allen BigQuery-Datasets.
  • type=table.view oder type=view führt zu Übereinstimmung mit allen Ansichten.
  • type=tag_template führt zu Übereinstimmung mit allen Tag-Vorlagen.
  • type=entry_group führt zu Übereinstimmung mit allen Eintragsgruppen.
  • type=data_stream führt zu Übereinstimmung mit allen Pub/Sub-Themen.
projectid:bar Führt zu Übereinstimmung mit Datenassets in Cloud-Projekten, die bar als Teilstring in der ID enthalten.
orgid:bar Führt zu Übereinstimmung mit Datenassets in Cloud-Organisationen, die bar als Teilstring in der ID enthalten.
system=<system> Führt zu Übereinstimmung mit allen Daten-Assets eines angegebenen Systems .
Zu den Systemen gehören:
  • system=bigquery führt zu Übereinstimmung mit allen Datenassets von BigQuery.
  • system=cloud_pubsub führt zu Übereinstimmung mit allen Datenassets von Pub/Sub.
  • system=data_catalog führt zu Übereinstimmung mit allen Datenassets, die in Data Catalog erstellt wurden.
tag:x Führt zu Übereinstimmung mit Datenassets, bei denen x mit einem beliebigen Teilstring in <tag_template_project_id>.<tag_template_id>.<tag_field_id> übereinstimmt.
Beispiele:
  • tag:data_owner führt zu Übereinstimmung mit Daten-Assets, die das Tag data_owner enthalten.
  • tag:data_gov_template führt zu Übereinstimmung mit Datenassets, die mit der Tag-Vorlage data_gov_template getaggt wurden.
  • tag:mycloudproject.data_gov_template führt zu Übereinstimmung mit Datenassets, die mit der Vorlage data_gov_template im Projekt mycloudproject getaggt sind.
tag:key:val Führt zu Übereinstimmung von key mit einem beliebigen Teilstring der Tag-Feld-ID, der Tag-Vorlagen-ID oder der Cloud-Projekt-ID einer Tag-Vorlage. Führt zu Übereinstimmung von val mit einem Token im Tag-Wert von key, wenn das Tag-Feld vom Typ string ist. Führt zu genauer Übereinstimmung von val mit dem Tag-Wert von key wenn der Tag-Feldwert vom Typ boolean oder enum oder double. ist
Zulässige Operatoren:
  • String: ":"
  • boolesch und enum: "="
  • double: "=", "<", ">", "<=", ">="
  • Zeitstempel: ":", "=", "<", ">", "<=", ">="
Beispiele:
  • String: tag:data_owner:@mail.com führt zu Übereinstimmung mit Datenassets mit @mail.com -Werten.
  • boolesch: tag:data_gov_template.hasPII=true führt zu Übereinstimmung mit booleschen hasPII-Tags in data_gov_template die true sind.
  • enum: tag:certification_level_1=HIGHEST.
  • double: tag:datascore=9 führt zu Übereinstimmung mit Datenassets mit datascore-double-Tags mit dem Wert 9.
  • Zeitstempel: tag:expiredDate:2019-01-01 führt zu Übereinstimmung mit Datenassets mit einem expiredDate-Tag mit dem Wert 2019-01-01.
  • Zeitstempel: tag:expiredDate<2019-02 führt zu Übereinstimmung mit Daten-Assets, die ein expiredDate -Tag haben, dessen Zeitstempel zeitlich vor 2019-02-01T00:00:00 liegt.
Timestamp
createtime Findet Datenassets, die an bzw. zu, vor oder nach einem bestimmten Datum oder einer bestimmten Uhrzeit erstellt wurden.
Beispiele:
  • createtime:2019-01-01 führt zu Übereinstimmung mit Datenassets, die am 2019-01-01 erstellt wurden.
  • createtime<2019-02 führt zu Übereinstimmung mit Datenassets, die vor dem 2019-02-01T00:00:00 erstellt wurden.
  • createtime>2019-02 führt zu Übereinstimmung mit Datenassets, die nach dem 2019-02-01T00:00:00 erstellt wurden.
Timestamp
updatetime Findet Datenassets, die an bzw. zu, vor oder nach einem bestimmten Datum oder einer bestimmten Uhrzeit aktualisiert wurden.
Beispiele:
  • updatetime:2019-01-01 führt zu Übereinstimmung mit Datenassets, die am 2019-01-01 aktualisiert wurden.
  • updatetime<2019-02 führt zu Übereinstimmung mit Datenassets, die vor dem 2019-02-01T00:00:00 aktualisiert wurden.
  • updatetime>2019-02 führt zu Übereinstimmung mit Datenassets, die nach dem 2019-02-01T00:00:00 aktualisiert wurden.
Timestamp
policytag:x Entspricht x als Teilstring des Anzeige-Tags des Anzeigenamens. Findet alle Assets mit einem passenden Richtlinien-Tag oder seinen untergeordneten Elementen.
policytagid=x Entspricht x als Richtlinien-Tag oder Taxonomie-ID. Findet alle Assets mit einem passenden Richtlinien-Tag oder seinen untergeordneten Elementen.

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, z. B. foo OR bar.

Ein Prädikat kann mit einem Präfix - oder NOT negiert werden. Beispiel: -name:foo gibt alle Entitäten zurück, deren Namen nicht das Prädikat foo enthalten.

Abgekürzte Syntax

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

Für die Suche nach Einträgen in einem der zahlreichen Projekte verwenden Sie beispielsweise den Operator OR:

projectid:(pid1|pid2|pid3|pid4)

Anstelle von:

projectid:pid1 OR projectid:pid2 OR projectid:pid3 OR projectid:pid4

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

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

Diese abgekürzte Syntax funktioniert für alle oben aufgeführten qualifizierten Prädikate.