Sintaksis penelusuran untuk Knowledge Catalog

Dokumen ini menjelaskan sintaksis untuk penelusuran Knowledge Catalog.

Knowledge Catalog memungkinkan Anda menemukan, membuat katalog secara terpusat, mengelola, dan memahami data organisasi Anda. Untuk menemukan aset data tertentu dalam katalog data Anda secara efisien, Anda dapat menggunakan kueri penelusuran yang canggih. Sintaksis untuk kueri penelusuran mencakup:

  • Penelusuran sederhana: Cara menemukan aset data menggunakan satu istilah penelusuran.
  • Predikat yang memenuhi syarat: Cara mempersempit penelusuran menggunakan kolom metadata tertentu seperti nama, lokasi, atau deskripsi.
  • Penelusuran aspek: Cara menelusuri entri berdasarkan metadata bisnis dan teknis yang dilampirkan.
  • Operator logika: Cara menggabungkan beberapa kriteria penelusuran menggunakan AND dan OR untuk membuat kueri yang kompleks. Dengan memahami sintaksis ini, Anda dapat dengan cepat menemukan data yang Anda butuhkan.

Sebelum memulai

Pahami grup entri, entri, link entri, aspek, jenis entri, jenis link entri, dan jenis aspek Knowledge Catalog. Lihat Tentang pengelolaan metadata di Knowledge Catalog.

Knowledge Catalog menawarkan penelusuran yang memanfaatkan AI untuk memahami kueri bahasa alami dan makna semantik. Dengan penelusuran ini, Anda dapat menemukan resource menggunakan bahasa sehari-hari, sehingga tidak memerlukan sintaksis yang kompleks, sekaligus mendukung pencocokan kata kunci dan filter.

Anda dapat menemukan aset dengan memasukkan istilah atau frasa tanpa sintaksis tertentu. Knowledge Catalog melakukan penelusuran luas dengan mencocokkan kueri Anda dengan beberapa kolom metadata, termasuk yang berikut:

  • Nama, nama tampilan, atau deskripsi resource
  • Jenis resource
  • Project ID
  • Deskripsi ringkasan
  • Nama kolom (atau nama kolom bertingkat) dalam skema resource
  • Deskripsi kolom
  • Nama yang sepenuhnya memenuhi syarat
  • Kontak
  • Aspek

Menggunakan sintaksis kueri

Untuk penelusuran yang lebih akurat, Anda dapat membuat kueri menggunakan sintaksis tertentu, termasuk penentu, operator logika, dan penelusuran aspek.

Predikat yang memenuhi syarat

Anda dapat memenuhi syarat predikat dengan menambahkan awalan kunci yang membatasi pencocokan ke bagian metadata tertentu:

  • Tanda sama dengan (=) membatasi penelusuran ke pencocokan persis.
  • Titik dua (:) setelah kunci mencocokkan predikat dengan substring atau token dalam nilai di hasil penelusuran.

Tokenisasi membagi aliran teks menjadi serangkaian token, dengan setiap token biasanya sesuai dengan satu kata.

Contoh:

  • name:foo memilih resource dengan nama yang berisi substring foo, seperti foo1 dan barfoo.
  • description:foo memilih resource dengan token foo dalam deskripsi, seperti bar dan foo.
  • location=foo cocok dengan resource di lokasi tertentu dengan foo sebagai nama lokasi.

Perilaku penentu ini dapat sedikit berbeda di antara mode penelusuran, seperti yang dijelaskan di bagian berikut.

Kunci predikat type, system, location, dan description, serta penelusuran aspek (tidak termasuk has) hanya mendukung penentu pencocokan persis (=), bukan penentu substring (:). Misalnya, type=foo.

Penelusuran Knowledge Catalog mendukung penentu berikut:

Penentu Deskripsi
name:x Cocok dengan x sebagai substring dari ID resource atau nama tampilan resource.
displayname:x Cocok dengan x sebagai substring dari nama tampilan resource.
column:x Cocok dengan x sebagai substring dari nama kolom (atau nama kolom bertingkat) dalam skema resource.
description:x Cocok dengan x sebagai token dalam deskripsi resource.
labels:bar Cocok dengan resource BigQuery yang memiliki label (dengan nilai tertentu ) dan kunci label memiliki bar sebagai substring.
labels=bar Cocok dengan resource BigQuery yang memiliki label (dengan nilai tertentu) dan kunci label sama dengan bar sebagai string.
labels.bar:x Cocok dengan x sebagai substring dalam nilai label dengan kunci bar yang dilampirkan ke resource BigQuery.
labels.foo=bar Cocok dengan resource BigQuery yang kuncinya sama dengan foo dan nilai kuncinya sama dengan bar.
type=TYPE Cocok dengan resource dari jenis entri tertentu atau alias jenisnya.
projectid:bar Cocok dengan resource dalam Google Cloud project yang cocok dengan bar sebagai substring dalam ID.
parent:x Cocok dengan x sebagai substring dari jalur hierarkis dari sebuah resource.
system=SYSTEM Cocok dengan resource dari sistem tertentu.
location=LOCATION

