Package com.couchbase.client.java.manager.bucket

Class BucketManager

java.lang.Object
com.couchbase.client.java.manager.bucket.BucketManager
public class BucketManager extends Object
Performs management operations on Buckets.

All mutating operations on this manager are eventually consistent, which means that as soon as the call returns the operation is accepted by the server, but it does not mean that the operation has been applied to all nodes in the cluster yet. In the future, APIs will be provided which allow to assert the propagation state.

  • Constructor Details

  • Method Details

    • async

      public AsyncBucketManager async()
      Provides access to the AsyncBucketManager for convenience.

    • reactive

      public ReactiveBucketManager reactive()
      Provides access to the ReactiveBucketManager for convenience.

    • createBucket

      public void createBucket(BucketSettings settings)
      Creates a new bucket on the server.

      The SDK will not perform any logical validation on correct combination of the settings - the server will return an error on invalid combinations. As an example, a magma bucket needs at least 1024 MiB of bucket quota - otherwise the server will reject it.

      Parameters:
      settings - the BucketSettings describing the properties of the bucket.
      Throws:
      BucketExistsException - if the bucket already exists.
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • createBucket

      public void createBucket(BucketSettings settings, CreateBucketOptions options)
      Creates a new bucket on the server with custom options.

      The SDK will not perform any logical validation on correct combination of the settings - the server will return an error on invalid combinations. As an example, a magma bucket needs at least 1024 MiB of bucket quota - otherwise the server will reject it.

      Parameters:
      settings - the BucketSettings describing the properties of the bucket.
      options - the custom options to apply.
      Throws:
      BucketExistsException - if the bucket already exists.
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • updateBucket

      public void updateBucket(BucketSettings settings)
      Updates the settings of a bucket which already exists.

      Not all properties of a bucket can be changed on an update. Notably, the following properties are ignored by the SDK on update and so will not produce an error but also not change anything on the server side:

      The SDK will not perform any logical validation on correct combination of the settings - the server will return an error on invalid combinations. As an example, a magma bucket needs at least 1024 MiB of bucket quota - otherwise the server will reject it.

      Parameters:
      settings - the BucketSettings describing the properties of the bucket.
      Throws:
      BucketNotFoundException - if the specified bucket does not exist.
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • updateBucket

      public void updateBucket(BucketSettings settings, UpdateBucketOptions options)
      Updates the settings of a bucket which already exists with custom options.

      Not all properties of a bucket can be changed on an update. Notably, the following properties are ignored by the SDK on update and so will not produce an error but also not change anything on the server side:

      The SDK will not perform any logical validation on correct combination of the settings - the server will return an error on invalid combinations. As an example, a magma bucket needs at least 1024 MiB of bucket quota - otherwise the server will reject it.

      Parameters:
      settings - the BucketSettings describing the properties of the bucket.
      options - the custom options to apply.
      Throws:
      BucketNotFoundException - if the specified bucket does not exist.
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • dropBucket

      public void dropBucket(String bucketName)
      Drops ("deletes") a bucket from the cluster.
      Parameters:
      bucketName - the name of the bucket to drop.
      Throws:
      BucketNotFoundException - if the specified bucket does not exist.
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • dropBucket

      public void dropBucket(String bucketName, DropBucketOptions options)
      Drops ("deletes") a bucket from the cluster with custom options.
      Parameters:
      bucketName - the name of the bucket to drop.
      options - the custom options to apply.
      Throws:
      BucketNotFoundException - if the specified bucket does not exist.
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • getBucket

      public BucketSettings getBucket(String bucketName)
      Loads the properties of a bucket from the cluster.
      Parameters:
      bucketName - the name of the bucket for which the settings should be loaded.
      Returns:
      the bucket settings when the operation completed successfully.
      Throws:
      BucketNotFoundException - if the specified bucket does not exist.
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • getBucket

      public BucketSettings getBucket(String bucketName, GetBucketOptions options)
      Loads the properties of a bucket from the cluster with custom options.
      Parameters:
      bucketName - the name of the bucket for which the settings should be loaded.
      options - the custom options to apply.
      Returns:
      the bucket settings when the operation completed successfully.
      Throws:
      BucketNotFoundException - if the specified bucket does not exist.
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • getAllBuckets

      public Map<String,BucketSettings> getAllBuckets()
      Loads the properties of all buckets the current user has access to from the cluster.
      Returns:
      the bucket settings when the operation completed successfully.
      Throws:
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • getAllBuckets

      public Map<String,BucketSettings> getAllBuckets(GetAllBucketOptions options)
      Loads the properties of all buckets the current user has access to from the cluster.
      Parameters:
      options - the custom options to apply.
      Returns:
      the bucket settings when the operation completed successfully.
      Throws:
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • flushBucket

      public void flushBucket(String bucketName)
      Deletes all documents from ("flushes") a bucket.

      Flush needs to be enabled on the bucket in order to perform the operation. Enabling flush is not recommended in a production cluster and can lead to data loss!

      Keep in mind that flush is not an atomic operation, the server will need some time to clean the partitions out completely. If isolation is preferred in an integration-test scenario, creating individual buckets might provide a better user experience.

      Parameters:
      bucketName - the name of the bucket to flush.
      Throws:
      BucketNotFoundException - if the specified bucket does not exist.
      BucketNotFlushableException - if flush is not enabled on the bucket.
      CouchbaseException - if any other generic unhandled/unexpected errors.

    • flushBucket

      public void flushBucket(String bucketName, FlushBucketOptions options)
      Deletes all documents from ("flushes") a bucket with custom options.

      Flush needs to be enabled on the bucket in order to perform the operation. Enabling flush is not recommended in a production cluster and can lead to data loss!

      Keep in mind that flush is not an atomic operation, the server will need some time to clean the partitions out completely. If isolation is preferred in an integration-test scenario, creating individual buckets might provide a better user experience.

      Parameters:
      bucketName - the name of the bucket to flush.
      options - the custom options to apply.
      Throws:
      BucketNotFoundException - if the specified bucket does not exist.
      BucketNotFlushableException - if flush is not enabled on the bucket.
      CouchbaseException - if any other generic unhandled/unexpected errors.