com.couchbase.client.java

Class AsyncBucket

java.lang.Object

com.couchbase.client.java.AsyncBucket

public class AsyncBucket
extends Object

Provides access to a Couchbase bucket in an async fashion.

Method Summary

Modifier and Type	Method and Description
AsyncCollection	collection(String collectionName) Provides access to the collection with the given name for this AsyncBucket using the default scope.
AsyncCollectionManager	collections()
Core	core() Provides access to the underlying Core.
AsyncCollection	defaultCollection() Opens the default collection for this AsyncBucket using the default scope.
AsyncScope	defaultScope() Opens the default AsyncScope.
ClusterEnvironment	environment() Returns the attached ClusterEnvironment.
String	name() Returns the name of the AsyncBucket.
CompletableFuture<PingResult>	ping() Performs application-level ping requests against services in the couchbase cluster.
CompletableFuture<PingResult>	ping(PingOptions options) Performs application-level ping requests with custom options against services in the couchbase cluster.
AsyncScope	scope(String name) Opens the AsyncScope with the given name.
AsyncViewIndexManager	viewIndexes()
CompletableFuture<ViewResult>	viewQuery(String designDoc, String viewName)
CompletableFuture<ViewResult>	viewQuery(String designDoc, String viewName, ViewOptions options)
CompletableFuture<Void>	waitUntilReady(Duration timeout) Waits until the desired ClusterState is reached.
CompletableFuture<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

name

public String name()

Returns the name of the AsyncBucket.

environment

public ClusterEnvironment environment()

Returns the attached ClusterEnvironment.

core

@Stability.Volatile
public Core core()

Provides access to the underlying Core.

This is advanced API, use with care!

collections

public AsyncCollectionManager collections()

viewIndexes

public AsyncViewIndexManager viewIndexes()

scope

@Stability.Volatile
public AsyncScope scope(String name)

Opens the AsyncScope with the given name.

Parameters:

name - the name of the scope.

Returns:

the AsyncScope once opened.

defaultScope

@Stability.Volatile
public AsyncScope defaultScope()

Opens the default AsyncScope.

Returns:

the AsyncScope once opened.

defaultCollection

public AsyncCollection defaultCollection()

Opens the default collection for this AsyncBucket using 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 the AsyncBucket.

Returns:

the opened default AsyncCollection.

collection

@Stability.Volatile
public AsyncCollection collection(String collectionName)

Provides access to the collection with the given name for this AsyncBucket using 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 the AsyncBucket.

Returns:

the opened named AsyncCollection.

viewQuery

public CompletableFuture<ViewResult> viewQuery(String designDoc,
                                               String viewName)

viewQuery

public CompletableFuture<ViewResult> viewQuery(String designDoc,
                                               String viewName,
                                               ViewOptions options)

ping

public CompletableFuture<PingResult> ping()

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

Returns:

the PingResult once complete.

ping

public CompletableFuture<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 CompletableFuture<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.

Returns:

a completable future that completes either once ready or timeout.

waitUntilReady

public CompletableFuture<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.

Returns:

a completable future that completes either once ready or timeout.