Couchbase
Use this guide to set up the Couchbase destination connector and find reference information.
Overview
You can sync data to Couchbase, a distributed NoSQL database. The connector writes each stream to a collection. It supports local clusters and Couchbase Capella, the cloud service.
Output schema
The connector writes each stream to a Couchbase collection and maps data using these rules:
- The connector stores each record as a JSON document in Couchbase
- The stream name becomes the collection name, sanitised to meet Couchbase naming rules
- Each document contains:
id: A unique identifier, using a UUID or composite key for deduplicationtype: Set to “airbyte_record”stream: The source stream namedata: The record data
Performance
- The connector uses batch operations to improve performance
- The connector automatically creates primary indexes for each collection
- For large datasets, consider using incremental sync modes
- Adjust the batch size if needed. The default is 1000 documents
Supported sync modes
| Sync mode | Supported? |
|---|---|
| Full Refresh - Overwrite | Yes |
| Full Refresh - Append | Yes |
| Full Refresh - Overwrite + Deduped | Yes |
| Incremental Sync - Append | Yes |
| Incremental Sync - Append + Deduped | Yes |
Get started
Requirements
Local cluster requirements
- Couchbase Server 7.0 or later installed
- A bucket created in Couchbase
- A username and password with these permissions:
- Data Reader (
data_reader) - Data Writer (
data_writer) - Query Manager (
query_manage_index)
- Data Reader (
Capella cloud requirements
- A Couchbase Capella account
- Database access credentials:
- Database username
- Database password
- A bucket created in your Capella cluster
- Allow-list the IP addresses that Airbyte will connect from
Setup guide
Set up a local cluster
-
Install Couchbase Server
- Download and install Couchbase Server Community or Enterprise
- Follow the installation wizard for your platform
- Open the web console at
http://localhost:8091
-
Create Resources
- In the Couchbase Web Console, go to “Buckets” and click “Add Bucket”
- Enter these bucket details:
- Name: mybucket
- Memory Quota: Set an appropriate size (e.g. 100 MB)
- Bucket Type: Couchbase
- Click “Add Bucket” to create it
-
Configure in Airbyte
- Connection String: Enter your Couchbase connection string (e.g.
couchbase://localhost) - Username: Enter your database username (e.g.
airbyte_user) - Password: Enter your database password (e.g.
your_secure_password) - Bucket: Enter your bucket name (e.g.
my_bucket) - Scope: Enter your scope name (defaults to
_default)
- Connection String: Enter your Couchbase connection string (e.g.
Set up Capella
-
Create Capella Resources
- Log in to Couchbase Capella
- Create a new database or use an existing one
- Create a bucket for your data
-
Create Database Credentials
- In Capella, go to “Security → Database Access”
- Click “Create Database Credential”
- Save the username and password
-
Allow List IP Addresses
- In Capella, go to “Security → Network Security”
- Add the IP addresses that Airbyte will connect from
- Get the IPs from Airbyte documentation
-
Get Connection Details
- In Capella, go to “Connect”
- Copy the connection string
-
Configure in Airbyte
- Connection String: Your Capella connection string
- Username: Database username
- Password: Database password
- Bucket: Your bucket name
- Scope:
_default(or your custom scope)
Connection configuration
| Parameter | Description | Example |
|---|---|---|
| Connection String | The connection string to your Couchbase cluster | couchbase://localhost or Capella connection string |
| Username | Database username with required permissions | airbyte |
| Password | Database password | password |
| Bucket | The name of the bucket to sync data to | mybucket |
| Scope | The scope within the bucket (optional, defaults to _default) | _default |
Namespace support
This destination supports namespaces.
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.1.9 | 2025-05-24 | 60719 | Update dependencies |
| 0.1.8 | 2025-05-10 | 59875 | Update dependencies |
| 0.1.7 | 2025-05-03 | 59358 | Update dependencies |
| 0.1.6 | 2025-04-26 | 58279 | Update dependencies |
| 0.1.5 | 2025-04-12 | 57651 | Update dependencies |
| 0.1.4 | 2025-04-05 | 57148 | Update dependencies |
| 0.1.3 | 2025-03-29 | 56612 | Update dependencies |
| 0.1.2 | 2025-03-22 | 56082 | Update dependencies |
| 0.1.1 | 2025-03-08 | 55354 | Update dependencies |
| 0.1.0 | 2024-01-20 | #xxxxx | Initial release of the Couchbase destination connector |