Package com.couchbase.client.java

Class ReactiveCluster

java.lang.Object

com.couchbase.client.java.ReactiveCluster

public class ReactiveCluster
extends Object

Method Summary

Modifier and Type	Method	Description
Mono<ReactiveAnalyticsResult>	analyticsQuery(String statement)	Performs an Analytics query with default AnalyticsOptions.
Mono<ReactiveAnalyticsResult>	analyticsQuery(String statement, AnalyticsOptions options)	Performs an Analytics query with custom AnalyticsOptions.
AsyncCluster	async()	Provides access to the underlying AsyncCluster.
Mono<ReactiveBucket>	bucket(String name)	Opens a ReactiveBucket with the given name.
static Mono<ReactiveCluster>	connect(ClusterEnvironment environment)	Connect to a Couchbase cluster with a custom ClusterEnvironment.
static Mono<ReactiveCluster>	connect(String connectionString, Credentials credentials)	Connect to a Couchbase cluster with custom Credentials.
static Mono<ReactiveCluster>	connect(String connectionString, String username, String password)	Connect to a Couchbase cluster with a username and a password as credentials.
Core	core()	Provides access to the underlying Core.
ClusterEnvironment	environment()	Provides access to the configured ClusterEnvironment for this cluster.
Mono<ReactiveQueryResult>	query(String statement)	Performs a N1QL query with default QueryOptions.
Mono<ReactiveQueryResult>	query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions.
ReactiveSearchIndexManager	searchIndexes()	Provides access to the index management capabilities.
Mono<ReactiveSearchResult>	searchQuery(SearchQuery query)	Performs a Full Text Search (FTS) query with default SearchOptions.
Mono<ReactiveSearchResult>	searchQuery(SearchQuery query, SearchOptions options)	Performs a Full Text Search (FTS) query with custom SearchOptions.
Mono<Void>	shutdown()	Performs a non-reversible shutdown of this ReactiveCluster.
Mono<Void>	shutdown(Duration timeout)	Performs a non-reversible shutdown of this ReactiveCluster.

Methods inherited from class java.lang.Object

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

Method Detail

connect

public static Mono<ReactiveCluster> connect(String connectionString,
                                            String username,
                                            String password)

Connect to a Couchbase cluster with a username and a password as credentials.

Parameters:

connectionString - connection string used to locate the Couchbase cluster.

username - the name of the user with appropriate permissions on the cluster.

password - the password of the user with appropriate permissions on the cluster.

Returns:

if properly connected, returns a ReactiveCluster.

connect

public static Mono<ReactiveCluster> connect(String connectionString,
                                            Credentials credentials)

Connect to a Couchbase cluster with custom Credentials.

Parameters:

connectionString - connection string used to locate the Couchbase cluster.

credentials - custom credentials used when connecting to the cluster.

Returns:

if properly connected, returns a ReactiveCluster.

connect

public static Mono<ReactiveCluster> connect(ClusterEnvironment environment)

Connect to a Couchbase cluster with a custom ClusterEnvironment.

Parameters:

environment - the custom environment with its properties used to connect to the cluster.

Returns:

if properly connected, returns a ReactiveCluster.

core

@Volatile
public Core core()

Provides access to the underlying Core.

This is advanced API, use with care!

async

public AsyncCluster async()

Provides access to the underlying AsyncCluster.

environment

public ClusterEnvironment environment()

Provides access to the configured ClusterEnvironment for this cluster.

searchIndexes

@Volatile
public ReactiveSearchIndexManager searchIndexes()

Provides access to the index management capabilities.

query

public Mono<ReactiveQueryResult> query(String statement)

Performs a N1QL query with default QueryOptions.

Parameters:

statement - the N1QL query statement as a raw string.

Returns:

the ReactiveQueryResult once the response arrives successfully.

query

public Mono<ReactiveQueryResult> query(String statement,
                                       QueryOptions options)

Performs a N1QL query with custom QueryOptions.

Parameters:

statement - the N1QL query statement as a raw string.

options - the custom options for this query.

Returns:

the ReactiveQueryResult once the response arrives successfully.

analyticsQuery

public Mono<ReactiveAnalyticsResult> analyticsQuery(String statement)

Performs an Analytics query with default AnalyticsOptions.

Parameters:

statement - the Analytics query statement as a raw string.

Returns:

the ReactiveAnalyticsResult once the response arrives successfully.

analyticsQuery

public Mono<ReactiveAnalyticsResult> analyticsQuery(String statement,
                                                    AnalyticsOptions options)

Performs an Analytics query with custom AnalyticsOptions.

Parameters:

statement - the Analytics query statement as a raw string.

options - the custom options for this analytics query.

Returns:

the ReactiveAnalyticsResult once the response arrives successfully.

searchQuery

public Mono<ReactiveSearchResult> searchQuery(SearchQuery query)

Performs a Full Text Search (FTS) query with default SearchOptions.

Parameters:

query - the query, in the form of a SearchQuery

Returns:

the SearchRequest once the response arrives successfully, inside a Mono

searchQuery

public Mono<ReactiveSearchResult> searchQuery(SearchQuery query,
                                              SearchOptions options)

Performs a Full Text Search (FTS) query with custom SearchOptions.

Parameters:

query - the query, in the form of a SearchQuery

options - the custom options for this query.

Returns:

the SearchRequest once the response arrives successfully, inside a Mono

bucket

public Mono<ReactiveBucket> bucket(String name)

Opens a ReactiveBucket with the given name.

Parameters:

name - the name of the bucket to open.

Returns:

a ReactiveBucket once opened.

shutdown

public Mono<Void> shutdown()

Performs a non-reversible shutdown of this ReactiveCluster.

shutdown

public Mono<Void> shutdown(Duration timeout)

Performs a non-reversible shutdown of this ReactiveCluster.

Parameters:

timeout - overriding the default disconnect timeout if needed.