Mengelola resource Cloud SQL menggunakan Knowledge Catalog

MySQL   |  PostgreSQL   |  SQL Server

Halaman ini menjelaskan cara menelusuri dan mengelola resource Cloud SQL menggunakan Knowledge Catalog (sebelumnya dikenal sebagai Dataplex Universal Catalog).

Knowledge Catalog adalah platform untuk menyimpan, mengelola, dan mengakses metadata Anda. Knowledge Catalog mengambil metadata berikut dari instance, database, tabel, kolom, dan tampilan Cloud SQL secara otomatis:

• Nama
• Lokasi (wilayah)
• Tanggal dibuat dan tanggal terakhir diubah
• Skema (untuk tabel dan tabel virtual)
• Deskripsi
• Batasan kunci utama dan kunci asing

Knowledge Catalog hanya mengambil metadata dari instance utama Cloud SQL, bukan dari replika baca atau replika server eksternal.

Anda dapat menggunakan Knowledge Catalog untuk menemukan dan memahami metadata Cloud SQL Anda. Gunakan Knowledge Catalog untuk membantu aktivitas berikut:

• Penemuan data
• Klasifikasi
• Analisis, termasuk dependensi dan kesesuaian untuk kasus penggunaan
• Manajemen perubahan
• Perpindahan data (pipeline)
• Evolusi skema

Dengan Knowledge Catalog, Anda dapat mengumpulkan metadata dengan melampirkan aspek ke entri metadata Cloud SQL. Setiap aspek dapat memiliki beberapa kolom metadata dan dapat didasarkan pada jenis aspek yang telah ditentukan atau kustom.

Misalnya, Anda dapat melampirkan aspek berikut ke kolom yang berisi nomor Jaminan Sosial, yang merupakan informasi identitas pribadi (PII):

  pii:true
  pii_type:SSN

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

Catatan: Knowledge Catalog mengacu pada resource di Cloud SQL dan di layanan Google Cloud lainnya sebagai aset. Di halaman ini, kami menyebut resource Cloud SQL—instance, database, tabel, dan tampilan—sebagai aset Cloud SQL. Kami juga menggunakan istilah aset untuk merujuk pada resource dan metadata Knowledge Catalog untuk resource tersebut.

Keaktualan data integrasi Knowledge Catalog

Keaktualan metadata instance yang diharapkan di Knowledge Catalog bergantung pada tanggal pembuatan instance, versi database, dan arsitektur jaringannya.

Mendekati real-time

Integrasi dengan Knowledge Catalog diaktifkan secara default saat instance dibuat jika instance memenuhi semua kriteria berikut:

1. Waktu pembuatan: Pada atau setelah 9 November 2026

2. Versi: Semua versi SQL Server
3. Arsitektur jaringan: Arsitektur jaringan baru

Untuk instance yang sudah ada yang dibuat sebelum 18 April 2026 yang memenuhi kriteria versi dan arsitektur jaringan baru, mengaktifkan integrasi Knowledge Catalog menggunakan Enable the integration of Knowledge Catalog on an existing Cloud SQL instance akan mengaktifkan integrasi dalam waktu hampir real-time. Jika instance tersebut sudah mengaktifkan integrasi Knowledge Catalog sekali sehari, Anda dapat menonaktifkan integrasi dan mengaktifkannya kembali untuk beralih dari sekali sehari ke hampir real-time.

Jika instance Anda tidak memenuhi kriteria untuk integrasi hampir real-time, lihat Sekali sehari.

Instance yang terintegrasi dalam waktu hampir real-time berisi tabel stempel waktu untuk melacak waktu pembuatan dan pembaruan aset Anda. Tabel stempel waktu adalah tabel resource_timestamps dalam database gcloud_cloudsqladmin. Tabel stempel waktu dapat dikueri dari Cloud SQL di konsol Google Cloud . Saat instance Anda memiliki perubahan DDL atau skema, integrasi akan mengkueri tabel stempel waktu untuk mengidentifikasi aset yang baru saja diubah, lalu memuat update skema terbaru ke Knowledge Catalog hampir secara real-time. Dalam kasus yang jarang terjadi, misalnya saat ada ketidakstabilan jaringan, Knowledge Catalog mungkin melewatkan update. Meskipun jarang terjadi, setiap perubahan yang terlewat akan menjadi konsisten pada akhirnya, biasanya dalam waktu 24 jam. Untuk mengetahui informasi selengkapnya tentang skenario yang dapat menyebabkan perubahan terlewat, lihat Batasan di halaman ini.

