在 Knowledge Catalog 中搜尋資源

您可以使用 Knowledge Catalog (舊稱 Dataplex Universal Catalog) 搜尋功能，在整個機構中探索資源，並支援自然語言搜尋 (含語意比對)、關鍵字搜尋和廣泛的搜尋語法。

用途

以下列出常見的搜尋用途，並提供說明和查詢範例：

  • 指定資產查詢：搜尋與資產名稱、資料欄或說明相關的關鍵字，即可找出特定資產。

    查詢範例

    • retail_transactions_2026
    • customer_id
    • column:customer_id

  • 廣泛探索資料：使用開放式自然語言或關鍵字查詢，找出整個機構中的相關資產。

    查詢範例

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

  • 工作流程的範圍資產擷取：列舉特定容器 (例如專案) 內的資產，或具有特定屬性 (例如類型或系統) 的資產。這種方法常用於程式輔助和代理工作流程。

    查詢範例

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

如要在 Knowledge Catalog 中存取搜尋功能，請使用下列選項：

運作方式

搜尋功能會自動為 Knowledge Catalog 中維護的資料資產建立所有內容的索引。包含下列項目：

  • 從 BigQuery 和 Cloud SQL 等 Google Cloud 資料來源自動擷取的中繼資料
  • 透過連接器和整合功能擷取資源的脈絡
  • 您為資源建立的其他內容 (例如代表業務情境或說明資料語意)，並以層面或連結的業務字詞形式擷取。

處理查詢時，搜尋會同時套用語意和關鍵字比對。下表說明可搭配 Knowledge Catalog 搜尋使用的查詢類型，以及說明和查詢範例：

查詢類型 用量 範例
單一關鍵字 針對中繼資料元素 (例如資產名稱、說明和結構定義) 進行完全比對和子字串比對。 prd_fin_invoices_fct_v02
部分關鍵字和權杖化片段 比對中繼資料內容中的子字串，即使資源含有縮寫字詞、以空格分隔的字詞或命名變化，也能找到資源。 fin transactions 2026 (相符 prd_fin_transactions_fy2026_raw)
自然語言查詢 使用語意比對，不需完全比對名稱或資料欄。 customer churn prediction features
結構化述詞 結合自由文字查詢和明確述詞篩選器，縮小搜尋結果範圍。 audit logs system=bigquery
擴充語法 如要精準搜尋，請縮小範圍。擴充語法最常用於代理式和程式輔助式應用情境。詳情請參閱搜尋語法。 (system:bigquery OR system:spanner) AND column:credit_card_number aspect:classification.tier=PII -projectid:sandbox-project

搜尋範圍

Knowledge Catalog 搜尋結果會遵守您在來源系統中對應資源的權限。

舉例來說，如果您有物件的 BigQuery 中繼資料讀取權，該物件就會顯示在 Knowledge Catalog 的搜尋結果中。如果您有權存取 BigQuery 資料表，但無權存取包含該資料表的資料集，系統仍會在 Knowledge Catalog 搜尋中顯示該資料表。

根據預設，搜尋範圍會限定在貴機構。結果只會顯示與您搜尋的專案屬於同一個機構的資源。

搜尋結果只會顯示與執行搜尋的專案位於相同 VPC Service Controls 範圍的資源。使用Google Cloud 控制台時，這是控制台中選取的專案。

如要將搜尋結果範圍擴大到專案的 VPC Service Controls 範圍以外的資源，請使用 VPC Service Controls 輸入和輸出規則。這些規則可讓您在組織內私下有效率地交換資料。您可以使用Google Cloud 控制台，或透過 JSON 或 YAML 檔案設定輸入和輸出規則。請參閱下列 YAML 範例，並參閱 VPC Service Controls 說明文件，根據您的特定需求調整規則。

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

如要進一步瞭解使用 Knowledge Catalog 搜尋功能所需的 Identity and Access Management 角色，請參閱「Knowledge Catalog IAM 角色」。

使用 VPC Service Controls 依環境隔離搜尋結果

如要在開發、測試和正式環境等環境之間隔離 Knowledge Catalog 搜尋結果，請為每個環境設定個別的 VPC Service Controls 邊界。將包含資料資產的專案，以及用於執行搜尋的專案，都指派給相應環境的 perimeter。從特定範圍內的專案執行搜尋時，只會傳回位於相同範圍內的資產結果。

搜尋中的回憶集錦限制

Knowledge Catalog 搜尋查詢無法保證完整召回，也就是說，搜尋結果可能不會與查詢相符。此外，如果重複搜尋查詢，傳回 (和未傳回) 的結果可能會有所不同。

如要查詢所有 Knowledge Catalog 中繼資料，您可以將中繼資料匯出至 Cloud Storage，然後從 BigQuery 查詢。詳情請參閱「匯出中繼資料」。

事前準備

執行搜尋前，請確認您已獲授予必要角色，並啟用必要的 API。

必要的角色

