Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

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.6 SDK 3.0, 3.1 3.2

    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:

    GNU/Linux

    • 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 (July 2021): 10.14 (Mojave), 10.15 (Catalina), and 11 (Big Sur).

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

    Integrations

    Ottoman ODM

    The 3.2 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

    Analytics

    DP in 5.5 with 2.4.2

    Since 2.6

    Default Collections

    Not Supported

    Developer Preview in 6.5-6.6, SDK 3.0

    Since 3.0.7

    Scope-Level N1QL Queries & all Collections features

    Not Supported

    Since SDK 3.2.0

    Field Level Encryption v2

    Not Supported

    Since SDK 3.2.0[1]

    Request Tracing

    Not Supported

    Since SDK 3.2.0

    Unresolved include directive in modules/project-docs/pages/compatibility.adoc - include::7.0@sdk:shared:partial$network-requirements.adoc[]

    Unresolved include directive in modules/project-docs/pages/compatibility.adoc - include::7.0@sdk:shared:partial$interface-stability-pars.adoc[]

    1. Field Level Encryption distributed as separate library.