In diesem Dokument wird die Syntax für Suchanfragen an Cloud Data Catalog beschrieben. Bevor Sie dieses Dokument lesen, ist es wichtig, dass Sie die Konzepte von Data Catalog wie Dateneingabe, Tags, Tag-Vorlagen und andere Arten von Metadaten verstehen. Siehe Was ist Data Catalog?
Rufen Sie die Seite Dataplex-Suche auf, um eine Data Catalog-Suchabfrage in der Google Cloud Console zu starten.
Einfache Suche
In der einfachsten Form umfasst eine Data Catalog-Suchabfrage ein einzelnes Prädikat. Ein solches Prädikat kann mit mehreren Metadaten übereinstimmen:
- Teilstring eines Namens, Anzeigenamens oder der Beschreibung eines Daten-Assets
- Exakte Art eines Daten-Assets
- Ein Teilstring eines Spaltennamens (oder verschachtelten Spaltennamen) im Schema eines Datenassets
- Ein Teilstring einer Projekt-ID
- Der Wert eines öffentlichen Tags, der Name einer öffentlichen Tag-Vorlage oder ein Feldname in einer öffentlichen Tag-Vorlage, die an einen Dateneintrag angehängt ist.
- (Vorschau) Ein String für eine E-Mail-Adresse oder einen Namen für einen Data Steward
- (Vorschau) Ein String aus einer Übersichtsbeschreibung
Bei der einfachen Suche werden keine Tag-Vorlagenfelder vom Typ datetime
unterstützt.
Das Prädikat foo
stimmt beispielsweise mit den folgenden Entitäten überein:
- Datenasset mit dem Namen
foo.bar
- Datenasset mit dem Anzeigenamen
Foo Bar
- Datenasset mit der Beschreibung
This is the foo script.
- Datenasset mit dem genauen Typ
foo
- Spalte
foo_bar
im Schema eines Datenassets - Verschachtelte Spalte
foo_bar
im Schema eines Datenassets - Projekt
prod-foo-bar
- Öffentliche Tag-Vorlage mit dem Namen
foo
, Dateneinträge, die mit der Tag-Vorlagefoo
, Anzeigename der Tag-Vorlagefoo
, der Name des Tag-Vorlagenfelds vonfoo
und der Tag-Feldwertfoo
in einem String, einer Enum oder einem Rich-Text-Format sind. - (Vorabversion) Daten-Asset mit einem Data Steward namens
foo
. - (Vorabversion) Daten-Asset mit einer Übersicht, die das Wort „
foo
“ enthält.
Weitere Informationen zu den Rollen und Berechtigungen zum Aufrufen öffentlicher und privater Tags finden Sie unter Rollen zum Ansehen von öffentlichen und privaten Tags.
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 (:
) nach dem Schlüssel, der das Prädikat entweder mit einem Teilstring oder Token innerhalb des Werts in den Suchergebnissen übereinstimmt.
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 Teilstringfoo
enthalten:foo1
undbarfoo
. - Mit
description:foo
werden Entitäten mit dem Tokenfoo
in der Beschreibung ausgewählt:bar and foo
. location=foo
gleicht alle Daten-Assets an einem bestimmten Standort mitfoo
als Standortname ab.
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 |
Stimmt mit x als Teilstring des Spaltennamens (oder des verschachtelten Spaltennamens) im Schema des Daten-Assets überein.Sie können mithilfe des logischen Operators UND nach einer verschachtelten Spalte nach ihrem Pfad suchen. Beispiel: column:(foo bar) stimmt mit einer verschachtelten Spalte mit dem Pfad foo.bar überein. |
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-Datenassets, die ein Label haben (mit einem Wert) und deren Labelschlüssel bar als Teilstring hat. |
label=bar |
Gleicht BigQuery-Daten-Assets ab, die ein Label (mit einem bestimmten Wert) haben und der Labelschlüssel gleich bar als String ist. |
label:bar:x |
Stimmt mit x als Teilstring im Wert eines Labels mit dem Schlüssel bar überein, der an ein BigQuery-Daten-Asset angehängt ist. |
label=foo:bar |
Entspricht BigQuery-Daten-Assets, bei denen der Schlüssel gleich foo und der Schlüsselwert bar ist. |
label.foo=bar |
Entspricht BigQuery-Daten-Assets, bei denen der Schlüssel gleich foo und der Schlüsselwert bar ist. |
label.foo |
Gleicht BigQuery-Daten-Assets mit einem Label ab, dessen Schlüssel mit foo als String übereinstimmt. |
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:
|
projectid:bar |
Führt zu Übereinstimmung mit Datenassets in Cloud-Projekten, die bar als Teilstring in der ID enthalten. |
parent:x |
Führt zu Übereinstimmung von x mit einem Teilstring des hierarchischen Pfads eines BigQuery-Daten-Assets. Der Pfad hat das Format <project_id>.<dataset_name> .parent:foo.bar entspricht beispielsweise allen Tabellen und Ansichten eines Datasets mit dem Pfad project-foo.bar-dataset . |
orgid=number |
Führt zu Übereinstimmung mit Datenassets in einer Cloudorganisation mit dem genauen ID-Wert number . |
system=<system> |
Führt zu Übereinstimmung mit allen Daten-Assets eines angegebenen Systems . Zu den Systemen gehören:
|
location=<location> |
Führt zu Übereinstimmung mit allen Daten-Assets an einem angegebenen Standort mit einem genauen Namen. Beispiel: location=us-central1 stimmt mit allen Assets überein, die in Iowa gehostet werden.Eine vollständige Liste der unterstützten Standorte finden Sie unter Data Catalog-Regionen. |
cluster_location=<location> |
Gleicht alle Bigtable-Daten-Assets an einem angegebenen Standort mit einem genauen Namen ab. Beispiel: cluster_location=us-central1 entspricht allen in Iowa gehosteten Assets.Eine vollständige Liste der unterstützten Standorte finden Sie unter Bigtable-Regionen. |
tag:x |
Gleicht Daten-Assets ab, bei denen x mit einem beliebigen Teilstring in <tag_template_project_id >.<tag_template_id >.<tag_field_id > eines privaten oder öffentlichen Tags übereinstimmt.Beispiele:
|
tag:key<operator>val |
Zuerst wird der key mit einem beliebigen Teilstring der Tag-Feld-ID, der Tag-Vorlagen-ID oder der Google Cloud-Projekt-ID einer Tag-Vorlage abgeglichen. Gleicht dann val mit dem Tag-Wert von key abhängig vom Tag-Feldtyp ab.Die typabhängigen <operator> -Sets, die für Tag-Werte zulässig sind, sind:
|
createtime |
Findet Datenassets, die an bzw. zu, vor oder nach einem bestimmten Datum oder einer bestimmten Uhrzeit erstellt wurden. Beispiele:
|
updatetime |
Findet Datenassets, die an bzw. zu, vor oder nach einem bestimmten Datum oder einer bestimmten Uhrzeit aktualisiert wurden. Beispiele:
|
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. |
term:x |
Gleicht Daten-Assets ab, die mit einem Begriff aus einem Unternehmensglossar verknüpft sind, wobei ein Teilstring des Namens, der Beschreibung oder des Data Steward mit x übereinstimmt. |
fully_qualified_name:x |
Stimmt mit x als Teilstring von fully_qualified_name überein. |
fully_qualified_name=x |
Stimmt mit x als fully_qualified_name überein. |
Logische Operatoren
Eine Abfrage kann aus mehreren Prädikaten mit logischen Operatoren bestehen. Wenn Sie keinen Operator angeben, wird das logische AND
impliziert. foo bar
gibt beispielsweise Entitäten zurück, die sowohl mit dem Prädikat foo
als auch mit dem Prädikat bar
übereinstimmen.
Logisches AND und logisches OR werden unterstützt, z. B. foo OR bar
.
Sie können ein Prädikat mit dem Präfix -
oder NOT
negieren. -name:foo
gibt beispielsweise alle Entitäten mit Namen zurück, die nicht mit dem Prädikat foo
übereinstimmen.
Abgekürzte Syntax
Es ist auch eine verkürzte Suchsyntax verfügbar, bei der |
für OR
-Operatoren und ,
für AND
-Operatoren verwendet wird.
So können Sie beispielsweise mit dem Operator OR
nach Einträgen in einem von vielen Projekten suchen:
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 die oben aufgeführten qualifizierten Prädikate mit Ausnahme von tag
, term
, policytag
, policytagid
und label
.