如要取得在 Knowledge Catalog 中搜尋項目及存取搜尋結果所需的權限，請要求管理員授予您下列 IAM 角色：

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色，取得必要權限。

系統會獨立檢查搜尋結果的權限，與所選專案無關。

Knowledge Catalog 中的搜尋結果會根據您的角色設定範圍。如要在 Knowledge Catalog 中搜尋資產，您必須有權存取來源系統中的相應資源。詳情請參閱本文的「搜尋範圍」一節。

舉例來說，如要搜尋 BigQuery 資料集、資料表、檢視區塊和模型，您必須具備這些項目的相應權限。詳情請參閱「BigQuery 權限」一文。

下表列出所需的最低權限：

  • 如要搜尋資料表，您必須具備該資料表的 bigquery.tables.get 權限。
  • 如要搜尋資料集，您必須具備該資料集的 bigquery.datasets.get 權限。

舉例來說，如要搜尋 Cloud SQL 執行個體、資料庫、結構定義、資料表和檢視區塊，您必須具備這些項目的相應權限。詳情請參閱「Cloud SQL 角色和權限」。

啟用 API

啟用 Dataplex API。

啟用 API 時所需的角色

如要啟用 API，您必須具備 serviceusage.services.enable 權限。如果您建立了專案，可能已透過「擁有者」角色 (roles/owner) 取得這項權限。否則，您可以透過「服務使用情形管理員」角色 (roles/serviceusage.serviceUsageAdmin) 取得這項權限。瞭解如何授予角色。

啟用 API

搜尋資源

控制台

如要搜尋資源，請按照下列步驟操作：

  1. 在 Google Cloud 控制台，前往 Knowledge Catalog 的「Search」(搜尋) 頁面。

    前往「Search」(搜尋) 頁面

  2. 如果看到「試用自然語言搜尋」按鈕提示，請點選該按鈕。 系統預設會選取自然語言搜尋。

  3. 在「以自然語言尋找各項專案的資源」欄位中輸入查詢，然後按一下「Enter」。

  4. 如要修正搜尋結果，請按一下「篩選器」。 如需可用篩選器的清單，請參閱「篩選器」。

  5. 如要查看搜尋資源的詳細資訊，請在搜尋結果中點選資源名稱。系統隨即會開啟項目詳細資料頁面。

Google Cloud CLI

如要搜尋資源，請使用 gcloud dataplex entries search 指令：

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

將 PROJECT_ID 替換為 Google Cloud 專案 ID。

C#

C#

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 C# 設定說明操作。詳情請參閱 Knowledge Catalog C# API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Go 設定說明操作。詳情請參閱 Knowledge Catalog Go API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。


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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Java 設定說明操作。詳情請參閱 Knowledge Catalog Java API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Node.js 設定說明操作。詳情請參閱 Knowledge Catalog Node.js API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 PHP 設定說明操作。詳情請參閱 Knowledge Catalog PHP API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Python 設定說明操作。詳情請參閱 Knowledge Catalog Python API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

# 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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

如要搜尋資源，請使用 searchEntries 方法，並將 semanticSearch 參數設為 true。

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

更改下列內容：

  • PROJECT_ID：您 Google Cloud 專案的 ID
  • LOCATION：專案所在的區域 (例如 us-central1)

篩選器

篩選器可縮小搜尋結果範圍。

如果您在多個區段中提供篩選器，系統會使用 AND 邏輯運算子評估這些篩選器。搜尋結果會包含符合所選每個部分中至少一項條件的資源。舉例來說，如果您選取 BigQuery 系統和資料集資源類型，搜尋結果會包含 BigQuery 資料集，但不包含 Vertex AI 資料集。

如果您在單一區段中選取多個篩選器，系統會使用 OR 邏輯運算子評估這些篩選器。舉例來說，如果您選取資料集資源類型和資料表資源類型，搜尋結果就會同時包含資料集和資料表。

可用的篩選器如下：

  • 範圍：在整個機構 (預設)、目前專案或僅限已加星號的資源中搜尋。詳情請參閱本文的「搜尋範圍」一節。
  • 系統：資源所屬的 Google Cloud 服務，例如 BigQuery。Knowledge Catalog 系統包含項目群組。
  • 專案：要搜尋的專案。
  • 類型：資源類型，例如 BigQuery 連線、Cloud Storage 值區或資料庫。視資源類型而定，您也可以依子類型篩選，例如連線類型或 SQL 方言。
  • 選取地點：要搜尋的地點。
  • 選取資料集：搜尋結果僅限於屬於所選 BigQuery 資料集的 BigQuery 資源。在「Type to filter」(輸入篩選條件) 欄位中，輸入資料集名稱。
  • 切面類型：與您要搜尋的資源相關聯的 Knowledge Catalog切面類型。如要依切面值篩選，請按一下「篩選切面類型值」，然後選取值。

查看搜尋傳回的資產詳細資料

控制台

