Datenassets mit Data Catalog suchen und ansehen

In diesem Dokument wird erläutert, wie Sie mit Data Catalog Daten-Assets suchen können.

Sie können nach folgenden Datenassets suchen:

  • Mit Analytics Hub verknüpfte Datasets
  • BigQuery-Datasets, -Tabellen, -Ansichten und -Modelle
  • Bigtable-Instanzen, -Cluster und -Tabellen (einschließlich Details zu Spaltenfamilien)
  • Tag-Vorlagen, Eintragsgruppen und benutzerdefinierte Einträge für Data Catalog
  • Dataplex-Lakes, Zonen, Tabellen und Dateisätze
  • Dataproc Metastore-Dienste Datenbanken und Tabellen
  • Pub/Sub-Datenströme
  • Spanner-Instanzen, Datenbanken, Tabellen und Aufrufe
  • Vertex AI-Modelle, Datasets und Vertex AI Feature Store-Ressourcen
  • Assets in Unternehmensdatensilos, die mit Data Catalog verbunden sind

Suchbereich

Je nach Berechtigungen können die Suchergebnisse variieren. Die Suchergebnisse in Data Catalog sind nach Ihrer Rolle eingegrenzt.

Sie können sich die verschiedenen IAM-Rolle und -Berechtigungen für Data Catalog

Wenn Sie beispielsweise Lesezugriff auf BigQuery-Metadaten -Objekt enthält, wird es in Ihrer Data Catalog-Suche angezeigt. Ergebnisse. In der folgenden Liste werden die mindestens erforderlichen Berechtigungen beschrieben:

  • Um nach einer Tabelle zu suchen, benötigen Sie die Berechtigung bigquery.tables.get für dieser Tabelle.

  • Zum Suchen nach einem Dataset benötigen Sie die Berechtigung bigquery.datasets.get für dieses Dataset.

  • Wenn Sie nach Metadaten für einen Datensatz oder eine Tabelle suchen möchten, benötigen Sie die Rolle roles/bigquery.metadataViewer.

  • Um nach allen Ressourcen innerhalb eines Projekts oder einer Organisation zu suchen, benötigen Sie die Berechtigung datacatalog.catalogs.searchAll. Sie funktioniert für alle Ressourcen unabhängig vom Quellsystem.

Wenn Sie Zugriff auf eine BigQuery-Tabelle, aber nicht auf das Dataset haben die diese Tabelle enthält, wird sie weiterhin wie erwartet im Data Catalog-Suche. Die gleiche Zugriffslogik gilt für alle unterstützten Systeme wie Pub/Sub und Data Catalog selbst.

Data Catalog-Suchabfragen garantieren keinen vollständigen Recall. Ergebnisse, die Ihrer Abfrage entsprechen, werden möglicherweise auch auf nachfolgenden Ergebnisseiten nicht zurückgegeben. Außerdem können die zurückgegebenen (und nicht zurückgegebenen) Ergebnisse variieren, wenn Sie Suchanfragen wiederholen.

Wenn Trefferquotenprobleme auftreten und Sie die Ergebnisse nicht in einer bestimmten Reihenfolge abrufen müssen, sollten Sie den Parameter orderBy beim Aufrufen der Methode Katalogsuche auf default setzen.

Verwenden Sie das Flag admin_search.

Wenn Sie das Flag admin_search in der Suchanfrage verwenden, wird der vollständige Abruf sichergestellt. Für die Administratorsuche ist die Berechtigung datacatalog.catalogs.searchAll erforderlich für alle Projekte und Organisationen im Suchbereich festgelegt. Bei Verwendung von admin_search ist nur default orderBy zulässig.

Nach Datum getrennte Tabellen

