Couchbase

Konektor Couchbase memungkinkan Anda terhubung ke instance database Couchbase dan menjalankan operasi database yang didukung.

Sebelum memulai

Sebelum menggunakan konektor Couchbase, 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:

  1. Di Konsol Cloud, buka halaman Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.

    Buka halaman Connections

  2. Klik + CREATE NEW untuk membuka halaman Create Connection.
  3. 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.
  4. Di bagian Connection Details, selesaikan tindakan berikut:
    1. Konektor: Pilih Couchbase 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. Izinkan Parameter JSON: Mengizinkan JSON mentah untuk digunakan dalam parameter saat QueryPassthrough diaktifkan.
    8. Port Analytics: Port untuk terhubung ke Endpoint Analytics Couchbase.
    9. Pemisah Anak: Karakter yang digunakan untuk menunjukkan tabel turunan.
    10. Layanan Couchbase: Menentukan layanan Couchbase yang akan dihubungkan. Defaultnya adalah N1QL. Opsi yang tersedia adalah N1QL dan Analytics.
    11. Create Table Ram Quota: Kuota RAM default, dalam megabyte, untuk digunakan saat menyisipkan bucket melalui sintaksis CREATE TABLE.
    12. Pemisah Dataverse: Karakter atau beberapa karakter yang digunakan untuk menunjukkan dataverse dan cakupan/koleksi Analytics.
    13. Pemisah Rasa: Karakter atau beberapa karakter yang digunakan untuk menunjukkan rasa.
    14. Port N1QL: Port untuk terhubung ke Endpoint N1QL Couchbase.
    15. Pemisah Titik: Karakter yang digunakan untuk menunjukkan hierarki.
    16. Waktu Tunggu Eksekusi Kueri: Opsi ini menetapkan waktu tunggu sisi server untuk kueri, yang mengatur berapa lama Couchbase akan mengeksekusi kueri sebelum menampilkan error waktu tunggu.
    17. Perbandingan Ketat: Menyesuaikan seberapa akurat penerjemahan filter pada kueri input SQL menjadi kueri Couchbase. Ini dapat ditetapkan ke daftar nilai yang dipisahkan koma, dengan setiap nilai dapat berupa salah satu dari: tanggal, angka, boolean, atau string.
    18. Ketahanan Transaksi: Menentukan cara dokumen harus disimpan agar transaksi berhasil. Menentukan apakah akan menggunakan transaksi N1QL saat menjalankan kueri.
    19. Waktu Tunggu Transaksi: Opsi ini menetapkan jumlah waktu yang dapat dijalankan transaksi sebelum waktunya habis oleh Couchbase.
    20. Menggunakan Koleksi untuk DDL: Apakah berasumsi bahwa pernyataan CREATE TABLE menggunakan koleksi, bukan ragam. Hanya berlaku saat menghubungkan ke Couchbase v7+ dan GenerateSchemaFiles disetel ke OnCreate.
    21. Menggunakan Transaksi: Menentukan apakah akan menggunakan transaksi N1QL saat menjalankan kueri.
    22. Validasi Parameter JSON: Memungkinkan penyedia memvalidasi bahwa parameter string adalah JSON yang valid sebelum mengirim kueri ke Couchbase.
    23. Use proxy: Centang kotak ini guna mengonfigurasi server proxy untuk koneksi dan mengonfigurasi nilai berikut:
      • Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
        • Dasar: Autentikasi HTTP dasar.
        • Ringkasan: Autentikasi HTTP ringkasan.
      • Pengguna Proxy: Nama pengguna yang akan digunakan untuk melakukan autentikasi dengan server proxy.
      • Sandi Proxy: Rahasia Secret manager sandi pengguna.
      • Jenis SSL Proxy: 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 JANGAN digunakan.
        • Selalu: Koneksi selalu mengaktifkan SSL.
        • Tidak pernah: Koneksi tidak mengaktifkan SSL.
        • Tunnel: Koneksi 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 ingin membuat koneksi pribadi ke sistem backend Anda, lakukan hal berikut:

    24. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
    25. Klik BERIKUTNYA.
  5. 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.
  6. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi, lalu masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Couchbase:

      • Nama pengguna dan sandi

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

    2. Klik BERIKUTNYA.
  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
    • Password: Secret Manager yang berisi sandi yang terkait dengan konektor.
    • UseSSL: Kolom ini menetapkan apakah SSL diaktifkan atau tidak.
    • SSLServerCert: SSLServerCert untuk Couchbase Connector
    • Skema autentikasi: Skema Auth untuk Konektor Couchbase
    • Mode Koneksi: Menentukan cara terhubung ke server Couchbase. Harus Direct atau Cloud. Untuk Cloud, SSL bersifat wajib. Untuk informasi selengkapnya, lihat Koneksi aman dengan TLS.
    • Server DNS: Menentukan server DNS yang akan digunakan saat mengambil informasi Couchbase Cloud. Contoh, 8.8.8.8.

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:

    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.

