Package com.couchbase.client.java

Class CouchbaseCluster

  • All Implemented Interfaces:
    Cluster
    public class CouchbaseCluster
extends Object
implements Cluster
    Main synchronous entry point to a Couchbase Cluster. The CouchbaseCluster object is the main entry point when connecting to a remote Couchbase Server cluster. It will either create a bundled stateful environment or accept one passed in, in case the application needs to connect to more clusters at the same time. It provides cluster level management facilities through the ClusterManager class, but mainly provides facilities to open Buckets where the actual CRUD and query operations are performed against. The simplest way to initialize a CouchbaseCluster is by using the create() factory method. This is only recommended during development, since it will connect to a Cluster residing on `127.0.0.1`. ```java Cluster cluster = CouchbaseCluster.create(); ``` In production, it is recommended that at least two or three hosts are passed in, so in case one fails the SDK is able to bootstrap through alternative options. ```java Cluster cluster = CouchbaseCluster.create( "192.168.56.101", "192.168.56.102", "192.168.56.103" ); ``` Please make sure that these hosts are part of the same cluster, otherwise non-deterministic connecting behaviour will arise (the SDK may connect to the wrong cluster). If you need to customize CouchbaseEnvironment options or connect to multiple clusters, it is recommended to explicitly create one and then reuse it. Keep in mind that the cluster will not shut down the environment if it didn't create it, so this is up to the caller. ```java CouchbaseEnvironment environment = DefaultCouchbaseEnvironment.builder() .kvTimeout(3000) // change the default kv timeout .build(); Cluster cluster = CouchbaseCluster.create(environment, "192.168.56.101", "192.168.56.102"); Bucket bucket = cluster.openBucket("travel-sample"); // Perform your work here... cluster.disconnect(); environment.shutdownAsync().toBlocking().single(); ```
    Since:
    2.0.0
    Author:
    Michael Nitschinger, Simon Baslé

    • Method Detail

      • create

        public static CouchbaseCluster create​(CouchbaseEnvironment environment,
                                      String... nodes)
        Creates a new CouchbaseCluster reference against the nodes passed in.
        Parameters:
        environment - the custom environment to use for this cluster reference.
        nodes - the list of nodes to use when connecting to the cluster reference.
        Returns:
        a new CouchbaseCluster reference.

      • fromConnectionString

        public static CouchbaseCluster fromConnectionString​(String connectionString)
        Creates a new CouchbaseCluster reference using the connection string. The CouchbaseEnvironment will be automatically created and its lifecycle managed.
        Parameters:
        connectionString - the connection string to identify the remote cluster.
        Returns:
        a new CouchbaseCluster reference.

      • fromConnectionString

        public static CouchbaseCluster fromConnectionString​(CouchbaseEnvironment environment,
                                                    String connectionString)
        Creates a new CouchbaseCluster reference using the connection string.
        Parameters:
        environment - the custom environment to use for this cluster reference.
        connectionString - the connection string to identify the remote cluster.
        Returns:
        a new CouchbaseCluster reference.

      • async

        public AsyncCluster async()
        Description copied from interface: Cluster
        Returns a reference to the underlying async cluster.
        Specified by:
        async in interface Cluster
        Returns:
        the async cluster reference.

      • openBucket

        public Bucket openBucket()
        Description copied from interface: Cluster
        Opens the default bucket with an empty password with the default connect timeout. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
        Specified by:
        openBucket in interface Cluster
        Returns:
        the opened bucket if successful.

      • openBucket

        public Bucket openBucket​(long timeout,
                         TimeUnit timeUnit)
        Description copied from interface: Cluster
        Opens the default bucket with an empty password with a custom timeout. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
        Specified by:
        openBucket in interface Cluster
        Parameters:
        timeout - the custom timeout.
        timeUnit - the time unit for the custom timeout.
        Returns:
        the opened bucket if successful.

      • openBucket

        public Bucket openBucket​(String name)
        Description copied from interface: Cluster
        Opens the bucket with the given name, using the default timeout and the password from the Authenticator If no credential context can be found for the bucket when using ClassicAuthenticator , the old behavior of defaulting to an empty password is used. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed. - AuthenticatorException: If more than one credentials was returned by the Authenticator for this bucket.
        Specified by:
        openBucket in interface Cluster
        Returns:
        the opened bucket if successful.

      • openBucket

        public Bucket openBucket​(String name,
                         long timeout,
                         TimeUnit timeUnit)
        Description copied from interface: Cluster
        Opens the bucket with the given name, using a custom timeout and the password from the Authenticator If no credential context can be found for the bucket when using ClassicAuthenticator , the old behavior of defaulting to an empty password is used. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed. - AuthenticatorException: If more than one credentials was returned by the Authenticator for this bucket.
        Specified by:
        openBucket in interface Cluster
        timeout - the custom timeout.
        timeUnit - the time unit for the custom timeout.
        Returns:
        the opened bucket if successful.

      • openBucket

        public Bucket openBucket​(String name,
                         List<Transcoder<? extends Document,​?>> transcoders)
        Description copied from interface: Cluster
        Opens the bucket with the given name, using the default timeout and the password from the Authenticator If no credential context can be found for the bucket when using ClassicAuthenticator , the old behavior of defaulting to an empty password is used. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed. - AuthenticatorException: If more than one credentials was returned by the Authenticator for this bucket.
        Specified by:
        openBucket in interface Cluster
        Returns:
        the opened bucket if successful.

      • openBucket

        public Bucket openBucket​(String name,
                         List<Transcoder<? extends Document,​?>> transcoders,
                         long timeout,
                         TimeUnit timeUnit)
        Description copied from interface: Cluster
        Opens the bucket with the given name, using a custom timeout and the password from the Authenticator If no credential context can be found for the bucket when using ClassicAuthenticator , the old behavior of defaulting to an empty password is used. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed. - AuthenticatorException: If more than one credentials was returned by the Authenticator for this bucket.
        Specified by:
        openBucket in interface Cluster
        timeout - the custom timeout.
        timeUnit - the time unit for the custom timeout.
        Returns:
        the opened bucket if successful.

      • openBucket

        public Bucket openBucket​(String name,
                         String password)
        Description copied from interface: Cluster
        Opens a bucket identified by its name and password with the default connect timeout. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
        Specified by:
        openBucket in interface Cluster
        Returns:
        the opened bucket if successful.

      • openBucket

        public Bucket openBucket​(String name,
                         String password,
                         long timeout,
                         TimeUnit timeUnit)
        Description copied from interface: Cluster
        Opens a bucket identified by its name and password with a custom timeout. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
        Specified by:
        openBucket in interface Cluster
        timeout - the custom timeout.
        timeUnit - the time unit for the custom timeout.
        Returns:
        the opened bucket if successful.

      • openBucket

        public Bucket openBucket​(String name,
                         String password,
                         List<Transcoder<? extends Document,​?>> transcoders)
        Description copied from interface: Cluster
        Opens a bucket identified by its name and password with custom transcoders and with the default connect timeout. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
        Specified by:
        openBucket in interface Cluster
        Returns:
        the opened bucket if successful.

      • openBucket

        public Bucket openBucket​(String name,
                         String password,
                         List<Transcoder<? extends Document,​?>> transcoders,
                         long timeout,
                         TimeUnit timeUnit)
        Description copied from interface: Cluster
        Opens a bucket identified by its name and password with custom transcoders and with a custom timeout. This method throws: - java.util.concurrent.TimeoutException: If the timeout is exceeded. - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed). - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
        Specified by:
        openBucket in interface Cluster
        timeout - the custom timeout.
        timeUnit - the time unit for the custom timeout.
        Returns:
        the opened bucket if successful.

      • clusterManager

        public ClusterManager clusterManager​(String username,
                                     String password)
        Description copied from interface: Cluster
        Provides access to the ClusterManager to perform cluster-wide operations. Note that the credentials provided here are different from bucket-level credentials. As a rule of thumb, the "Administrator" credentials need to be passed in here or any credentials with enough permissions to perform the underlying operations. **Bucket level credentials will not work.**
        Specified by:
        clusterManager in interface Cluster
        Parameters:
        username - the username to perform cluster-wide operations.
        password - the password associated with the username.
        Returns:
        the ClusterManager if successful.

      • disconnect

        public Boolean disconnect()
        Description copied from interface: Cluster
        Disconnects form all open buckets and shuts down the CouchbaseEnvironment if it is the exclusive owner with the default disconnect timeout.
        Specified by:
        disconnect in interface Cluster
        Returns:
        true once done and everything succeeded, false otherwise.

      • disconnect

        public Boolean disconnect​(long timeout,
                          TimeUnit timeUnit)
        Description copied from interface: Cluster
        Disconnects form all open buckets and shuts down the CouchbaseEnvironment if it is the exclusive owner with a custom timeout.
        Specified by:
        disconnect in interface Cluster
        Returns:
        true once done and everything succeeded, false otherwise.

      • core

        public ClusterFacade core()
        Description copied from interface: Cluster
        Returns the underlying "core-io" library through its ClusterFacade. Handle with care, with great power comes great responsibility. All additional checks which are normally performed by this library are skipped.
        Specified by:
        core in interface Cluster
        Returns:
        the underlying ClusterFacade from the "core-io" package.

      • authenticate

        public CouchbaseCluster authenticate​(Authenticator auth)
        Description copied from interface: Cluster
        Sets the Authenticator to use when credentials are needed for an operation but no explicit credentials are provided. Note that setting a new Authenticator will not be propagated to any Bucket that has been opened with the previous Authenticator, as the instance is passed to the Bucket for its own use.
        Specified by:
        authenticate in interface Cluster
        Parameters:
        auth - the new Authenticator to use.
        Returns:
        this Cluster instance for chaining.

      • authenticate

        public CouchbaseCluster authenticate​(String username,
                                     String password)
        Description copied from interface: Cluster
        Shortcut method to directly authenticate with a username and a password.
        Specified by:
        authenticate in interface Cluster
        Parameters:
        username - the username to authenticate
        password - the password for the username
        Returns:
        this Cluster instance for chaining.

      • authenticator

        @Uncommitted
