Mengelola resource AlloyDB menggunakan Knowledge Catalog

Catatan: Integrasi Knowledge Catalog dengan AlloyDB kini diaktifkan secara default untuk semua cluster AlloyDB baru.

Integrasi Knowledge Catalog diaktifkan secara default untuk semua cluster AlloyDB baru, sehingga Anda dapat menelusuri dan mengelola resource AlloyDB untuk PostgreSQL menggunakan Knowledge Catalog, platform yang memungkinkan Anda menyimpan, mengelola, dan mengakses metadata. Integrasi ini membantu Anda menemukan dan memahami metadata AlloyDB, yang mendukung kasus penggunaan berikut:

• Analisis: Memahami dependensi dan menilai kesesuaian untuk berbagai kasus penggunaan.
• Pengelolaan Perubahan: Lacak dan kelola perubahan metadata secara efektif.
• Evolusi Skema: Pantau dan rencanakan modifikasi skema.

Knowledge Catalog otomatis mengambil metadata berikut dari cluster, instance, database, tabel, kolom, dan tampilan AlloyDB:

• Nama
• Lokasi (Wilayah)
• Label (untuk cluster dan instance)
• Integrasi Dataplex Diaktifkan (untuk cluster)
• Versi Database
• Jumlah CPU Mesin (untuk instance)
• Jenis Ketersediaan (untuk instance)
• Charset (untuk database)
• Kolasi (untuk database)
• Pemilik
• Deskripsi (untuk tabel, tampilan, kolom, dan kunci asing)
• Jenis (untuk cluster, instance, dan mesin)
• Kolom
  • Jenis Data
  • Mode
• Kunci Utama
• Kunci Asing
  • Tabel yang Direferensikan
  • Pemetaan Kolom
• Waktu Pembuatan
• Waktu Modifikasi Terakhir

Untuk mengetahui informasi selengkapnya, lihat Tentang pengelolaan metadata di Knowledge Catalog.

Catatan: Knowledge Catalog mengacu pada resource di AlloyDB dan di layanan Google Cloud lainnya sebagai aset. Dalam dokumen ini, resource AlloyDB—cluster, instance, database, tabel, skema, dan tampilan—disebut aset AlloyDB. Aset juga merujuk ke resource dan metadata Knowledge Catalog-nya.

Jenis penemuan metadata

Penemuan metadata Knowledge Catalog adalah proses otomatis yang memindai sumber data yang terhubung—seperti AlloyDB—untuk mengidentifikasi aset data seperti tabel, tampilan, dan database. Kemudian, Knowledge Catalog mengekstrak metadata teknis dari aset seperti skema, deskripsi, dan lokasi, ke dalam Knowledge Catalog.

Proses ini menyinkronkan metadata hampir secara real-time, yang membuat katalog tetap sinkron dengan sistem sumber. Untuk AlloyDB, metadata cluster dan instance ditemukan secara default. Penemuan metadata database, skema, tabel, dan tampilan diaktifkan secara default di cluster baru. Untuk cluster yang dibuat sebelum setelan default ini diterapkan (26 Februari 2026), aktifkan integrasi secara manual.

Penelusuran kata kunci dan penelusuran bahasa alami

Knowledge Catalog mendukung penelusuran kata kunci dan bahasa alami.

• Penelusuran kata kunci membantu Anda menemukan resource menggunakan kata kunci, filter, dan sintaksis yang ditentukan. Misalnya, untuk melihat semua database AlloyDB, masukkan system=AlloyDB AND type=Database.
• Penelusuran bahasa alami menggunakan AI untuk memahami kueri semantik. Alat ini membantu Anda menemukan resource menggunakan bahasa sehari-hari, sehingga tidak memerlukan sintaksis yang rumit. Misalnya, masukkan kueri seperti List all AlloyDB tables related to sales.

Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.

Contoh: Menemukan skema database AlloyDB

Untuk memahami proses penemuan metadata, pertimbangkan contoh cluster AlloyDB bernama user-data-cluster dengan integrasi Knowledge Catalog yang diaktifkan. Di dalam instance utama cluster ini, terdapat database bernama profiles, yang berisi tabel customers (id, email, signup_date) dan tabel virtual active_users (id, email).

Karena AlloyDB disinkronkan hampir secara real-time ke Knowledge Catalog, resource berikut tersedia:

