CockroachDB

Konektor CockroachDB memungkinkan Anda melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan di database CockroachDB.

Sebelum memulai

Sebelum menggunakan konektor CockroachDB, lakukan tugas berikut:

• Di project Google Cloud Anda:
  • Pastikan konektivitas jaringan sudah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
  • Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
  • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk informasi selengkapnya, lihat Membuat akun layanan.

  • Aktifkan layanan berikut:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

  Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

Untuk mengetahui informasi selengkapnya tentang cara membuat cluster serverless dan menggunakan semua parameter aplikasi yang dibuat, lihat Membuat cluster Serverless CockroachDB di Cockroachlabs

Untuk mengetahui informasi tentang cara membuat sertifikat yang ditandatangani sendiri , lihat Sertifikat Cockroach

Mengonfigurasi konektor

Untuk mengonfigurasi konektor, Anda harus membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:

1. Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.

   Buka halaman Koneksi

2. Klik + CREATE NEW untuk membuka halaman Create Connection.
3. Di bagian Location, pilih lokasi untuk koneksi.
   1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

   2. Klik NEXT.
4. Di bagian Connection Details, selesaikan tindakan berikut:
   1. Konektor: Pilih CockroachDB dari menu drop-down Konektor yang tersedia.
   2. Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
   3. Di kolom Connection Name, masukkan nama untuk instance Connection.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
   4. Secara opsional, masukkan Description untuk instance koneksi.
   5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
   6. Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
   7. Secara opsional, konfigurasikan Setelan node koneksi:
      • Jumlah node minimum: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Semakin banyak node yang diperlukan untuk memproses lebih banyak transaksi untuk koneksi, dan sebaliknya, semakin sedikit node yang diperlukan untuk memproses lebih sedikit transaksi. Untuk memahami pengaruh node terhadap harga konektor, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default, node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

   Catatan: Anda hanya dapat menyesuaikan nilai node koneksi jika merupakan pelanggan Bayar sesuai penggunaan.
   8. Database: Nama database Cockroach.
   9. Allow Prepared Statement: Mengizinkan penyiapan pernyataan kueri sebelum dieksekusi.
   10. Mengambil Metadata Kumpulan Hasil: Kolom ini menetapkan apakah penyedia mendapatkan informasi mendetail tentang kolom set hasil dari server.
   11. UseSSL: Kolom ini menetapkan apakah SSL diaktifkan.
   12. SSLServerCert: Kolom ini menetapkan apakah SSL diaktifkan.
   13. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
   14. Klik NEXT.
5. Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
   1. Jenis Tujuan: Pilih Jenis Tujuan.
      • Pilih Host address dari daftar untuk menentukan nama host atau alamat IP tujuan.
      • Jika Anda ingin membuat koneksi pribadi ke sistem backend, pilih Endpoint attachment dari daftar, lalu pilih lampiran endpoint yang diperlukan dari daftar Endpoint Attachment.
        Catatan: Untuk memahami cara membuat lampiran endpoint, lihat lampiran layanan PSC dan lampiran endpoint. Setelah Anda membuat lampiran endpoint, lampiran tersebut akan terlihat dalam daftar Lampiran Endpoint.

      Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk mengonfigurasi alamat IP keluar statis untuk koneksi, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.

      Untuk memasukkan tujuan tambahan, klik +TAMBAHKAN TUJUAN.

   2. Klik NEXT.
6. Di bagian Authentication, masukkan detail autentikasi.
   1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi CockroachDB:

      • Nama pengguna dan sandi

   Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

   2. Klik NEXT.
7. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
8. Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

• Nama pengguna dan sandi
  • Nama pengguna: Nama pengguna untuk konektor
  • Sandi: Secret Manager Secret yang berisi sandi yang terkait dengan konektor.

Contoh konfigurasi koneksi

Bagian ini mencantumkan contoh nilai untuk berbagai kolom yang Anda konfigurasi saat membuat koneksi CockroachDB.

CockroachDB - Jenis koneksi autentikasi dasar

Nama kolom	Detail
Lokasi	us-central1
Konektor	CockroachDB
Versi konektor	1
Nama Koneksi	cockroach-db-cloud-conn
Mengaktifkan Cloud Logging	Ya
Akun Layanan	SERVICE_ACCOUNT_NAME@serviceaccount
SSL	Ya
SSLServerCert	cockroach-db-ssl-cert
SecretVersion	1
Database	TestGCP
Mengizinkan Pernyataan yang Disiapkan	Ya
Mengambil Metadata Set Hasil	Ya
Tingkat verbositas	5
Jumlah minimum node	2
Jumlah maksimum node	50
Jenis Tujuan(Server)	Alamat host
Alamat host	googlecloud-bcone-cluster-13792.5xj.cockroachlabs.cloud. Ini adalah nama cluster cloud CockroachDB.
Port	26257
Nama pengguna	Nama pengguna
Sandi	sandi
Versi rahasia	1

CockroachDB - Jenis koneksi PSC

