Apache CouchDB

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

Sebelum memulai

Sebelum menggunakan konektor Apache CouchDB, 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.

• Pastikan Anda memiliki peran pengguna admin untuk mengautentikasi ke Apache CouchDB.
• Untuk informasi tentang Apache CouchDB, lihat Panduan memulai dengan Apache CouchDB. Untuk informasi selengkapnya tentang platform Apache CouchDB, lihat Ringkasan platform Apache CouchDB. Untuk informasi tentang konfigurasi SSL Apache CouchDB, lihat Apache CouchDB 3.5.2. HTTPS (SSL/TLS) Options dan How Do I Configure SSL (HTTPS) in Apache CouchDB?.

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 Apache CouchDB 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. Flexible Schema: Tetapkan FlexibleSchema ke true untuk memindai metadata tambahan pada set hasil kueri. Jika tidak, metadata akan tetap sama.
   9. Gunakan proxy: Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi dan konfigurasi nilai berikut:
   • Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
     • Dasar: Autentikasi HTTP dasar.
     • Digest: Ringkasan autentikasi HTTP.
   • Pengguna Proxy: Nama pengguna yang akan digunakan untuk mengautentikasi dengan server proxy.
   • Sandi Proxy: Secret Secret Manager dari sandi pengguna.
   • Proxy SSL Type: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Jenis autentikasi berikut didukung:
     • Otomatis: Setelan default. Jika URL adalah URL HTTPS, opsi Tunnel akan digunakan. Jika URL adalah URL HTTP, opsi NEVER akan digunakan.
     • Selalu: Koneksi selalu mengaktifkan SSL.
     • Tidak pernah: Koneksi tidak mengaktifkan SSL.
     • Tunnel: Koneksi dilakukan melalui proxy tunneling. Server proxy membuka koneksi ke host jarak jauh dan traffic mengalir bolak-balik melalui proxy.
   • Di bagian Server Proxy, masukkan detail server proxy.
     1. Klik + Tambahkan tujuan.
     2. Pilih Jenis Tujuan.
        • Alamat host: Tentukan nama host atau alamat IP tujuan.

          Jika Anda ingin membuat koneksi pribadi ke sistem backend, lakukan langkah berikut:

          • Buat lampiran layanan PSC.
          • Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
   10. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
   11. 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 Apache CouchDB:

      • 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 Apcache CouchDB.

Jenis koneksi autentikasi dasar

Nama kolom	Detail
Lokasi	us-central1
Konektor	Apache CouchDB
Versi konektor	1
Nama Koneksi	couchdb-vm-connection
Mengaktifkan Cloud Logging	Ya
Akun Layanan	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Tampilan Daftar	Ya
Skema Fleksibel	Ya
Jumlah minimum node	2
Jumlah maksimum node	50
Jenis Tujuan(Server)	Alamat host
Alamat host	http://198.51.100.0
Nama pengguna	USERNAME
Sandi	PASSWORD
Versi rahasia	1

Jenis koneksi proxy

Nama kolom	Detail
Lokasi	us-central1
Konektor	Apache CouchDB
Versi konektor	1
Nama Koneksi	couchdb-proxy-conn
Mengaktifkan Cloud Logging	Ya
Akun Layanan	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Tampilan Daftar	Tidak
Skema Fleksibel	Tidak
Proxy	menggunakan proxy
Skema Autentikasi Proxy	Ringkasan
Pengguna Proxy	PROXY_USER
Sandi Proxy	PROXY_PASSWORD
Jumlah minimum node	2
Jumlah maksimum node	50
Jenis Tujuan(Server)	Alamat host
Alamat host	http://198.51.100.0
Nama pengguna	USERNAME
Sandi	PASSWORD
Versi rahasia	1

Jenis koneksi koneksi SSL (tidak aman)

Nama kolom	Detail
Lokasi	us-central1
Konektor	Apache CouchDB
Versi konektor	1
Nama Koneksi	couchdb-ssl-conn
Mengaktifkan Cloud Logging	Ya
Akun Layanan	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Tampilan Daftar	Tidak
Skema Fleksibel	Tidak
Jumlah minimum node	2
Jumlah maksimum node	50
Trust store (pilih model kepercayaan)	Koneksi Tidak Aman
Jenis Tujuan(Server)	Alamat host
Alamat host	http://198.51.100.0
Nama pengguna	USERNAME
Sandi	PASSWORD
Versi rahasia	1

Jenis koneksi koneksi SSL (pribadi)

Nama kolom	Detail
Lokasi	us-central1
Konektor	Apache CouchDB
Versi konektor	1
Nama Koneksi	couchdb-proxy-conn
Mengaktifkan Cloud Logging	Ya
Akun Layanan	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Tampilan Daftar	Tidak
Skema Fleksibel	Tidak
Jumlah minimum node	2
Jumlah maksimum node	50
Trust store (pilih model kepercayaan)	Pribadi
Trust Store kustom	Sertifikat yang ditandatangani sendiri.
Versi Secret	1
Jenis Tujuan(Server)	Alamat host
Alamat host	https://198.51.100.0
Nama pengguna	USERNAME
Sandi	PASSWORD
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 Apache CouchDB dapat memproses maksimum 5 transaksi per detik, per node, dan memperlambat transaksi apa pun di luar 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 semua data pelanggan

Contoh ini mencantumkan semua data pelanggan di entitas Customer.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Customer dari daftar Entity.
3. Pilih operasi LIST, lalu klik Done.
4. Secara opsional, Anda dapat memasukkan nilai di filterClause untuk memfilter set hasil.

Contoh - Mendapatkan data pelanggan

Contoh ini mendapatkan data pelanggan tertentu dari entity Customers.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Customers dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan cust-2 di kolom Default Value.

   Di sini, cust-2 adalah nilai kunci utama entity Customers.

Contoh - Menambahkan pelanggan

Contoh ini membuat data pelanggan di entitas Customers.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Customers 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:

   {
   "name": "John",
   "_id": "cust-3"
   }

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

   {
   "_id": cust-3
   }

Contoh - Memperbarui data pelanggan

Contoh ini memperbarui data pelanggan yang ditentukan di entitas Customers.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Customers 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:

   {
         "name": "Jason",
       }
       

5. Klik entityId, lalu masukkan cust-5 di kolom Default Value.

   Atau, alih-alih menentukan entityId, Anda juga dapat menetapkan filterClause ke cust-5.

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

   {
   "_id": cust-5
   }
       

Contoh - Menghapus data pelanggan

Contoh ini menghapus data pelanggan yang ditentukan dari entity Customers.

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

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
flexible_schema	BOOLEAN	Salah	Tetapkan FlexibleSchema ke benar untuk memindai metadata tambahan pada kumpulan hasil kueri. Jika tidak, metadata akan tetap sama.
proxy_enabled	BOOLEAN	Salah	Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi.
proxy_auth_scheme	ENUM	Salah	Jenis autentikasi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. Nilai yang didukung adalah: BASIC, DIGEST, NONE
proxy_user	STRING	Salah	Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
proxy_password	SECRET	Salah	Sandi yang akan digunakan untuk melakukan autentikasi ke proxy ProxyServer.
proxy_ssltype	ENUM	Salah	Jenis SSL yang akan digunakan saat terhubung ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, TUNNEL

Menggunakan koneksi Apache CouchDB 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.