使用 Knowledge Catalog 搜尋功能查看資產詳細資料。

  1. 在 Knowledge Catalog 搜尋資產。

  2. 在搜尋結果中，按一下要查看詳細資料的資產。

    系統會開啟項目詳細資料頁面。這個頁面包含下列章節：

    • 項目詳細資料：包括項目類型、系統、平台、完整名稱、建立時間、上次修改時間、說明和管理員等資訊。
    • 總覽：項目的總覽 (如有)。
    • 切面：為項目定義的必要和選用切面。 詳情請參閱「各類別的面向」。

gcloud

gcloud dataplex entries lookup 指令：

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

更改下列內容：

  • ENTRY_ID：項目的 ID
  • ENTRY_GROUP_ID：項目群組的 ID
  • LOCATION：專案所在的區域
  • PROJECT_ID： Google Cloud 專案的 ID

C#

C#

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 C# 設定說明操作。詳情請參閱 Knowledge Catalog C# API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Go 設定說明操作。詳情請參閱 Knowledge Catalog Go API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。


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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Java 設定說明操作。詳情請參閱 Knowledge Catalog Java API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Node.js 設定說明操作。詳情請參閱 Knowledge Catalog Node.js API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 PHP 設定說明操作。詳情請參閱 Knowledge Catalog PHP API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Python 設定說明操作。詳情請參閱 Knowledge Catalog Python API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

# 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

在試用這個範例之前，請先按照「使用用戶端程式庫的 Knowledge Catalog 快速入門導覽課程」中的 Ruby 設定說明操作。詳情請參閱 Knowledge Catalog Ruby API 參考文件。

如要向 Knowledge Catalog 進行驗證，請設定應用程式預設憑證。詳情請參閱「為本機開發環境設定驗證機制」。

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

如要查看資產詳細資料，請使用 lookupEntry 方法。

為提供回溯相容性，Knowledge Catalog 提供僅限關鍵字的搜尋模式，標準搜尋模式則支援語意和關鍵字比對。

除非需要關鍵字搜尋功能才能向後相容，否則建議使用標準搜尋模式。

僅限關鍵字的搜尋篩選器

關鍵字搜尋的篩選條件會歸入下列區段：

  • BigQuery、Cloud SQL 等系統。Knowledge Catalog 系統包含自訂項目。
  • 「構面」會列出所有可用的構面。如要依切面值篩選，請按一下「篩選切面值」，然後選取值。
  • 「專案」會列出所有可用的專案。
  • 類型別名是與項目類型相關聯的資料類型。項目類型可能有名稱 projects/test-project/locations/us/entryTypes/my-entry-type，但您可以使用類型別名 TABLE 或 DATABASE 搜尋。您可以在建立或更新項目類型時，設定一或多個型別別名。
  • 資料集來自 BigQuery。

系統會根據「搜尋」欄位中的目前查詢，顯示「系統」、「型別別名」、「專案」和「資料集」篩選器。

如要使用僅限關鍵字的搜尋功能，請按照下列步驟操作：

控制台

  1. 如果目前處於自然語言搜尋模式，請按一下「改回關鍵字搜尋」。
  2. 在「尋找各項專案的資源」欄位中輸入查詢。

  3. 如要修正搜尋範圍，請使用「篩選器」面板。

    如需可用篩選器的清單，請參閱「關鍵字搜尋篩選器」。

    您可以手動新增下列篩選器：

    • 新增專案篩選器：在「專案」中，按一下「新增專案」。搜尋特定專案，選取專案，然後按一下「開啟」。
    • 新增切面類型篩選器：在「切面」中，按一下「新增更多切面類型」選單。搜尋特定範本，選取範本，然後按一下「確定」。

  4. 選用：除了可用的資產外，您也可以選取「Include public datasets」(納入公開資料集)，在 Google Cloud 中搜尋公開資源。

    請參考下列訣竅建構搜尋查詢：

    • 如果搜尋運算式中包含空格，請使用引號將其括住。例如 "search terms"。
    • 在關鍵字前面加上 NOT，即可比對 keyword:term 篩選器的邏輯否定。您也可以使用 AND 和 OR 布林運算子合併搜尋運算式。AND、OR 和 NOT 運算子不區分大小寫。

    舉例來說，NOT column:term 會列出所有資料欄，但排除與指定字詞相符的資料欄。如需您可以在 Knowledge Catalog 搜尋運算式中使用的關鍵字與其他字詞的清單，請參閱「搜尋語法」。

gcloud

如要使用僅限關鍵字的搜尋模式搜尋資源，請使用 gcloud dataplex entries search 指令並省略 --semantic-search 旗標，或使用 --no-semantic-search 旗標。

REST

如要使用僅限關鍵字的搜尋模式搜尋資源，請使用 searchEntries 方法，並將 semanticSearch 查詢參數設為 false。

限制

搜尋功能有下列限制：

  • 自然語言搜尋功能不支援搜尋公開資源。
  • 附加至項目連結的層面不在自然語言搜尋的範圍內。

後續步驟