Cocok dengan resource di lokasi tertentu dengan nama yang persis. Misalnya, location=us-central1 cocok dengan aset yang dihosting di Iowa.

Aset BigQuery Omni mendukung penentu ini dengan menggunakan nama lokasi BigQuery Omni. Misalnya, location=aws-us-east-1 cocok dengan aset BigQuery Omni di Virginia Utara.

createtime

Menemukan resource yang dibuat dalam, sebelum, atau setelah tanggal atau waktu tertentu.

Contoh:

  • createtime:2019-01-01 cocok dengan semua resource yang dibuat pada 2019-01-01.
  • createtime<2019-02 cocok dengan semua resource yang dibuat sebelum 2019-02-01T00:00:00.
  • createtime>2019-02 cocok dengan semua resource yang dibuat setelah 2019-02-01T00:00:00.
  • createtime>-30d cocok dengan semua resource yang dibuat dalam 30 hari terakhir.
  • createtime<=-30d cocok dengan semua resource yang dibuat 30 hari yang lalu atau sebelumnya.
  • createtime<=-1d cocok dengan semua resource yang dibuat pada hari sebelumnya.

Format stempel waktu: YYYY-MM-DDThh:mm:ss

Semua stempel waktu harus dalam GMT; zona waktu tidak didukung. Stempel waktu parsial, pemisah tanggal tanda hubung (-), dan pemisah tanggal garis miring (/) didukung.

Contoh:

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22
updatetime

Menemukan resource yang diperbarui dalam, sebelum, atau setelah tanggal atau waktu tertentu.

Contoh:

  • updatetime:2019-01-01 cocok dengan semua resource yang diperbarui pada 2019-01-01.
  • updatetime<2019-02 cocok dengan semua resource yang diperbarui sebelum 2019-02-01T00:00:00.
  • updatetime>2019-02 cocok dengan semua resource yang diperbarui setelah 2019-02-01T00:00:00.
  • updatetime>-30d cocok dengan semua resource yang diperbarui dalam 30 hari terakhir.
  • updatetime<-30d cocok dengan semua resource yang diperbarui 30 hari yang lalu atau sebelumnya.
  • updatetime=-1d cocok dengan semua resource yang diperbarui pada hari sebelumnya.
  • updatetime>=-30d cocok dengan semua resource yang diperbarui dalam 30 hari terakhir.
  • updatetime<=-30d cocok dengan semua resource yang diperbarui 30 hari yang lalu atau sebelumnya.

Format stempel waktu: YYYY-MM-DDThh:mm:ss

Semua stempel waktu harus dalam GMT; zona waktu tidak didukung. Stempel waktu parsial, pemisah tanggal tanda hubung (-), dan pemisah tanggal garis miring (/) didukung.

Contoh:

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22

Anda dapat menggunakan sintaksis kueri untuk menelusuri entri berdasarkan aspek yang dilampirkan.

Pencocokan substring mencoba mencocokkan dengan jumlah aspek yang terbatas. Jika Anda tidak dapat menemukan entri menggunakan fragmen jalur, gunakan jalur lengkap untuk mempersempit penelusuran dan meningkatkan recall.

Penentu Deskripsi
aspect:x
atau
has:x
Cocok dengan x sebagai substring dari jalur lengkap ke jenis aspek dari aspek yang dilampirkan ke entri, dalam format projectid.location.ASPECT_TYPE_ID
aspect=x
atau
has=x
Cocok dengan x sebagai jalur lengkap ke jenis aspek dari aspek yang dilampirkan ke entri, dalam format projectid.location.ASPECT_TYPE_ID
x
OPERATOR
value

Menelusuri nilai kolom aspek. Cocok dengan x sebagai substring dari jalur lengkap ke jenis aspek dan nama kolom dari aspek yang dilampirkan ke entri, dalam format berikut:

  • Sintaksis untuk jenis aspek sistem:

    • ASPECT_TYPE_ID.FIELD_NAME
    • dataplex-types.ASPECT_TYPE_ID.FIELD_NAME
    • dataplex-types.LOCATION.ASPECT_TYPE_ID.FIELD_NAME

    Misalnya, kueri berikut cocok dengan entri yang nilai kolom type dalam aspek bigquery-dataset adalah default:

    • bigquery-dataset.type=default
    • dataplex-types.bigquery-dataset.type=default
    • dataplex-types.global.bigquery-dataset.type=default
  • Sintaksis untuk jenis aspek kustom:

    • Jika aspek dibuat di region global: PROJECT_ID.ASPECT_TYPE_ID.FIELD_NAME
    • Jika aspek dibuat di region tertentu: PROJECT_ID.REGION.ASPECT_TYPE_ID.FIELD_NAME

    Misalnya, kueri berikut cocok dengan entri yang nilai kolom is-enrolled dalam employee-info aspek adalah true.

    • example-project.us-central1.employee-info.is-enrolled=true
    • example-project.employee-info.is-enrolled=true

    Daftar operator yang didukung bergantung pada jenis kolom dalam aspek, sebagai berikut:

    • String: = (pencocokan persis)
    • Semua jenis angka: =, :, <, >, <=, >=, =>, =<
    • Enum: =
    • Tanggalwaktu: sama seperti untuk angka, tetapi nilai yang akan dibandingkan diperlakukan sebagai tanggalwaktu, bukan angka
    • Boolean: =

