Data Catalog로 검색하는 방법

이 문서에서는 Data Catalog를 사용하여 Googld Cloud 프로젝트의 데이터 세트, 테이블, 뷰, Cloud Pub/Sub와 같은 데이터 애셋 검색을 수행하는 방법을 설명합니다.

검색 범위

권한이 다른 사용자의 경우 검색 결과가 다를 수 있습니다. Data Catalog 검색 결과는 사용자의 IAM 역할 및 권한에 따라 범위가 지정됩니다. 사용자에게 객체에 대한 BigQuery 메타데이터 읽기 액세스 권한이 있으면 해당 객체가 Data Catalog 검색 결과에 표시됩니다.

예를 들어 테이블을 검색하려면 해당 테이블에 대해 bigquery.tables.get 권한이 필요하고, 데이터 세트를 검색하려면 해당 데이터 세트에 대해 bigquery.datasets.get 권한이 필요합니다. BigQuery 메타데이터 뷰어 역할(roles/bigquery.metadataViewer)에는 데이터 세트, 테이블, 뷰를 검색 결과에 표시하기 위해 필요한 최소 메타데이터 읽기 권한이 포함됩니다.

날짜로 샤딩된 테이블

Data Catalog는 날짜로 샤딩된 테이블을 단일 논리 항목으로 집계합니다. 이 항목에는 가장 최근 날짜의 테이블 샤드와 동일한 스키마가 있으며 총 샤드 수에 대한 집계 정보가 포함됩니다. 이 항목은 항목이 속한 데이터 세트에서 액세스 수준을 가져옵니다. Data Catalog 검색에는 사용자에게 해당 항목이 포함된 데이터 세트에 대한 액세스 권한이 있는 경우에만 이러한 논리적 항목이 표시됩니다. 개별 데이터 공유 테이블은 데이터 카탈로그에 있고 태그를 지정할 수 있더라도 Data Catalog 검색에 표시되지 않습니다.

데이터 애셋 검색 방법

Console

  1. Google Cloud Console의 Data Catalog 홈페이지에서 데이터 애셋 검색을 수행할 수 있습니다. 또한 데이터 애셋 및 검색 팁 패널에서 항목을 선택하여 검색을 필터링할 수 있습니다.

  2. 검색을 클릭하거나 Data Catalog 홈페이지의 데이터 애셋 및 검색 팁 패널에서 항목을 선택하면 검색 페이지가 열립니다. 홈 페이지에서 데이터 애셋 또는 검색 팁 항목을 선택하면 유형 패널 또는 검색 상자 표현식에 적용되어 검색이 한정됩니다.

  3. 검색창 아래의 데이터 유형 상자를 클릭하고 검색할 유형을 선택하여 특정 데이터 애셋 유형을 필터링할 수 있습니다.

    예시: 공개 택시 운행 데이터 세트 목록을 나열하려면 데이터 세트 유형을 선택하고 검색창에 'trips'를 입력한 후 검색을 클릭합니다. 다음 결과를 표시하도록 공개 데이터 세트 포함이 선택되어 있는지 확인합니다.

  4. 검색 상자에서 검색어에 keyword:value를 추가하여 검색을 필터링할 수 있습니다.

    키워드설명
    name: 일치하는 데이터 애셋 이름을 찾습니다.
    column: 일치하는 열 이름을 찾습니다.
    description: 일치하는 테이블 설명을 찾습니다.

  5. 검색 상자에서 검색어에 다음 태그 키워드 프리픽스 중 하나를 추가하여 태그 검색을 수행할 수 있습니다.

    태그설명
    tag:project-name.tag_template_name 일치하는 태그 이름을 찾습니다.
    tag.project-name.tag_template_name.key 일치하는 태그 키를 찾습니다.
    tag.project-name.tag_template_name.key:value 일치하는 태그 key:string value 쌍을 찾습니다.

Python

"""This application demonstrates how to perform search operations with the
Cloud Data Catalog API.

For more information, see the README.md under /datacatalog and the
documentation at https://cloud.google.com/data-catalog/docs.
"""

