A newer version of this documentation is available.

View Latest

Provisioning Cluster Resources

      Provisioning cluster resources is managed at the collection or bucket level, depending upon the service affected. Common use cases are outlined here, less common use cases are covered in the API docs.

      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 Java SDK also comes with some convenience functionality for common Couchbase management requests.

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

      • BucketManager — Cluster.Buckets()

      • UserManager — Cluster.Users()

      • QueryIndexManager — Cluster.QueryIndexes()

      • AnalyticsIndexManager — Cluster.AnalyticsIndexes()

      • SearchIndexManager — Cluster.SearchIndexes()

      • CollectionManager — Bucket.Collections()

      • ViewIndexManager — Bucket.ViewIndexes().

      When using a Couchbase version earlier than 6.5, you must create a valid Bucket connection using cluster.Bucket(name) before you can use cluster level managers.

      Creating and Removing Buckets

      The ClusterManager interface may be used to create and delete buckets from the Couchbase cluster. It is instantiated through the Cluster.Buckets() method. Refer to the API Bucket documentation — and to its Async counterpart — for further details.

      The CreateBucketSettings and BucketSettings structs are used for creating and updating buckets, BucketSettings is also used for exposing information about existing buckets.

      Note that any property that is not explicitly set when building the BucketSettings will use the default value. In the case of the update, this is not necessarily the currently configured value, so you should be careful to set all properties to their correct expected values when updating an existing bucket configuration.

      Flushing Buckets

      When a bucket is flushed, all content is removed. Because this operation is potentially dangerous it is disabled by default for each bucket. Bucket flushing may be useful in test environments where it becomes a simpler alternative to removing and creating a test bucket. You may enable bucket flushing on a per-bucket basis using the Couchbase Web Console or when creating a bucket.

      You can flush a bucket in the SDK by using the FlushBucketOptions — see the API docs.

      Collection Management

      The CollectionManager interface may be used to create and delete scopes and collections from the Couchbase cluster. It is instantiated through the Bucket.collections() method. Refer to the CollectionManager API documentation — and to its Async counterpart — for further details.

      Cluster cluster = Cluster.connect("localhost", "scopeAdmin", "password");
      Bucket bucket = cluster.bucket("travel-sample");
      CollectionManager collectionMgr = bucket.collections();

      You can create a scope:

      try {
      catch (ScopeExistsException e) {
        System.out.println("Scope already exists");

      You can then create a collection within that scope:

      CollectionSpec spec = CollectionSpec.create("example-collection", "example-scope");
      try {
      catch (CollectionExistsException e) {
        System.out.println("Collection already exists");
      catch (ScopeNotFoundException e) {
        System.out.println("The specified parent scope doesn't exist");

      Finally, you can drop unneeded collections and scopes:

      try {
      catch (CollectionNotFoundException e) {
        System.out.println("The specified collection doesn't exist");
      catch (ScopeNotFoundException e) {
        System.out.println("The specified parent scope doesn't exist");
      try {
      catch (ScopeNotFoundException e) {
        System.out.println("The specified scope doesn't exist");

      Note that the most minimal permissions to create and drop a Scope or Collections is Manage Scopes along with Data Reader

      You can create users with the appropriate RBAC programmatically:

        new User("scopeAdmin")
        .displayName("Manage Scopes [travel-sample:*]")
          new Role("scope_admin", "travel-sample", "*", "*"),
          new Role("data_reader", "travel-sample", "*", "*")));

      Index Management

      In general,you will rarely need to work with Index Managers from the SDK. For those occasions when you do, please see the relevant API docs:

      View Management

      Views are stored in design documents. The SDK provides convenient methods to create, retrieve, and remove design documents. To set up views, you create design documents that contain one or more view definitions, and then insert the design documents into a bucket. Each view in a design document is represented by a name and a set of MapReduce functions. The mandatory map function describes how to select and transform the data from the bucket, and the optional reduce function describes how to aggregate the results.

      In the SDK, design documents are represented by the DesignDocument and View structs. All operations on design documents are performed on the ViewIndexManager instance: