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.

Full Installation

      +
      Installation instructions for the Node.js Columnar SDK.

      Before You Start

      Sign up for a Capella account, and choose a Columnar cluster.

      Prerequisites

      The Columnar Node.js SDK supports LTS versions of Node.js — these are 20 and 22 at the time of the 1.0.0 release (October 2024). See the compatibility page for more information about platform support.

      We recommend using the most recent long-term support (LTS) version of Node.js — at the time of writing (October 2024) this is version 22.

      Don’t Mix Columnar & Operational SDKs.

      Do not combine the Node.js Columnar SDK with the Node.js Operational SDK on the same app server (or development machine). This combination is not tested and not supported. There may be problems with different versions of shared dependencies if you try this. This only applies to the Node.js and Python Columnar SDKs.

      Note, this does not apply to combining our Enterprise Analytics SDKs with our Operational SDKs. See the Analytics SDK page for a reminder of which Analytics SDK to use with which Analytics service.

      Getting the SDK

      The SDK can be installed via npm:

      npm install couchbase-columnar

      Other Installation Methods

      A select set of packages with prebuilt binaries are available on the GitHub Releases page. If a packages is not available for your specific platform, See the GitHub Building page for details on how to build the SDK’s binary.

      Installing from a Downloaded Package

      To install the SDK from a package on the GitHub Releases page:

      1. Download the appropriate package

      2. Unzip the downloaded file

      3. Install via npm: npm install <path to unzipped file>

      Building from Source

      If a compatible package is not available, the SDK’s binary will need to be built from source:

      • Follow the steps on the GitHub Building page.

      • After the build succeeds, the SDK can be used by running Node scripts from within the cloned repository — or the SDK can be installed via npm: npm install <path to cloned repository>.