import argparse

def search(organization_id, search_string):
    """Searches Data Catalog entries for a given organization."""
    from google.cloud import datacatalog_v1

    datacatalog = datacatalog_v1.DataCatalogClient()

    scope = datacatalog_v1.types.SearchCatalogRequest.Scope()
    scope.include_org_ids.append(organization_id)

    # Alternatively, search using project scopes.
    # scope.include_project_ids.append("my_project_id")

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

if __name__ == '__main__':
    parser = argparse.ArgumentParser(
        description=__doc__,
        formatter_class=argparse.RawDescriptionHelpFormatter
    )

    parser.add_argument('organization_id',
                        help='Your Google Cloud organization ID')
    parser.add_argument('query', help='Your custom query')

    args = parser.parse_args()

    search_results = None

    if args.query:
        search_results = search(args.organization_id, args.query)
    else:
        raise Exception('Please provide valid search input.')

    for result in search_results:
        print(result)

자바

/*
This application demonstrates how to perform search operations with the
Cloud Data Catalog API.

For more information, see the README.md under /datacatalog and the
documentation at https://cloud.google.com/data-catalog/docs.
*/

package com.example.datacatalog;

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

public class SearchCatalog {

  public static void searchCatalog() {
    // TODO(developer): Replace these variables before running the sample.
    String orgId = "111111000000";
    String query = "type=dataset";
    searchCatalog(orgId, query);
  }

  /**
   * Search Data Catalog entries for a given organization.
   *
   * @param orgId The organization ID to which the search will be scoped, e.g. '111111000000'.
   * @param query The query, e.g. 'type:dataset'.
   */
  public static void searchCatalog(String orgId, String query) {
    // Create a scope object setting search boundaries to the given organization.
    Scope scope = Scope.newBuilder().addIncludeOrgIds(orgId).build();

    // Alternatively, search using project scopes.
    // Scope scope = Scope.newBuilder().addAllIncludeProjectIds("my-project").build();

    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the "close" method on the client to safely clean up any remaining background resources.
    try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {

      // Search the catalog.
      SearchCatalogRequest searchCatalogRequest =
          SearchCatalogRequest.newBuilder().setScope(scope).setQuery(query).build();
      SearchCatalogPagedResponse response = dataCatalogClient.searchCatalog(searchCatalogRequest);

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

    } catch (Exception e) {
      System.out.print("Error during SearchCatalog:\n" + e.toString());
    }
  }
}

Node.js

// This application demonstrates how to perform search operations with the
// Cloud Data Catalog API.

async function search() {

  // -------------------------------
  // Import required modules.
  // -------------------------------
  const { DataCatalogClient } = require('@google-cloud/datacatalog').v1;
  const datacatalog = new DataCatalogClient();

  // -------------------------------
  // Set your Google Cloud Organization ID.
  // -------------------------------
  // TODO: Replace your organization ID in the next line.
  const organizationId = 111111000000;

  // -------------------------------
  // Set your custom query.
  // -------------------------------
  // TODO: If applicable, edit the query string in the next line.
  const query = 'type=dataset'

  // Create request.
  const scope = {
    includeOrgIds: [organizationId],
    // Alternatively, search using project scopes.
    // includeProjectIds: ['my-project'],
  };

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

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

search().then(response => { console.log(response) });

REST 및 명령줄

해당 언어의 Cloud 클라이언트 라이브러리에 액세스할 수 없거나 REST 요청을 사용하여 API를 테스트하려는 경우 다음 예시를 참조하고 Data Catalog REST API 문서를 참조하세요.

1. 카탈로그 검색

아래의 요청 데이터를 사용하기 전에 다음을 바꿉니다.

HTTP 메서드 및 URL:

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

JSON 요청 본문:

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

요청을 보내려면 다음 옵션 중 하나를 펼칩니다.

다음과 비슷한 JSON 응답이 표시됩니다.

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