Module com.couchbase.columnar.client.java

Package com.couchbase.columnar.client.java

Class Cluster

java.lang.Object

com.couchbase.columnar.client.java.Cluster

All Implemented Interfaces:

Queryable, Closeable, AutoCloseable

@ThreadSafe
public final class Cluster
extends Object
implements Closeable, Queryable

Create a new instance by calling newInstance(java.lang.String, com.couchbase.columnar.client.java.Credential).

To create an instance with default options:

 Cluster cluster = Cluster.newInstance(
     connectionString,
     Credential.of(username, password)
 );
 

To create an instance with custom options:

 Cluster cluster = Cluster.newInstance(
     connectionString,
     Credential.of(username, password),
     options -> options
         .timeout(it -> it.queryTimeout(Duration.ofMinutes(5)))
         .deserializer(new JacksonDeserializer(new ObjectMapper()))
 );
 

For best efficiency, create a single `Cluster` instance per Columnar cluster and share it throughout your application.

When you're done interacting with the cluster, it's important to call close() to release resources used by the cluster.

Method Summary

Modifier and Type	Method	Description
void	close()	Releases resources and prevents further use of this object.
Database	database(String name)	Returns the database in this cluster with the given name.
QueryResult	executeQuery(String statement, Consumer<QueryOptions> optionsCustomizer)	Executes a query statement using the specified options (query parameters, etc.), and buffers all result rows in memory.
QueryMetadata	executeStreamingQuery(String statement, Consumer<Row> rowAction, Consumer<QueryOptions> optionsCustomizer)	Executes a query statement using the specified options, (query parameters, etc.), and passes result rows to the given rowAction callback, one by one as they arrive from the server.
static Cluster	newInstance(String connectionString, Credential credential)	Returns a new instance, with default options.
static Cluster	newInstance(String connectionString, Credential credential, Consumer<ClusterOptions> optionsCustomizer)	Returns a new instance, with options customized by the optionsCustomizer callback.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.couchbase.columnar.client.java.Queryable

executeQuery, executeStreamingQuery

Method Details

newInstance

public static Cluster newInstance(String connectionString,
 Credential credential)

Returns a new instance, with default options.

Example usage:

 Cluster cluster = Cluster.newInstance(
     "couchbases://example.com",
     Credentials.of(username, password)
 );
 

See Also:

• newInstance(String, Credential, Consumer)
• Credential.of(String, String)

newInstance

public static Cluster newInstance(String connectionString,
 Credential credential,
 Consumer<ClusterOptions> optionsCustomizer)

Returns a new instance, with options customized by the optionsCustomizer callback.

Example usage:

 Cluster cluster = Cluster.newInstance(
     connectionString,
     Credential.of(username, password),
     options -> options
         .timeout(it -> it.queryTimeout(Duration.ofMinutes(5)))
         .deserializer(new JacksonDeserializer(new ObjectMapper()))
 );
 

See Also:

• Credential.of(String, String)
• newInstance(String, Credential)
• ClusterOptions

close

public void close()

Releases resources and prevents further use of this object.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

database

public Database database(String name)

Returns the database in this cluster with the given name.

A database is a container for Scopes.

If the database does not exist, this method still returns a non-null object, but operations using that object fail with an exception indicating the database does not exist.

executeQuery

public QueryResult executeQuery(String statement,
 Consumer<QueryOptions> optionsCustomizer)

Description copied from interface: Queryable

Executes a query statement using the specified options (query parameters, etc.), and buffers all result rows in memory.

If the results are not known to fit in memory, consider using the streaming version that takes a row action callback: Queryable.executeStreamingQuery(String, Consumer, Consumer).

Specified by:

executeQuery in interface Queryable

Parameters:

statement - The Columnar SQL++ statement to execute.

optionsCustomizer - A callback for specifying custom query options.

Returns:

A query result consisting of metadata and a list of rows.

executeStreamingQuery

public QueryMetadata executeStreamingQuery(String statement,
 Consumer<Row> rowAction,
 Consumer<QueryOptions> optionsCustomizer)

Description copied from interface: Queryable

Executes a query statement using the specified options, (query parameters, etc.), and passes result rows to the given rowAction callback, one by one as they arrive from the server.

The callback action is guaranteed to execute in the same thread (or virtual thread) that called this method. If the callback throws an exception, the query is cancelled and the exception is re-thrown by this method.

Specified by:

executeStreamingQuery in interface Queryable

Parameters:

statement - The Columnar SQL++ statement to execute.

optionsCustomizer - A callback for specifying custom query options.

Returns:

Query metadata.