Tindakan

Konektor ini mendukung eksekusi tindakan berikut:

  • Prosedur dan fungsi tersimpan yang ditentukan pengguna. Jika Anda memiliki prosedur dan fungsi yang tersimpan di backend, prosedur dan fungsi tersebut akan tercantum di kolom Actions pada dialog Configure connector task.
  • Kueri SQL kustom. Untuk menjalankan kueri SQL kustom, konektor menyediakan tindakan Jalankan kueri kustom.

    Untuk membuat kueri kustom, ikuti langkah-langkah berikut:

    1. Ikuti petunjuk mendetail untuk menambahkan tugas konektor.
    2. Saat Anda mengonfigurasi tugas konektor, pada jenis tindakan yang ingin dilakukan, pilih Tindakan.
    3. Dalam daftar Action, pilih Execute custom query, lalu klik Done.
    4. 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=?

      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.

Keterbatasan sistem

Konektor Couchbase dapat memproses 25 transaksi per detik, per node, dan 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.

Tindakan

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

Tindakan AddDocument

Tindakan ini akan menambahkan dokumen di sofabase.

Parameter input tindakan AddDocument

Nama Parameter Jenis Data Diperlukan Deskripsi
BucketName String Ya Bucket untuk memasukkan dokumen.
SourceTable Objek Tidak Nama tabel sementara yang berisi kolom ID dan Dokumen. Wajib diisi jika tidak ada ID yang ditentukan.
ID String Tidak Kunci utama untuk menyisipkan dokumen. Wajib jika tidak ada SourceTable yang ditentukan.
Dokumen String Tidak Teks JSON dokumen yang akan disisipkan. Wajib jika SourceTable tidak ditentukan.

Parameter output tindakan AddDocument

Tindakan ini akan menampilkan status 200 (OK) jika tindakan tersebut berhasil.

Untuk mengetahui contoh cara mengonfigurasi tindakan AddDocument, lihat Contoh tindakan.

Tindakan CreateCollection

Tindakan ini akan membuat koleksi dalam cakupan yang ada.

Parameter input tindakan CreateCollection

Nama Parameter Jenis Data Diperlukan Deskripsi
Bucket String Ya Nama bucket yang berisi koleksi.
Cakupan String Ya Nama cakupan yang berisi koleksi.
Nama String Ya Nama koleksi yang akan dibuat.

Parameter output tindakan CreateCollection

Tindakan ini akan menampilkan status 200 (OK) jika tindakan tersebut berhasil.

Untuk mengetahui contoh cara mengonfigurasi tindakan CreateCollection, lihat Contoh tindakan.

Tindakan DeleteCollection

Tindakan ini akan menghapus koleksi dalam cakupan yang ada.

Parameter input tindakan DeleteCollection

Nama Parameter Jenis Data Diperlukan Deskripsi
Bucket string Benar Nama bucket yang berisi koleksi.
Cakupan String Benar Nama cakupan yang berisi koleksi.
Nama string Benar Nama koleksi yang akan dihapus.

Parameter output tindakan DeleteCollection

Tindakan ini akan menampilkan status 200 (OK) jika tindakan tersebut berhasil.