Nama kolom	Detail
Lokasi	us-central1
Konektor	CockroachDB
Versi konektor	1
Nama Koneksi	cockroach-db-cloud-conn-psc
Mengaktifkan Cloud Logging	Ya
Akun Layanan	SERVICE_ACCOUNT_NAME@serviceaccount
SSL	Ya
SSLServerCert	gcp-bcone-crdb-hosted-node-crt
SecretVersion	1
Database	bank
Mengizinkan Pernyataan yang Disiapkan	Tidak
Mengambil Metadata Set Hasil	Tidak
Tingkat verbositas	5
Jumlah minimum node	2
Jumlah maksimum node	50
Jenis Tujuan(Server)	Alamat host
Alamat host	192.0.2.0/24 (ini harus berupa lampiran endpoint yang dibuat berdasarkan ip server yang menghosting instance db cockroach)
Port	26257
Nama pengguna	Nama pengguna
Sandi	sandi
Versi rahasia	1

Entity, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

Catatan: Anda dapat melihat entity, operasi, dan tindakan konektor di tugas Konektor.

• Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, dalam konektor database, tabel adalah entitas, dalam konektor server file, folder adalah entitas, dan dalam konektor sistem pesan, antrean adalah entitas.

  Namun, mungkin konektor tidak mendukung atau memiliki entity apa pun, dalam hal ini, daftar Entities akan kosong.

• Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:
  • Cantumkan
  • Dapatkan
  • Buat
  • Update
  • Hapus

  Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak akan tercantum dalam daftar Operations.

• Tindakan: Tindakan adalah fungsi kelas satu yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan bervariasi dari satu konektor ke konektor lainnya. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, konektor mungkin tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Catatan: Semua entitas dan tindakan akan memiliki skema yang terkait dengannya. Misalnya, skema tindakan akan memiliki detail parameter seperti; nama parameter, dan jenis data yang sesuai. Skema (metadata) untuk entity dan tindakan diambil oleh koneksi saat runtime dari backend Anda. Jika ada pembaruan pada skema, pembaruan tersebut tidak akan otomatis ditampilkan di koneksi yang ada; Anda harus memuat ulang skema secara manual. Untuk memuat ulang skema koneksi, buka halaman Connection details koneksi, lalu klik Refresh connection schema.

Batasan sistem

Konektor CockroachDB dapat memproses 1 transaksi per detik, per node, dan mencegah transaksi apa pun melebihi batas ini. Secara default, Konektor Integrasi mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

Untuk mengetahui informasi tentang batas yang berlaku untuk Konektor Integrasi, lihat Batas.

Catatan: Jumlah node Konektor Integrasi akan diskalakan secara otomatis secara dinamis berdasarkan penggunaan Anda. Namun, jika ingin mencadangkan kapasitas untuk volume besar tanpa menunggu penskalaan otomatis, Anda dapat menyesuaikan nilai node minimum untuk koneksi. Diperlukan lebih banyak node untuk memproses lebih banyak transaksi untuk koneksi. Sebaliknya, lebih sedikit node yang diperlukan jika koneksi memproses lebih sedikit transaksi. Untuk mengonfigurasi nilai node, lakukan hal berikut:

• Jika Anda adalah pelanggan bayar sesuai penggunaan, konfigurasikan nilai node minimum dan maksimum di halaman edit koneksi.
• Jika Anda adalah pelanggan berbasis langganan, hubungi dukungan.

Transaksi maksimum yang dapat ditangani node bergantung pada berbagai faktor. Jadi, sebelum menyesuaikan node minimum untuk throughput yang lebih baik, sebaiknya periksa apakah sistem backend Anda disiapkan secara optimal untuk menangani traffic yang diperlukan.

Contoh operasi entity

Contoh - Mencantumkan data entitas

Contoh ini mencantumkan data entity Users.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Users dari daftar Entity.
3. Pilih operasi List, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan Anda.

   Misalnya, menetapkan klausa filter ke employeeCode='5100' and startDate='2010-01-01 00:00:00', hanya mencantumkan data yang employeeCode-nya adalah 5100 dan startDate-nya adalah 2010-01-01 00:00:00.

Contoh - Mendapatkan satu kumpulan data dari entity

Contoh ini mengambil data dari entity Users.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih User dari daftar Entity.
3. Pilih operasi Get, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 103032 di kolom Default Value.

   Di sini, 103032 adalah nilai kunci utama entity Users.

Contoh - Menghapus data dari entity

Contoh ini menghapus data dari entity Users.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Users dari daftar Entity.
3. Pilih operasi Delete, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 113132 di kolom Default Value.

   Atau, jika entitas memiliki kunci utama gabungan, bukan menentukan entityId, Anda dapat menetapkan filterClause. Misalnya, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Contoh - Membuat kumpulan data dalam entity

Contoh ini membuat data di entitas Users.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Users dari daftar Entity.
3. Pilih operasi Create, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "employeeCode": "5100",
   "startDate": "2010-01-01 00:00:00.0",
   "country": "US"
   }

Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor akan memiliki respons operasi pembuatan.

