Class Bucket
- java.lang.Object
-
- com.couchbase.client.java.Bucket
-
public class Bucket extends Object
Provides access to a Couchbase bucket in a blocking fashion.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AsyncBucketasync()Provides access to the underlyingAsyncBucket.Collectioncollection(String collectionName)Provides access to the collection with the given name for thisBucketusing the default scope.CollectionManagercollections()Corecore()Provides access to the underlyingCore.CollectiondefaultCollection()Opens the default collection for thisBucketusing the default scope.ScopedefaultScope()Opens the defaultScope.ClusterEnvironmentenvironment()Returns the attachedClusterEnvironment.Stringname()Returns the name of theBucket.PingResultping()Performs application-level ping requests against services in the couchbase cluster.PingResultping(PingOptions options)Performs application-level ping requests with custom options against services in the couchbase cluster.ReactiveBucketreactive()Provides access to the relatedReactiveBucket.Scopescope(String name)Opens theScopewith the given name.ViewIndexManagerviewIndexes()ViewResultviewQuery(String designDoc, String viewName)Queries a view on the bucket.ViewResultviewQuery(String designDoc, String viewName, ViewOptions options)Queries a view on the bucket with custom options.voidwaitUntilReady(Duration timeout)Waits until the desiredClusterStateis reached.voidwaitUntilReady(Duration timeout, WaitUntilReadyOptions options)Waits until the desiredClusterStateis reached.
-
-
-
Method Detail
-
async
public AsyncBucket async()
Provides access to the underlyingAsyncBucket.
-
reactive
public ReactiveBucket reactive()
Provides access to the relatedReactiveBucket.
-
environment
public ClusterEnvironment environment()
Returns the attachedClusterEnvironment.
-
collections
public CollectionManager collections()
-
viewIndexes
public ViewIndexManager viewIndexes()
-
core
@Volatile public Core core()
Provides access to the underlyingCore.This is advanced API, use with care!
-
scope
public Scope scope(String name)
Opens theScopewith the given name.- Parameters:
name- the name of the scope.- Returns:
- the
Scopeonce opened.
-
defaultCollection
public Collection defaultCollection()
Opens the default collection for thisBucketusing the default scope.This method does not block and the client will try to establish all needed resources in the background. If you need to eagerly await until all resources are established before performing an operation, use the
waitUntilReady(Duration)method on theBucket.- Returns:
- the opened default
Collection.
-
collection
public Collection collection(String collectionName)
Provides access to the collection with the given name for thisBucketusing the default scope.This method does not block and the client will try to establish all needed resources in the background. If you need to eagerly await until all resources are established before performing an operation, use the
waitUntilReady(Duration)method on theBucket.- Returns:
- the opened named
Collection.
-
viewQuery
public ViewResult viewQuery(String designDoc, String viewName)
Queries a view on the bucket.- Parameters:
designDoc- the name of the design document in which the view resides.viewName- the name of the view to query.- Returns:
- a
ViewResultonce completed. - Throws:
ViewNotFoundException- if the view or design document is not found on the server.TimeoutException- if the operation times out before getting a result.CouchbaseException- for all other error reasons (acts as a base type and catch-all).
-
viewQuery
public ViewResult viewQuery(String designDoc, String viewName, ViewOptions options)
Queries a view on the bucket with custom options.- Parameters:
designDoc- the name of the design document in which the view resides.viewName- the name of the view to query.options- allows to customize view options.- Returns:
- a
ViewResultonce completed. - Throws:
ViewNotFoundException- if the view or design document is not found on the server.TimeoutException- if the operation times out before getting a result.CouchbaseException- for all other error reasons (acts as a base type and catch-all).
-
ping
public PingResult ping()
Performs application-level ping requests against services in the couchbase cluster.- Returns:
- the
PingResultonce complete.
-
ping
public PingResult ping(PingOptions options)
Performs application-level ping requests with custom options against services in the couchbase cluster.- Returns:
- the
PingResultonce complete.
-
waitUntilReady
public void waitUntilReady(Duration timeout)
Waits until the desiredClusterStateis reached.This method will wait until either the cluster state is "online", or the timeout is reached. Since the SDK is bootstrapping lazily, this method allows to eagerly check during bootstrap if all of the services are online and usable before moving on.
- Parameters:
timeout- the maximum time to wait until readiness.
-
waitUntilReady
public void waitUntilReady(Duration timeout, WaitUntilReadyOptions options)
Waits until the desiredClusterStateis reached.This method will wait until either the cluster state is "online" by default, or the timeout is reached. Since the SDK is bootstrapping lazily, this method allows to eagerly check during bootstrap if all of the services are online and usable before moving on. You can tune the properties through
WaitUntilReadyOptions.- Parameters:
timeout- the maximum time to wait until readiness.options- the options to customize the readiness waiting.
-
-