Untuk mengetahui contoh cara mengonfigurasi tindakan DeleteCollection, lihat Contoh tindakan.

Tindakan CreateScope

Tindakan ini akan membuat cakupan di bucket yang ada.

Parameter input tindakan CreateScope

Nama Parameter Jenis Data Diperlukan Deskripsi
Bucket String Ya Nama bucket yang berisi cakupan
Nama String Ya Nama cakupan yang akan dibuat.

Parameter output tindakan CreateScope

Tindakan ini akan menampilkan status 200 (OK) jika tindakan tersebut berhasil.

Untuk mengetahui contoh cara mengonfigurasi tindakan CreateScope, lihat Contoh tindakan.

Tindakan DeleteScope

Tindakan ini akan menghapus cakupan dan semua koleksinya.

Parameter input tindakan DeleteScope

Nama Parameter Jenis Data Diperlukan Deskripsi
Bucket String Ya Nama bucket yang berisi cakupan.
Nama String Ya Nama cakupan yang akan dihapus.

Parameter output tindakan DeleteScope

Tindakan ini akan menampilkan status 200 (OK) jika tindakan tersebut berhasil.

Untuk mengetahui contoh cara mengonfigurasi tindakan DeleteScope, lihat Contoh tindakan.

Tindakan ListIndices

Tindakan ini mencantumkan semua indeks yang tersedia di Couchbase.

Parameter input tindakan ListIndices

T/A

Parameter output tindakan ListIndices

Tindakan ini akan menampilkan status 200 (OK) jika tindakan tersebut berhasil.

Untuk mengetahui contoh cara mengonfigurasi tindakan ListIndices, lihat Contoh tindakan.

Tindakan ManageIndices

Tindakan ini akan membuat atau meletakkan indeks dalam bucket.

Input parameter tindakan ManageIndices

Nama Parameter Jenis Data Diperlukan Deskripsi
BucketName String Ya Bucket target untuk membuat atau menghapus indeks.
ScopeName objek Tidak Cakupan target untuk membuat atau menghapus indeks (Couchbase versi 7 dan yang lebih baru)
CollectionName String Tidak Koleksi target tempat indeks dibuat atau dihapus (Couchbase versi 7 dan yang lebih baru)
Tindakan String Ya Menentukan tindakan yang akan dilakukan pada indeks, dapat berupa Buat atau Lepas.
Ekspresi String Tidak Daftar ekspresi atau fungsi, yang dienkode sebagai JSON, yang akan menjadi dasar indeks. Setidaknya satu kolom diperlukan jika IsPrimary disetel ke false dan tindakannya adalah Create.
Nama String Tidak Nama indeks yang akan dibuat atau dihapus, diperlukan jika IsPrimary disetel ke false.
IsPrimary String Tidak Menentukan apakah indeks harus berupa indeks utama.Nilai defaultnya adalah benar.
Filter String Tidak Daftar filter, yang dienkode sebagai JSON, untuk diterapkan pada indeks.
IndexType String Tidak Jenis indeks yang akan dibuat, dapat berupa GSI atau View, hanya digunakan jika tindakannya adalah Create. Nilai defaultnya adalah GSI.
ViewName String Tidak Tidak digunakan lagi, hanya disertakan untuk kompatibilitas. Tidak melakukan apa-apa.
Node String Tidak Daftar node yang dienkode sebagai JSON untuk memuat indeks harus berisi port. Hanya digunakan jika tindakannya adalah Create.
NumReplica String Tidak Jumlah replika yang akan dibuat di antara node indeks dalam cluster.

Parameter output tindakan ManageIndices

Tindakan ini akan menampilkan status 200 (OK) jika tindakan tersebut berhasil.

Untuk mengetahui contoh cara mengonfigurasi tindakan ManageIndices, 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, pada jenis tindakan yang ingin dilakukan, pilih Tindakan.
  3. Dalam daftar Action, pilih Execute custom query, lalu klik Done.
  4. 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=?

    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

Bagian ini menjelaskan cara melakukan beberapa tindakan dalam konektor ini.

Contoh - Menambahkan dokumen