Data Catalog aggregiert nach Datum fragmentierte Tabellen zu einem einzigen logischen Eintrag. Dieser Eintrag hat dasselbe Schema wie die Tabelle mit dem neuesten Datum und enthält zusammengefasste Informationen über die Gesamtzahl der Shards. Der Eintrag bezieht sich auf die Zugriffsebene des Datasets, zu dem er gehört. In der Data Catalog-Suche werden diese logischen Einträge nur angezeigt, wenn der Nutzer Zugriff auf das Dataset hat, in dem sie enthalten sind. Einzelne datumsfragmentierte Daten Tabellen sind in der Data Catalog-Suche nicht sichtbar, auch wenn sie sind in Data Catalog vorhanden und können getaggt werden.

Filter

Mit Filtern können Sie die Suchergebnisse eingrenzen. Alle Filter werden in Abschnitten gruppiert:

  • Mit Bereich können Sie die Suche auf Elemente mit Markierungen beschränken.
  • Systeme wie BigQuery, Pub/Sub, Dataplex, Dataproc Metastore, benutzerdefinierte Systeme, Vertex AI und Data Catalog selbst. Das Data Catalog-System enthält Dateisätze und benutzerdefinierte Einträge.
  • Lakes und Zonen stammen aus Dataplex.
  • Datentypen wie Datenstreams, Datasets, Lakes, Zonen, Dateisätze, Modelle, Tabellen, Ansichten, Dienste, Datenbanken und benutzerdefinierte Typen.
  • Unter Projekte werden alle verfügbaren Projekte aufgelistet.
  • Unter Tags werden alle verfügbaren Tag-Vorlagen (und ihre einzelnen Felder) aufgelistet.
  • Datasets stammen aus BigQuery und Vertex AI.
  • Öffentliche Datasets sind öffentlich verfügbare Daten aus BigQuery.

Du kannst Filter aus mehreren Bereichen kombinieren, um Assets zu finden, die mindestens mit eine Bedingung aus jedem ausgewählten Bereich. Mehrere Filter, die in einem einzelnen Bereich ausgewählt wurden, werden mit dem logischen Operator „OR“ ausgewertet. Angenommen, Sie haben die folgende Filterkombination:

Filterbereich für Tag-Werte mit mehreren ausgewählten Bereichen

Data Catalog sucht nach:

  • BigQuery-Datasets mit dem Tag der Vorlage „MyTemplate1“.

  • BigQuery-Datasets mit dem Tag der Vorlage MyTemplate2.

  • BigQuery-Tabellen, die mit der Vorlage „MyTemplate1“ getaggt sind.

  • BigQuery-Tabellen, die mit der Vorlage „MyTemplate2“ getaggt sind.

Nach Tag-Wert filtern

Mit den Filtern Tags können Sie nach Assets suchen, die mit einer bestimmten Vorlage getaggt sind. Über das Menü Anpassen können Sie die Ergebnisse weiter eingrenzen und nach bestimmten Tag-Werten filtern. Die Filterbedingungen für Tag-Werte hängen vom Datentyp des jeweiligen Tag-Felds ab. Für Datum/Uhrzeit- und Zahlenfelder können Sie beispielsweise ein bestimmtes Datum oder einen Bereich angeben.

Sichtbarkeit der Filter

Die in den einzelnen Abschnitten angezeigten Filter hängen von der aktuellen Suchanfrage im Suchfeld ab. Der gesamte Satz von Suchergebnissen kann Einträge enthalten, die mit der aktuellen Abfrage übereinstimmen. Die Filter, die diesen Einträgen entsprechen, werden jedoch möglicherweise nicht im Bereich Filter angezeigt.

So suchen Sie nach Daten-Assets

Console

Console

  1. Rufen Sie die Seite Dataplex-Suche auf, um eine Dataplex-Suchabfrage in der Google Cloud Console zu starten.

    Dataplex Search aufrufen

  2. Wählen Sie unter Suchplattform auswählen die Option Data Catalog als Suchmodus aus.

  3. Geben Sie Ihre Suchanfrage in das Suchfeld ein oder verfeinern Sie die Suchparameter im Bereich Filter.

