Compatibility
Couchbase Sync Gateway
Covers Couchbase Sync Gateway’s compatibility with Couchbase Server and Couchbase Lite
|
Couchbase Lite 4.0 with Sync Gateway 3.2.0 and 3.3.0 is unsupported. Use Sync Gateway 4.0 for Couchbase Lite 4.0 compatibility. See What’s New for details. |
Sync Gateway and Couchbase Server
|
Users of Couchbase Server 6.0 should ensure they have addressed the known issue (MB-41255) by upgrading to one of the recommended Couchbase Server versions (6.0.5, 6.5.2, or 6.6.1). The known issue can cause re-balance failures and/or failed replica writes of deleted or expired documents that use Xattrs. This impacts Sync Gateway deployments running with shared bucket access enabled, which use Xattrs for metadata storage. |
Sync Gateway ↓ |
Couchbase Server → |
||||||
Version |
Scenario |
8.0.0 |
7.6.5 |
7.6.4 |
7.6 |
7.2 |
7.1 |
4.0.0 |
|
|
|
|
|
|
|
4.0.0 |
Bidirectional Active-Active XDCR |
|
|
|
|
|
|
3.3.0 |
|
|
|
|
|
|
|
3.2.0 |
|
|
|
|
|
|
|
3.1.0 |
|
|
|
|
|
|
|
3.0.3 |
|
|
|
|
|
|
|
2.5-2.8 |
|
|
|
|
|
|
|
2.5-2.8 |
|
|
|
|
|
|
|
2.5-2.8 |
|
|
|
|
|
|
|
2.1 |
|
|
|
|
|
|
|
2.1 |
|
|
|
|
|
|
|
2.1 |
|
|
|
|
|
|
|
2.0 |
|
|
|
|
|
|
|
2.0 |
|
|
|
|
|
|
|
|
Starting from CBS 7.0, the
Sync Gateway 4.0 requires CBS 7.6.1+. Active-Active XDCR requires CBS 7.6.5+. Sync Gateway 3.x does not support Active-Active XDCR. |
|
Couchbase Server Bucket Types
Use only Couchbase bucket types in Couchbase Mobile.
We do not support the use of Couchbase Server’s Ephemeral or Memcached bucket types — for more on bucket types see: Couchbase Server bucket types.
|
Compatibility with Couchbase Server 5.0-7.0
For Couchbase Server versions 5.0, 5.1, 5.5-6.0, and 6.5-7.0:
-
Sync Gateway 4.0.0 is not compatible with these versions
-
Sync Gateway 3.x and 2.x versions are fully compatible with these versions
Sync Gateway and Couchbase Lite
The table below summarizes the compatible versions of Couchbase Lite with Sync Gateway.
Sync Gateway Versions ↓ |
Couchbase Lite → |
||||||||
1.4 [1] |
2.0 |
2.1 |
2.5 - 2.8 |
3.0.0 |
3.1.0 |
3.2.0 |
3.3.0 |
4.0.0 |
|
|
|
|
|
|
|
|
|
|
|
2.0 and 2.1 |
|
|
|
|
|
|
|
|
|
2.5 to 2.8 |
|
|
|
|
|
|
|
|
|
2.5 to 2.8 |
|
|
|
|
|
|
|
|
|
3.0.0 |
|
|
|
|
|
|
|
|
|
3.1.0 |
|
|
|
|
|
|
|
|
|
3.2.0 |
|
|
|
|
|
|
|
|
|
3.3.0 |
|
|
|
|
|
|
|
|
|
4.0.0 |
|
|
|
|
|
|
|
|
|
|
Couchbase Lite 4.0 requires Sync Gateway 4.0. Couchbase Lite 4.0 is only compatible with Sync Gateway 4.0. Connecting Couchbase Lite 4.0 to Sync Gateway versions before 4.0 is not supported due to version vector architecture changes. However, Sync Gateway 4.0 is compatible with all supported Couchbase Lite versions (2.0+), allowing customers to upgrade Sync Gateway first. |