• Cluster
• Kolom
• Database
• Instance
• Tabel
• Tampilan

Setelah penemuan selesai, telusuri aset ini—tabel customers dan active_users—di halaman Knowledge Catalog di konsol Google Cloud atau menggunakan API. Kemudian, lihat skemanya dan perkaya dengan metadata bisnis atau operasional tambahan.

Memperkaya metadata menggunakan aspek

Jenis aspek adalah resource yang dapat digunakan kembali dan berfungsi sebagai template untuk aspek. Jenis aspek membantu menghindari duplikasi pekerjaan dan pembuatan aspek yang tidak lengkap. Buat jenis aspek yang diperlukan menggunakan Knowledge Catalog.

Setelah membuat jenis aspek kustom, lampirkan aspek ke aset AlloyDB Anda. Dengan melampirkan aspek ke aset AlloyDB, Anda dapat melakukan hal berikut:

• Tambahkan metadata bisnis ke aset.
• Menelusuri aset berdasarkan metadata bisnis dan metadata kustom lainnya.

Untuk mempelajari lebih lanjut cara membuat jenis aspek dan melampirkan aspek ke AlloyDB, lihat Mengelola aspek dan memperkaya metadata.

Alur kerja penemuan metadata

Secara default, resource cluster dan instance diserap dan dapat ditemukan. Untuk menyerap dan menemukan resource database, skema, tabel, dan tampilan, ikuti langkah-langkah berikut:

1. Aktifkan integrasi Knowledge Catalog untuk cluster AlloyDB Anda menggunakan AlloyDB API jika belum diaktifkan. Langkah ini diperlukan untuk cluster yang dibuat sebelum 26 Februari 2026.

2. Telusuri aset AlloyDB Anda menggunakan halaman penelusuran Knowledge Catalog di konsol Google Cloud . Untuk mengetahui informasi selengkapnya, lihat Menelusuri resource di Knowledge Catalog.

3. Untuk menambahkan lebih banyak konteks ke aset AlloyDB, lampirkan aspek ke aset Anda. Aspek adalah entri metadata kustom yang membantu tata kelola dan analisis data. Misalnya, gunakan aspek untuk memberi label pada kolom yang berisi informasi identitas pribadi (PII). Untuk mengetahui informasi selengkapnya, lihat Mengelola aspek dan memperkaya metadata.

4. Buka resource AlloyDB Anda dengan mengikuti hierarki ini: Cluster > Database > Schema > Table atau View > Column. Hierarki ini memberikan tampilan mendetail tentang lanskap data Anda. Untuk mengetahui informasi selengkapnya, lihat Menelusuri resource di Knowledge Catalog.

Sebelum memulai

1. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Roles required to select or create a project

   • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
   • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

2. Verify that billing is enabled for your Google Cloud project.

3. Mengaktifkan Dataplex API untuk project.

   Mengaktifkan Dataplex API

4. Periksa izin.

   Anda harus memiliki peran dan izin Identity and Access Management (IAM) tertentu untuk menelusuri dan melampirkan entri ke aset AlloyDB. Untuk mengetahui informasi selengkapnya, lihat Peran dan izin IAM yang diperlukan untuk Knowledge Catalog.

Peran IAM yang diperlukan

Bagian ini menjelaskan peran dan izin yang diperlukan untuk menelusuri resource dan mengakses hasil penelusuran.

Peran yang diperlukan untuk mengakses hasil penelusuran

Untuk menelusuri dan melihat metadata AlloyDB di Knowledge Catalog, akun utama memerlukan izin untuk melihat resource AlloyDB, termasuk izin dataplex.projects.search.

Untuk memberikan izin ini kepada akun utama—seperti pengguna, grup, atau akun layanan—tetapkan peran IAM AlloyDB Viewer (roles/alloydb.viewer) pada project yang berisi resource AlloyDB.

Operasi Knowledge Catalog	Resource AlloyDB	Peran atau izin yang diperlukan
Menelusuri resource AlloyDB	Cluster	alloydb.clusters.get
	Kolom	alloydb.databases.get
	Instance	alloydb.instances.get
	Database	alloydb.databases.get
	Tabel	alloydb.databases.get
	Tampilan	alloydb.databases.get

