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:
- 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 melakukan autentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk mengetahui 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.

Mengonfigurasi konektor

Mengonfigurasi konektor mengharuskan Anda 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:

Di Konsol Cloud, buka halaman Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.
Buka halaman Connections
Klik + CREATE NEW untuk membuka halaman Create Connection.
Di bagian Lokasi, pilih lokasi untuk koneksi.
1. Region: Pilih lokasi dari menu drop-down.
  Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.
2. Klik BERIKUTNYA.
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 kecil.
  - Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
  - Nama koneksi tidak boleh lebih dari 63 karakter.
4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
6. Secara opsional, konfigurasikan Setelan node koneksi:
  - Jumlah minimum node: Masukkan jumlah minimum node koneksi.
  - Jumlah maksimum node: Masukkan jumlah maksimum node koneksi.
  {i>Node<i} adalah unit (atau replika) koneksi yang memproses transaksi. Lebih banyak node diperlukan untuk memproses lebih banyak transaksi untuk sebuah koneksi dan sebaliknya, lebih sedikit node diperlukan untuk memproses transaksi yang lebih sedikit. Untuk memahami pengaruh node terhadap harga konektor Anda, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum akan ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.
7. Database: Nama database Cockroach.
8. Izinkan Pernyataan yang Disiapkan: Mengizinkan persiapan pernyataan kueri sebelum dieksekusi.
9. Mengambil Metadata Kumpulan Hasil: Kolom ini menetapkan apakah penyedia mendapatkan informasi mendetail tentang kolom hasil dari server.
10. UseSSL: Kolom ini menetapkan apakah SSL diaktifkan atau tidak.
11. SSLServerCert: Kolom ini menetapkan apakah SSL diaktifkan.
12. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
13. Klik BERIKUTNYA.
Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
1. Jenis Tujuan: Pilih Jenis Tujuan.
  1. Di kolom Host address, tentukan nama host atau alamat IP tujuan.
    1. Jika ingin membuat koneksi pribadi ke sistem backend, ikuti langkah-langkah berikut:
      1. Buat lampiran layanan PSC.
      2. Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
    2. Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk mengonfigurasi alamat IP keluar statis untuk koneksi Anda, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.
  Untuk memasukkan tujuan tambahan, klik +TAMBAHKAN TUJUAN.
2. Klik BERIKUTNYA.
Di bagian Authentication, masukkan detail autentikasi.
1. Pilih Jenis autentikasi, lalu masukkan detail yang relevan.
  Jenis autentikasi berikut didukung oleh koneksi CockroachDB:
  - Nama pengguna dan sandi
2. Klik BERIKUTNYA.
Tinjau: Tinjau detail koneksi dan autentikasi Anda.
Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

Nama pengguna dan sandi
- Nama pengguna: Nama pengguna untuk konektor
- Password: Secret Manager yang berisi sandi yang terkait dengan konektor.

Entitas, operasi, dan tindakan

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

Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entity berbeda dari konektor ke konektor. Misalnya, pada konektor database, tabel adalah entity, pada konektor server file, folder adalah entity, dan di konektor sistem pesan, antrean adalah entity.
Namun, mungkin saja konektor tidak mendukung atau memiliki entitas, 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 entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk deskripsi operasi secara mendetail, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung salah satu operasi entity, operasi yang tidak didukung tersebut tidak akan dicantumkan dalam daftar Operations.
Tindakan: Tindakan adalah fungsi kelas pertama 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. Namun, mungkin saja konektor tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Keterbatasan sistem

Konektor CockroachDB dapat memproses 1 transaksi per detik, per node, dan men-throttle setiap transaksi di luar batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk satu koneksi.

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

Catatan: Jumlah node Konektor Integrasi akan diskalakan 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. Perlu lebih banyak node untuk memproses lebih banyak transaksi untuk sebuah koneksi. Sebaliknya, lebih sedikit node yang diperlukan jika koneksi memproses transaksi yang lebih sedikit. Untuk mengonfigurasi nilai node, lakukan langkah berikut:

Jika Anda adalah pelanggan yang membayar sesuai penggunaan, konfigurasikan nilai node minimum dan maksimum di halaman edit koneksi.
Jika Anda adalah pelanggan yang 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 sudah disiapkan secara optimal untuk menangani traffic yang diperlukan.

Contoh operasi entitas

Contoh - Catatan daftar entity

Contoh ini mencantumkan catatan entity Users.

Dalam dialog Configure connector task, klik Entities.
Pilih Users dari daftar Entity.
Pilih operasi List, lalu klik Done.
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 dengan employeeCode 5100 dan startDate adalah 01-01-2010 00:00:00.

Contoh - Mendapatkan satu kumpulan data dari entity

Contoh ini mengambil data dari entity Users.

Dalam dialog Configure connector task, klik Entities.
Pilih User dari daftar Entity.
Pilih operasi Get, lalu klik Done.
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.

Dalam dialog Configure connector task, klik Entities.
Pilih Users dari daftar Entity.
Pilih operasi Delete, lalu klik Done.
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 data dalam entity

Contoh ini membuat data dalam entity Users.

Dalam dialog Configure connector task, klik Entities.
Pilih Users dari daftar Entity.
Pilih operasi Create, lalu klik Done.
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 merespons operasi buat.

Contoh - Memperbarui data dalam entity

Contoh ini memperbarui data dalam entity Users.

Dalam dialog Configure connector task, klik Entities.
Pilih Users dari daftar Entity.
Pilih operasi Update, lalu klik Done.
Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
```
{
"country": "IN"
}
```
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 merespons operasi update.

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:

Ikuti petunjuk mendetail untuk menambahkan tugas konektor.
Saat Anda mengonfigurasi tugas konektor, pada jenis tindakan yang ingin dilakukan, pilih Tindakan.
Dalam daftar Action, pilih Execute custom query, lalu klik Done.
Luaskan bagian Task input, lalu lakukan tindakan berikut:
1. Di kolom Timeout after, masukkan jumlah detik untuk menunggu hingga kueri dieksekusi.
  Nilai default: 180 detik.
2. Di kolom Maximum number of rows, masukkan jumlah maksimum baris yang akan ditampilkan dari database.
  Nilai default: 25.
3. Untuk memperbarui kueri kustom, klik Edit Kueri Kustom. Dialog Editor skrip akan terbuka.
4. Dalam 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 menggantikan tanda tanya (?) dalam kueri SQL secara berurutan. Misalnya, jika Anda telah menambahkan tiga tanda tanya (?), Anda harus menambahkan tiga parameter secara berurutan. Untuk menambahkan parameter kueri, lakukan tindakan berikut:
  1. Dari daftar Jenis, pilih jenis data parameter.
  2. Di kolom Nilai, masukkan nilai parameter.
  3. Untuk menambahkan beberapa parameter, klik + Tambahkan Parameter Kueri.

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

Contoh tindakan

Contoh - Temukan nilai yang lebih besar

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

Dalam dialog Configure connector task, klik Actions.
Pilih tindakan find_greater, lalu klik Done.
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
}]

Gunakan 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	Diperlukan	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 persiapan pernyataan kueri sebelum dieksekusi.
fetch_result_set_metadata	BOOLEAN	Salah	Kolom ini menetapkan apakah penyedia mendapatkan informasi mendetail tentang kolom hasil dari server.

Menggunakan koneksi CockroachDB dalam integrasi

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

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

Dapatkan bantuan dari komunitas Google Cloud

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

Langkah selanjutnya

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