A newer version of this documentation is available.
View Latest (v2.2)

Couchbase Agent for Gluesync: Features & Compatibility

Static

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

This agent makes use of the Eventing Service provided by Couchbase to catch real-time data changes from Couchbase’s buckets starting from Database Server version 7.0 and above.

Eventing functions are built-in in Gluesync and bundled with this agent that takes care of their lifecycle, deployment and update.

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

Works with Couchbase Server 7.0 and above, hosted on-prem or in Capella DBaaS. Both Community Edition (CE) and Enterprise Edition (EE) are supported.

Platform supported features

Feature Support Notes

Target role

Uses the official Couchbase Java SDK with automatic node discovery, TLS, and load-balanced writes.

Source role

Deploys embedded Eventing functions to emit bucket-level change events.

Snapshots

Supports initial snapshot loads into/out of Couchbase buckets.

CDC

Real-time replication powered by the Couchbase Eventing service.

CDC type

Eventing Service

Built-in functions bundled with the agent manage deployment and lifecycle (docs).

Bulk load

N/A

Eventing + SDK streaming handle throughput; no staging-table bulk flow required.

Source persisted internal cache

N/A

State is managed in Core Hub metadata; Eventing stores offsets in Couchbase itself.

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.