public interface CassandraClient
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_POOL_NAME
The name of the default pool
|
Modifier and Type | Method and Description |
---|---|
CassandraClient |
connect()
Connect to a Cassandra service.
|
CassandraClient |
connect(Handler<AsyncResult<Void>> connectHandler)
Connect to a Cassandra service.
|
CassandraClient |
connect(String keyspace,
Handler<AsyncResult<Void>> connectHandler)
Connect to a Cassandra service.
|
static CassandraClient |
createNonShared(Vertx vertx)
Like
createNonShared(Vertx, CassandraClientOptions) but with default client options. |
static CassandraClient |
createNonShared(Vertx vertx,
CassandraClientOptions cassandraClientOptions)
Create a Cassandra client which maintains its own data source.
|
static CassandraClient |
createShared(Vertx vertx)
Like
createShared(Vertx, String, CassandraClientOptions) , but with default client options and datasource. |
static CassandraClient |
createShared(Vertx vertx,
CassandraClientOptions cassandraClientOptions)
Like
createShared(Vertx, String, CassandraClientOptions) , but with datasource name. |
static CassandraClient |
createShared(Vertx vertx,
String datasourceName)
Like
createShared(Vertx, String, CassandraClientOptions) , but with default client options. |
static CassandraClient |
createShared(Vertx vertx,
String datasourceName,
CassandraClientOptions cassandraClientOptions)
Create a Cassandra client which shares its data source with any other Cassandra clients created with the same
data source name.
|
CassandraClient |
disconnect()
Disconnects from the Cassandra service.
|
CassandraClient |
disconnect(Handler<AsyncResult<Void>> disconnectHandler)
Disconnects from the Cassandra service.
|
CassandraClient |
execute(com.datastax.driver.core.Statement statement,
Handler<AsyncResult<ResultSet>> resultHandler)
Execute the statement and provide a handler for consuming results.
|
CassandraClient |
execute(String query,
Handler<AsyncResult<ResultSet>> resultHandler)
Execute the query and provide a handler for consuming results.
|
CassandraClient |
executeWithFullFetch(com.datastax.driver.core.Statement statement,
Handler<AsyncResult<List<com.datastax.driver.core.Row>>> resultHandler)
Execute the query and provide a handler for consuming results.
|
CassandraClient |
executeWithFullFetch(String query,
Handler<AsyncResult<List<com.datastax.driver.core.Row>>> resultHandler)
Execute the query and provide a handler for consuming results.
|
boolean |
isConnected() |
CassandraClient |
prepare(String query,
Handler<AsyncResult<com.datastax.driver.core.PreparedStatement>> resultHandler)
Prepares the provided query string.
|
CassandraClient |
queryStream(com.datastax.driver.core.Statement statement,
Handler<AsyncResult<CassandraRowStream>> rowStreamHandler)
Executes the given SQL statement which returns the results of the query as a read stream.
|
CassandraClient |
queryStream(String sql,
Handler<AsyncResult<CassandraRowStream>> rowStreamHandler)
Executes the given SQL
SELECT statement which returns the results of the query as a read stream. |
static final String DEFAULT_POOL_NAME
static CassandraClient createNonShared(Vertx vertx)
createNonShared(Vertx, CassandraClientOptions)
but with default client options.static CassandraClient createNonShared(Vertx vertx, CassandraClientOptions cassandraClientOptions)
It is not recommended to create several non shared clients in an application.
Your application should either use only single non shared client, or use shared client.
This is because CassandraClient
backed by Session
.
And Datastax does not recommended to have several Session
instances. Better to have only one, and share it.
vertx
- the Vert.x instancecassandraClientOptions
- the optionsstatic CassandraClient createShared(Vertx vertx)
createShared(Vertx, String, CassandraClientOptions)
, but with default client options and datasource.static CassandraClient createShared(Vertx vertx, String datasourceName)
createShared(Vertx, String, CassandraClientOptions)
, but with default client options.static CassandraClient createShared(Vertx vertx, CassandraClientOptions cassandraClientOptions)
createShared(Vertx, String, CassandraClientOptions)
, but with datasource name.static CassandraClient createShared(Vertx vertx, String datasourceName, CassandraClientOptions cassandraClientOptions)
vertx
- the Vert.x instancecassandraClientOptions
- the optionsdatasourceName
- the data source nameCassandraClient connect()
boolean isConnected()
CassandraClient connect(Handler<AsyncResult<Void>> connectHandler)
connectHandler
- handler called when asynchronous connect call endsCassandraClient connect(String keyspace, Handler<AsyncResult<Void>> connectHandler)
keyspace
- The name of the keyspace to use for the created connection.connectHandler
- handler called when asynchronous connect call endsCassandraClient executeWithFullFetch(String query, Handler<AsyncResult<List<com.datastax.driver.core.Row>>> resultHandler)
resultHandler
- handler called when result of execution is fully fetched.query
- the query to executeCassandraClient executeWithFullFetch(com.datastax.driver.core.Statement statement, Handler<AsyncResult<List<com.datastax.driver.core.Row>>> resultHandler)
resultHandler
- handler called when result of execution is fully fetched.statement
- the statement to executeCassandraClient execute(String query, Handler<AsyncResult<ResultSet>> resultHandler)
resultHandler
- handler called when result of execution is present, but can be not fully fetchedquery
- the query to executeCassandraClient execute(com.datastax.driver.core.Statement statement, Handler<AsyncResult<ResultSet>> resultHandler)
resultHandler
- handler called when result of execution is presentstatement
- the statement to executeCassandraClient prepare(String query, Handler<AsyncResult<com.datastax.driver.core.PreparedStatement>> resultHandler)
resultHandler
- handler called when result of query preparation is presentquery
- the query to prepareCassandraClient queryStream(String sql, Handler<AsyncResult<CassandraRowStream>> rowStreamHandler)
SELECT
statement which returns the results of the query as a read stream.sql
- the SQL to execute. For example SELECT * FROM table ...
.rowStreamHandler
- the handler which is called once the operation completes. It will return an instance of CassandraRowStream
.CassandraClient queryStream(com.datastax.driver.core.Statement statement, Handler<AsyncResult<CassandraRowStream>> rowStreamHandler)
statement
- the statement to execute.rowStreamHandler
- the handler which is called once the operation completes. It will return an instance of CassandraRowStream
.CassandraClient disconnect()
CassandraClient disconnect(Handler<AsyncResult<Void>> disconnectHandler)
disconnectHandler
- handler called when asynchronous disconnect call endsCopyright © 2018 Eclipse. All rights reserved.