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.

    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 Scala 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:

    val bucketManager: BucketManager = cluster.buckets
    val userManager: UserManager = cluster.users
    val queryIndexManager: QueryIndexManager = cluster.queryIndexes
    val analyticsIndexManager: AnalyticsIndexManager = cluster.analyticsIndexes
    val searchIndexManager: SearchIndexManager = cluster.searchIndexes
    val collectionManager: CollectionManager = bucket.collections
    val viewIndexManager: 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 BucketManager interface may be used to create and delete buckets from the Couchbase cluster.

    The CreateBucketSettings and BucketSettings classes 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.

    Here is the list of parameters available for CreateBucketSettings and BucketSettings. The "Updatable" column indicates whether the parameter may only be specified when creating a bucket, or whether it may be updated after creation.

    Name Type Description Updatable

    name

    String

    The name of the bucket, required for creation.

    false

    flushEnabled

    boolean

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

    true

    replicaIndexes

    boolean

    Whether or not to replicate indexes.

    false

    ramQuotaMB

    int

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

    true

    numReplicas

    int

    The number of replicas to use for the bucket.

    true

    bucketType

    BucketType

    The type of the bucket, required for creation.

    false

    ejectionMethod

    EjectionMethod

    The type of the ejection to use for the bucket, defaults to ValueOnly.

    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.)

    true

    compressionMode

    CompressionMode

    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.)

    true

    conflictResolutionType

    ConflictResolutionType

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

    false

    The following example creates a "hello" bucket:

    val bucketManager: BucketManager = cluster.buckets
    
    val result: Try[Unit] = bucketManager.create(
      CreateBucketSettings("hello", ramQuotaMB = 1024)
        .flushEnabled(false)
        .replicaIndexes(false)
        .numReplicas(1)
        .bucketType(BucketType.Couchbase)
        .conflictResolutionType(ConflictResolutionType.SequenceNumber))
    
    result match {
      case Success(_) =>
      case Failure(err) => print(s"Failed with error $err")
    }

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

    val result: Try[Unit] = bucketManager.getBucket("hello")
      .flatMap((bucket: BucketSettings) => {
        val updated = bucket.toCreateBucketSettings.flushEnabled(true)
        bucketManager.updateBucket(updated)
      })
    
    // Result error-checking omitted for brevity

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

    val result: Try[Unit] = bucketManager.dropBucket("hello")
    
    // Result error-checking omitted for brevity

    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:

    val result: Try[Unit] = bucketManager.flushBucket("hello")
    
    result match {
      case Success(_) =>
      case Failure(err: BucketNotFlushableException) =>
        print("Flushing not enabled on this bucket")
      case Failure(err) => print(s"Failed with error $err")
    }

    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:

    val queryIndexManager: QueryIndexManager = cluster.queryIndexes
    val analyticsIndexManager: AnalyticsIndexManager = cluster.analyticsIndexes
    val searchIndexManager: SearchIndexManager = cluster.searchIndexes
    val viewIndexManager: ViewIndexManager = bucket.viewIndexes

    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:

    val viewIndexManager: ViewIndexManager = bucket.viewIndexes

    The following example upserts a design document with two views:

    val view1 = View("function (doc, meta) { if (doc.type == 'landmark') { emit([doc.country, doc.city], null); } }")
    val view2 = View("function (doc, meta) { if (doc.type == 'landmark') { emit(doc.activity, null); } }", reduce = Some("_count"))
    
    val designDoc = DesignDocument("landmarks",
      Map("by_country" -> view1, "by_activity " -> view2))
    
    viewIndexManager.upsertDesignDocument(designDoc, DesignDocumentNamespace.Development)

    When you want to update an existing document with a new view (or a modification of a view’s definition), you can use the upsertDesignDocument method.

    However, this method needs the list of views in the document to be exhaustive, meaning that if you just create the new view definition as previously and add it to a new DesignDocument that you upsert, all your other views will be erased!

    The solution is to perform a getDesignDocument, add your view definition to the DesignDocument’s views list, then upsert it. This also works with view modifications, provided the change is in the map or reduce functions (just reuse the same name for the modified View), or for deletion of one out of several views in the document.

    Note the use of DesignDocumentNamespace.Development, the other option is DesignDocumentNamespace.Production. This parameter specifies whether the design document should be created as development, or as production — with the former running over only a small fraction of the documents.

    Now that we’ve created a design document we can fetch it:

    val designDoc: Try[DesignDocument] =
      viewIndexManager.getDesignDocument("landmarks", DesignDocumentNamespace.Development)

    We’ve created the design document using DesignDocumentNamespace.Development and now want to push it to production, we can do this with:

    val publishResult = viewIndexManager.publishDesignDocument("landmarks")
    
    // Result error-handling omitted for brevity

    To remove this design document:

    val dropResult = viewIndexManager.dropDesignDocument("landmarks", DesignDocumentNamespace.Production)
    // Result error-handling omitted for brevity