Sie können die folgenden Filter manuell hinzufügen:

  • Projektfilter in Projekten, indem Sie auf die Schaltfläche PROJEKT HINZUFÜGEN klicken, nach einem bestimmten Projekt suchen, es auswählen und auf ÖFFNEN klicken.
  • In Tags einen Tag-Vorlagenfilter. Klicken Sie dazu auf das Drop-down-Menü Weitere Tag-Vorlagen hinzufügen, suchen Sie nach einer bestimmten Vorlage, wählen Sie sie aus und klicken Sie auf OK.

Sie können auch regelmäßiger Leser eines Blogs oder einer URL

  • Klicken Sie auf das Kästchen Öffentliche Datasets einschließen, um zusätzlich zu den verfügbaren Assets nach Datenassets zu suchen, die in Google Cloud öffentlich verfügbar sind.

Suchbeispiel

So suchen Sie beispielsweise nach der Tabelle trips, die Sie unter Tag-Vorlagen, Tags, Übersichten und Datenbetreuer konfigurieren eingerichtet haben:

  1. Geben Sie trips in das Suchfeld ein und klicken Sie auf Suchen.
  2. Wählen Sie im Bereich Systeme die Option BigQuery aus, um Daten-Assets auszuschließen, die zu anderen Systemen gehören.
  3. Wählen Sie im Abschnitt Projekte Ihre Projekt-ID aus, um Daten-Assets aus anderen Projekten auszuschließen. Wenn Ihr Projekt nicht aufgeführt ist, Klicken Sie auf PROJEKT HINZUFÜGEN und wählen Sie es im Dialogfeld aus.
  4. Wählen Sie im Abschnitt Tag-Vorlagen die Demo-Tag-Vorlage aus, um zu sehen, ob ein Tag, das diese Vorlage verwendet, an die Tabelle trips angehängt wird. Wenn diese Vorlage nicht im Abschnitt angezeigt wird, klicken Sie im Drop-down-Menü auf Weitere Tags hinzufügen, suchen Sie sie und wählen Sie sie aus und klicken Sie auf OK.

Bei allen ausgewählten Filtern sollten die Suchergebnisse nur einen Eintrag enthalten – die BigQuery-Tabelle trips in Ihrem Projekt mit dem angehängten Tag, das die Demo Tag Template verwendet.

Außerdem haben Sie folgende Möglichkeiten:

  1. Filtern Sie Ihre Suche, indem Sie im Suchfeld den Suchbegriffen ein keyword:value hinzufügen:

    KeywordBeschreibung
    name: Übereinstimmung mit dem Namen des Datenassets
    column: Übereinstimmung mit dem Spaltennamen oder dem verschachtelten Spaltennamen
    description: Übereinstimmung mit der Tabellenbeschreibung

  2. Für eine Tag-Suche stellen Sie den Suchbegriffen im Suchfeld einen der folgenden Tag-Suchbegriffe voran:

    TagBeschreibung
    tag:project-name.tag_template_name Stimmt mit Tag-Namen überein.
    tag:project-name.tag_template_name.key Stimmt mit Tag-Schlüssel überein.
    tag:project-name.tag_template_name.key:value Stimmt mit Tag-key:string value-Paar überein

Tipps zu Suchausdrücken

  • Setzen Sie den Suchausdruck in Anführungszeichen ("search terms"), wenn er Leerzeichen enthält.

  • Sie können einem Keyword „NOT“ voranstellen (Großschreibung erforderlich) entsprechend dem logischen Negation des Filters keyword:term. Sie können auch die Booleschen Operatoren "AND" und "OR" (in Großbuchstaben) verwenden, um Suchausdrücke zu kombinieren.

    Beispiel:NOT column:term listet alle Spalten außer denen auf, die mit angegebenen Begriff. Eine Liste mit Suchbegriffen und anderen Begriffen, die Sie in einem Data Catalog-Suchausdruck verwenden können, finden Sie unter Data Catalog-Suchsyntax.