Saat melihat kueri yang telah dijalankan dalam instance, Anda akan melihat kueri yang mendukung integrasi Knowledge Catalog. Anda dapat mengidentifikasi kueri ini berdasarkan komentar --Dataplex yang disertakan. Untuk melihat kueri untuk sebuah instance, lihat Melihat kueri aktif.

Anda dapat menonaktifkan integrasi dan mengaktifkannya kembali nanti menggunakan petunjuk di Mengupdate instance.

Sehari sekali

Integrasi dengan Knowledge Catalog dapat diaktifkan untuk instance yang memenuhi salah satu kriteria berikut:

1. Waktu pembuatan: Sebelum 18 April 2026
2. Versi: Semua versi SQL Server
3. Arsitektur jaringan: Arsitektur jaringan lama

Setelah Anda mengaktifkan integrasi dengan Knowledge Catalog, metadata untuk instance yang memenuhi salah satu kriteria ini biasanya diperbarui di Knowledge Catalog sekitar sekali sehari.

Jika instance Anda dibuat setelah 24 Maret 2026 , integrasi dengan Knowledge Catalog akan diaktifkan secara default. Untuk instance yang dibuat sebelum 18 April 2026, Anda dapat Mengaktifkan integrasi Knowledge Catalog pada instance Cloud SQL yang ada .

Jika instance yang ada yang dibuat sebelum 18 April 2026 memenuhi kriteria versi dan arsitektur jaringan baru di Hampir real-time, mengaktifkan integrasi Knowledge Catalog (atau menonaktifkan integrasi dan mengaktifkannya kembali jika sudah terintegrasi sekali sehari) akan mengonfigurasi instance untuk update hampir real-time.

Anda dapat menonaktifkan integrasi dan mengaktifkannya kembali nanti menggunakan petunjuk di Mengupdate instance.

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 memerlukan peran dan izin Identity and Access Management (IAM) tertentu untuk menelusuri dan melampirkan entri ke aset Cloud SQL. Untuk mengetahui detailnya, lihat Peran dan izin IAM yang diperlukan untuk Knowledge Catalog.

Peran dan izin IAM yang diperlukan untuk Knowledge Catalog

Cloud SQL menggunakan izin cloudsql.schemas.view untuk memberikan akses ke metadata di Knowledge Catalog.

Untuk memberikan izin ini, buat peran khusus yang menyertakan izin ini, atau gunakan salah satu peran bawaan yang memiliki izin ini.

Untuk mengetahui informasi selengkapnya, lihat Peran IAM Cloud SQL yang telah ditetapkan.

Perhatian: Izin cloudsql.schemas.view harus diberikan di level project. Pengguna dengan izin ini dapat melihat metadata untuk semua instance Cloud SQL dalam project.

Membuat instance dengan integrasi Knowledge Catalog diaktifkan

Instance baru terintegrasi dengan Knowledge Catalog secara default. Untuk membuat instance baru dengan integrasi Knowledge Catalog yang diaktifkan, Anda hanya perlu membuat instance baru. Untuk membuat instance dengan Knowledge Catalog yang terintegrasi dalam hampir real-time, instance baru Anda harus memenuhi semua kriteria berikut:

1. Waktu pembuatan: Pada atau setelah 9 November 2026

2. Versi: Semua versi SQL Server
3. Arsitektur jaringan: Arsitektur jaringan baru

Jika ingin mengaktifkan Knowledge Catalog hampir real-time untuk instance baru dengan versi database yang lebih lama atau arsitektur jaringan lama, Anda dapat meng-clone instance atau memulihkan dari cadangan ke instance baru.

gcloud

Buat instance

