In Knowledge Catalog nach Ressourcen suchen

Mit der Knowledge Catalog-Suche (früher Dataplex Universal Catalog) können Sie Ressourcen in Ihrer Organisation finden. Dabei werden die Suche in natürlicher Sprache mit semantischem Abgleich, die Stichwortsuche und eine umfangreiche Suchsyntax unterstützt.

Anwendungsfälle

In der folgenden Liste werden häufige Anwendungsfälle für die Suche beschrieben. Außerdem finden Sie Beschreibungen und Beispielabfragen:

  • Gezielte Suche nach Assets: Sie können nach einem bestimmten Asset suchen, indem Sie Keywords eingeben, die sich auf den Asset-Namen, die Spalten oder die Beschreibung beziehen.

    Beispielabfragen

    • retail_transactions_2026
    • customer_id
    • column:customer_id

  • Umfassende Datenerkennung: Identifizieren Sie relevante Assets in Ihrer Organisation mithilfe von offenen Anfragen in natürlicher Sprache oder Keyword-Anfragen.

    Beispielabfragen

    • quarterly financial reports
    • ad campaign click through rates tables
    • server health metrics
    • audit logs system=bigquery

  • Abrufen von Assets mit Bereich für Workflows: Assets in einem bestimmten Container, z. B. einem Projekt, oder mit bestimmten Eigenschaften, z. B. Typ oder System, auflisten. Diese Methode wird häufig für programmatische und agentenbasierte Workflows verwendet.

    Beispielabfragen

    • type=table projectid:banking-prod aspect:classification.tier=PII
    • system=spanner projectid:inventory-service (parent=marketing_analytics OR parent=finance_analytics)

Sie haben folgende Möglichkeiten, auf die Suche in Knowledge Catalog zuzugreifen:

Funktionsweise

Search indexiert automatisch den gesamten Kontext für Daten-Assets, die in Knowledge Catalog verwaltet werden. Der Support umfasst

  • Metadaten, die automatisch aus Google Cloud Datenquellen wie BigQuery und Cloud SQL aufgenommen werden
  • Kontext für Ressourcen, die Sie über Connectors und Integrationen aufnehmen
  • Zusätzlicher Kontext, den Sie für Ressourcen erstellen (z. B. zur Darstellung des geschäftlichen Kontexts oder zur Beschreibung der Datensemantik) und der in Form von Aspekten oder verknüpften Geschäftsbedingungen erfasst wird.

Bei der Verarbeitung Ihrer Anfrage wendet die Suche eine Kombination aus semantischem und Keyword-Abgleich an. In der folgenden Tabelle werden die Abfragetypen beschrieben, die Sie für die Knowledge Catalog-Suche verwenden können. Außerdem finden Sie Beschreibungen und Beispielabfragen:

Abfragetyp Nutzung Beispiele
Einzelnes Keyword Für genaue und Teilstring-Abgleiche von Metadatenelementen wie Asset-Name, Beschreibung und Schema. prd_fin_invoices_fct_v02
Teilweise Keywords und tokenisierte Fragmente Es werden Teilstrings in Metadateninhalten abgeglichen. So werden Ressourcen auch bei abgekürzten Begriffen, getrennten Wörtern oder Namensvariationen gefunden. fin transactions 2026 (entspricht prd_fin_transactions_fy2026_raw)
Abfragen in natürlicher Sprache Verwendet den semantischen Abgleich, ohne dass genaue Namens- oder Spaltenübereinstimmungen erforderlich sind. customer churn prediction features
Strukturierte Prädikate Kombiniert Freitextanfragen mit expliziten Prädikatfiltern, um Suchergebnisse einzugrenzen. audit logs system=bigquery
Erweiterte Syntax Für eine präzise Suche, die auf einen bestimmten Bereich eingegrenzt ist. Die erweiterte Syntax wird am häufigsten in agentischen und programmatischen Anwendungsfällen verwendet. Weitere Informationen finden Sie unter Suchsyntax. (system:bigquery OR system:spanner) AND column:credit_card_number aspect:classification.tier=PII -projectid:sandbox-project

Suchbereich

Bei den Suchergebnissen in Knowledge Catalog werden die Berechtigungen berücksichtigt, die Sie für die entsprechenden Ressourcen in Quellsystemen haben.

