Couchbase Agent for Gluesync: Features & Compatibility

Index

Source data from Couchbase (Eventing)

Source data from Couchbase (DCP)

Target Couchbase

Agent changelog

Couchbase source advanced settings — shared scopes/collections flag and Eventing settings

Couchbase target advanced settings

Core principles

Gluesync’s Couchbase agent uses and implements the Couchbase Java SDK to connect and perform all the operations at the node/cluster level. Gluesync also supports Couchbase HA features as well as load balancing across multiple cluster nodes, thanks to automatic node discovery.

We worked jointly with the Couchbase engineering team to meet both design and great performance goals to achieve the best-in-class native integration with Couchbase Server, officially supported by the vendor.

Change data capture

The catalog contains 2 role-specific Couchbase entries.

Couchbase DCP agent: Reads the native DCP stream through dcp-client and writes nothing to the source bucket. No Eventing service. Works on Community Edition and Enterprise Edition. Couchbase 7.0+ with scopes/collections; Couchbase 6.x without scopes/collections. See Source data from Couchbase (DCP).
Couchbase Eventing agent: Uses the Eventing Service, requires Enterprise Edition, and works on Couchbase 6.x. Eventing functions are bundled with this agent, which manages their lifecycle, deployment and update. Event documents are written to gluesync-scope.gluesync-collection. See Source data from Couchbase (Eventing).

Security

Gluesync replication supports secure communication via TLS encryption when connecting to the Couchbase cluster, this can be optionally enabled depending on your configuration and use case. We recommend adopting TLS encryption for any production use case.

Supported version

Eventing source: Couchbase 6.x is supported; the Eventing service requires Enterprise Edition.
Couchbase target: Couchbase Server 7.0 and above, hosted on-prem or in Capella DBaaS.
DCP source: Couchbase 7.0+ when using scopes and collections; Couchbase 6.x when not using scopes and collections.

Community Edition (CE) and Enterprise Edition (EE) are supported on the DCP source path. DCP support has been verified with TLS, Capella, rebalance, and failover.

Platform supported features

Feature	Support	Notes
Target role	✅	Provided only by the target catalog row Couchbase agent.
Source role	✅	Two source agents: native DCP stream or embedded Eventing functions.
Snapshots	✅	Shared snapshot and discovery behavior comes from the parent module and is available to both source agents; the target supports incoming snapshot loads.
CDC	✅	Real-time replication via native DCP or the Couchbase Eventing service.
CDC type	DCP or Eventing	DCP: native stream, no Eventing service (docs). Eventing: built-in functions bundled with the agent (docs).
Bulk load	N/A	No separate staging-table bulk flow is documented. Initial loads use the shared Couchbase snapshot behavior.
Database pooling	✅	Supports connection pooling for efficient resource utilization across multiple pipelines.
Source persisted internal cache	N/A	Eventing stores offsets in Couchbase. DCP derives checkpoint sizing from the live cluster map instead of assuming a fixed vbucket count.
Target persisted internal cache	N/A	Writes go directly through the SDK to the cluster.
Driver / connector	Couchbase Java SDK + Kotlin SDK	Vendor-certified integration jointly validated with Couchbase engineering.
Chains	N/A	Not supported being it a NoSQL database.
Truncate operation support (reading)	N/A	Document stores do not emit TRUNCATE events; deletions are item-level.
Truncate operation support (writing)	N/A	Gluesync does not issue bucket-level TRUNCATE/DROP commands automatically.

Feature

Support

Notes

Target role

✅

Provided only by the target catalog row Couchbase agent.

Source role

✅

Two source agents: native DCP stream or embedded Eventing functions.

Snapshots

✅

Shared snapshot and discovery behavior comes from the parent module and is available to both source agents; the target supports incoming snapshot loads.

CDC

✅

Real-time replication via native DCP or the Couchbase Eventing service.

CDC type

DCP or Eventing

DCP: native stream, no Eventing service (docs). Eventing: built-in functions bundled with the agent (docs).

Bulk load

N/A

No separate staging-table bulk flow is documented. Initial loads use the shared Couchbase snapshot behavior.

Database pooling

✅

Supports connection pooling for efficient resource utilization across multiple pipelines.

Source persisted internal cache

N/A

Eventing stores offsets in Couchbase. DCP derives checkpoint sizing from the live cluster map instead of assuming a fixed vbucket count.

Target persisted internal cache

N/A

Writes go directly through the SDK to the cluster.

Driver / connector

Couchbase Java SDK + Kotlin SDK

Vendor-certified integration jointly validated with Couchbase engineering.

Chains

N/A

Not supported being it a NoSQL database.

Truncate operation support (reading)

N/A

Document stores do not emit TRUNCATE events; deletions are item-level.

Truncate operation support (writing)

N/A

Gluesync does not issue bucket-level TRUNCATE/DROP commands automatically.

Q&A

I have got a Couchbase Sync Gateway running on the same bucket in which I would like to run Gluesync, is it supported? Sure, Gluesync has been specifically designed to work even within the Sync Gateway running on the same data buckets.