Package com.couchbase.client.java

Class AsyncCluster

java.lang.Object

com.couchbase.client.java.AsyncCluster

public class AsyncCluster
extends Object

The AsyncCluster is the main entry point when connecting to a Couchbase cluster.

Note that most of the time you want to use the blocking Cluster or the powerful reactive ReactiveCluster API instead. Use this API if you know what you are doing and you want to build low-level, even faster APIs on top.

Method Summary

Modifier and Type	Method	Description
AsyncAnalyticsIndexManager	analyticsIndexes()	Returns a manager for Analytics services.
CompletableFuture<AnalyticsResult>	analyticsQuery(String statement)	Performs an Analytics query with default AnalyticsOptions.
CompletableFuture<AnalyticsResult>	analyticsQuery(String statement, AnalyticsOptions options)	Performs an Analytics query with custom AnalyticsOptions.
CompletableFuture<AsyncBucket>	bucket(String name)	Opens a AsyncBucket with the given name.
AsyncBucketManager	buckets()
static CompletableFuture<AsyncCluster>	connect(ClusterEnvironment environment)	Connect to a Couchbase cluster with a custom ClusterEnvironment.
static CompletableFuture<AsyncCluster>	connect(String connectionString, Credentials credentials)	Connect to a Couchbase cluster with custom Credentials.
static CompletableFuture<AsyncCluster>	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.
CompletableFuture<QueryResult>	query(String statement)	Performs a N1QL query with default QueryOptions.
CompletableFuture<QueryResult>	query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions.
AsyncSearchIndexManager	searchIndexes()	Provides access to the index management capabilities.
CompletableFuture<SearchResult>	searchQuery(SearchQuery query)	Performs a Full Text Search (FTS) query with default SearchOptions.
CompletableFuture<SearchResult>	searchQuery(SearchQuery query, SearchOptions options)	Performs a Full Text Search (FTS) query with custom SearchOptions.
CompletableFuture<Void>	shutdown()	Performs a non-reversible shutdown of this AsyncCluster.
CompletableFuture<Void>	shutdown(Duration timeout)	Performs a non-reversible shutdown of this AsyncCluster.
AsyncUserManager	users()	Provides access to the user management capabilities.

Methods inherited from class java.lang.Object

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

Method Detail

connect

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

connect

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

connect

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

environment

public ClusterEnvironment environment()

Provides access to the configured ClusterEnvironment for this cluster.

core

@Volatile
public Core core()

Provides access to the underlying Core.

This is advanced API, use with care!

searchIndexes

@Volatile
public AsyncSearchIndexManager searchIndexes()

Provides access to the index management capabilities.

users

@Volatile
public AsyncUserManager users()

Provides access to the user management capabilities.

buckets

@Volatile
public AsyncBucketManager buckets()

query

public CompletableFuture<QueryResult> query(String statement)

Performs a N1QL query with default QueryOptions.

Parameters:

statement - the N1QL query statement as a raw string.

Returns:

the QueryResult once the response arrives successfully.

query

public CompletableFuture<QueryResult> 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 QueryResult once the response arrives successfully.

analyticsIndexes

public AsyncAnalyticsIndexManager analyticsIndexes()

Returns a manager for Analytics services.

analyticsQuery

public CompletableFuture<AnalyticsResult> analyticsQuery(String statement)

Performs an Analytics query with default AnalyticsOptions.

Parameters:

statement - the Analytics query statement as a raw string.

Returns:

the AnalyticsResult once the response arrives successfully.

analyticsQuery

public CompletableFuture<AnalyticsResult> 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 AnalyticsResult once the response arrives successfully.

searchQuery

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

searchQuery

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

bucket

public CompletableFuture<AsyncBucket> bucket(String name)

Opens a AsyncBucket with the given name.

Parameters:

name - the name of the bucket to open.

Returns:

a AsyncBucket once opened.

shutdown

public CompletableFuture<Void> shutdown()

Performs a non-reversible shutdown of this AsyncCluster.

shutdown

public CompletableFuture<Void> shutdown(Duration timeout)

Performs a non-reversible shutdown of this AsyncCluster.

Parameters:

timeout - overriding the default disconnect timeout if needed.