A newer version of this documentation is available.

View Latest

Compatibility of Couchbase Features, Couchbase Server Versions, and the Couchbase Node.js SDK

    Features available in different SDK versions, and compatibility between Server and SDK. Plus notes on Cloud, networks, and AWS Lambda.

    The Couchbase Node.js Client will run on any supported LTS version of Node.js — currently, 10.x, 12.x, and 14.x.

    Couchbase Version/SDK Version Matrix

    Couchbase SDKs are tested against a variety of different environments to ensure both backward and forward compatibility with different versions of Couchbase Server. The matrix below denotes the version of Couchbase Server, the version of the Node.js SDK and whether the SDK is:

    • Unsupported: This combination is not tested, and is not within the scope of technical support if you have purchased a support agreement.

    • Compatible: This combination has been tested previously, and should be compatible. This combination is not recommended by our technical support organization. It is best to upgrade either the SDK or the Couchbase version you are using.

    • Supported:This combination is subject to ongoing quality assurance, and is fully supported by our technical support organization.

    Table 1. Recommended SDK per Server Version Matrix
    SDK 2.4 SDK 2.5 SDK 2.6 SDK 3.0, 3.1

    Server 5.0-5.5

    Server 6.0

    Server 6.5-6.6

    Server 7.0

    Note the End of Life dates for Couchbase Server and SDK versions. See the notes there for Support details.

    Platform Compatibility

    The Node.js SDK is built on top of libcouchbase (the C SDK), which is tested and supported on the following platforms:


    • Amazon Linux 2.

    • Red Hat Enterprise Linux 7 & 8;

      & CentOS 7 & 8.

    • Ubuntu (LTS) 16.04 (Xenial), 18.04 (Bionic), & 20.04 (Focal).

    • Debian 9 (Stretch) & 10 (Buster).

    Microsoft Windows

    Microsoft Windows 7 / Windows Server 2012 and onwards.

    Mac OS X

    The current and previous two releases of OS X. At time of writing (September 2020): 10.13 (High Sierra), 10.14 (Mojave), and 10.15 (Catalina).

    Although installable or compilable on many other platforms, we cannot provide support for untested combinations.


    Ottoman ODM

    The 3.1 Node.js SDK is compatible with version 2.0 of the Ottoman ODM.

    Couchbase New Feature Availability Matrix

    Table 2. Couchbase Server and SDK Supported Version Matrix
    Server 5.0, 5.1, & 5.5 Server 6.0 Server 6.5 & 6.6 Server 7.0

    Enhanced Durability

    All SDK versions

    Durable Writes

    Not Supported

    Since 3.0


    DP in 5.5 with 2.4.2

    Since 2.6


    Not Supported

    SDK 3.0 for Developer Preview in Server 6.5 & 6.6

    Since 3.0

    Scope-Level N1QL Queries

    Not Supported

    Since SDK 3.0.7

    Network Requirements

    Couchbase SDKs are developed to be run in an environment with local area network (LAN) like throughput and latencies. While there is no technical issue that prevents the use across a wide area network (WAN), SDKs have certain thresholds around timeouts and behaviors to recover that will not be the same once the higher latency and possible bandwidth constraints and congestion of a WAN is introduced. Couchbase tests for correctness under LAN like conditions. For this reason, only LAN-like network environments are officially supported.

    Couchbase does document, for purposes of convenience when developing and performing basic operational work, what may need to be tuned when network throughputs and latencies are higher. If you encounter issues, even with these tune-ables, you should attempt the same workload from a supported, LAN-like environment.

    Running on AWS Lambda

    AWS Lambda’s execution environment can freeze/thaw processes. Current Couchbase SDKs run background processing to check and adapt to topology changes in the Couchbase Cluster being used. Since the freeze does not allow this background processing and upon thaw the event-driven Couchbase SDKs may issue requests to an old topology, unexpected behavior including failures may occur. AWS λ does not provide a way to detect the freeze/thaw cycle. For this reason AWS λ is not currently a tested and supported platform for running current Couchbase SDKs.

    Interface Stability

    Couchbase SDKs indicate the stability of an API through documentation. Since there are different meanings when developers mention stability, we mean interface stability: how likely the interface is to change or be removed entirely. A stable interface is one that is guaranteed not to change between versions, meaning that you may use an API of a given SDK version and be assured that the given API will retain the same parameters and behavior in subsequent versions. An unstable interface is one which may appear to work or behave in a specific way within a given SDK version, but may change in its behavior or arguments in future SDK versions, causing odd application behavior or compiler/API usage errors. Implementation stability is implied to be more reliable at higher levels, but all are tested to the level that is appropriate for their stability.

    Couchbase uses three interface stability classifiers. You may find these classifiers appended as annotations or comments within documentation for each API:

    • Committed: This stability level is used to indicate the most stable interfaces that are guaranteed to be supported and remain stable between SDK versions. This is the default — unless otherwise stated in the documentation, each API has Committed status.

    • Uncommitted: This level is used to indicate APIs that are unlikely to change, but may still change as final consensus on their behavior has not yet been reached. Uncommitted APIs usually end up becoming stable APIs.

    • Volatile: This level is used to indicate experimental APIs that are still in flux and may likely be changed. It may also be used to indicate inherently private APIs that may be exposed, but "YMMV" (your mileage may vary) principles apply. Volatile APIs typically end up being promoted to Uncommitted after undergoing some modifications.

    APIs that are marked as Committed have a stable implementation. Uncommitted and Volatile APIs should be stable within the bounds of any known and often documented issues, but Couchbase has not made a commitment to these APIs and may not respond to reported defects with the same priority.

    Additionally, take note of the following interface labels:

    • Deprecated: Any API marked deprecated may be removed in the next major version released. Couchbase recommends migrating from the deprecated API to the replacement as soon as possible. In rare instances, deprecated API may be rendered non-functional in a dot-minor release when the API cannot continue to be supported.

    • Internal: This level is used to indicate you should not rely on this API as it is not intended for use outside the module, even to other Couchbase components.