Perhatian: Jika Anda memberikan peran roles/alloydb.viewer di level project, akun utama dengan peran ini dapat melihat metadata untuk semua instance AlloyDB dalam project.

Jika Anda tidak ingin menggunakan peran AlloyDB Viewer yang telah ditetapkan, tetapkan peran khusus yang mencakup izin alloydb.clusters.get, alloydb.instances.get, dan alloydb.databases.get.

Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses. Untuk mengetahui informasi selengkapnya tentang peran IAM AlloyDB, lihat Peran dan izin IAM untuk AlloyDB.

Peran yang diperlukan untuk menelusuri entri

Anda harus memiliki setidaknya salah satu peran IAM berikut pada project yang digunakan untuk penelusuran:

• Dataplex Catalog Admin (roles/dataplex.catalogAdmin)
• Dataplex Catalog Editor (roles/dataplex.catalogEditor)
• Dataplex Catalog Viewer (roles/dataplex.catalogViewer)

Izin pada hasil penelusuran diperiksa secara independen dari project yang dipilih. Untuk mengetahui informasi selengkapnya, lihat Menelusuri aset data dengan Knowledge Catalog.

Keaktualan data integrasi Knowledge Catalog

Secara default, Knowledge Catalog menyerap dan menemukan resource cluster dan instance, dan keaktualan metadatanya hampir real-time.

Integrasi Knowledge Catalog untuk resource database, skema, tabel, dan tampilan diaktifkan secara default saat Anda membuat cluster AlloyDB baru. Untuk mencegah metadata ini disinkronkan, nonaktifkan integrasi.

Mengaktifkan integrasi akan mengaktifkan ekspor metadata AlloyDB—seperti database, skema, dan tabel—ke bucket Cloud Storage untuk sinkronisasi berkala atau ke topik Pub/Sub untuk sinkronisasi hampir real-time, sehingga tersedia untuk Knowledge Catalog. Fitur ini hanya berlaku untuk cluster utama. Cluster sekunder yang digunakan untuk replikasi lintas region tidak mendukung integrasi Knowledge Catalog untuk metadata database, skema, tabel, dan tampilan.

Catatan: Metadata level resource, seperti metadata cluster dan instance, selalu diaktifkan dan tidak dapat dinonaktifkan.

Keaktualan metadata untuk resource ini bergantung pada waktu cluster dibuat atau dipulihkan:

• Hampir real-time: cluster yang dibuat atau dipulihkan pada atau setelah 3 April 2026, menyinkronkan metadata ke Knowledge Catalog hampir secara real-time. Update tersedia di Knowledge Catalog dalam waktu hingga 5 menit. Proses ekstraksi biasanya memerlukan waktu beberapa detik.

• Setiap beberapa jam: cluster yang dibuat atau dipulihkan antara 26 Februari 2026 dan 3 April 2026 memperbarui metadata di Knowledge Catalog setiap beberapa jam. Pembaruan tersedia di Knowledge Catalog dalam waktu hingga 48 jam. Proses ekstraksi biasanya memerlukan waktu beberapa menit, tetapi waktu penyelesaiannya bergantung pada ukuran CPU dan jumlah tabel.

Catatan: Untuk mengupgrade cluster dari setiap beberapa jam ke sinkronisasi hampir real-time, hubungi Google Cloud Dukungan.

Membuat AlloyDB dengan integrasi Knowledge Catalog dinonaktifkan

Anda dapat mengontrol integrasi ini saat membuat atau mengupdate cluster menggunakan Google Cloud CLI atau AlloyDB API:

gcloud

Gunakan perintah gcloud alloydb clusters create untuk membuat cluster AlloyDB. Jika Anda menghilangkan flag --enable-dataplex-integration, integrasi Knowledge Catalog akan diaktifkan secara default untuk metadata database, skema, tabel, dan tampilan. Untuk mengetahui daftar lengkap parameter panggilan ini, lihat gcloud alloydb clusters create. Untuk mengetahui informasi tentang setelan cluster, lihat Melihat setelan cluster dan instance.

Jangan sertakan informasi identitas pribadi atau yang sensitif dalam ID cluster Anda karena ID cluster mungkin terlihat dalam berbagai konteks operasional, seperti log sistem, dasbor pemantauan, dan komunikasi dukungan. Anda tidak perlu menyertakan project ID dalam nama cluster. Sistem akan otomatis menyertakan ID ini jika sesuai, misalnya, dalam file log.

