com.couchbase.client.java

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

Modifier and Type	Method and Description
AsyncBucket	async() Provides access to the underlying AsyncBucket.
Collection	collection(String collectionName) Opens the collection with the given name for this Bucket.
CollectionManager	collections()
Core	core() Provides access to the underlying Core.
Collection	defaultCollection() Opens the default collection for this Bucket.
Scope	defaultScope() Opens the default Scope.
ClusterEnvironment	environment() Returns the attached ClusterEnvironment.
String	name() Returns the name of the Bucket.
PingResult	ping() Performs application-level ping requests against services in the couchbase cluster.
PingResult	ping(PingOptions options) Performs application-level ping requests with custom options against services in the couchbase cluster.
ReactiveBucket	reactive() Provides access to the related ReactiveBucket.
Scope	scope(String name) Opens the Scope with the given name.
ViewIndexManager	viewIndexes()
ViewResult	viewQuery(String designDoc, String viewName) Queries a view on the bucket.
ViewResult	viewQuery(String designDoc, String viewName, ViewOptions options) Queries a view on the bucket with custom options.
void	waitUntilReady(Duration timeout) Waits until the desired ClusterState is reached.
void	waitUntilReady(Duration timeout, WaitUntilReadyOptions options) Waits until the desired ClusterState is reached.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

async

public AsyncBucket async()

Provides access to the underlying AsyncBucket.

reactive

public ReactiveBucket reactive()

Provides access to the related ReactiveBucket.

name

public String name()

Returns the name of the Bucket.

environment

public ClusterEnvironment environment()

Returns the attached ClusterEnvironment.

collections

public CollectionManager collections()

viewIndexes

public ViewIndexManager viewIndexes()

core

@Stability.Volatile
public Core core()

Provides access to the underlying Core.

This is advanced API, use with care!

scope

@Stability.Volatile
public Scope scope(String name)

Opens the Scope with the given name.

Parameters:

name - the name of the scope.

Returns:

the Scope once opened.

defaultScope

@Stability.Volatile
public Scope defaultScope()

Opens the default Scope.

Returns:

the Scope once opened.

defaultCollection

public Collection defaultCollection()

Opens the default collection for this Bucket.

Returns:

the Collection once opened.

collection

@Stability.Volatile
public Collection collection(String collectionName)

Opens the collection with the given name for this Bucket.

Returns:

the Collection once opened.

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 ViewResult once 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 ViewResult once 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 PingResult once complete.

ping

public PingResult ping(PingOptions options)

Performs application-level ping requests with custom options against services in the couchbase cluster.

Returns:

the PingResult once complete.

waitUntilReady

public void waitUntilReady(Duration timeout)

Waits until the desired ClusterState is 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 desired ClusterState is 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.