Provisioning Cluster Resources

  • how-to
    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 PHP 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:

    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.

    Since SDK 4.0 uses the Couchbase++ library rather than libcouchbase, some management APIs have not been fully implemented, in particular:

    • AnalyticsIndexManager

    • SearchIndexManager

    • ViewIndexManager

    • CollectionManager

    Any attempt to use them will raise an UnsupportedOperationException error. The APIs will be available in a future 4.x release.

    Bucket Management

    The BucketManager interface may be used to create and delete buckets from the Couchbase cluster. It is instantiated through the Cluster::buckets() method.

    $connectionString = "couchbase://localhost";
    $options = new ClusterOptions();
    $options->credentials("Administrator", "password");
    $cluster = new Cluster($connectionString, $options);
    $bucketMgr = $cluster->buckets();

    The BucketSettings class is used for creating and updating buckets, and for exposing information about existing buckets.

    Note that any property that is not explicitly set when building the bucket settings 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.

    Here is the list of parameters available:



    Can be updated

    name() string

    The name of the bucket, required for creation.


    flushEnabled() boolean

    Enables flushing to be performed on this bucket (see the Flushing Buckets section below).


    enableReplicaIndexes() boolean

    Whether or not to replicate indexes.


    ramQuotaMb() int

    How much memory should each node use for the bucket, required for creation.


    numReplicas() int

    The number of replicas to use for the bucket.


    bucketType() string

    The type of the bucket, required for creation.


    evictionPolicy string

    The type of the eviction to use for the bucket, defaults to VALUE_ONLY.

    true (note: changing will cause the bucket to restart causing temporary inaccessibility)

    maxTtl() int

    The default maximum time-to-live to apply to documents in the bucket. (note: This option is only available for Couchbase and Ephemeral buckets in Couchbase Enterprise Edition.)


    compressionMode() string

    The compression mode to apply to documents in the bucket. (note: This option is only available for Couchbase and Ephemeral buckets in Couchbase Enterprise Edition.)


    ConflictResolutionType ConflictResolutionType

    The conflict resolution type to apply to conflicts on the bucket, defaults to SEQUENCE_NUMBER


    The following example creates a "hello" bucket:

    $settings = new BucketSettings("hello");

    We can now get this bucket and update it to enable Flush:

    $settings = $bucketMgr->getBucket("hello");

    Once you no longer need to use the bucket, you can remove it:


    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 flush() method:


    The flush() operation may fail if the bucket does not have flush enabled, in that case it will return an BucketNotFlushableException.

    Index Management

    In general, you will rarely need to work with Index Managers from the SDK. For those occasions when you do, index management operations can be performed with the following interfaces:

    You will find some of these described in the following section.


    The QueryIndexManager interface contains the means for managing indexes used for queries. It can be instantiated through the Cluster::queryIndexes() method.

    $options = new ClusterOptions();
    $options->credentials("Administrator", "password");
    $cluster = new Cluster("couchbase://localhost", $options);
    $queryIndexMgr = $cluster->queryIndexes();

    Applications can use this manager to perform operations such as creating, deleting, and fetching primary or secondary indexes:

    • A Primary index is built from a document’s key and is mostly suited for simple queries.

    • A Secondary index is the most commonly used type, and is suited for complex queries that require filtering on document fields.

    To perform query index operations, the provided user must either be an Admin or assigned the Query Manage Index role. See the Roles page for more information.

    The example below shows how to create a simple primary index, restricted to a named scope and collection, by calling the createPrimaryIndex() method. Note that you cannot provide a named scope or collection separately, both must be set for the QueryIndexManager to create an index on the relevant keyspace path.

    Creating a primary index
    $options = new CreateQueryPrimaryIndexOptions();
    // Set this if you wish to use a custom name
    // $options->indexName("custom_name");
    $queryIndexMgr->createPrimaryIndex("travel-sample", $options);

    When a primary index name is not specified, the SDK will create the index as #primary by default. However, if you wish to provide a custom name, you can simply set an indexName property in the CreatePrimaryQueryIndexOptions class.

    You may have noticed that the example also sets the ignoreIfExists boolean flag. When set to true, this optional argument ensures that an error is not thrown if an index under the same name already exists.

    Creating a secondary index follows a similar approach, with some minor differences:

    Creating a secondary index
    $options = new CreateQueryIndexOptions();
    $queryIndexMgr->createIndex("travel-sample", "tenant_agent_01_users_email", ["preferred_email"], $options);

    The createIndex() method requires an index name to be provided, along with the fields to create the index on. Like the primary index, you can restrict a secondary index to a named scope and collection by passing some options.

    Indexes can easily take a long time to build if they contain a lot of documents. In these situations, it is more ideal to build indexes in the background. To achieve this we can use the deferred boolean option, and set it to true.

    Deferring index creation
    // Create a deferred index
    $createOpts = new CreateQueryIndexOptions();
    $queryIndexMgr->createIndex("travel-sample", "tenant_agent_01_users_phone", ["preferred_phone"], $createOpts);
    // Build any deferred indexes within `travel-sample`.tenant_agent_01.users
    $deferredOpts = new BuildQueryIndexesOptions();
    $queryIndexMgr->buildDeferredIndexes("travel-sample", $deferredOpts);
    // Wait for indexes to come online
    $watchOpts = new WatchQueryIndexesOptions();
    $queryIndexMgr->watchIndexes("travel-sample", ["tenant_agent_01_users_phone"], 30000, $watchOpts);

    To delete a query index you can use the dropIndex() or dropPrimaryIndex() methods. Which one you use depends on the type of query index you wish to drop from the database.

    Deleting an index
    // Drop a primary index
    $options = new DropQueryPrimaryIndexOptions();
    $queryIndexMgr->dropPrimaryIndex("travel-sample", $options);
    // Drop a secondary index
    $options = new DropQueryIndexOptions();
    $queryIndexMgr->dropIndex("travel-sample", "tenant_agent_01_users_email", $options);