Wenn Sie beispielsweise BigQuery-Metadaten-Lesezugriff auf ein Objekt haben, wird dieses Objekt in Ihren Knowledge Catalog-Suchergebnissen angezeigt. Wenn Sie Zugriff auf eine BigQuery-Tabelle, aber nicht auf das Dataset haben, das diese Tabelle enthält, wird die Tabelle trotzdem in der Knowledge Catalog-Suche wie erwartet angezeigt.

Standardmäßig ist die Suche auf Ihre Organisation beschränkt. Die Ergebnisse enthalten nur Ressourcen aus derselben Organisation wie das Projekt, in dem Sie suchen.

Die Suchergebnisse enthalten nur Ressourcen, die zum selben VPC Service Controls-Perimeter wie das Projekt gehören, unter dem die Suche ausgeführt wird. Wenn Sie dieGoogle Cloud -Konsole verwenden, ist dies das Projekt, das in der Konsole ausgewählt ist.

Wenn Sie den Umfang Ihrer Suchergebnisse über die Ressourcen innerhalb des VPC Service Controls-Perimeters Ihres Projekts hinaus erweitern möchten, verwenden Sie VPC Service Controls-Regeln für ein- und ausgehenden Traffic. Diese Regeln erleichtern den privaten und effizienten Datenaustausch in Ihrer Organisation. Sie können Regeln für eingehenden und ausgehenden Traffic über dieGoogle Cloud Console oder über JSON- oder YAML-Dateien konfigurieren. Sehen Sie sich das folgende YAML-Beispiel an und lesen Sie die Dokumentation zu VPC Service Controls, um die Regel an Ihre spezifischen Anforderungen anzupassen.

egressPolicies:
  - egressFrom:
      identityType: ANY_USER_ACCOUNT
    egressTo:
      # Specify which resources should be present in the search results. In this example,
      # BigQuery.
      operations:
      - methodSelectors:
        - method: '*'
        serviceName: bigquery.googleapis.com
      # Specify project ids under which the search is performed.
      resources:
      - projects/SEARCH_PROJECT_ID
ingressPolicies:
  - ingressFrom:
      identityType: ANY_USER_ACCOUNT
      sources:
      - accessLevel: '*'
    ingressTo:
      # Specify which resources should be present in the search results. In this example,
      # BigQuery.
      operations:
      - methodSelectors:
        - method: '*'
        serviceName: bigquery.googleapis.com
      # Specify project ids to expose in search results.
      resources:
      - projects/INGRESS_PROJECT_ID

Weitere Informationen zu den IAM-Rollen (Identity and Access Management), die Sie für die Knowledge Catalog-Suche benötigen, finden Sie unter Knowledge Catalog-IAM-Rollen.

Suchergebnisse mithilfe von VPC Service Controls nach Umgebung isolieren

Wenn Sie die Suchergebnisse des Knowledge Catalog zwischen Umgebungen wie Entwicklung, Test und Produktion isolieren möchten, konfigurieren Sie separate VPC Service Controls-Perimeter für jede Umgebung. Weisen Sie sowohl die Projekte, die die Daten-Assets enthalten, als auch die Projekte, die für die Durchführung von Suchvorgängen verwendet werden, dem Perimeter der entsprechenden Umgebung zu. Bei Suchanfragen, die über ein Projekt innerhalb eines bestimmten Perimeters ausgeführt werden, werden nur Ergebnisse für Assets zurückgegeben, die sich ebenfalls in diesem Perimeter befinden.

Einschränkungen bei der Erinnerungsfunktion in der Suche

Knowledge Catalog-Suchanfragen garantieren keine vollständige Trefferquote. Das bedeutet, dass die Suche möglicherweise keine Ergebnisse zurückgibt, die Ihrer Anfrage entsprechen. Außerdem können die zurückgegebenen (und nicht zurückgegebenen) Ergebnisse variieren, wenn Sie Suchanfragen wiederholen.

Wenn Sie alle Knowledge Catalog-Metadaten abfragen möchten, können Sie die Metadaten in Cloud Storage exportieren und dann in BigQuery abfragen. Weitere Informationen finden Sie unter Metadaten exportieren.

Hinweis

Bevor Sie eine Suche durchführen, müssen Sie sicherstellen, dass Ihnen die erforderlichen Rollen zugewiesen wurden und Sie die erforderliche API aktiviert haben.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Suchen nach Einträgen und zum Aufrufen von Suchergebnissen im Knowledge Catalog benötigen:

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Berechtigungen für Suchergebnisse werden unabhängig vom ausgewählten Projekt geprüft.

