Couchbase

Overview

Couchbase is a NoSQL database management system that is designed for high-performance, scalability, and flexibility. Integrate Couchbase with Superblocks to build applications and other custom internal tools on top of your Couchbase documents.

Setting up Couchbase

Create Cluster Access Credentials

To connect to Couchbase, you'll need a username and password. For self-managed clusters, refer to Couchbase's guide on how to Connect a Self-Managed Cluster.

For Couchbase Cloud, use the following instructions to create Cluster Access Credentials.

1. Navigate to your Couchbase Cluster
2. Click Settings
3. In the navigation menu, click Cluster Access
4. Click Create Cluster Access
5. Specify a cluster access name and secret, these will serve as the username and password when connecting
6. Specify the buckets and scope the credentials should have access to
7. Once you have finished making the desired configurations, click Create Cluster Access

Learn more about how to Configure Cluster Access Credentials

Set up allowed IP Addresses

If you're using Superblocks Cloud, add Superblocks' IPs as allowed IPs for your cluster. Learn how to in Couchbase's guide on Configuring Allowed IP Addresses.

This is not necessary for Superblocks On-Premise.

Add integration

1. In the web app, navigate to the Integrations page
2. Click the Couchbase tile
3. Name the integration
4. Fill out the connection configuration as follows:

Field	Required	Description
URI		Comma-delimited list of IP addresses and/or hostnames to connect to. Learn more about the format of Couchbase connection strings in Couchbases's guide on Managing Connections.
Username		Cluster access credential name or username.
Password		Cluster access credential secret or cluster password.

5. Optionally, add more configurations to set credentials for different environments
6. Click Test Connection to check that Superblocks can connect
7. Click Create

success

Couchbase connected!
Now you can use Couchbase in any Application, Workflow, or Scheduled Job.

Use Couchbase in APIs

Once your Couchbase integration is created, you can start using Couchbase actions in Superblocks APIs.

Raw query

Write SQL++ queries to issue queries to Couchbase.

Insert Item

Insert new documents into Couchbase collections with the Insert item action.

Get Item

Get a single document from your Couchbase collection with the Get item action.

Remove Item

Remove individual documents from a Couchbase collection with the Remove item action.