Untuk membuat instance Cloud SQL, gunakan perintah gcloud sql instances create.

gcloud sql instances create INSTANCE_NAME \
  --database-version=DATABASE_VERSION \
  --tier=MACHINE_TYPE \
  --region=REGION_NAME

Lakukan penggantian berikut:

• INSTANCE_NAME: nama instance
• DATABASE_VERSION: versi database untuk instance (misalnya, SQLSERVER_2019_ENTERPRISE ). Untuk daftar lengkap string yang tersedia, lihat SqlDatabaseVersion
• MACHINE_TYPE: jenis mesin untuk instance
• REGION_NAME: nama region untuk instance

Contoh ini berbasis Linux.

REST v1

Buat instance

Gunakan contoh ini untuk membuat instance dengan integrasi yang diaktifkan. Untuk mengetahui daftar lengkap parameter yang tersedia untuk panggilan ini, lihat halaman instances.insert.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari project Google Cloud yang berisi instance
• INSTANCE_NAME: nama instance
• REGION_NAME: nama region untuk instance
• DATABASE_VERSION: string enum versi database (misalnya, POSTGRES_13). Untuk daftar lengkap string yang tersedia, lihat SqlDatabaseVersion.
• PASSWORD: sandi untuk pengguna root
• MACHINE_TYPE: string enum jenis (tingkat) mesin, seperti: db-custom-[CPUS]-[MEMORY_MBS]
• EDITION_TYPE: edisi Cloud SQL Anda

Metode HTTP dan URL:

POST https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances

Meminta isi JSON:

{
  "name": "INSTANCE_NAME",
  "region": "REGION_NAME",
  "databaseVersion": "DATABASE_VERSION",
  "rootPassword": "PASSWORD",
  "settings": {
    "tier": "MACHINE_TYPE",
    "edition": "EDITION_TYPE",
    "enableDataplexIntegration": true
  }
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud 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. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances" | Select-Object -Expand Content

Anda akan melihat respons JSON seperti berikut:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "[e-mail]",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

Buat instance

Gunakan contoh ini untuk membuat instance dengan integrasi yang diaktifkan. Untuk mengetahui daftar lengkap parameter yang tersedia untuk panggilan ini, lihat halaman instances.insert.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari project Google Cloud yang berisi instance
• INSTANCE_NAME: nama instance
• REGION_NAME: nama region untuk instance
• DATABASE_VERSION: string enum versi database (misalnya, POSTGRES_13). Untuk daftar lengkap string yang tersedia, lihat SqlDatabaseVersion.
• PASSWORD: sandi untuk pengguna root
• MACHINE_TYPE: string enum jenis (tingkat) mesin, seperti: db-custom-[CPUS]-[MEMORY_MBS]
• EDITION_TYPE: edisi Cloud SQL Anda

Metode HTTP dan URL:

POST https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances

Meminta isi JSON:

{
  "name": "INSTANCE_NAME",
  "region": "REGION_NAME",
  "databaseVersion": "DATABASE_VERSION",
  "rootPassword": "PASSWORD",
  "settings": {
    "tier": "MACHINE_TYPE",
    "edition": "EDITION_TYPE",
    "enableDataplexIntegration": true
  }
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud 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. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances" | Select-Object -Expand Content

Anda akan melihat respons JSON seperti berikut:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "[e-mail]",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Mengaktifkan integrasi Knowledge Catalog pada instance Cloud SQL yang ada

Anda dapat mengikuti petunjuk update di bagian ini untuk mengaktifkan integrasi Knowledge Catalog pada instance yang ada yang dibuat sebelum 18 April 2026.

Saat Anda mengaktifkan integrasi Knowledge Catalog pada instance yang ada:

• Untuk instance yang memenuhi salah satu kriteria berikut, mengaktifkan integrasi Knowledge Catalog akan mengaktifkan update sekali sehari:

  • Versi: Semua versi SQL Server
  • Arsitektur jaringan: Arsitektur jaringan lama

• Untuk instance yang memenuhi semua kriteria berikut, mengaktifkan integrasi Knowledge Catalog akan mengaktifkan update hampir real-time:

  • Versi: Semua versi SQL Server
  • Arsitektur jaringan: Arsitektur jaringan baru

  Setelah mengaktifkan integrasi dalam waktu hampir real-time, perubahan DDL dan skema baru akan muncul dalam waktu 10 menit, sedangkan resource yang ada di instance akan diisi dalam waktu 24 jam.

Untuk mengaktifkan atau mengaktifkan kembali integrasi Knowledge Catalog pada instance Cloud SQL yang ada, gunakan salah satu prosedur berikut.

gcloud

Mengupdate instance

Untuk mengaktifkan integrasi bagi instance yang ada, gunakan perintah gcloud sql instances patch.

gcloud sql instances patch INSTANCE_NAME \
  --enable-dataplex-integration

Jika perlu mengaktifkan dan mengupdate semua instance Cloud SQL dalam project, Anda dapat menjalankan skrip yang mirip dengan berikut ini:

gcloud sql instances list --format="(NAME)" \
| tail -n +2 | xargs -t -I %
gcloud sql instances patch % --enable-dataplex-integration

Contoh ini berbasis Linux.

REST v1

Mengupdate instance

Gunakan contoh ini untuk memperbarui instance yang ada. Untuk mengetahui daftar lengkap parameter yang tersedia untuk panggilan ini, lihat halaman instances.patch.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari project Google Cloud yang berisi instance
• INSTANCE_NAME: nama instance

Metode HTTP dan URL:

PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME

Meminta isi JSON:

{
  "settings":
  {
    "enableDataplexIntegration": true
  }
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud 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. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

Anda akan melihat respons JSON seperti berikut:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME",
  "status": "PENDING",
  "user": "[e-mail]",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

Mengupdate instance

Gunakan contoh ini untuk memperbarui instance yang ada. Untuk mengetahui daftar lengkap parameter yang tersedia untuk panggilan ini, lihat halaman instances.patch.

Gunakan contoh ini untuk memperbarui instance yang ada. Untuk mengetahui daftar lengkap parameter yang tersedia untuk panggilan ini, lihat halaman instances.patch.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari project Google Cloud yang berisi instance
• INSTANCE_NAME: nama instance

Metode HTTP dan URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

Meminta isi JSON:

{
  "settings":
  {
    "enableDataplexIntegration": true
  }
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud 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. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

Anda akan melihat respons JSON seperti berikut:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME",
  "status": "PENDING",
  "user": "[e-mail]",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Memverifikasi integrasi Knowledge Catalog di instance Cloud SQL Anda

Untuk memverifikasi bahwa integrasi Knowledge Catalog diaktifkan di instance Anda, gunakan salah satu prosedur berikut.

gcloud

Untuk memverifikasi bahwa integrasi Knowledge Catalog diaktifkan pada instance yang ada, gunakan perintah gcloud sql instances describe.

gcloud sql instances describe INSTANCE_NAME

Ganti INSTANCE_NAME dengan nama instance. Di output, cari setelan konfigurasi enableDataplexIntegration yang ditetapkan ke true.

REST v1

Sebelum menggunakan salah satu data permintaan, buatlah pengganti berikut:

• PROJECT_ID: project ID
• INSTANCE_ID: ID instance

Metode HTTP dan URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud 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. Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID" | Select-Object -Expand Content

Anda akan menerima respons JSON seperti berikut:

{
"settings":
  {
  "enableDataplexIntegration": true
  }
}

REST v1beta4

Sebelum menggunakan salah satu data permintaan, buatlah pengganti berikut:

• PROJECT_ID: project ID
• INSTANCE_ID: ID instance

Metode HTTP dan URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud 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. Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID" | Select-Object -Expand Content

Anda akan melihat respons JSON seperti berikut:

{
"settings":
  {
  "enableDataplexIntegration": true
  }
}

Menonaktifkan integrasi Knowledge Catalog di instance Cloud SQL Anda

Untuk menonaktifkan integrasi Knowledge Catalog di instance Cloud SQL Anda, gunakan salah satu prosedur berikut.

Menonaktifkan integrasi Knowledge Catalog pada instance yang terintegrasi dalam waktu hampir real-time memerlukan waktu hingga 10 menit.

Konsol

1. Di konsol Google Cloud , buka halaman Instance Cloud SQL.

   Buka Instance Cloud SQL

2. Untuk membuka halaman Ringkasan instance, klik nama instance.
3. Klik Edit.
4. Di bagian Customize your instance, luaskan menu Show configuration options.

5. Di bagian Flags and parameters, hapus centang pada kotak Enable Knowledge Catalog integration.

6. Klik Simpan.

gcloud

Untuk menonaktifkan integrasi untuk instance yang ada, gunakan perintah gcloud sql instances patch.

gcloud sql instances patch INSTANCE_NAME \
  --no-enable-dataplex-integration

Jika Anda perlu menonaktifkan integrasi dan memperbarui semua instance Cloud SQL dalam project, Anda dapat menjalankan skrip yang mirip dengan berikut ini:

gcloud sql instances list --format="(NAME)" \
| tail -n +2 | xargs -t -I %
gcloud sql instances patch % --no-enable-dataplex-integration

Contoh ini berbasis Linux.

REST v1

Gunakan contoh ini untuk menonaktifkan integrasi.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari project Google Cloud yang berisi instance
• INSTANCE_NAME: nama instance

Metode HTTP dan URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

Meminta isi JSON:

{
  "settings":
  {
    "enableDataplexIntegration": false
  }
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud 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. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

Anda akan melihat respons JSON seperti berikut:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME",
  "status": "PENDING",
  "user": "[e-mail]",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

Gunakan contoh ini untuk menonaktifkan integrasi.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: ID atau nomor project dari project Google Cloud yang berisi instance
• INSTANCE_NAME: nama instance

Metode HTTP dan URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

Meminta isi JSON:

{
  "settings":
  {
    "enableDataplexIntegration": false
  }
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud 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. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

Anda akan melihat respons JSON seperti berikut:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME",
  "status": "PENDING",
  "user": "[e-mail]",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Memperkaya aset Cloud SQL dengan aspek

Jenis aspek adalah resource yang dapat digunakan kembali dan dapat Anda gunakan sebagai template untuk aspek. Jenis aspek membantu Anda menghindari duplikasi pekerjaan dan aspek yang tidak lengkap. Anda dapat menggunakan Knowledge Catalog untuk membuat jenis aspek yang Anda perlukan.

Setelah membuat jenis aspek kustom, Anda dapat melampirkan aspek ke aset Cloud SQL. Dengan melampirkan aspek ke aset Cloud SQL, Anda dapat melakukan hal 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 Cloud SQL, lihat Mengelola aspek dan memperkaya metadata.

Menelusuri aset Cloud SQL

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

1. Buka halaman Search Knowledge Catalog.

   Buka Penelusuran

2. Di Choose search platform, pilih Knowledge Catalog.

3. Di panel Filters, klik Systems, lalu pilih Cloud SQL.

4. Opsional. Di Type aliases, Anda dapat memfilter hasil penelusuran ke jenis aset Cloud SQL tertentu dengan memilih satu atau beberapa alias jenis berikut:

   • Database
   • Skema database
   • Layanan
   • Table
   • Lihat
   Catatan: Service adalah alias jenis untuk instance Cloud SQL.

Menggunakan kueri untuk melakukan penelusuran

Anda juga dapat menggunakan kolom penelusuran di Knowledge Catalog untuk menjalankan kueri penelusuran. Untuk melihat semua aset Cloud SQL, masukkan system=Cloud_SQL.

Kemudian, Anda dapat memasukkan kata kunci tertentu. Misalnya, untuk melihat semua database Cloud SQL:

system=Cloud_SQL AND type=Database

Untuk melihat semua tabel Cloud SQL, masukkan kueri berikut:

system=Cloud_SQL AND type=Table

Anda juga dapat menggunakan tanda kurung dan operator logika AND dan OR untuk ekspresi yang kompleks. Untuk mempelajari lebih lanjut ekspresi yang dapat Anda gunakan di kolom penelusuran, lihat Sintaksis penelusuran untuk Knowledge Catalog.

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

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

Ganti QUERY_STRING dengan string kueri berdasarkan mesin Cloud SQL dan jenis aset yang ingin Anda kueri. Gunakan tabel berikut untuk mengidentifikasi string kueri yang sesuai.

Mesin Cloud SQL	String kueri
Cloud SQL untuk MySQL	cloudsql-mysql-database cloudsql-mysql-instance cloudsql-mysql-table cloudsql-mysql-view Catatan: Skema tidak didukung untuk MySQL.
Cloud SQL for PostgreSQL	cloudsql-postgresql-database cloudsql-postgresql-instance cloudsql-postgresql-table cloudsql-postgresql-schema cloudsql-postgresql-view
Cloud SQL untuk SQL Server	cloudsql-sqlserver-database cloudsql-sqlserver-instance cloudsql-sqlserver-table cloudsql-sqlserver-schema cloudsql-sqlserver-view

Contoh kueri mungkin akan terlihat seperti berikut:

type="projects/dataplex-types/locations/global/entryTypes/cloudsql-postgresql-instance"

Memfilter aset Cloud SQL berdasarkan dialek Cloud SQL

Secara default, Knowledge Catalog menampilkan semua aset Cloud SQL. Untuk memfilter aset Cloud SQL untuk MySQL, Cloud SQL untuk PostgreSQL, atau SQL Server saja, lakukan langkah-langkah berikut.

1. Di panel Aspects, klik menu Add more aspect types.

2. Pilih SQL Access.

3. Klik Oke.

4. Klik tombol edit aspek playlist_add . Di halaman SQL Access, lakukan tindakan berikut:

   • Di kolom Dialect, pilih SQL Server untuk memfilter aset SQL Server.
5. Opsional. Pilih kolom Version, lalu masukkan versi SQL Server tertentu.

6. Klik Terapkan. Knowledge Catalog hanya menampilkan aset SQL Server.

Menelusuri berdasarkan jenis aspek

Knowledge Catalog menyertakan beberapa jenis aspek bawaan yang dapat Anda gunakan untuk melakukan penelusuran.

1. Di panel Aspects, klik menu Add more aspect types.

2. Opsional. Pilih SQL Access untuk memfilter hasil berdasarkan dialek Cloud SQL. Untuk mengetahui informasi selengkapnya, lihat prosedur sebelumnya, Memfilter aset Cloud SQL berdasarkan dialek Cloud SQL.

3. Pilih satu atau beberapa jenis aspek berikut untuk membatasi hasil penelusuran ke jenis tersebut.

   • Database Cloud SQL
   • Instance Cloud SQL
   • Tampilan Cloud SQL
   • Skema Cloud SQL
   • Tabel Cloud SQL

4. Klik Oke.

5. Di tabel hasil, klik nama aset untuk melihat metadata aset tersebut.

6. Opsional: Tingkatkan atau lihat aset Anda. Anda dapat melakukan salah satu dari tindakan berikut:

   • Di Overview, klik Add untuk menambahkan deskripsi rich text aset.
   • Di Aspects, klik Add untuk melampirkan aspek ke aset.
   • Misalnya, untuk melihat database anggota, klik tab Entry List, lalu klik Show all children entries in search. Jika tab Entry List tidak muncul, berarti instance tidak memiliki database.
   • Di Detail entri, lihat detail lengkap aset. Klik nama entri untuk melihat entri tambahan.

Contoh alur kerja - Penelusuran dari instance ke kolom

Dalam contoh alur kerja ini, Anda memulai dengan menelusuri instance Cloud SQL, lalu melihat database anggota, lalu melihat tabel dalam database tersebut, dan kemudian melihat kolom dalam tabel.

1. Buka halaman Search Knowledge Catalog.

   Buka Penelusuran

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

3. Di Filters panel, pilih Systems, lalu Cloud SQL. Atau, masukkan system=Cloud_SQL di kolom penelusuran.

4. Pilih nama instance.

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

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

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

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

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

Alur kerja ini menunjukkan penelusuran dari instance ke tabel. Anda dapat langsung membuka daftar tabel dengan memasukkan system=Cloud_SQL AND type=Table di kolom penelusuran.

Harga

Tidak ada biaya untuk menyimpan metadata teknis Cloud SQL di Knowledge Catalog. Harga Standard Knowledge Catalog berlaku untuk panggilan API dan pengayaan metadata bisnis tambahan. Untuk mengetahui informasi selengkapnya, lihat halaman harga Knowledge Catalog.

Penggunaan resource

Saat integrasi Knowledge Catalog diaktifkan, Knowledge Catalog akan mengekstrak data dari instance Anda secara berkala. Proses ekstraksi memerlukan sejumlah penggunaan CPU.

Instance yang terintegrasi dengan Knowledge Catalog dalam waktu hampir real-time umumnya memiliki dampak minimal pada penggunaan CPU. Untuk instance yang diintegrasikan dengan Knowledge Catalog sekali sehari, penggunaan CPU dapat lebih besar. Hal ini terutama terlihat pada instance dengan jenis mesin yang lebih kecil—misalnya, mesin yang memiliki inti bersama dan skema yang lebih besar (10.000 tabel atau lebih), yang dapat menggunakan hingga 40% CPU-nya selama proses ekstraksi. Instance dengan jenis mesin yang lebih kecil—misalnya, mesin yang memiliki core bersama dan skema yang lebih besar (10.000 tabel atau lebih), dapat menggunakan hingga 40% CPU-nya selama proses ekstraksi.

Batasan

Bagian ini mencantumkan batasan penggunaan Cloud SQL dan Knowledge Catalog.

• Untuk instance yang dibuat sebelum 18 April 2026, integrasi Knowledge Catalog dengan Cloud SQL dinonaktifkan untuk instance apa pun yang membatasi akses ke resource karena pendaftaran resource di Assured Workloads.

• Setelah Anda mengaktifkan Knowledge Catalog di instance, perlu waktu antara 2 hingga 48 jam agar resource Cloud SQL Anda muncul di Knowledge Catalog sebagai aset, bergantung pada ukuran, versi, dan jenis mesin Cloud SQL yang Anda gunakan.

Batasan ini tidak berlaku saat instance Anda diupdate hampir secara real-time seperti yang dijelaskan dalam Hampir real-time.

• Database SQL Server yang mengaktifkan opsi Auto Close tidak akan dapat menyinkronkan informasi skema ke Knowledge Catalog. Sebagai praktik terbaik umum dan karena alasan performa, sebaiknya tetapkan opsi Auto Close ke false di SQL Server. Namun, jika ingin menggunakan Knowledge Catalog, Anda harus menetapkan opsi Auto Close ke false. Untuk edisi Express, opsi Auto Close ditetapkan ke true secara default, seperti yang dirancang oleh mesin SQL Server.

Batasan berikut hanya berlaku saat instance Anda diupdate dalam waktu hampir real-time seperti yang dijelaskan dalam Hampir real-time:

• Saat database diganti namanya, hanya update database yang tersedia di Knowledge Catalog dalam waktu hampir real-time. Pemetaan dasar database dan semua tabel terkait pada akhirnya akan konsisten di Knowledge Catalog.
• Instance mungkin menghapus pesan, yang dapat menyebabkan data di Knowledge Catalog hanya menjadi konsisten pada akhirnya. Jika pesan dihapus, pembaruan yang terlewat pada akhirnya akan terlihat di Knowledge Catalog. Kasus saat instance mungkin menghapus pesan mencakup hal berikut:
  • Instance yang mengalami tingkat DDL tinggi dalam jangka waktu singkat.
  • Instance yang merupakan clone dari instance yang ada.
  • Instance yang dipulihkan dari cadangan.
  • Instance yang kehabisan memori.
  • Instance yang sedang memulai ulang atau memulai ulang databasenya.
  • Instance yang mengalami masalah jaringan atau gangguan proses sinkronisasi dengan Knowledge Catalog.

Langkah berikutnya

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