Contoh - Memperbarui data dalam entity

Contoh ini memperbarui data di entity Users.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Users dari daftar Entity.
3. Pilih operasi Update, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "country": "IN"
   }

5. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 113132 di kolom Default Value.

   Atau, jika entitas memiliki kunci utama gabungan, bukan menentukan entityId, Anda dapat menetapkan filterClause. Misalnya, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor akan memiliki respons operasi pembaruan.

Tindakan

Bagian ini mencantumkan tindakan yang didukung oleh konektor. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Tindakan ExecuteCustomQuery

Tindakan ini memungkinkan Anda menjalankan kueri kustom.

Untuk membuat kueri kustom, ikuti langkah-langkah berikut:

1. Ikuti petunjuk mendetail untuk menambahkan tugas konektor.
2. Saat Anda mengonfigurasi tugas konektor, pilih Tindakan pada jenis tindakan yang ingin Anda lakukan.
3. Dalam daftar Action, pilih Execute custom query, lalu klik Done.

   

4. Luaskan bagian Task input, lalu lakukan hal berikut:
   1. Di kolom Waktu tunggu setelah, masukkan jumlah detik untuk menunggu hingga kueri dieksekusi.

      Nilai default: 180 detik.

   2. Di kolom Jumlah baris maksimum, masukkan jumlah baris maksimum yang akan ditampilkan dari database.

      Nilai default: 25.

   3. Untuk memperbarui kueri kustom, klik Edit Skrip Kustom. Dialog Script editor akan terbuka.

      

   4. Di dialog Editor skrip, masukkan kueri SQL, lalu klik Simpan.

      Anda dapat menggunakan tanda tanya (?) dalam pernyataan SQL untuk mewakili satu parameter yang harus ditentukan dalam daftar parameter kueri. Misalnya, kueri SQL berikut memilih semua baris dari tabel Employees yang cocok dengan nilai yang ditentukan untuk kolom LastName:

      SELECT * FROM Employees where LastName=?

      Catatan: Pernyataan bahasa manipulasi data (DML) dan bahasa definisi data (DDL) didukung.
   5. Jika telah menggunakan tanda tanya dalam kueri SQL, Anda harus menambahkan parameter dengan mengklik + Tambahkan Nama Parameter untuk setiap tanda tanya. Saat menjalankan integrasi, parameter ini akan mengganti tanda tanya (?) dalam kueri SQL secara berurutan. Misalnya, jika telah menambahkan tiga tanda tanya (?), Anda harus menambahkan tiga parameter dalam urutan.

      

      Untuk menambahkan parameter kueri, lakukan tindakan berikut:

      1. Dari daftar Type, pilih jenis data parameter.
      2. Di kolom Value, masukkan nilai parameter.
      3. Untuk menambahkan beberapa parameter, klik + Tambahkan Parameter Kueri.

Jika berhasil dieksekusi, tindakan ini akan menampilkan status 200 (OK) dengan isi respons yang memiliki hasil kueri.

Catatan: Fungsi yang ditentukan di CockroachDB dicantumkan sebagai tindakan dalam tugas konektor. Oleh karena itu, Anda dapat menjalankan fungsi dengan menjalankan tindakan yang sesuai. Misalnya, cara menjalankan fungsi, lihat .

Contoh tindakan

Contoh - Menemukan nilai yang lebih besar

Contoh ini menunjukkan cara menjalankan fungsi yang ditentukan pengguna. Fungsi find_greater dalam contoh ini membandingkan dua bilangan bulat dan menampilkan bilangan bulat yang lebih besar.

1. Pada dialog Configure connector task, klik Actions.
2. Pilih tindakan find_greater, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "$1": 1.0,
   "$2": 5.0
   }

Jika eksekusi tindakan berhasil, kolom connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut ini:

[{
"bignum": 5.0
}]

Menggunakan terraform untuk membuat koneksi

Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.

Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:

Nama parameter	Jenis data	Wajib	Deskripsi
use_ssl	BOOLEAN	Salah	Kolom ini menetapkan apakah SSL diaktifkan.
ssl_server_cert	SECRET	Salah	Kolom ini menetapkan apakah SSL diaktifkan.
database	STRING	Benar	Nama database Cockroach.
allow_prepared_statement	BOOLEAN	Salah	Mengizinkan penyiapan pernyataan kueri sebelum dieksekusi.
fetch_result_set_metadata	BOOLEAN	Salah	Kolom ini menetapkan apakah penyedia mendapatkan informasi mendetail tentang kolom set hasil dari server.

Menggunakan koneksi CockroachDB dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integration Apigee dan Integration Aplikasi. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

• Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
• Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.

Langkah selanjutnya

• Pahami cara menangguhkan dan melanjutkan koneksi.
• Pahami cara memantau penggunaan konektor.
• Pahami cara melihat log konektor.