Contoh ini menambahkan dokumen di bucket Couchbase.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan AddDocument, lalu klik Done.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"Document": "{\"ID\":10,\"Name\":\"TestDoc\"}",
"BucketName": "CouchbaseTestBucket",
"ID": "Test"
}

    4. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas AddDocument akan memiliki nilai yang mirip dengan berikut ini:

    [{
"RowsAffected": "1"
}]

Contoh - Membuat koleksi

Contoh ini akan membuat koleksi.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan CreateCollection, lalu klik Done.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"bucket": "CouchbaseTestBucket",
"scope": "TestScope",
"name": "CollectionFromGoogleCloud"
}

    4. Contoh ini akan membuat koleksi di bagian TestScope. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas CreateCollection akan memiliki nilai yang mirip dengan berikut ini:

    [{
"Success": true,
"scope": null,
"uid": null,
"collection": null,
"collections.uid": null,
"maxTTL": null,
"history": null
}]

Contoh - Menghapus koleksi

Contoh ini menghapus koleksi.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan DeleteCollection, lalu klik Done.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"bucket": "CouchbaseTestBucket",
"scope": "TestScope",
"name": "CollectionFromGoogleCloud"
}

    4. Contoh ini menghapus koleksi di bagian TestScope. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas CreateCollection akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Success": true,
"uid": "12"
}]

Contoh - Membuat cakupan

Contoh ini akan membuat cakupan.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan CreateScope, lalu klik Done.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"bucket": "CouchbaseTestBucket",
"name": "ScopeFromGoogleCloud"
}

    4. Contoh ini akan membuat cakupan di bagian CouchbaseTestBucket. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas CreateScope akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Success": true,
"name": null,
"uid": null,
"collections": null,
"collections.name": null,
"collections.uid": null,
"collections.maxTTL": null,
"collections.history": null
}]

Contoh - Menghapus cakupan

Contoh ini menghapus cakupan.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan DeleteScope, lalu klik Done.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"bucket": "CouchbaseTestBucket",
"name": "ScopeFromGoogleCloud"
}

    4. Contoh ini menghapus cakupan ScopeFromGoogleCloud. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas DeleteScope akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Success": true,
"uid": "10"
}]

Contoh - Indeks daftar

Contoh ini mencantumkan semua indeks yang tersedia di Couchbase.

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

    4. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas ListIndices akan memiliki nilai yang mirip dengan yang berikut:

    [{
"id": "3d8a78cd2e302ac2",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": null,
"scope_id": null,
"keyspace_id": "CouchbaseTestBucket",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "test",
"state": "online",
"using": "gsi"
}, {
"id": "d6ce8c103b97a00d",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "CouchBaseDatatypes",
"index_key": "",
"condition": null,
"is_primary": "true",
"name": "#primary",
"state": "online",
"using": "gsi"
},
{
"id": "58c25aef49dd32b3",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "TestCollection",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "SearchIndexTest_1",
"state": "online",
"using": "fts"
}]

Contoh - Mengelola indeks

Contoh ini menghapus indeks di bucket yang ditentukan.

  1. Dalam dialog Configure connector task, klik Actions.
  2. Pilih tindakan ManageIndices, lalu klik Done.
  3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value: 
    {
"BucketName": "CouchbaseTestBucket",
"Action": "DROP",
"Name": "CouchBaseTestIndex"
}

    4. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas ManageIndices akan memiliki nilai yang mirip dengan yang berikut:

    [{
"Success": "true"
}]

Contoh operasi entitas

Bagian ini menunjukkan cara melakukan beberapa operasi entity di konektor ini.

Contoh - Menampilkan daftar semua catatan

