Connect to Your Cluster

    Connect to your cluster using the Couchbase SDK.

    This information is for anyone still using Couchbase Server 6.6, hosted in their own cloud provider’s VPC. It does not apply to Couchbase 7.0, hosted in Couchbase’s VPC and fully managed for you.

    For further information contact Couchbase.

    The easiest way to get started with Capella, our fully managed DBaaS, is hosting in Couchbase’s Cloud.

    There are several ways to connect to your cluster, but this guide specifically covers how to connect using the Couchbase SDK. This page contains instructions that will work with Couchbase’s Cloud Account and with installations in Your Cloud Account on the Public Cloud — regardless of your Capella installation type, client code remains the same.


    The procedures on this page assume the following:

    Download and Install the Couchbase SDK

    You can connect to your cluster programmatically using the Couchbase SDK. The examples on this page use the Couchbase Node.js SDK, however there are several other supported SDK languages to choose from.

    The following instructions draw from the regular Couchbase Node.js SDK installation page.

    To install the Couchbase Node.js SDK
    1. If you haven’t already, make sure to download and install the latest long term support (LTS) release of Node.

      If you’re installing Node for the first time, we recommend using the Node Version Manager (nvm) for getting started with Node.

      1. Follow the instructions for installing nvm.

      2. Install the latest Node LTS release.

        $ nvm install --lts
    2. Create a Node.js project by making a directory and initializing it with npm.

      $ mkdir node-couchbase-project && cd $_
      $ npm init -y
    3. Install the Couchbase Node.js SDK.

      $ npm install couchbase --save

    Connect to Your Cluster Using the Built-in SDK Examples

    After installing the Couchbase SDK, the next step is to use the built-in SDK examples to connect to your cluster.

    1. Go to the cluster’s Connect tab in the Couchbase Capella UI.

      1. Go to the Clusters tab in the main navigation.

      2. Find and click on your cluster.

        This opens the cluster with its Overview tab selected.

      3. Click the Connect tab.

        The cluster’s 'Connect' tab.

      In the Connection section, there are two endpoints listed: One labeled Public and one labeled Private. When connecting to the cluster over a wide area network — such as when you’re connecting to the cluster over the Internet from an application on your laptop (e.g. the scenario described in this guide) — you will use the public endpoint. When connecting to the cluster from within your cloud provider using a peering connection, you will use the private endpoint.

      For the purposes of this guide, however, you will not need to copy the public endpoint. This is because the public endpoint is automatically included in the built-in SDK examples that are used later in this guide.

    2. Click SDK Examples.

      This opens the SDK Examples fly-out menu.

      The 'SDK Examples' fly-out menu, showing the Node.js tab selected.

      Each of the supported Couchbase SDK languages is represented by a tab. Under each tab, a snippet of example code is provided. The example code is pre-populated with the cluster’s public endpoint, and with a few modifications, can quickly be used for connecting to the cluster.

    3. Copy the example code.

      Click on the tab for your desired SDK language, and copy the example code. If you’re following the examples in this guide, click the Node.js tab, and copy the example JavaScript code.

    4. Paste the example code into a text editor and update it with your connection details.

      The SDK example code automatically comes pre-populated with the cluster’s public endpoint and default bucket name. However, you’ll need to update the following connection details:

      • username

      • password

      The username and password are the those of the database credential that you created when you configured database access.

      The bucketName is the name of a bucket on the cluster that you will be connecting to. The example code comes pre-populated with the name of the default bucket: couchbasecloudbucket. This bucket will suffice for the purposes of this guide, but if you choose to create a new bucket for this exercise, you’ll need to specify the new bucket’s name in the example code.

      Note that the bucket needs to be one which the database credential has access to. If you configured the database credential to have read/write permissions on all buckets (as recommended), then you can specify any bucket when testing out the connection.

      The following is an example of a completed Node.js configuration:

      var couchbase = require('couchbase');
      // Update this to your cluster
      const endpoint = ''
      const username = 'admin'
      const password = 'P@ssw0rd'
      const bucketName = 'couchbasecloudbucket'
      // User Input ends here.
      // Initialize the Connection
      var cluster = new couchbase.Cluster('couchbases://' +endpoint+'?ssl=no_verify&console_log_level=5', {username: username, password: password});
      var bucket = cluster.bucket(bucketName);
      var collection = bucket.defaultCollection();
      function start(){
        return new Promise( (resolve, reject) => { resolve(); });
      async function run(){
          // Create a N1QL Primary Index (but ignore if it exists)
        try {
          await cluster.queryIndexes().createPrimaryIndex(bucketName, {ignoreExists: true});
        } catch (e) {
        // Create and store a document
        try {
          await collection.upsert('user:king_arthur', {
              'name': 'Arthur', 'email': '', 'interests': ['Holy Grail', 'African Swallows']
        } catch (e) {
          // Load the Document and print it
          // Prints Content and Metadata of the stored Document
        try {
          let getResult = await collection .get('user:king_arthur');
          console.log('Got: ');
        } catch (e) {
        // Perform a N1QL Query
        const options = { parameters: ['African Swallows'] };
        try {
          let queryResult = await cluster.query('SELECT name FROM '+bucketName +' WHERE $1 in interests LIMIT 1', options);
          queryResult.rows.forEach((row) => {
            console.log('Query row: ', row)
        } catch (e) {
      start().then(run).then(() => { console.log("closing..."); cluster.close();});

      Once you’ve finished updating the example code with your connection details, save it in your project directory, making sure to use the file extension that is appropriate for the SDK language. If you’re following the examples in this guide, save the file as connection-script.js in the node-couchbase-project directory that you created earlier when you installed the Couchbase Node.js SDK.

    5. Connect to the cluster.

      From the project directory, run the connection script using the following command:

      node connection-script.js

      The results you should expect are as follows:

        cas: CbCas { '0': <Buffer 00 00 64 71 50 c3 25 16> },
        value: {
          name: 'Arthur',
          email: '',
          interests: [ 'Holy Grail', 'African Swallows' ]
      Query row:  { name: 'Arthur' }

      If you received the results above, the connection was successful, and a document has been written to the bucket.

    Next Steps

    Now that you’ve established that you can connect to your cluster, you can move on to the next step: Interact with Data in Your Cluster.