Couchbase

Entitas, operasi, dan tindakan

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

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

  Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity apa pun, sehingga daftar Entities akan kosong.

• Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:
  • Daftar
  • 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 entitas tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak tercantum 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 berbeda-beda dari konektor ke konektor. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, ada kemungkinan konektor tidak mendukung tindakan apa pun, sehingga daftar Actions akan kosong.

Tindakan

Konektor ini mendukung eksekusi tindakan berikut:

• Prosedur dan fungsi tersimpan yang ditentukan pengguna. Jika Anda memiliki prosedur dan fungsi 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, di jenis tindakan yang ingin Anda lakukan, pilih Tindakan.
  3. Dalam daftar Tindakan, pilih Jalankan kueri kustom, lalu klik Selesai.

     

  4. Luaskan bagian Input tugas, 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. Dalam dialog Editor skrip, masukkan kueri SQL, lalu klik Simpan.

        Anda dapat menggunakan tanda tanya (?) dalam pernyataan SQL untuk merepresentasikan 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 Anda 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 (?), maka Anda harus menambahkan tiga parameter sesuai urutan.

        

        Untuk menambahkan parameter kueri, lakukan hal 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.

Tindakan

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

Tindakan AddDocument

Tindakan ini menambahkan dokumen di Couchbase.

Parameter input tindakan AddDocument

Parameter output tindakan AddDocument

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

Untuk contoh cara mengonfigurasi tindakan AddDocument, lihat Contoh tindakan.

Tindakan CreateCollection

Tindakan ini membuat koleksi dalam cakupan yang ada.

Parameter input tindakan CreateCollection

Parameter output tindakan CreateCollection

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

Untuk contoh cara mengonfigurasi tindakan CreateCollection, lihat Contoh tindakan.

Tindakan DeleteCollection

Tindakan ini akan menghapus koleksi dalam cakupan yang ada.

Parameter input tindakan DeleteCollection

Parameter output tindakan DeleteCollection

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

Untuk contoh cara mengonfigurasi tindakan DeleteCollection, lihat Contoh tindakan.

Tindakan CreateScope

Tindakan ini membuat cakupan di bucket yang ada.

Parameter input tindakan CreateScope

Parameter output tindakan CreateScope

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

Untuk contoh cara mengonfigurasi tindakan CreateScope, lihat Contoh tindakan.

Tindakan DeleteScope

Tindakan ini akan menghapus cakupan dan semua koleksinya.

Parameter input tindakan DeleteScope

Parameter output tindakan DeleteScope

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

Untuk contoh cara mengonfigurasi tindakan DeleteScope, lihat Contoh tindakan.

Tindakan ListIndices

Tindakan ini mencantumkan semua indeks yang tersedia di Couchbase.

Parameter input tindakan ListIndices

Parameter output tindakan ListIndices

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

Untuk contoh cara mengonfigurasi tindakan ListIndices, lihat Contoh tindakan.

Tindakan ManageIndices

Tindakan ini membuat atau menghapus indeks dalam bucket.

Parameter input tindakan ManageIndices

Parameter output tindakan ManageIndices

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

Untuk 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, di jenis tindakan yang ingin Anda lakukan, pilih Tindakan.
3. Dalam daftar Tindakan, pilih Jalankan kueri kustom, lalu klik Selesai.

   

4. Luaskan bagian Input tugas, 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. Dalam dialog Editor skrip, masukkan kueri SQL, lalu klik Simpan.

      Anda dapat menggunakan tanda tanya (?) dalam pernyataan SQL untuk merepresentasikan 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 Anda 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 (?), maka Anda harus menambahkan tiga parameter sesuai urutan.

      

      Untuk menambahkan parameter kueri, lakukan hal 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.

Jika 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 di konektor ini.

Contoh - Menambahkan dokumen

Contoh ini menambahkan dokumen dalam bucket Couchbase.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan AddDocument, lalu klik Selesai.
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"
   }

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

[{
"RowsAffected": "1"
}]

Contoh - Membuat koleksi

Contoh ini membuat koleksi.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan CreateCollection, lalu klik Selesai.
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"
   }

Contoh ini membuat koleksi di bawah TestScope. Jika tindakan 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 Selesai.
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"
   }

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

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

Contoh - Membuat cakupan

Contoh ini membuat cakupan.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan CreateScope, lalu klik Selesai.
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"
   }

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

[{
"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 Selesai.
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"
   }

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

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

Contoh - Mencantumkan indeks

Contoh ini mencantumkan semua indeks yang tersedia di Couchbase.

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

   {
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas ListIndices akan memiliki nilai yang mirip dengan 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 dalam bucket yang ditentukan.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan ManageIndices, lalu klik Selesai.
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"
   }

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

[{
"Success": "true"
}]

Contoh operasi entity

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

Contoh - Mencantumkan semua catatan

Contoh ini mencantumkan semua data dalam entitas TestCollection.

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

Contoh - Mendapatkan rekaman dari entity

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

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih TestCollection dari daftar Entity.
3. Pilih operasi Get, lalu klik Selesai.
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 entitas TestCollection.

Contoh - Memperbarui data dalam entity

Contoh ini memperbarui data dalam entitas TestCollection.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih TestCollection dari daftar Entity.
3. Pilih operasi Update, lalu klik Selesai.
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 Default Value.

   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 di entitas TestCollection.

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