Untuk menonaktifkan integrasi Knowledge Catalog untuk resource database, skema, tabel, dan tampilan, sertakan flag --no-enable-dataplex-integration:

gcloud alloydb clusters create CLUSTER_ID \
    --password=PASSWORD \
    --region=REGION \
    --no-enable-dataplex-integration

Lakukan penggantian berikut:

• CLUSTER_ID: ID cluster yang Anda buat. ID cluster harus diawali dengan huruf kecil dan dapat berisi huruf kecil, angka, dan tanda hubung.
• PASSWORD: sandi yang Anda gunakan untuk pengguna postgres default.
• REGION: ID region cluster.

REST

Gunakan metode POST untuk membuat cluster AlloyDB. Jika Anda menghilangkan dataplexConfig dari permintaan, integrasi Knowledge Catalog akan diaktifkan secara default untuk metadata database, skema, tabel, dan tampilan. Untuk mengetahui daftar lengkap parameter panggilan ini, lihat Metode: projects.locations.clusters.create. Untuk mengetahui informasi tentang setelan cluster, lihat Melihat setelan cluster dan instance.

Jangan sertakan informasi identitas pribadi atau yang sensitif dalam ID cluster Anda karena ID cluster mungkin terlihat dalam berbagai konteks operasional, seperti log sistem, dasbor pemantauan, dan komunikasi dukungan. Anda tidak perlu menyertakan project ID dalam nama cluster. Sistem akan otomatis menyertakan ID ini jika sesuai, misalnya, dalam file log.

Untuk menonaktifkan integrasi Knowledge Catalog untuk resource database, skema, tabel, dan tampilan, sertakan "dataplexConfig": { "enabled": false } dalam isi permintaan:

{
  "databaseVersion": "DATABASE_VERSION",
  "initialUser": {
    "user": "INITIAL_USERNAME",
    "password": "INITIAL_USER_PASSWORD"
  },
  "labels": {
    "test": "alloydb-cluster-full"
  },
  "dataplexConfig" : {
    "enabled" : false
  }
}

Lakukan penggantian berikut:

• DATABASE_VERSION: string enum versi database—misalnya, POSTGRES_16.
• INITIAL_USERNAME: nama pengguna yang Anda gunakan untuk pengguna postgres default.
• INITIAL_USER_PASSWORD: sandi yang Anda gunakan untuk pengguna postgres default.

Gunakan metode HTTP dan URL berikut:

POST https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID

Lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari project Google Cloud yang berisi cluster.
• LOCATION_ID: ID region cluster.
• CLUSTER_ID: ID cluster yang Anda buat. ID cluster harus diawali dengan huruf kecil dan dapat berisi huruf kecil, angka, dan tanda hubung.

Untuk mengirim permintaan Anda, gunakan salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Perintah berikut mengasumsikan bahwa Anda telah login ke Google Cloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Periksa akun yang aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

    curl -X POST \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"
      

PowerShell (Windows)

Perintah berikut mengasumsikan bahwa Anda login ke Google Cloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Periksa akun yang aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"| Select-Object -Expand Content

Anda akan menerima respons JSON yang mirip dengan yang berikut ini:

Respons

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.alloydb.v1.OperationMetadata",
    "createTime": "2024-09-25T22:19:33.735Z",
    "target": "projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Mengaktifkan integrasi Knowledge Catalog untuk cluster AlloyDB Anda

Untuk mengaktifkan integrasi Knowledge Catalog di cluster yang ada, gunakan salah satu prosedur berikut:

gcloud

Untuk mengaktifkan integrasi Knowledge Catalog di cluster yang ada, gunakan perintah gcloud alloydb clusters update dengan flag --enable-dataplex-integration.

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --enable-dataplex-integration

Lakukan penggantian berikut:

• CLUSTER_ID: nama cluster.
• REGION: ID region cluster.

REST

Untuk memperbarui kolom tertentu dari cluster yang ada, gunakan metode PATCH di projects.locations.clusters resource.

Gunakan metode HTTP dan URL berikut:

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

Lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari project Google Cloud yang berisi cluster.
• LOCATION_ID: ID region cluster.
• CLUSTER_ID: nama cluster.

Meminta isi JSON:

{
  "dataplexConfig": {
    "enabled": true
  }
}

Untuk mengirim permintaan Anda, gunakan salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Perintah berikut mengasumsikan bahwa Anda telah login ke Google Cloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Periksa akun yang aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

    curl -X PATCH \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"
      

PowerShell (Windows)

Perintah berikut mengasumsikan bahwa Anda telah login ke Google Cloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Periksa akun yang aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

Anda akan menerima respons JSON yang mirip dengan yang berikut ini:

Respons

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.alloydb.v1.OperationMetadata",
    "createTime": "2024-09-25T22:19:33.735Z",
    "target": "projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID",
    "verb": "update",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Memverifikasi integrasi Knowledge Catalog di cluster AlloyDB Anda

Untuk memverifikasi bahwa integrasi Knowledge Catalog diaktifkan di cluster yang ada, gunakan salah satu prosedur berikut:

gcloud

Untuk memverifikasi bahwa integrasi Knowledge Catalog diaktifkan di cluster yang ada, gunakan perintah gcloud alloydb clusters describe.

gcloud alloydb clusters describe CLUSTER_ID --region=REGION

Lakukan penggantian berikut:

• CLUSTER_ID: ID cluster.
• REGION: ID region cluster.

Output-nya mencakup bagian dataplexConfig dalam format YAML. Jika enabled adalah true, integrasi Knowledge Catalog akan diaktifkan:

dataplexConfig:
  enabled: true

REST

Untuk memverifikasi bahwa integrasi Knowledge Catalog diaktifkan di cluster yang ada, gunakan metode GET.

Gunakan metode HTTP dan URL berikut:

GET https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID

Lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari project Google Cloud yang berisi cluster.
• LOCATION_ID: ID region cluster.
• CLUSTER_ID: ID cluster.

Untuk mengirim permintaan Anda, gunakan salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Perintah berikut mengasumsikan bahwa Anda telah login ke Google Cloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Periksa akun yang aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"
      

PowerShell (Windows)

Perintah berikut mengasumsikan bahwa Anda telah login ke Google Cloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Periksa akun yang aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"| Select-Object -Expand Content

Anda akan menerima respons JSON untuk seluruh proto Cluster, yang mencakup pesan dataplexConfig:

{
  "dataplexConfig": {
    "enabled": true
  }
}

Catatan: Jika integrasi Knowledge Catalog dinonaktifkan di cluster, API akan menampilkan "dataplexConfig": {} karena proto3 menghilangkan kolom dengan nilai default.

Menonaktifkan integrasi Knowledge Catalog di cluster AlloyDB Anda

Jika Anda menonaktifkan integrasi Knowledge Catalog di cluster AlloyDB, hanya metadata cluster dan instance yang akan tersedia.

gcloud

Gunakan perintah gcloud alloydb clusters update dengan flag --no-enable-dataplex-integration untuk menonaktifkan integrasi.

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --no-enable-dataplex-integration

Lakukan penggantian berikut:

• CLUSTER_ID: ID cluster.
• REGION: ID region cluster.

REST

Gunakan contoh berikut untuk menonaktifkan integrasi.

Gunakan metode HTTP dan URL berikut:

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

Lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari Google Cloud project yang berisi cluster.
• LOCATION_ID: ID region cluster.
• CLUSTER_ID: ID cluster.

Meminta isi JSON:

{
  "dataplexConfig": {
    "enabled": false
  }
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Perintah berikut mengasumsikan bahwa Anda telah login ke Google Cloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Periksa akun yang aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"
      

PowerShell (Windows)

Perintah berikut mengasumsikan bahwa Anda telah login ke Google Cloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Periksa akun yang aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json, dan jalankan perintah berikut:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

Anda akan menerima respons JSON yang mirip dengan yang berikut ini:

Respons

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.alloydb.v1.OperationMetadata",
    "createTime": "2024-01-16T02:32:12.281Z",
    "target": "projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID",
    "verb": "update",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Memperkaya aset AlloyDB dengan aspek

Jenis aspek adalah resource yang dapat digunakan kembali dan berfungsi sebagai template untuk aspek. Jenis aspek membantu menghindari duplikasi pekerjaan dan pembuatan aspek yang tidak lengkap. Buat jenis aspek yang diperlukan menggunakan Knowledge Catalog.

Setelah membuat jenis aspek kustom, lampirkan aspek ke aset AlloyDB Anda. Melampirkan aspek ke aset AlloyDB memberikan kemampuan berikut:

• Menambahkan metadata bisnis ke aset
• Menelusuri aset berdasarkan metadata bisnis dan metadata kustom lainnya

Untuk mempelajari lebih lanjut cara membuat jenis aspek dan melampirkan aspek ke AlloyDB, lihat Mengelola aspek dan memperkaya metadata.

Menelusuri aset AlloyDB

Gunakan halaman penelusuran Knowledge Catalog di konsol Google Cloud untuk menelusuri aset AlloyDB.

1. Buka halaman Search Knowledge Catalog.

   Buka Penelusuran

2. Di Choose search platform, pilih Knowledge Catalog.

3. Di panel Filters, klik Systems, lalu pilih AlloyDB.

4. Opsional. Di Type aliases, filter hasil penelusuran ke jenis aset AlloyDB tertentu dengan memilih satu atau beberapa alias jenis berikut:

   • Database
   • Skema database
   • Cluster
   • Instance
   • Layanan
   • Tabel
   • Lihat
   Catatan: Service adalah alias jenis untuk instance AlloyDB.

Menggunakan kueri untuk melakukan penelusuran kata kunci

Gunakan kolom penelusuran di Knowledge Catalog untuk melakukan kueri penelusuran kata kunci. Misalnya, masukkan system=AlloyDB AND type=Database untuk melihat semua database AlloyDB.

Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.

Untuk melihat semua aset AlloyDB, masukkan system=AlloyDB.

Kemudian, masukkan kata kunci tertentu. Misalnya, untuk melihat semua database AlloyDB:

system=AlloyDB AND type=Database

Untuk melihat semua tabel AlloyDB, masukkan kueri berikut:

system=AlloyDB AND type=Table

Anda juga dapat menggunakan tanda kurung dan operator logika AND dan OR untuk ekspresi yang kompleks. Untuk mengetahui informasi selengkapnya tentang ekspresi yang dapat Anda gunakan di kolom penelusuran, lihat Sintaksis penelusuran untuk Knowledge Catalog.

Anda dapat langsung memasukkan kueri penelusuran untuk aset AlloyDB tertentu ke dalam kolom penelusuran. Format string kueri adalah sebagai berikut:

type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"

Ganti kode berikut:

• QUERY_STRING: gunakan daftar berikut untuk mengidentifikasi string kueri berdasarkan jenis aset AlloyDB yang ingin Anda kueri:

  • alloydb-database
  • alloydb-cluster
  • alloydb-instance
  • alloydb-table
  • alloydb-schema
  • alloydb-view

Contoh kueri mungkin akan terlihat seperti berikut:

type="projects/dataplex-types/locations/global/entryTypes/alloydb-cluster"

Menelusuri berdasarkan jenis aspek

Knowledge Catalog menyertakan beberapa jenis aspek bawaan yang membantu Anda melakukan penelusuran.

Untuk menelusuri berdasarkan jenis aspek, ikuti langkah-langkah berikut:

1. Di panel Aspects, klik menu Add more aspect types.
2. Opsional. Pilih AlloyDB Access untuk memfilter hasil berdasarkan dialek AlloyDB.
3. Pilih satu atau beberapa jenis aspek berikut untuk membatasi hasil penelusuran pada jenis tersebut.
   • Database AlloyDB
   • Cluster AlloyDB
   • Instance AlloyDB
   • Tampilan AlloyDB
   • Skema AlloyDB
   • Tabel AlloyDB
4. Klik Oke.
5. Di tabel hasil, klik nama aset untuk melihat metadata aset tersebut.
6. Opsional: Tingkatkan atau lihat aset Anda. Anda dapat menyempurnakan atau melihat aset dengan cara berikut:
   • Untuk menambahkan deskripsi rich text aset, klik Tambahkan di Ringkasan.
   • Untuk melampirkan aspek ke aset, klik Add di Aspects.
   • Untuk melihat database anggota untuk sebuah instance, klik tab Entry List, lalu klik Show all children entries in search. Jika tab Entry List tidak muncul, berarti cluster tidak memiliki database.
   • Lihat detail lengkap aset di Detail entri. Klik nama entri untuk melihat entri tambahan.

Penelusuran Bahasa Alami di AlloyDB

Penelusuran bahasa alami menggunakan AI untuk memahami kueri semantik. Fitur ini membantu Anda menemukan resource menggunakan bahasa sehari-hari, sehingga tidak memerlukan sintaksis yang rumit. Misalnya, masukkan kueri seperti List all AlloyDB tables related to sales.

Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.

Penelusuran sintaksis di AlloyDB

Penelusuran kata kunci membantu Anda menemukan resource menggunakan kata kunci, filter, dan sintaksis yang ditentukan. Misalnya, masukkan system=AlloyDB AND type=Database untuk melihat semua database AlloyDB.

Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.

Contoh alur kerja - Penelusuran dari cluster ke kolom

Untuk melihat perincian dari cluster ke kolom, ikuti langkah-langkah berikut:

1. Buka halaman Search Knowledge Catalog.

   Buka Penelusuran

2. Untuk opsi Choose search platform, pilih Knowledge Catalog.

3. Di panel Filter, pilih Sistem, lalu AlloyDB. Atau, masukkan system=AlloyDB di kolom penelusuran.

4. Pilih nama cluster.

5. Di halaman AlloyDB details, klik tab Entry list, lalu klik Show all children entries in search. Knowledge Catalog menampilkan database dalam cluster.

   Catatan: Jika tab Entry list tidak muncul, kembali ke halaman Search dan pilih cluster lain.

6. Di halaman AlloyDB database details, klik tab Entry list, lalu klik View child entries in search. Knowledge Catalog menampilkan tabel dalam cluster.

7. Pilih nama tabel, lalu di halaman AlloyDB table details, klik Schema untuk melihat kolom tabel.

8. Opsional: Untuk menambahkan jenis aspek ke kolom, klik tombol Add aspect.

Harga

Penyimpanan metadata teknis AlloyDB di Knowledge Catalog tidak dikenai biaya. Harga standar Knowledge Catalog berlaku untuk panggilan API dan pengayaan metadata bisnis tambahan. Untuk mengetahui informasi selengkapnya, lihat halaman harga Knowledge Catalog.

Penggunaan resource

Knowledge Catalog mengekstrak metadata secara berkala dari cluster AlloyDB Anda. Proses ekstraksi ini menggunakan resource CPU di cluster Anda. Penggunaan CPU umumnya minimal. Misalnya, cluster dengan jenis mesin yang lebih kecil (seperti n2-highmem-2-icelake) yang mengelola skema besar (seperti yang memiliki 100.000 tabel atau lebih) mungkin mengalami peningkatan penggunaan CPU hingga 5% selama ekstraksi.

Batasan

• Integrasi ini mendukung maksimum satu juta tabel per database dan rata-rata 150 kolom per tabel. Jika salah satu batas ini terlampaui, metadata untuk resource seperti database, skema, tabel, dan tampilan tidak akan diekstrak. Hanya metadata cluster dan instance yang tersedia di Knowledge Catalog.
• Saat cluster pertama kali dibuat, sinkronisasi awal semua metadata ke Knowledge Catalog dapat memerlukan waktu hingga 48 jam. Setelah sinkronisasi awal, update berikutnya akan tersedia dalam waktu hampir real-time.
• Jika terjadi tingkat perubahan metadata yang tinggi (lebih dari 100 perubahan DDL atau lebih per detik) pada database Anda, sinkronisasi metadata Hampir real-time dengan Knowledge Catalog mungkin akan dijeda hingga 30 menit sebelum dilanjutkan.
• Jika ada update yang terlewat karena tingginya tingkat perubahan metadata, masalah jaringan, atau saat proses sinkronisasi terganggu, update tersebut pada akhirnya akan terlihat di Knowledge Catalog dalam waktu 48 jam.
• Jika instance tidak ada atau tidak berjalan, perlu waktu 7 hari agar metadata dihapus.
• Saat database diganti namanya, hanya update database yang tersedia di Knowledge Catalog dalam waktu hampir real-time. Pemetaan pokok database dan semua tabel terkait akan diperbarui di Knowledge Catalog dalam waktu 48 jam.

Langkah berikutnya

• Tentang pengelolaan metadata di Knowledge Catalog
• Peran Identity and Access Management Knowledge Catalog