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.

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, more recherché use cases are covered in the API docs.

    Unresolved include directive in modules/howtos/pages/provisioning-cluster-resources.adoc - include::6.5@sdk:shared:partial$flush-info-pars.adoc[]

    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.

    Unresolved include directive in modules/howtos/pages/provisioning-cluster-resources.adoc - include::6.5@sdk:shared:partial$flush-info-pars.adoc[]

    Flushing Buckets

    Unresolved include directive in modules/howtos/pages/provisioning-cluster-resources.adoc - include::6.5@sdk:shared:partial$flush-info-pars.adoc[]

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

    Collection Management

    This is a Developer Preview feature, see the API doc.

    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

    Unresolved include directive in modules/howtos/pages/provisioning-cluster-resources.adoc - include::6.5@sdk:shared:partial$flush-info-pars.adoc[]

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