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

      Compatibility Matrix

      Sync Gateway ↓

      Couchbase Server →

      Version

      Scenario

      8.0.0

      7.6.5

      7.6.4

      7.6

      7.2

      7.1

      6.5-7.0

      5.5-6.0

      5.1

      5.0 [1]

      4.0.0

      yes

      yes

      yes

      yes

      no

      no

      no

      no

      no

      no

      4.0.0

      Bidirectional Active-Active XDCR

      yes

      yes

      no

      no

      no

      no

      no

      no

      no

      no

      3.3.0

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      3.2.0

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      3.1.0

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      3.0.3

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      2.5-2.8

      shared_bucket_access: false
      use_views: true

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      2.5-2.8

      shared_bucket_access: true

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      2.5-2.8

      use_views: false

      yes

      no

      no

      no

      yes

      yes

      yes

      yes

      yes

      yes

      2.1

      shared_bucket_access: false
      use_views: true

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      2.1

      shared_bucket_access: true

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      2.1

      use_views: false

      yes

      no

      no

      no

      yes

      yes

      yes

      yes

      yes

      yes

      2.0

      shared_bucket_access: false

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      2.0

      shared_bucket_access: true

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      Starting from CBS 7.0, the use_views feature is deprecated.

      • SGW 3.1 will only run with use_views with a default scope/collection configuration

      • You cannot run use_views with a defined scope/collection

      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.

      Sync Gateway and Couchbase Lite

      The table below summarizes the compatible versions of Couchbase Lite with Sync Gateway.

      Table 1. Sync Gateway and Couchbase Lite Compatibility Matrix

      Sync Gateway Versions ↓

      Couchbase Lite →

      1.4 [2]

      2.0

      2.1

      2.5 - 2.8

      3.0.3

      3.1.0

      3.2.0

      3.3.0

      4.0.0

      1.4 [3] and 1.5 [4]

      yes

      no

      no

      no

      no

      no

      no

      no

      no

      2.0 and 2.1

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      no

      2.5 to 2.8
      with delta sync disabled

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      no

      2.5 to 2.8
      with delta sync enabled

      no

      no

      no

      yes

      yes

      yes

      yes

      yes

      no

      3.0.3

      no

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      no

      3.1.0

      no

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      no

      3.2.0

      no

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      3.3.0

      no

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      yes

      4.0.0

      Couchbase Lite 4.0 with Sync Gateway 3.2.0 and 3.3.0 is unsupported.

      Connecting Couchbase Lite 4.0 to Sync Gateway versions before 4.0 is not supported. This is a known issue with fixes coming in Sync Gateway 3.2.7 and 3.3.1. This does not affect Sync Gateway 3.1 or earlier. Use Sync Gateway 4.0 for Couchbase Lite 4.0 compatibility.



      1. The 3.0 is compatible with these versions but its use is not recommended
      2. This Couchbase Lite version is End of Support
      3. This Sync Gateway version is End of Support
      4. This Sync Gateway version is End of Life