Die Suchergebnisse in Knowledge Catalog werden entsprechend Ihrer Rolle gefiltert. Wenn Sie in Knowledge Catalog nach einem Asset suchen möchten, benötigen Sie Berechtigungen für den Zugriff auf die entsprechende Ressource im Quellsystem. Weitere Informationen finden Sie im Abschnitt Suchbereich in diesem Dokument.

Wenn Sie beispielsweise nach BigQuery-Datasets, -Tabellen, -Ansichten und -Modellen suchen möchten, benötigen Sie die entsprechenden Berechtigungen für diese Einträge. Weitere Informationen finden Sie unter BigQuery-Berechtigungen.

In der folgenden Liste werden die erforderlichen Mindestberechtigungen beschrieben:

  • Zum Suchen nach einer Tabelle benötigen Sie die Berechtigung bigquery.tables.get für diese Tabelle.
  • Zur Suche nach einem Dataset benötigen Sie die Berechtigung bigquery.datasets.get für dieses Dataset.

Wenn Sie beispielsweise nach Cloud SQL-Instanzen, Datenbanken, Schemas, Tabellen und Ansichten suchen möchten, benötigen Sie die entsprechenden Berechtigungen für diese Einträge. Weitere Informationen finden Sie unter Cloud SQL-Rollen und -Berechtigungen.

API aktivieren

Dataplex API aktivieren

Rollen, die zum Aktivieren von APIs erforderlich sind

Zum Aktivieren von APIs benötigen Sie die Berechtigung serviceusage.services.enable. Wenn Sie das Projekt erstellt haben, haben Sie diese Berechtigung wahrscheinlich bereits über die Rolle „Inhaber“ (roles/owner). Andernfalls können Sie diese Berechtigung über die Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin) erhalten. Informationen zum Zuweisen von Rollen

API aktivieren

Nach Ressourcen suchen

Console

So suchen Sie nach Ressourcen:

  1. Rufen Sie in der Google Cloud Console die Seite Suchen im Knowledge Catalog auf.

    Zur Suche

  2. Wenn Sie die Aufforderung Suche in natürlicher Sprache ausprobieren sehen, klicken Sie darauf. Standardmäßig ist die Suche in natürlicher Sprache ausgewählt.

  3. Geben Sie im Feld Mit der Suche in natürlicher Sprache projektübergreifend nach Ressourcen suchen Ihre Anfrage ein und klicken Sie dann auf die Eingabetaste.

  4. Klicken Sie auf Filter, um die Suche einzugrenzen. Eine Liste der verfügbaren Filter finden Sie unter Filter.

  5. Wenn Sie weitere Informationen zur gesuchten Ressource aufrufen möchten, klicken Sie in den Suchergebnissen auf den Ressourcennamen. Dadurch wird die Seite mit den Eintragsdetails geöffnet.

Google Cloud CLI

Verwenden Sie den Befehl gcloud dataplex entries search, um nach Ressourcen zu suchen:

gcloud dataplex entries search 'foo' \
  --project=PROJECT_ID \
  [--semantic-search]

Ersetzen Sie PROJECT_ID durch die ID des Google Cloud -Projekts.

C#

C#

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für C# in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog C# API.

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