Java

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Java in der Data Catalog-Kurzanleitung mit Clientbibliotheken. Weitere Informationen finden Sie in der Data Catalog Java API Referenzdokumentation.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Data Catalog zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

import com.google.cloud.datacatalog.v1.DataCatalogClient;
import com.google.cloud.datacatalog.v1.DataCatalogClient.SearchCatalogPagedResponse;
import com.google.cloud.datacatalog.v1.SearchCatalogRequest;
import com.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope;
import com.google.cloud.datacatalog.v1.SearchCatalogResult;
import java.io.IOException;

// Sample to search catalog
public class SearchAssets {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project-id";
    String query = "type=dataset";
    searchCatalog(projectId, query);
  }

  public static void searchCatalog(String projectId, String query) throws IOException {
    // Create a scope object setting search boundaries to the given organization.
    // Scope scope = Scope.newBuilder().addIncludeOrgIds(orgId).build();

    // Alternatively, search using project scopes.
    Scope scope = Scope.newBuilder().addIncludeProjectIds(projectId).build();

    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the "close" method on the client to safely clean up any remaining background resources.
    try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
      // Search the catalog.
      SearchCatalogRequest searchCatalogRequest =
          SearchCatalogRequest.newBuilder().setScope(scope).setQuery(query).build();
      SearchCatalogPagedResponse response = dataCatalogClient.searchCatalog(searchCatalogRequest);

      System.out.println("Search results:");
      for (SearchCatalogResult result : response.iterateAll()) {
        System.out.println(result);
      }
    }
  }
}

Node.js

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Node.js in der Data Catalog-Kurzanleitung mit Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Data Catalog Node.js API.

Richten Sie die Standardanmeldedaten für Anwendungen ein, um sich bei Data Catalog zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

// Import the Google Cloud client library.
const {DataCatalogClient} = require('@google-cloud/datacatalog').v1;
const datacatalog = new DataCatalogClient();

async function searchAssets() {
  // Search data assets.

  /**
   * TODO(developer): Uncomment the following lines before running the sample.
   */
  // const projectId = 'my_project'; // Google Cloud Platform project

  // Set custom query.
  const query = 'type=lake';

  // Create request.
  const scope = {
    includeProjectIds: [projectId],
    // Alternatively, search using Google Cloud Organization scopes.
    // includeOrgIds: [organizationId],
  };

  const request = {
    scope: scope,
    query: query,
  };

  const [result] = await datacatalog.searchCatalog(request);

  console.log(`Found ${result.length} datasets in project ${projectId}.`);
  console.log('Datasets:');
  result.forEach(dataset => {
    console.log(dataset.relativeResourceName);
  });
}
searchAssets();

Python

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Python in der Data Catalog-Kurzanleitung mit Clientbibliotheken. Weitere Informationen finden Sie in der Data Catalog Python API Referenzdokumentation.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Data Catalog zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

from google.cloud import datacatalog_v1

datacatalog = datacatalog_v1.DataCatalogClient()

# TODO: Set these values before running the sample.
project_id = "project_id"

# Set custom query.
search_string = "type=dataset"
scope = datacatalog_v1.types.SearchCatalogRequest.Scope()
scope.include_project_ids.append(project_id)

# Alternatively, search using organization scopes.
# scope.include_org_ids.append("my_organization_id")

search_results = datacatalog.search_catalog(scope=scope, query=search_string)

print("Results in project:")
for result in search_results:
    print(result)

REST UND BEFEHLSZEILE

REST

Wenn Sie keinen Zugriff auf Cloud Client-Bibliotheken für Ihre Sprache haben oder das API mithilfe von REST-Anforderungen testen möchten, sehen Sie sich die folgenden Beispiele an und lesen Sie die Dokumentation zur Data Catalog REST API.

1 Katalog durchgehen

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • organization-id: GCP-Organisations-ID
  • project-id: GCP-Projekt-ID