Contoh ini mencantumkan semua data dalam entity TestCollection.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih TestCollection dari daftar Entity.
  3. Pilih operasi List, lalu klik Done.
  4. Secara opsional, di bagian Task Input pada tugas Connectors, Anda dapat memfilter kumpulan hasil dengan menentukan klausa filter. Tentukan nilai klausa filter selalu dalam tanda kutip tunggal (').

Contoh - Mendapatkan kumpulan data dari entity

Contoh ini mendapatkan data dengan ID yang ditentukan dari entity TestCollection.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih TestCollection dari daftar Entity.
  3. Pilih operasi Get, lalu klik Done.
  4. Di bagian Task Input pada tugas Connectors, klik EntityId lalu masukkan 120 di kolom Default Value.

    Di sini, 120 adalah ID data unik dalam entity TestCollection.

Contoh - Memperbarui data dalam entity

Contoh ini memperbarui data dalam entity TestCollection.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih TestCollection 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: 
    {
"COL_TEXT": "CouchBase Update"
}
  5. Klik entityId, lalu masukkan 120 di kolom Nilai Default.

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

    [{
"Document.Id": "120"
}]

Contoh - Menghapus data dari entity

Contoh ini menghapus data dengan ID yang ditentukan dalam entity TestCollection.

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

Masalah umum

Operasi create pada entitas tidak didukung.

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
allow_jsonparameters BOOLEAN Salah Memungkinkan JSON mentah digunakan dalam parameter saat QueryPassthrough diaktifkan.
analytics_port STRING Salah Port untuk terhubung ke Endpoint Analytics Couchbase.
child_separator STRING Salah Karakter yang digunakan untuk menunjukkan tabel turunan.
couchbase_service ENUM Salah Menentukan layanan Couchbase yang akan disambungkan. Defaultnya adalah N1QL. Opsi yang tersedia adalah N1QL dan Analytics. Nilai yang didukung adalah: N1QL, Analytics
create_table_ram_quota STRING Salah Kuota RAM default, dalam megabyte, yang akan digunakan saat memasukkan bucket melalui sintaksis CREATE TABLE.
dataverse_separator STRING Salah Karakter atau karakter yang digunakan untuk menunjukkan dataverse dan cakupan/koleksi Analytics.
flavor_separator STRING Salah Karakter yang digunakan untuk menunjukkan rasa.
n1_qlport STRING Salah Port untuk terhubung ke Endpoint N1QL Couchbase.
periods_separator STRING Salah Karakter yang digunakan untuk menunjukkan hierarki.
query_execution_timeout STRING Salah Tindakan ini menetapkan waktu tunggu sisi server untuk kueri, yang mengatur berapa lama Couchbase akan mengeksekusi kueri sebelum menampilkan error waktu tunggu.
strict_comparison STRING Salah Menyesuaikan ketelitian dalam menerjemahkan filter pada kueri input SQL menjadi kueri Couchbase. Ini dapat ditetapkan ke daftar nilai yang dipisahkan koma, dengan setiap nilai dapat berupa salah satu dari: tanggal, angka, boolean, atau string.
transaction_durability STRING Salah Menentukan cara dokumen harus disimpan agar transaksi berhasil. Menentukan apakah akan menggunakan transaksi N1QL saat menjalankan kueri.
transaction_timeout STRING Salah Langkah ini menetapkan jumlah waktu yang dapat dieksekusi oleh transaksi sebelum waktunya habis oleh Couchbase.
use_collections_for_ddl BOOLEAN Salah Apakah akan mengasumsikan bahwa pernyataan CREATE TABLE menggunakan koleksi, bukan ragam. Hanya berlaku saat menghubungkan ke Couchbase v7+ dan GenerateSchemaFiles disetel ke OnCreate.
use_transactions STRING Salah Menentukan apakah akan menggunakan transaksi N1QL saat menjalankan kueri.
validate_jsonparameters BOOLEAN Salah Memungkinkan penyedia memvalidasi bahwa parameter string adalah JSON yang valid sebelum mengirim kueri ke Couchbase.
proxy_enabled BOOLEAN Salah Pilih kotak centang 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 mengautentikasi ke proxy ProxyServer.
proxy_ssltype ENUM Salah Jenis SSL yang akan digunakan saat menghubungkan ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, WorkManager
panjang STRING Salah Tingkat panjang untuk koneksi, bervariasi dari 1-5. Tingkat panjang yang lebih tinggi akan mencatat semua detail komunikasi (sertifikat permintaan,respons & SSL).

Menggunakan koneksi Couchbase 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