Package com.couchbase.client.java

Class Cluster

java.lang.Object

com.couchbase.client.java.Cluster

public class Cluster
extends Object

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

Method Summary

Modifier and Type	Method	Description
AnalyticsIndexManager	analyticsIndexes()	Provides access to the Analytics index management services.
AnalyticsResult	analyticsQuery(String statement)	Performs an analytics query with default AnalyticsOptions.
AnalyticsResult	analyticsQuery(String statement, AnalyticsOptions options)	Performs an analytics query with custom AnalyticsOptions.
AsyncCluster	async()	Provides access to the underlying AsyncCluster.
Bucket	bucket(String name)	Opens a Bucket with the given name.
BucketManager	buckets()	Provides access to the bucket management services.
static Cluster	connect(String connectionString, ClusterOptions options)	Connect to a Couchbase cluster with custom Authenticator.
static Cluster	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.
DiagnosticsResult	diagnostics()	Returns a DiagnosticsResult, reflecting the SDK's current view of all its existing connections to the cluster.
DiagnosticsResult	diagnostics(DiagnosticsOptions options)	Returns a DiagnosticsResult, reflecting the SDK's current view of all its existing connections to the cluster.
void	disconnect()	Performs a non-reversible disconnect of this Cluster.
void	disconnect(Duration timeout)	Performs a non-reversible disconnect of this Cluster.
ClusterEnvironment	environment()	Provides access to the configured ClusterEnvironment for this cluster.
QueryResult	query(String statement)	Performs a N1QL query with default QueryOptions.
QueryResult	query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions.
QueryIndexManager	queryIndexes()	Provides access to the N1QL index management services.
ReactiveCluster	reactive()	Provides access to the related ReactiveCluster.
SearchIndexManager	searchIndexes()	Provides access to the Full Text Search index management services.
SearchResult	searchQuery(String indexName, SearchQuery query)	Performs a Full Text Search (FTS) query with default SearchOptions.
SearchResult	searchQuery(String indexName, SearchQuery query, SearchOptions options)	Performs a Full Text Search (FTS) query with custom SearchOptions.
UserManager	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 Cluster 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 Cluster.

connect

public static Cluster 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 Cluster.

async

public AsyncCluster async()

Provides access to the underlying AsyncCluster.

reactive

public ReactiveCluster reactive()

Provides access to the related ReactiveCluster.

core

@Volatile
public Core core()

Provides access to the underlying Core.

This is advanced API, use with care!

users

@Volatile
public UserManager users()

Provides access to the user management services.

buckets

@Volatile
public BucketManager buckets()

Provides access to the bucket management services.

analyticsIndexes

@Volatile
public AnalyticsIndexManager analyticsIndexes()

Provides access to the Analytics index management services.

queryIndexes

@Volatile
public QueryIndexManager queryIndexes()

Provides access to the N1QL index management services.

searchIndexes

@Volatile
public SearchIndexManager searchIndexes()

Provides access to the Full Text Search index management services.

environment

public ClusterEnvironment environment()

Provides access to the configured ClusterEnvironment for this cluster.

query

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

analyticsQuery

public AnalyticsResult analyticsQuery(String statement)

Performs an analytics query with default AnalyticsOptions.

Parameters:

statement - the query statement as a raw string.

Returns:

the AnalyticsResult once the response arrives successfully.

analyticsQuery

public AnalyticsResult analyticsQuery(String statement,
                                      AnalyticsOptions options)

Performs an analytics query with custom AnalyticsOptions.

Parameters:

statement - the query statement as a raw string.

options - the custom options for this query.

Returns:

the AnalyticsResult once the response arrives successfully.

searchQuery

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

searchQuery

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

bucket

public Bucket bucket(String name)

Opens a Bucket with the given name.

Parameters:

name - the name of the bucket to open.

Returns:

a Bucket once opened.

disconnect

public void disconnect()

Performs a non-reversible disconnect of this Cluster.

disconnect

public void disconnect(Duration timeout)

Performs a non-reversible disconnect of this Cluster.

Parameters:

timeout - overriding the default disconnect timeout if needed.

diagnostics

@Volatile
public DiagnosticsResult diagnostics(DiagnosticsOptions options)

Returns a DiagnosticsResult, reflecting the SDK's current view of all its existing connections to the cluster.

Parameters:

options - options on the generation of the report

Returns:

a DiagnosticsResult

diagnostics

@Volatile
public DiagnosticsResult diagnostics()

Returns a DiagnosticsResult, reflecting the SDK's current view of all its existing connections to the cluster.

Returns:

a DiagnosticsResult