HTTP-Methode und URL:

POST https://datacatalog.googleapis.com/v1/catalog:search

JSON-Text anfordern:

{
  "query":"trips",
  "scope":{
    "includeOrgIds":[
      "organization-id"
    ]
  }
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten in etwa folgende JSON-Antwort erhalten:

{
  "results":[
    {
      "searchResultType":"ENTRY",
      "searchResultSubtype":"entry.table",
"relativeResourceName":"projects/project-id/locations/US/entryGroups/@bigquery/entries/entry1-id",
      "linkedResource":"//bigquery.googleapis.com/projects/project-id/datasets/demo_dataset/tables/taxi_trips"
    },
    {
      "searchResultType":"ENTRY",
      "searchResultSubtype":"entry.table",
      "relativeResourceName":"projects/project-id/locations/US/entryGroups/@bigquery/entries/entry2-id",
      "linkedResource":"//bigquery.googleapis.com/projects/project-id/datasets/demo_dataset/tables/tlc_yellow_trips_2018"
    }
  ]
}

Tabellendetails anzeigen

In der Cloud Console können Sie Data Catalog zum Ansehen von Tabellendetails verwenden.

  1. Rufen Sie in Dataplex die Seite Suche auf.

    Zu Data Catalog

  2. Wählen Sie unter Suchplattform auswählen als Suchmodus Data Catalog aus.

  3. Geben Sie im Suchfeld den Namen eines Datasets ein, das eine Tabelle enthält.

    Wenn Sie beispielsweise die Kurzanleitung durchgearbeitet haben, können Sie nach demo-dataset suchen und die Tabelle trips auswählen.

  4. Klicken Sie auf die Tabelle.

    Die Seite BigQuery-Tabellendetails wird geöffnet.

Die Tabelle enthält die folgenden Abschnitte:

  • BigQuery-Tabellendetails. Enthält Informationen wie Erstellungszeitpunkt, Zeitpunkt der letzten Änderung, Ablaufdatum Ressourcen-URLs, Labels usw.

  • Tags: Hier werden die angewendeten Tags aufgeführt. Sie können die Tags auf dieser Seite bearbeiten und die Tag-Vorlage aufrufen. Klicken Sie auf das Symbol Aktionen.

  • Schema- und Spalten-Tags: Hier werden das angewendete Schema und seine Werte aufgeführt.

Lieblingseinträge markieren und danach suchen

Wenn Sie häufig nach denselben Daten-Assets suchen, können Sie ihre Einträge in personalisierte Liste erstellen, indem Sie sie mit Sternen markieren. So gehen Sie in der Dataplex-Benutzeroberfläche vor:

  1. Rufen Sie in Dataplex die Seite Suche auf.

    Zu Data Catalog

  2. Wählen Sie unter Suchplattform auswählen die Option Data Catalog als Suchmodus aus.

  3. Suchen Sie das Asset und markieren Sie den Eintrag wie folgt:

    • Klicken Sie neben dem Eintrag in den Suchergebnissen auf das Symbol .
    • Klicken Sie auf den Namen des Eintrags, um die Detailseite zu öffnen, und dann oben in der Aktionsleiste auf die Schaltfläche STERN.

Sie können bis zu 200 Einträge mit einem Stern markieren.

Mit einem Stern markierte Einträge werden auf der Suchergebnisseite in der Liste Mit Stern markierte Einträge angezeigt, bevor Sie eine Suchanfrage in die Suchleiste eingeben. Diese Liste ist nur für dich sichtbar.

Wenn Sie nur nach getaggten Einträgen suchen möchten, wählen Sie im Bereich Filter die Option Umfang > Gemarkte aus.

Sie können auch die entsprechenden Methoden der Data Catalog API verwenden, um Einträge mit einem Stern zu markieren oder die Markierung aufzuheben. Bei der Suche nach Assets den Parameter starredOnly in Das scope-Objekt. Siehe catalog.search-Methode.