Cercare risorse in Knowledge Catalog

La ricerca in Knowledge Catalog (in precedenza Dataplex Universal Catalog) ti consente di scoprire le risorse della tua organizzazione con il supporto della ricerca in linguaggio naturale con corrispondenza semantica, ricerca per parole chiave e una sintassi di ricerca estesa.

Casi d'uso

Il seguente elenco descrive i casi d'uso comuni della ricerca, insieme a descrizioni ed esempi di query:

  • Ricerca mirata delle risorse: trova una risorsa specifica cercando parole chiave correlate al nome, alle colonne o alla descrizione della risorsa.

    Esempi di query

    • retail_transactions_2026
    • customer_id
    • column:customer_id

  • Ampia scoperta dei dati: identifica gli asset pertinenti nella tua organizzazione utilizzando query in linguaggio naturale o con parole chiave.

    Esempi di query

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

  • Recupero di asset con ambito per i workflow: enumera gli asset all'interno di un contenitore specifico, ad esempio un progetto, o con proprietà specifiche, ad esempio tipo o sistema. Questo approccio viene spesso utilizzato per i flussi di lavoro programmatici e agentici.

    Esempi di query

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

Per accedere alla ricerca in Knowledge Catalog, hai a disposizione le seguenti opzioni:

Come funziona

La ricerca indicizza automaticamente tutto il contesto degli asset di dati gestiti in Knowledge Catalog. È incluso quanto segue:

  • Metadati inseriti automaticamente da Google Cloud origini dati come BigQuery e Cloud SQL
  • Contesto per le risorse che inserisci tramite connettori e integrazioni
  • Contesto aggiuntivo che crei per le risorse (ad esempio, che rappresenta il contesto aziendale o descrive la semantica dei dati) e acquisito sotto forma di aspetti o termini aziendali collegati.

Quando elabora la query, la ricerca applica una combinazione di corrispondenza semantica e per parole chiave. La tabella seguente descrive i tipi di query che puoi utilizzare con la ricerca di Knowledge Catalog, insieme a descrizioni ed esempi di query:

Tipo di query Utilizzo Esempi
Parola chiave singola Per la corrispondenza esatta e di sottostringa tra gli elementi dei metadati, ad esempio nome, descrizione e schema della risorsa. prd_fin_invoices_fct_v02
Parole chiave parziali e frammenti tokenizzati Corrispondenze di sottostringhe nei contenuti dei metadati, ricerca di risorse anche con termini abbreviati, parole separate o varianti di denominazione. fin transactions 2026 (corrispondenze prd_fin_transactions_fy2026_raw)
Query in linguaggio naturale Utilizza la corrispondenza semantica senza richiedere corrispondenze esatte di nomi o colonne. customer churn prediction features
Predicati strutturati Combina le query di testo libero con filtri di predicato espliciti per restringere i risultati di ricerca. audit logs system=bigquery
Sintassi estesa Per una ricerca precisa, ristretta a un ambito specifico. La sintassi estesa viene utilizzata più spesso nei casi d'uso agentici e programmatici. Per maggiori informazioni, vedi Sintassi di ricerca. (system:bigquery OR system:spanner) AND column:credit_card_number aspect:classification.tier=PII -projectid:sandbox-project

Ambito di ricerca

I risultati di ricerca in Knowledge Catalog rispettano le autorizzazioni che hai sulle risorse corrispondenti nei sistemi di origine.

Ad esempio, se hai accesso in lettura ai metadati BigQuery di un oggetto, questo viene visualizzato nei risultati di ricerca di Knowledge Catalog. Se hai accesso a una tabella BigQuery, ma non al set di dati che la contiene, la tabella viene comunque visualizzata come previsto nella ricerca del Knowledge Catalog.

Per impostazione predefinita, la ricerca è limitata alla tua organizzazione. I risultati includono solo le risorse della stessa organizzazione del progetto in cui esegui la ricerca.

I risultati di ricerca includono solo le risorse che appartengono allo stesso perimetro dei Controlli di servizio VPC del progetto in cui viene eseguita la ricerca. Quando utilizzi la consoleGoogle Cloud , questo è il progetto selezionato nella console.

Per ampliare l'ambito dei risultati di ricerca oltre le risorse all'interno del perimetro dei Controlli di servizio VPC del tuo progetto, utilizza le regole in entrata e in uscita dei Controlli di servizio VPC. Queste regole facilitano lo scambio di dati privato ed efficiente all'interno della tua organizzazione. Puoi configurare le regole in entrata e in uscita utilizzando la consoleGoogle Cloud o tramite file JSON o YAML. Fai riferimento al seguente esempio YAML e consulta la documentazione dei Controlli di servizio VPC per adattare la regola ai tuoi requisiti specifici.

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

