Package com.couchbase.client.java

Class ReactiveBucket

java.lang.Object

com.couchbase.client.java.ReactiveBucket

public class ReactiveBucket
extends Object

Provides access to a Couchbase bucket in a reactive fashion.

Method Summary

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

name

public String name()

Returns the name of the ReactiveBucket.

core

@Volatile
public Core core()

Provides access to the underlying Core.

This is advanced API, use with care!

collections

public ReactiveCollectionManager collections()

viewIndexes

public ReactiveViewIndexManager viewIndexes()

environment

public ClusterEnvironment environment()

Returns the attached ClusterEnvironment.

scope

@Volatile
public ReactiveScope scope(String name)

Opens the ReactiveScope with the given name.

Parameters:

name - the name of the scope.

Returns:

the ReactiveScope once opened.

defaultScope

@Volatile
public ReactiveScope defaultScope()

Opens the default ReactiveScope.

Returns:

the ReactiveScope once opened.

defaultCollection

public ReactiveCollection defaultCollection()

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

Returns:

the opened default ReactiveCollection.

collection

@Volatile
public ReactiveCollection collection(String collectionName)

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

Returns:

the opened named ReactiveCollection.

viewQuery

public Mono<ReactiveViewResult> viewQuery(String designDoc,
                                          String viewName)

viewQuery

public Mono<ReactiveViewResult> viewQuery(String designDoc,
                                          String viewName,
                                          ViewOptions options)

ping

public Mono<PingResult> ping()

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

Returns:

the PingResult once complete.

ping

public Mono<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 Mono<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 mono that completes either once ready or timeout.

waitUntilReady

public Mono<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 mono that completes either once ready or timeout.