@Private
public Authenticator authenticator()
        Get the Authenticator currently used when credentials are needed for an operation, but no explicit credentials are provided.
        Returns:
        the Authenticator currently used for this cluster.

      • query

        public N1qlQueryResult query​(N1qlQuery query,
                             long timeout,
                             TimeUnit timeUnit)
        Description copied from interface: Cluster
        Synchronously perform a N1QL query that can span multiple buckets, with a custom timeout. The query will use credentials set through this cluster's Authenticator. In order to use that method, at least one Bucket must currently be opened. Note that if you are only performing queries spanning a single bucket, you should prefer opening that Bucket and use the query API at the bucket level. This method throws under the following conditions: - UnsupportedOperationException: no bucket is currently opened. - IllegalStateException: no Authenticator is set or no credentials are available in it for cluster level querying. - TimeoutException wrapped in a RuntimeException: the operation takes longer than the specified timeout. - BackpressureException: the producer outpaces the SDK. - RequestCancelledException: the operation had to be cancelled while on the wire or the retry strategy cancelled it instead of retrying.
        Specified by:
        query in interface Cluster
        Parameters:
        query - the N1qlQuery to execute.
        timeout - the custom timeout.
        timeUnit - the unit for the timeout.
        Returns:
        the query result.

      • diagnostics

        public DiagnosticsReport diagnostics()
        Description copied from interface: Cluster
        Provides a simple health check which allows insight into the current state of services and endpoints.
        Specified by:
        diagnostics in interface Cluster
        Returns:
        health services in the form of DiagnosticsReport.

      • diagnostics

        public DiagnosticsReport diagnostics​(String reportId)
        Description copied from interface: Cluster
        Provides a simple health check which allows insight into the current state of services and endpoints.
        Specified by:
        diagnostics in interface Cluster
        Returns:
        health services in the form of DiagnosticsReport.