Per saperne di più sui ruoli Identity and Access Management che devi utilizzare per la ricerca in Knowledge Catalog, consulta Ruoli IAM per Knowledge Catalog.

Isolare i risultati di ricerca per ambiente utilizzando i Controlli di servizio VPC

Per isolare i risultati di ricerca di Knowledge Catalog tra ambienti come sviluppo, test e produzione, configura perimetri dei Controlli di servizio VPC separati per ogni ambiente. Assegna sia i progetti che contengono gli asset di dati sia i progetti utilizzati per eseguire le ricerche al perimetro dell'ambiente corrispondente. Le ricerche eseguite da un progetto all'interno di un perimetro specifico restituiranno risultati solo per gli asset che si trovano anche all'interno dello stesso perimetro.

Limitazioni del ritiro nella ricerca

Le query di ricerca di Knowledge Catalog non garantiscono il recupero completo, il che significa che la ricerca potrebbe non restituire risultati corrispondenti alla query. Inoltre, i risultati restituiti (e non restituiti) potrebbero variare se ripeti le query di ricerca.

Per eseguire query su tutti i metadati di Knowledge Catalog, puoi esportarli in Cloud Storage ed eseguire query da BigQuery. Per saperne di più, consulta Esportare i metadati.

Prima di iniziare

Prima di eseguire la ricerca, assicurati di disporre dei ruoli richiesti e di aver abilitato l'API necessaria.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per cercare voci e accedere ai risultati di ricerca in Knowledge Catalog, chiedi all'amministratore di concederti i seguenti ruoli IAM:

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Le autorizzazioni sui risultati di ricerca vengono controllate indipendentemente dal progetto selezionato.

I risultati di ricerca in Knowledge Catalog sono limitati in base al tuo ruolo. Per cercare un asset in Knowledge Catalog, devi disporre delle autorizzazioni per accedere alla risorsa corrispondente nel sistema di origine. Per saperne di più, consulta la sezione Ambito di ricerca di questo documento.

Ad esempio, per cercare set di dati, tabelle, viste e modelli BigQuery, devi disporre delle rispettive autorizzazioni per queste voci. Per ulteriori informazioni, vedi Autorizzazioni BigQuery.

Il seguente elenco descrive le autorizzazioni minime richieste:

  • Per cercare una tabella, devi disporre dell'autorizzazione bigquery.tables.get per quella tabella.
  • Per cercare un set di dati, devi disporre dell'autorizzazione bigquery.datasets.get per quel set di dati.

Come altro esempio, per cercare istanze, database, schemi, tabelle e viste Cloud SQL, devi disporre delle rispettive autorizzazioni per queste voci. Per saperne di più, consulta Ruoli e autorizzazioni di Cloud SQL.

Abilita l'API

Abilitare l'API Dataplex.

Ruoli richiesti per abilitare le API

Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente disponi già di questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore utilizzo dei servizi (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.

Abilitare l'API

Cerca risorse

Console

Per cercare risorse, segui questi passaggi:

  1. Nella console Google Cloud , vai alla pagina Ricerca di Knowledge Catalog.

    Vai a Cerca

  2. Se vedi il prompt del pulsante Prova la ricerca in linguaggio naturale, fai clic. Per impostazione predefinita, è selezionata la ricerca in linguaggio naturale.

  3. Nel campo Trova risorse tra i progetti con il linguaggio naturale, inserisci la query e poi fai clic su Invio.

  4. Per perfezionare la ricerca, fai clic su Filtri. Per l'elenco dei filtri disponibili, vedi Filtri.

  5. Per visualizzare ulteriori informazioni sulla risorsa cercata, fai clic sul nome della risorsa nei risultati di ricerca. Viene visualizzata la pagina dei dettagli della voce.

Google Cloud CLI

Per cercare risorse, utilizza il comando gcloud dataplex entries search:

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

Sostituisci PROJECT_ID con l'ID del progetto Google Cloud .

C#

C#

Prima di provare questo esempio, segui le istruzioni di configurazione di C# nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog C#.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

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;
    }
}

Vai

Go

Prima di provare questo esempio, segui le istruzioni di configurazione di Go nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Go.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 