Hanya kolom tingkat atas aspek yang dapat ditelusuri.

Operator logika

Kueri dapat terdiri dari beberapa predikat dengan operator logika.

  • Jika Anda tidak menentukan operator, AND logika akan tersirat. Misalnya, foo bar menampilkan resource yang cocok dengan predikat foo dan predikat bar.
  • AND logika dan OR logika didukung. Misalnya, foo OR bar.
  • Anda dapat meniadakan predikat dengan awalan - (tanda hubung) atau NOT. Misalnya, -name:foo menampilkan resource dengan nama yang tidak cocok dengan predikat foo.

Sintaksis singkat

Sintaksis penelusuran singkat juga tersedia, menggunakan | (garis vertikal) untuk operator OR dan , (koma) untuk operator AND.

Misalnya, untuk menelusuri entri di dalam salah satu dari banyak project menggunakan operator OR, Anda dapat menggunakan sintaksis singkat berikut:

projectid:(id1|id2|id3|id4)

Penelusuran yang sama tanpa menggunakan sintaksis singkat akan terlihat seperti berikut:

projectid:id1 OR projectid:id2 OR projectid:id3 OR projectid:id4

Untuk menelusuri entri dengan nama kolom yang cocok, gunakan hal berikut:

  • AND: column:(name1,name2,name3)
  • OR: column:(name1|name2|name3)

Sintaksis singkat ini berfungsi untuk predikat yang memenuhi syarat, kecuali untuk label dalam penelusuran kata kunci.

Knowledge Catalog menyediakan mode penelusuran khusus kata kunci untuk kompatibilitas mundur, dengan mode penelusuran standar yang mendukung pencocokan semantik dan kata kunci. Sebaiknya gunakan mode penelusuran standar, kecuali jika penelusuran khusus kata kunci diperlukan untuk kompatibilitas mundur.

Tabel berikut merangkum perbedaan utama dalam penentu yang harus Anda pertimbangkan saat menggunakan penelusuran khusus kata kunci.

Penentu Perbedaan utama
name:x Cocok dengan x sebagai substring dari ID resource saja.
Penentu label

Menggunakan awalan label, bukan labels. Format sintaksis yang didukung mencakup:

  • label:bar
  • label=bar
  • label:bar:x
  • label=foo:bar
  • label.foo=bar
  • label.foo
orgid=number Cocok dengan resource dalam Google Cloud organisasi dengan nilai ID persis number, hanya didukung dalam penelusuran khusus kata kunci.
fully_qualified_name Mendukung fully_qualified_name:x (pencocokan substring) dan fully_qualified_name=x (pencocokan persis) (hanya didukung dalam penelusuran khusus kata kunci).
createtime dan updatetime Hanya mendukung tanggal persis (:) dan operator perbandingan dasar (<, >). Tidak mendukung filter waktu relatif (seperti -30d atau -1d) atau operator perbandingan seperti <=, >=, =, =>, =<.
Pembatasan pencocokan persis Kunci predikat type, system, location, dan orgid hanya mendukung pencocokan persis (=), bukan pencocokan substring (:).

Penelusuran aspek untuk penelusuran khusus kata kunci

Tabel berikut merangkum perbedaan utama dalam penelusuran aspek yang harus Anda pertimbangkan saat menggunakan penelusuran khusus kata kunci.

Elemen penelusuran aspek Perbedaan utama
Awalan penentu Mendukung aspect: dan aspect=. Tidak mendukung has: atau has=.
Sintaksis penelusuran nilai kolom aspek Memerlukan awalan aspect: saat menelusuri nilai kolom aspek (format: aspect:x OPERATOR value, seperti aspect:employee-info.is-enrolled=true atau aspect:employee=true).
Operator kolom string Kolom string mendukung pencocokan persis (=) dan pencocokan substring match (:).
Singkatan jenis aspek sistem Tidak mendukung singkatan jenis aspek sistem, seperti ASPECT_TYPE_ID.FIELD_NAME atau dataplex-types...).

Langkah berikutnya