using Google.Api.Gax;
using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dataplex.V1;
using System;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for SearchEntries</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void SearchEntriesRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        SearchEntriesRequest request = new SearchEntriesRequest
        {
            LocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            Query = "",
            OrderBy = "",
            Scope = "",
            SemanticSearch = false,
        };
        // Make the request
        PagedEnumerable<SearchEntriesResponse, SearchEntriesResult> response = catalogServiceClient.SearchEntries(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (SearchEntriesResult item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (SearchEntriesResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (SearchEntriesResult item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<SearchEntriesResult> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (SearchEntriesResult item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Go

Go

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Go in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog Go API.

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.SearchEntriesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#SearchEntriesRequest.
	}
	it := c.SearchEntries(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*dataplexpb.SearchEntriesResponse)
	}
}

Java

Java

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

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.LocationName;
import com.google.cloud.dataplex.v1.SearchEntriesRequest;
import com.google.cloud.dataplex.v1.SearchEntriesResult;

public class SyncSearchEntries {

  public static void main(String[] args) throws Exception {
    syncSearchEntries();
  }

  public static void syncSearchEntries() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      SearchEntriesRequest request =
          SearchEntriesRequest.newBuilder()
              .setName(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setQuery("query107944136")
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .setOrderBy("orderBy-1207110587")
              .setScope("scope109264468")
              .setSemanticSearch(true)
              .build();
      for (SearchEntriesResult element : catalogServiceClient.searchEntries(request).iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

Node.js

Node.js

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

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The project to which the request should be attributed in the
 *  following form: `projects/{project}/locations/global`.
 */
// const name = 'abc123'
/**
 *  Required. The query against which entries in scope should be matched.
 *  The query syntax is defined in Search syntax for Dataplex Universal
 *  Catalog (https://cloud.google.com/dataplex/docs/search-syntax).
 */
// const query = 'abc123'
/**
 *  Optional. Number of results in the search page. If <=0, then defaults
 *  to 10. Max limit for page_size is 1000. Throws an invalid argument for
 *  page_size > 1000.
 */
// const pageSize = 1234
/**
 *  Optional. Page token received from a previous `SearchEntries` call. Provide
 *  this to retrieve the subsequent page.
 */
// const pageToken = 'abc123'
/**
 *  Optional. Specifies the ordering of results.
 *  Supported values are:
 *  * `relevance`
 *  * `last_modified_timestamp`
 *  * `last_modified_timestamp asc`
 */
// const orderBy = 'abc123'
/**
 *  Optional. The scope under which the search should be operating. It must
 *  either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
 *  unspecified, it defaults to the organization where the project provided in
 *  `name` is located.
 */
// const scope = 'abc123'
/**
 *  Optional. Specifies whether the search should understand the meaning and
 *  intent behind the query, rather than just matching keywords.
 */
// const semanticSearch = true

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callSearchEntries() {
  // Construct request
  const request = {
    name,
    query,
  };

  // Run request
  const iterable = dataplexClient.searchEntriesAsync(request);
  for await (const response of iterable) {
      console.log(response);
  }
}

callSearchEntries();

PHP

PHP

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für PHP in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog PHP API.

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\CatalogServiceClient;
use Google\Cloud\Dataplex\V1\SearchEntriesRequest;
use Google\Cloud\Dataplex\V1\SearchEntriesResult;

/**
 * Searches for Entries matching the given query and scope.
 *
 * @param string $formattedName The project to which the request should be attributed in the
 *                              following form: `projects/{project}/locations/global`. Please see
 *                              {@see CatalogServiceClient::locationName()} for help formatting this field.
 * @param string $query         The query against which entries in scope should be matched.
 *                              The query syntax is defined in [Search syntax for Dataplex Universal
 *                              Catalog](https://cloud.google.com/dataplex/docs/search-syntax).
 */
function search_entries_sample(string $formattedName, string $query): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = (new SearchEntriesRequest())
        ->setName($formattedName)
        ->setQuery($query);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $catalogServiceClient->searchEntries($request);

        /** @var SearchEntriesResult $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = CatalogServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $query = '[QUERY]';

    search_entries_sample($formattedName, $query);
}

Python

Python

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

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_search_entries():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.SearchEntriesRequest(
        name="name_value",
        query="query_value",
    )

    # Make the request
    page_result = client.search_entries(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Ruby

Ruby

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Ruby in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog Ruby API.

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

require "google/cloud/dataplex/v1"

##
# Snippet for the search_entries call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#search_entries.
#
def search_entries
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::SearchEntriesRequest.new

  # Call the search_entries method.
  result = client.search_entries request

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::Dataplex::V1::SearchEntriesResult.
    p item
  end
end

REST

Verwenden Sie die searchEntries-Methode, um nach Ressourcen zu suchen. Der Parameter semanticSearch muss dabei auf true festgelegt sein.

POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:searchEntries?query=foo&semanticSearch=true

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID Ihres Google Cloud -Projekts
  • LOCATION: Die Region, in der sich das Projekt befindet, z. B. us-central1

Filter

Mit Filtern können Sie die Suchergebnisse eingrenzen.

Wenn Sie Filter in mehreren Abschnitten angeben, werden sie mit dem logischen Operator AND ausgewertet. Die Suchergebnisse enthalten Ressourcen, die mindestens einer Bedingung aus jedem ausgewählten Abschnitt entsprechen. Wenn Sie beispielsweise das BigQuery-System und den Ressourcentyp „Dataset“ auswählen, enthalten die Suchergebnisse BigQuery-Datasets, aber keine Vertex AI-Datasets.

Wenn Sie mehrere Filter in einem Abschnitt auswählen, werden sie mit dem logischen Operator OR ausgewertet. Wenn Sie beispielsweise den Ressourcentyp „Dataset“ und den Ressourcentyp „Tabelle“ auswählen, enthalten die Suchergebnisse sowohl Datasets als auch Tabellen.

Folgende Filter sind verfügbar:

  • Umfang: Sie können in der gesamten Organisation (Standard), im aktuellen Projekt oder nur nach mit Sternchen markierten Ressourcen suchen. Weitere Informationen finden Sie im Abschnitt Suchbereich in diesem Dokument.
  • Systeme: Der Google Cloud Dienst, zu dem die Ressource gehört, z. B. BigQuery. Das Knowledge Catalog-System enthält Eintragsgruppen.
  • Projekte: die Projekte, in denen gesucht werden soll.
  • Typ: Der Ressourcentyp, z. B. BigQuery-Verbindung, Cloud Storage-Bucket oder Datenbank. Je nach Ressourcentyp können Sie auch nach Untertyp filtern, z. B. nach Verbindungstyp oder SQL-Dialekt.
  • Standorte auswählen: die Standorte, an denen gesucht werden soll.
  • Datasets auswählen: Die Suchergebnisse sind auf BigQuery-Ressourcen beschränkt, die zu den ausgewählten BigQuery-Datasets gehören. Geben Sie im Feld Zum Filtern eingeben den Namen des Datasets ein.
  • Aspekttypen: Die Aspekttypen des Knowledge Catalog, die mit der Ressource verknüpft sind, nach der Sie suchen. Wenn Sie nach Aspektwerten filtern möchten, klicken Sie auf Nach Aspekttypwerten filtern und wählen Sie die Werte aus.

Details zu einem Asset ansehen, das in der Suche zurückgegeben wurde

Console

Mit der Knowledge Catalog-Suche können Sie die Details eines Assets aufrufen.

  1. Nach einem Asset im Knowledge Catalog suchen

  2. Klicken Sie in den Suchergebnissen auf das Asset, dessen Details Sie sich ansehen möchten.

    Die Seite mit den Eintragsdetails wird geöffnet. Die Seite enthält die folgenden Abschnitte:

    • Eintragsdetails: Hier finden Sie Informationen wie den Eintragstyp, das System, die Plattform, den voll qualifizierten Namen, die Erstellungszeit, die Zeit der letzten Änderung, die Beschreibung und die Stewards.
    • Übersicht: Eine Übersicht über den Eintrag, sofern verfügbar.
    • Aspekte: Die erforderlichen und optionalen Aspekte, die für den Eintrag definiert sind. Weitere Informationen finden Sie unter Kategorien von Aspekten.

gcloud

gcloud dataplex entries lookup-Befehl:

gcloud dataplex entries lookup ENTRY_ID \
  --entry-group=ENTRY_GROUP_ID \
  --location=LOCATION \
  --project=PROJECT_ID

Ersetzen Sie Folgendes:

  • ENTRY_ID: die ID des Eintrags
  • ENTRY_GROUP_ID: die ID der Eintragsgruppe
  • LOCATION: die Region, in der sich das Projekt befindet
  • PROJECT_ID: die ID des Google Cloud -Projekts

C#

C#

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für C# in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog C# API.

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

using Google.Cloud.Dataplex.V1;

public sealed partial class GeneratedCatalogServiceClientSnippets
{
    /// <summary>Snippet for LookupEntry</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void LookupEntryRequestObject()
    {
        // Create client
        CatalogServiceClient catalogServiceClient = CatalogServiceClient.Create();
        // Initialize request argument(s)
        LookupEntryRequest request = new LookupEntryRequest
        {
            Name = "",
            View = EntryView.Unspecified,
            AspectTypes = { "", },
            Paths = { "", },
            EntryAsEntryName = EntryName.FromProjectLocationEntryGroupEntry("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]"),
        };
        // Make the request
        Entry response = catalogServiceClient.LookupEntry(request);
    }
}

Go

Go

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Go in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog Go API.

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewCatalogClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.LookupEntryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#LookupEntryRequest.
	}
	resp, err := c.LookupEntry(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Java

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

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

import com.google.cloud.dataplex.v1.CatalogServiceClient;
import com.google.cloud.dataplex.v1.Entry;
import com.google.cloud.dataplex.v1.EntryName;
import com.google.cloud.dataplex.v1.EntryView;
import com.google.cloud.dataplex.v1.LookupEntryRequest;
import java.util.ArrayList;

public class SyncLookupEntry {

  public static void main(String[] args) throws Exception {
    syncLookupEntry();
  }

  public static void syncLookupEntry() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
      LookupEntryRequest request =
          LookupEntryRequest.newBuilder()
              .setName("name3373707")
              .setView(EntryView.forNumber(0))
              .addAllAspectTypes(new ArrayList<String>())
              .addAllPaths(new ArrayList<String>())
              .setEntry(
                  EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
              .build();
      Entry response = catalogServiceClient.lookupEntry(request);
    }
  }
}

Node.js

Node.js

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

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The project to which the request should be attributed in the
 *  following form: `projects/{project}/locations/{location}`.
 */
// const name = 'abc123'
/**
 *  Optional. View to control which parts of an entry the service should
 *  return.
 *  **Please check the limitations on returned aspects in the Entry view
 *  documentation. Amount of returned aspects depends on the selected Entry
 *  View.**
 */
// const view = {}
/**
 *  Optional. Limits the aspects returned to the provided aspect types.
 *  It only works for CUSTOM view.
 */
// const aspectTypes = ['abc','def']
/**
 *  Optional. Limits the aspects returned to those associated with the provided
 *  paths within the Entry. It only works for CUSTOM view.
 */
// const paths = ['abc','def']
/**
 *  Required. The resource name of the Entry:
 *  `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
 */
// const entry = 'abc123'

// Imports the Dataplex library
const {CatalogServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new CatalogServiceClient();

async function callLookupEntry() {
  // Construct request
  const request = {
    name,
    entry,
  };

  // Run request
  const response = await dataplexClient.lookupEntry(request);
  console.log(response);
}

callLookupEntry();

PHP

PHP

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für PHP in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog PHP API.

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\CatalogServiceClient;
use Google\Cloud\Dataplex\V1\Entry;
use Google\Cloud\Dataplex\V1\LookupEntryRequest;

/**
 * Looks up an entry by name using the permission on the source system.
 *
 * @param string $name           The project to which the request should be attributed in the
 *                               following form: `projects/{project}/locations/{location}`.
 * @param string $formattedEntry The resource name of the Entry:
 *                               `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`. Please see
 *                               {@see CatalogServiceClient::entryName()} for help formatting this field.
 */
function lookup_entry_sample(string $name, string $formattedEntry): void
{
    // Create a client.
    $catalogServiceClient = new CatalogServiceClient();

    // Prepare the request message.
    $request = (new LookupEntryRequest())
        ->setName($name)
        ->setEntry($formattedEntry);

    // Call the API and handle any network failures.
    try {
        /** @var Entry $response */
        $response = $catalogServiceClient->lookupEntry($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $name = '[NAME]';
    $formattedEntry = CatalogServiceClient::entryName(
        '[PROJECT]',
        '[LOCATION]',
        '[ENTRY_GROUP]',
        '[ENTRY]'
    );

    lookup_entry_sample($name, $formattedEntry);
}

Python

Python

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

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_lookup_entry():
    # Create a client
    client = dataplex_v1.CatalogServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.LookupEntryRequest(
        name="name_value",
        entry="entry_value",
    )

    # Make the request
    response = client.lookup_entry(request=request)

    # Handle the response
    print(response)

Ruby

Ruby

Bevor Sie dieses Beispiel ausprobieren, folgen Sie der Einrichtungsanleitung für Ruby in der Knowledge Catalog-Kurzanleitung zur Verwendung von Clientbibliotheken. Weitere Informationen finden Sie in der Referenzdokumentation zur Knowledge Catalog Ruby API.

Richten Sie zur Authentifizierung bei Knowledge Catalog die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

require "google/cloud/dataplex/v1"

##
# Snippet for the lookup_entry call in the CatalogService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::CatalogService::Client#lookup_entry.
#
def lookup_entry
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::CatalogService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::LookupEntryRequest.new

  # Call the lookup_entry method.
  result = client.lookup_entry request

  # The returned object is of type Google::Cloud::Dataplex::V1::Entry.
  p result
end

REST

Verwenden Sie die Methode lookupEntry, um die Details eines Assets aufzurufen.

Knowledge Catalog bietet einen reinen Keyword-Suchmodus für die Abwärtskompatibilität. Der Standardsuchmodus unterstützt sowohl die semantische Suche als auch Keyword-Optionen.

Wir empfehlen, den Standard-Suchmodus zu verwenden, es sei denn, die Suche nur nach Keywords ist aus Gründen der Abwärtskompatibilität erforderlich.

Suchfilter nur für Keywords

Bei der Keyword-Suche sind Filter in die folgenden Abschnitte unterteilt:

  • Systeme wie BigQuery und Cloud SQL. Das Knowledge Catalog-System enthält benutzerdefinierte Einträge.
  • Unter Aspekte werden alle verfügbaren Aspekte aufgelistet. Wenn Sie nach Aspektwerten filtern möchten, klicken Sie auf Nach Aspektwerten filtern und wählen Sie die Werte aus.
  • Unter Projekt werden alle verfügbaren Projekte aufgelistet.
  • Typaliasse sind Datentypen, die einem Eintragstyp zugeordnet sind. Ein Eintragstyp kann den Namen projects/test-project/locations/us/entryTypes/my-entry-type haben, Sie können aber auch mit den Typaliasen TABLE oder DATABASE danach suchen. Sie können einen oder mehrere Typaliase festlegen, wenn Sie einen Eintragstyp erstellen oder aktualisieren.
  • Datasets stammen aus BigQuery.

Die Filter Systeme, Typ-Aliase, Projekt und Datasets werden je nach aktueller Abfrage im Feld Suche angezeigt.

So verwenden Sie die Keyword-Suche:

Console

  1. Wenn Sie sich im Modus für die Suche in natürlicher Sprache befinden, klicken Sie auf Zur Suche mit Suchbegriffen zurückkehren.
  2. Geben Sie im Feld Ressourcen projektübergreifend suchen Ihre Anfrage ein.

  3. Verwenden Sie zum Verfeinern der Suche den Bereich Filter.

    Eine Liste der verfügbaren Filter finden Sie unter Filter für die Suche mit Suchbegriffen.

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

    • Projektfilter hinzufügen: Klicken Sie unter Projekt auf Projekt hinzufügen. Suchen Sie nach einem bestimmten Projekt, wählen Sie es aus und klicken Sie dann auf Öffnen.
    • Aspekttypfilter hinzufügen: Klicken Sie unter Aspekte auf das Menü Weitere Aspekttypen hinzufügen. Suchen Sie nach einer bestimmten Vorlage, wählen Sie sie aus und klicken Sie dann auf OK.

  4. Optional: Zusätzlich zu den verfügbaren Assets können Sie nach Ressourcen suchen, die in Google Cloud öffentlich verfügbar sind. Wählen Sie dazu Öffentliche Datasets einschließen aus.

    Hier einige Tipps zum Erstellen einer Suchanfrage:

    • Setzen Sie den Suchausdruck in Anführungszeichen, wenn er Leerzeichen enthält. Beispiel: "search terms"
    • Stellen Sie einem Keyword NOT voran, um die logische Negation des Filters keyword:term zu berücksichtigen. Sie können auch die booleschen Operatoren AND und OR verwenden, um Suchausdrücke zu kombinieren. Bei den Operatoren AND, OR und NOT wird nicht zwischen Groß- und Kleinschreibung unterschieden.

    Beispiel: NOT column:term listet alle Spalten mit Ausnahme derjenigen auf, die dem angegebenen Begriff entsprechen. Eine Liste mit Suchbegriffen und anderen Begriffen, die Sie in einem Knowledge Catalog-Suchausdruck verwenden können, finden Sie unter Suchsyntax.

gcloud

Wenn Sie im reinen Keyword-Suchmodus nach Ressourcen suchen möchten, verwenden Sie den Befehl gcloud dataplex entries search und lassen Sie das Flag --semantic-search weg oder verwenden Sie das Flag --no-semantic-search.

REST

Wenn Sie mit dem reinen Keyword-Suchmodus nach Ressourcen suchen möchten, verwenden Sie die Methode searchEntries, wobei der Abfrageparameter semanticSearch auf false gesetzt ist.

Beschränkungen

Für die Suche gelten die folgenden Einschränkungen:

  • Öffentliche Ressourcen sind nicht Teil der Suche in natürlicher Sprache.
  • Aspekte, die mit Links zu Einträgen verknüpft sind, fallen nicht in den Bereich der Suche in natürlicher Sprache.

Nächste Schritte