//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

Prima di provare questo esempio, segui le istruzioni di configurazione di Java nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Java.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

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

Prima di provare questo esempio, segui le istruzioni di configurazione di Node.js nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Node.js.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

/**
 * 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

Prima di provare questo esempio, segui le istruzioni di configurazione di PHP nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog PHP.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

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

Prima di provare questo esempio, segui le istruzioni di configurazione di Python nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Python.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

# 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

Prima di provare questo esempio, segui le istruzioni di configurazione di Ruby nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Ruby.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

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

Per cercare risorse, utilizza il metodo searchEntries con il parametro semanticSearch impostato su true.

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

Sostituisci quanto segue:

  • PROJECT_ID: l'ID del tuo Google Cloud progetto
  • LOCATION: la regione in cui esiste il progetto (ad esempio us-central1)

Filtri

I filtri ti consentono di restringere i risultati di ricerca.

Quando fornisci filtri in più sezioni, questi vengono valutati utilizzando l'operatore logico AND. I risultati di ricerca contengono risorse che corrispondono ad almeno una condizione di ogni sezione selezionata. Ad esempio, se selezioni il sistema BigQuery e il tipo di risorsa del set di dati, i risultati della ricerca includono i set di dati BigQuery, ma non quelli di Vertex AI.

Se selezioni più filtri all'interno di una singola sezione, questi vengono valutati utilizzando l'operatore logico OR. Ad esempio, se selezioni il tipo di risorsa del set di dati e il tipo di risorsa della tabella, i risultati di ricerca includono sia i set di dati che le tabelle.

Sono disponibili i seguenti filtri:

  • Ambito: esegui la ricerca nell'organizzazione (impostazione predefinita), nel progetto corrente o solo per le risorse preferite. Per saperne di più, consulta la sezione Ambito di ricerca di questo documento.
  • Sistemi: il servizio Google Cloud a cui appartiene la risorsa, ad esempio BigQuery. Il sistema Knowledge Catalog contiene gruppi di voci.
  • Progetti: i progetti in cui eseguire la ricerca.
  • Tipo: il tipo di risorsa, ad esempio connessione BigQuery, bucket Cloud Storage o database. A seconda del tipo di risorsa, puoi anche filtrare per sottotipo, ad esempio il tipo di connessione o il dialetto SQL.
  • Seleziona località: le località in cui eseguire la ricerca.
  • Seleziona set di dati: i risultati della ricerca sono limitati alle risorse BigQuery appartenenti ai set di dati BigQuery selezionati. Nel campo Digita per filtrare, inserisci il nome del set di dati.
  • Tipi di aspetto: i tipi di aspetto di Knowledge Catalog associati alla risorsa che stai cercando. Per filtrare in base ai valori dell'aspetto, fai clic su Filtra in base ai valori del tipo di aspetto, quindi seleziona i valori.

Visualizzare i dettagli di un asset restituito dalla ricerca

Console

Utilizza la ricerca di Knowledge Catalog per visualizzare i dettagli di un asset.

  1. Cerca un asset in Knowledge Catalog.

  2. Nei risultati di ricerca, fai clic sull'asset di cui vuoi visualizzare i dettagli.

    Viene visualizzata la pagina dei dettagli della voce. La pagina include le seguenti sezioni:

    • Dettagli della voce: includono informazioni quali tipo di voce, sistema, piattaforma, nome completo, ora di creazione, ora dell'ultima modifica, descrizione e responsabili.
    • Panoramica: una panoramica della voce, se disponibile.
    • Aspetti: gli aspetti obbligatori e facoltativi definiti per la voce. Per saperne di più, consulta Categorie di aspetti.

gcloud

Comando gcloud dataplex entries lookup:

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

Sostituisci quanto segue:

  • ENTRY_ID: l'ID della voce
  • ENTRY_GROUP_ID: l'ID del gruppo di voci
  • LOCATION: la regione in cui esiste il progetto
  • PROJECT_ID: l'ID del progetto Google Cloud

C#

C#

Prima di provare questo esempio, segui le istruzioni di configurazione di C# nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog C#.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

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);
    }
}

Vai

Go

Prima di provare questo esempio, segui le istruzioni di configurazione di Go nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Go.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 


//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

Prima di provare questo esempio, segui le istruzioni di configurazione di Java nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Java.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

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

Prima di provare questo esempio, segui le istruzioni di configurazione di Node.js nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Node.js.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

/**
 * 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

Prima di provare questo esempio, segui le istruzioni di configurazione di PHP nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog PHP.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

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

Prima di provare questo esempio, segui le istruzioni di configurazione di Python nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Python.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

# 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

Prima di provare questo esempio, segui le istruzioni di configurazione di Ruby nella guida rapida di Knowledge Catalog per l'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Knowledge Catalog Ruby.

Per eseguire l'autenticazione in Knowledge Catalog, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale. 

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

Per visualizzare i dettagli di una risorsa, utilizza il metodo lookupEntry.

Knowledge Catalog fornisce la modalità di ricerca solo per parole chiave per la compatibilità con le versioni precedenti, mentre la modalità di ricerca standard supporta sia la corrispondenza semantica che la corrispondenza delle parole chiave.

Ti consigliamo di utilizzare la modalità di ricerca standard, a meno che non sia necessaria la ricerca solo per parole chiave per la compatibilità con le versioni precedenti.

Filtri di ricerca solo per parole chiave

Per la ricerca di parole chiave, i filtri sono raggruppati nelle seguenti sezioni:

  • Sistemi come BigQuery, Cloud SQL e altri. Il sistema Knowledge Catalog contiene voci personalizzate.
  • L'elenco Aspetti mostra tutti gli aspetti a tua disposizione. Per filtrare in base ai valori di aspetto, fai clic su Filtra in base ai valori di aspetto e poi seleziona i valori.
  • Progetto elenca tutti i progetti a tua disposizione.
  • Gli alias del tipo sono tipi di dati associati a un tipo di voce. Un tipo di voce potrebbe avere il nome projects/test-project/locations/us/entryTypes/my-entry-type, ma puoi cercarlo utilizzando gli alias del tipo TABLE o DATABASE. Puoi impostare uno o più alias di tipo quando crei o aggiorni un tipo di voce.
  • I set di dati provengono da BigQuery.

I filtri Sistemi, Alias di tipo, Progetto e Set di dati vengono visualizzati a seconda della query corrente nel campo Cerca.

Per utilizzare la ricerca solo per parole chiave:

Console

  1. Se ti trovi nella modalità di ricerca in linguaggio naturale, fai clic su Torna alla ricerca per parole chiave.
  2. Nel campo Trova risorse tra progetti, inserisci la query.

  3. Per perfezionare la ricerca, utilizza il riquadro Filtri.

    Per l'elenco dei filtri disponibili, consulta Filtri di ricerca per parole chiave.

    Puoi aggiungere manualmente i seguenti filtri:

    • Aggiungi un filtro per progetto: in Progetto, fai clic su Aggiungi progetto. Cerca un progetto specifico, selezionalo e fai clic su Apri.
    • Aggiungi un filtro per tipo di aspetto: in Aspetti, fai clic sul menu Aggiungi altri tipi di aspetto. Cerca un modello specifico, selezionalo e poi fai clic su Ok.

  4. (Facoltativo) Oltre agli asset a tua disposizione, puoi cercare risorse disponibili pubblicamente in Google Cloud selezionando Includi set di dati pubblici.

    Utilizza i seguenti suggerimenti per creare una query di ricerca:

    • Racchiudi l'espressione di ricerca tra virgolette se contiene spazi. Ad esempio, "search terms".
    • Precedi una parola chiave con NOT per trovare la negazione logica del filtro keyword:term. Puoi anche utilizzare gli operatori booleani AND e OR per combinare le espressioni di ricerca. Gli operatori AND, OR e NOT non sono sensibili alle maiuscole.

    Ad esempio, NOT column:term elenca tutte le colonne tranne quelle che corrispondono al termine specificato. Per un elenco di parole chiave e altri termini che puoi utilizzare in un'espressione di ricerca di Knowledge Catalog, consulta Sintassi di ricerca.

gcloud

Per cercare risorse utilizzando la modalità di ricerca solo per parole chiave, utilizza il comando gcloud dataplex entries search e ometti il flag --semantic-search oppure utilizza il flag --no-semantic-search.

REST

Per cercare risorse utilizzando la modalità di ricerca solo per parole chiave, utilizza il metodo searchEntries con il parametro di query semanticSearch impostato su false.

Limitazioni

La ricerca presenta le seguenti limitazioni:

  • Le risorse pubbliche non rientrano nell'ambito della ricerca in linguaggio naturale.
  • Gli aspetti collegati ai link delle voci non rientrano nell'ambito della ricerca in linguaggio naturale.

Passaggi successivi