Couchbase

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

This connector supports execution of the following actions:

• User-defined stored procedures and functions. If you have any stored procedures and functions in your backend, those are listed in the Actions column of the Configure connector task dialog.
• Custom SQL queries. To execute custom SQL queries, the connector provides the Execute custom query action.

  To create a custom query, follow these steps:

  1. Follow the detailed instructions to add a connectors task.
  2. When you configure the connector task, in the type of action you want to perform, select Actions.
  3. In the Action list, select Execute custom query, and then click Done.

     

  4. Expand the Task input section, and then do the following:
     1. In the Timeout after field, enter the number of seconds to wait till the query executes.

        Default value: 180 seconds.

     2. In the Maximum number of rows field, enter the maximum number of rows to be returned from the database.

        Default value: 25.

     3. To update the custom query, click Edit Custom Script. The Script editor dialog opens.

        

     4. In the Script editor dialog, enter the SQL query and click Save.

        You can use a question mark (?) in a SQL statement to represent a single parameter that must be specified in the query parameters list. For example, the following SQL query selects all rows from the Employees table that matches the values specified for the LastName column:

        SELECT * FROM Employees where LastName=?

     5. If you've used question marks in your SQL query, you must add the parameter by clicking + Add Parameter Name for each question mark. While executing the integration, these parameters replace the question marks (?) in the SQL query sequentially. For example, if you have added three question marks (?), then you must add three parameters in order of sequence.

        

        To add query parameters, do the following:

        1. From the Type list, select the data type of the parameter.
        2. In the Value field, enter the value of the parameter.
        3. To add multiple parameters, click + Add Query Parameter.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, see Action examples.

AddDocument action

This action add documets in couchbase.

Input parameters of the AddDocument action

Output parameters of the AddDocument action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the AddDocument action, see Action examples.

CreateCollection action

This action creates a collection in an existing scope.

Input parameters of the CreateCollection action

Output parameters of the CreateCollection action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the CreateCollection action, see Action examples.

DeleteCollection action

This action deletes a collection in an existing scope.

Input parameters of the DeleteCollection action

Output parameters of the DeleteCollection action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the DeleteCollection action, see Action examples.

CreateScope action

This action creates a scope in an existing bucket.

Input parameters of the CreateScope action

Output parameters of the CreateScope action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the CreateScope action, see Action examples.

DeleteScope action

This action deletes a scope and all its collections.

Input parameters of the DeleteScope action

Output parameters of the DeleteScope action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the DeleteScope action, see Action examples.

ListIndices action

This action lists all indices available in Couchbase.

Input parameters of the ListIndices action

Output parameters of the ListIndices action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the ListIndices action, see Action examples.

ManageIndices action

This action creates or drops an index in a bucket.

Input parameters of the ManageIndices action

Output parameters of the ManageIndices action

This action returns the status 200 (OK) if the action is successful.

For example on how to configure the ManageIndices action, see Action examples.

ExecuteCustomQuery action

This action lets you execute a custom query.

To create a custom query, follow these steps:

1. Follow the detailed instructions to add a connectors task.
2. When you configure the connector task, in the type of action you want to perform, select Actions.
3. In the Action list, select Execute custom query, and then click Done.

   

4. Expand the Task input section, and then do the following:
   1. In the Timeout after field, enter the number of seconds to wait till the query executes.

      Default value: 180 seconds.

   2. In the Maximum number of rows field, enter the maximum number of rows to be returned from the database.

      Default value: 25.

   3. To update the custom query, click Edit Custom Script. The Script editor dialog opens.

      

   4. In the Script editor dialog, enter the SQL query and click Save.

      You can use a question mark (?) in a SQL statement to represent a single parameter that must be specified in the query parameters list. For example, the following SQL query selects all rows from the Employees table that matches the values specified for the LastName column:

      SELECT * FROM Employees where LastName=?

   5. If you've used question marks in your SQL query, you must add the parameter by clicking + Add Parameter Name for each question mark. While executing the integration, these parameters replace the question marks (?) in the SQL query sequentially. For example, if you have added three question marks (?), then you must add three parameters in order of sequence.

      

      To add query parameters, do the following:

      1. From the Type list, select the data type of the parameter.
      2. In the Value field, enter the value of the parameter.
      3. To add multiple parameters, click + Add Query Parameter.

On successful execution, this action returns the status 200 (OK) with a response body that has the query results.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Add a document

This example adds a document in a Couchbase bucket.

1. In the Configure connector task dialog, click Actions.
2. Select the AddDocument action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the AddDocument task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"RowsAffected": "1"
}]

Example - Create a collection

This example creates a collection.

1. In the Configure connector task dialog, click Actions.
2. Select the CreateCollection action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

This example creates a collection under the TestScope. If the action is successful, the CreateCollection task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Delete a collection

This example deletes a collection.

1. In the Configure connector task dialog, click Actions.
2. Select the DeleteCollection action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

This example deletes a collection under the TestScope. If the action is successful, the CreateCollection task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Create a scope

This example creates a scope.

1. In the Configure connector task dialog, click Actions.
2. Select the CreateScope action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

This example creates a scope under CouchbaseTestBucket. If the action is successful, the CreateScope task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Delete a scope

This example deletes a scope.

1. In the Configure connector task dialog, click Actions.
2. Select the DeleteScope action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

This example deletes the ScopeFromGoogleCloud scope. If the action is successful, the DeleteScope task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - List indices

This example lists all indices available in Couchbase.

1. In the Configure connector task dialog, click Actions.
2. Select the ListIndices action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   }

If the action is successful, the ListIndices task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Manage indices

This example deletes an index in the specified bucket.

1. In the Configure connector task dialog, click Actions.
2. Select the ManageIndices action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the ManageIndices task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all the records

This example lists all the records in the TestCollection entity.

1. In the Configure connector task dialog, click Entities.
2. Select TestCollection from the Entity list.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. Specify the filter clause value always within the single quotes (').

Example - Get a record from an entity

This example gets a record with the specified ID from the TestCollection entity.

1. In the Configure connector task dialog, click Entities.
2. Select TestCollection from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 120 in the Default Value field.

   Here, 120 is a unique record ID in the TestCollection entity.

Example - Update a record in an entity

This example updates a record in the TestCollection entity.

1. In the Configure connector task dialog, click Entities.
2. Select TestCollection from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "COL_TEXT": "CouchBase Update"
   }

5. Click entityId, and then enter 120 in the Default Value field.

   If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:

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

Example - Delete a record from an entity

This example deletes the record with the specified ID in the TestCollection entity.

1. In the Configure connector task dialog, click Entities.
2. Select TestCollection from the Entity list.
3. Select the Delete operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 20 in the Default Value field.