How to use IBM App Connect with Couchbase
Couchbase is a distributed NoSQL cloud database for interactive applications. It features reliable performance, easy scaling, and a flexible data model.
- Linux® on Z
- Linux on Power®
Supported product and API versions
To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.
Connecting to Couchbase
Complete the connection fields that you see in the App Connect Designer page (previously the Catalog page) or flow editor. If necessary, work with your Couchbase administrator to obtain these values.
| Connection field | Description |
|---|---|
| Endpoint URL | The connection URL that is used to connect to the Couchbase Server cluster in the format <couchbase or
couchbases>://<hostname or IP address>. For secure TLS connections, use the
couchbases:// prefix. |
| Username | The username of your Couchbase account. |
| Password | The password for the specified username. |
For more information on Endpoint URL, see Connect to Your Cluster on the Couchbase documentation page.
To connect to a Couchbase endpoint from the App Connect Designer Applications and APIs page for the first time, expand Couchbase, then click Connect. For more information about ways to connect to Couchbase, see Managing accounts in App Connect.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.
General considerations
Before you use App Connect Designer with Couchbase, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
Couchbase events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
Couchbase actions
Your flow completes these actions on this application.
| Object | Action | Description |
|---|---|---|
| Buckets | Retrieve buckets | Retrieves the buckets from Couchbase Server |
| Collections | Retrieve collections | Retrieves the collections from the Couchbase Server |
| Custom SQL | Execute custom SQL | Allows user to execute custom queries |
| Documents | Create document | Creates a document in Couchbase Server |
| Delete documents | Deletes a document in Couchbase Server | |
| Retrieve documents | Retrieves the documents from Couchbase Server | |
| Update document | Updates a document in Couchbase Server | |
| Update or create document | Updates or creates a document in Couchbase Server | |
| Scopes | Retrieve scopes | Retrieves the scopes from the Couchbase server |
Examples
Use templates to quickly create flows for Couchbase
Learn how to use App Connect templates to quickly create flows that perform actions on Couchbase. For example, open Discover, and then search for Couchbase.
Use IBM® App Connect to build flows that integrate with Couchbase.
Read the blog in the IBM Community to learn how to sync employee records between Couchbase and Amazon DynamoDB. Click Read the blog to go to the blog.