Buckets and Clusters

  • concept
    The Couchbase Node.js SDK provides an API for managing a Couchbase cluster programmatically.

    The primary means for managing clusters is through the Couchbase Web UI which provides an easy to use interface for adding, removing, monitoring, and modifying buckets. In some instances you may wish to have a programmatic interface. For example, if you wish to manage a cluster from a setup script, or if you are setting up buckets in test scaffolding.

    The SDK also comes with some convenience functionality for common Couchbase management requests — see the Provisioning Cluster Resources guide.

    Management operations in the Node.js SDK may be performed through several interfaces depending on the object:

    Creating and Removing Buckets

    To create or delete a bucket, call the bucket manager with the buckets() call on the cluster:

    const bucketMgr = cluster.buckets()
        name: 'my_bucket',
        flushEnabled: false,
        ramQuotaMB: 256,
        numReplicas: 1,
        replicaIndexes: false,
        bucketType: couchbase.BucketType.Couchbase,
        ejectionMethod: couchbase.EvictionPolicy.ValueOnly,
        maxTTL: 0,
        compressionMode: couchbase.CompressionMode.Passive,

    The default Collection & Default Scope will be used automatically.

    See Provisioning Cluster Resources for more details.