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
ReactiveAnalyticsIndexManager	analyticsIndexes()	Provides access to the Analytics index management services.
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.
ReactiveBucketManager	buckets()	Provides access to the bucket management services.
static Mono<ReactiveCluster>	connect(String connectionString, ClusterOptions options)	Connect to a Couchbase cluster with custom Authenticator.
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.
Mono<Void>	disconnect()	Performs a non-reversible disconnect of this ReactiveCluster.
Mono<Void>	disconnect(Duration timeout)	Performs a non-reversible disconnect of this ReactiveCluster.
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.
ReactiveQueryIndexManager	queryIndexes()	Provides access to the N1QL index management services.
Mono<ReactiveSearchResult>	searchQuery(String indexName, SearchQuery query)	Performs a Full Text Search (FTS) query with default SearchOptions.
Mono<ReactiveSearchResult>	searchQuery(String indexName, SearchQuery query, SearchOptions options)	Performs a Full Text Search (FTS) query with custom SearchOptions.
ReactiveUserManager	users()	Provides access to the user management services.

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,
                                            ClusterOptions options)

Connect to a Couchbase cluster with custom Authenticator.

Parameters:

connectionString - connection string used to locate the Couchbase cluster.

options - custom options when creating 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!

users

@Volatile
public ReactiveUserManager users()

Provides access to the user management services.

buckets

@Volatile
public ReactiveBucketManager buckets()

Provides access to the bucket management services.

analyticsIndexes

@Volatile
public ReactiveAnalyticsIndexManager analyticsIndexes()

Provides access to the Analytics index management services.

queryIndexes

@Volatile
public ReactiveQueryIndexManager queryIndexes()

Provides access to the N1QL index management services.

async

public AsyncCluster async()

Provides access to the underlying AsyncCluster.

environment

public ClusterEnvironment environment()

Provides access to the configured ClusterEnvironment for this cluster.

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(String indexName,
                                              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(String indexName,
                                              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.

disconnect

public Mono<Void> disconnect()

Performs a non-reversible disconnect of this ReactiveCluster.

disconnect

public Mono<Void> disconnect(Duration timeout)

Performs a non-reversible disconnect of this ReactiveCluster.

Parameters:

timeout - overriding the default disconnect timeout if needed.