Couchbase

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

  不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

  從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱 Connectors 工作的實體作業。 不過，如果連接器不支援任何實體作業，系統就不會在 Operations 清單中列出這些不支援的作業。

• 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

動作

這個連接器支援執行下列動作：

• 使用者定義的預存程序和函式。如果後端有任何預存程序和函式，這些項目會列在 Configure connector task 對話方塊的 Actions 欄中。
• 自訂 SQL 查詢。如要執行自訂 SQL 查詢，連接器提供「執行自訂查詢」動作。

  如要建立自訂查詢，請按照下列步驟操作：

  1. 請按照詳細說明 新增連接器工作。
  2. 設定連接器工作時，請在要執行的動作類型中選取「動作」。
  3. 在「動作」清單中，選取「執行自訂查詢」，然後按一下「完成」。

     

  4. 展開「Task input」(工作輸入) 區段，然後執行下列操作：
     1. 在「Timeout after」(逾時時間) 欄位中，輸入查詢執行前的等待秒數。

        預設值：180 秒。

     2. 在「資料列數量上限」欄位中，輸入要從資料庫傳回的資料列數量上限。

        預設值為 25。

     3. 如要更新自訂查詢，請按一下「編輯自訂指令碼」。「指令碼編輯器」對話方塊隨即開啟。

        

     4. 在「指令碼編輯器」對話方塊中輸入 SQL 查詢，然後按一下「儲存」。

        您可以在 SQL 陳述式中使用問號 (?) 代表單一參數，該參數必須在查詢參數清單中指定。舉例來說，下列 SQL 查詢會從 Employees 資料表選取與 LastName 資料欄指定值相符的所有資料列：

        SELECT * FROM Employees where LastName=?

     5. 如果您在 SQL 查詢中使用問號，請為每個問號點按「+ 新增參數名稱」，加入參數。執行整合時，這些參數會依序取代 SQL 查詢中的問號 (?)。舉例來說，如果您新增了三個問號 (?)，就必須依序新增三個參數。

        

        如要新增查詢參數，請按照下列步驟操作：

        1. 在「類型」清單中，選取參數的資料類型。
        2. 在「值」欄位中輸入參數值。
        3. 如要新增多個參數，請按一下「+ 新增查詢參數」。

動作

本節列出連接器支援的操作。如要瞭解如何設定動作，請參閱「動作範例」。

AddDocument 動作

這項動作會在 Couchbase 中新增文件。

AddDocument 動作的輸入參數

AddDocument 動作的輸出參數

如果動作成功，這項操作會傳回狀態 200 (OK)。

如要瞭解如何設定 AddDocument 動作，請參閱動作範例。

CreateCollection 動作

這項動作會在現有範圍中建立集合。

CreateCollection 動作的輸入參數

CreateCollection 動作的輸出參數

如果動作成功，這項操作會傳回狀態 200 (OK)。

如要瞭解如何設定 CreateCollection 動作，請參閱動作範例。

DeleteCollection 動作

這項操作會刪除現有範圍中的集合。

DeleteCollection 動作的輸入參數

DeleteCollection 動作的輸出參數

如果動作成功，這項操作會傳回狀態 200 (OK)。

如要瞭解如何設定 DeleteCollection 動作，請參閱動作範例。

CreateScope 動作

這項動作會在現有 bucket 中建立範圍。

CreateScope 動作的輸入參數

CreateScope 動作的輸出參數

如果動作成功，這項操作會傳回狀態 200 (OK)。

如要瞭解如何設定 CreateScope 動作，請參閱動作範例。

DeleteScope 動作

這項操作會刪除範圍和所有集合。

DeleteScope 動作的輸入參數

DeleteScope 動作的輸出參數

如果動作成功，這項操作會傳回狀態 200 (OK)。

如要瞭解如何設定 DeleteScope 動作，請參閱動作範例。

ListIndices 動作

這項動作會列出 Couchbase 中的所有可用索引。

ListIndices 動作的輸入參數

ListIndices 動作的輸出參數

如果動作成功，這項操作會傳回狀態 200 (OK)。

如要瞭解如何設定 ListIndices 動作，請參閱「動作範例」。

ManageIndices 動作

這項操作會在 bucket 中建立或捨棄索引。

ManageIndices 動作的輸入參數

ManageIndices 動作的輸出參數

如果動作成功，這項操作會傳回狀態 200 (OK)。

如要瞭解如何設定 ManageIndices 動作，請參閱「動作範例」。

ExecuteCustomQuery 動作

這項操作可讓您執行自訂查詢。

如要建立自訂查詢，請按照下列步驟操作：

1. 請按照詳細說明 新增連接器工作。
2. 設定連接器工作時，請在要執行的動作類型中選取「動作」。
3. 在「動作」清單中，選取「執行自訂查詢」，然後按一下「完成」。

   

4. 展開「Task input」(工作輸入) 區段，然後執行下列操作：
   1. 在「Timeout after」(逾時時間) 欄位中，輸入查詢執行前的等待秒數。

      預設值：180 秒。

   2. 在「資料列數量上限」欄位中，輸入要從資料庫傳回的資料列數量上限。

      預設值為 25。

   3. 如要更新自訂查詢，請按一下「編輯自訂指令碼」。「指令碼編輯器」對話方塊隨即開啟。

      

   4. 在「指令碼編輯器」對話方塊中輸入 SQL 查詢，然後按一下「儲存」。

      您可以在 SQL 陳述式中使用問號 (?) 代表單一參數，該參數必須在查詢參數清單中指定。舉例來說，下列 SQL 查詢會從 Employees 資料表選取與 LastName 資料欄指定值相符的所有資料列：

      SELECT * FROM Employees where LastName=?

   5. 如果您在 SQL 查詢中使用問號，請為每個問號點按「+ 新增參數名稱」，加入參數。執行整合時，這些參數會依序取代 SQL 查詢中的問號 (?)。舉例來說，如果您新增了三個問號 (?)，就必須依序新增三個參數。

      

      如要新增查詢參數，請按照下列步驟操作：

      1. 在「類型」清單中，選取參數的資料類型。
      2. 在「值」欄位中輸入參數值。
      3. 如要新增多個參數，請按一下「+ 新增查詢參數」。

執行成功後，這項動作會傳回狀態 200 (OK)，以及含有查詢結果的回應內容。

動作範例

本節說明如何在這個連接器中執行部分動作。

範例 - 新增文件

這個範例會在 Couchbase bucket 中新增文件。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 AddDocument 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "Document": "{\"ID\":10,\"Name\":\"TestDoc\"}",
   "BucketName": "CouchbaseTestBucket",
   "ID": "Test"
   }

如果動作成功，AddDocument 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"RowsAffected": "1"
}]

範例 - 建立集合

這個範例會建立集合。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 CreateCollection 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "bucket": "CouchbaseTestBucket",
   "scope": "TestScope",
   "name": "CollectionFromGoogleCloud"
   }

這個範例會在 TestScope 下建立集合。如果動作成功，CreateCollection 工作的 connectorOutputPayload 回應參數會包含類似下列內容的值：

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

範例 - 刪除集合

這個範例會刪除集合。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 DeleteCollection 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "bucket": "CouchbaseTestBucket",
   "scope": "TestScope",
   "name": "CollectionFromGoogleCloud"
   }

這個範例會刪除 TestScope 下的集合。如果動作成功，CreateCollection 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

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

範例 - 建立範圍

這個範例會建立範圍。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 CreateScope 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "bucket": "CouchbaseTestBucket",
   "name": "ScopeFromGoogleCloud"
   }

這個範例會在 CouchbaseTestBucket 下建立範圍。如果動作成功，CreateScope 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

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

範例 - 刪除範圍

這個範例會刪除範圍。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 DeleteScope 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "bucket": "CouchbaseTestBucket",
   "name": "ScopeFromGoogleCloud"
   }

這個範例會刪除 ScopeFromGoogleCloud 範圍。如果動作成功，DeleteScope 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

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

範例 - 列出索引

這個範例會列出 Couchbase 中所有可用的索引。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 ListIndices 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   }

如果動作成功，ListIndices 工作的 connectorOutputPayload 回應參數值會類似於下列內容：

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

範例 - 管理索引

這個範例會刪除指定 bucket 中的索引。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 ManageIndices 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "BucketName": "CouchbaseTestBucket",
   "Action": "DROP",
   "Name": "CouchBaseTestIndex"
   }

如果動作成功，ManageIndices 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Success": "true"
}]

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

範例 - 列出所有記錄

這個範例會列出 TestCollection 實體中的所有記錄。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 TestCollection。
3. 選取「List」作業，然後按一下「完成」。
4. (選用) 在「連結器」工作的「工作輸入」部分，您可以指定篩選子句，篩選結果集。請一律在單引號 (') 內指定篩選子句值。

範例 - 從實體取得記錄

這個範例會從 TestCollection 實體取得具有指定 ID 的記錄。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 TestCollection。
3. 選取「Get」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入) 區段中，按一下「EntityId」，然後在「Default Value」(預設值) 欄位中輸入 120。

   其中 120 是 TestCollection 實體中的專屬記錄 ID。

範例 - 更新實體中的記錄

這個範例會更新 TestCollection 實體中的記錄。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 TestCollection。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "COL_TEXT": "CouchBase Update"
   }

5. 按一下「entityId」，然後在「Default Value」欄位中輸入 120。

   如果整合成功，連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值：

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

範例 - 從實體刪除記錄

這個範例會刪除 TestCollection 實體中具有指定 ID 的記錄。

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 TestCollection。
3. 選取「Delete」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下「entityId」，然後在「Default Value」(預設值) 欄位中輸入 20。