com.datastax.oss.driver.api.core.cql

Interface AsyncCqlSession

All Superinterfaces:

AsyncAutoCloseable, AutoCloseable, Session

All Known Subinterfaces:

CqlSession, DseSession

public interface AsyncCqlSession
extends Session

A session that offers user-friendly methods to execute CQL requests asynchronously.

Since:

4.4.0

Field Summary

Fields inherited from interface com.datastax.oss.driver.api.core.session.Session

OSS_DRIVER_COORDINATES

Method Summary

Modifier and Type	Method and Description
default CompletionStage<AsyncResultSet>	executeAsync(Statement<?> statement) Executes a CQL statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).
default CompletionStage<AsyncResultSet>	executeAsync(String query) Executes a CQL statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).
default CompletionStage<AsyncResultSet>	executeAsync(String query, Map<String,Object> values) Executes a CQL statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).
default CompletionStage<AsyncResultSet>	executeAsync(String query, Object... values) Executes a CQL statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).
default CompletionStage<PreparedStatement>	prepareAsync(PrepareRequest request) Prepares a CQL statement asynchronously (the call returns as soon as the prepare query was sent, generally before the statement is prepared).
default CompletionStage<PreparedStatement>	prepareAsync(SimpleStatement statement) Prepares a CQL statement asynchronously (the call returns as soon as the prepare query was sent, generally before the statement is prepared).
default CompletionStage<PreparedStatement>	prepareAsync(String query) Prepares a CQL statement asynchronously (the call returns as soon as the prepare query was sent, generally before the statement is prepared).

Methods inherited from interface com.datastax.oss.driver.api.core.session.Session

checkSchemaAgreement, checkSchemaAgreementAsync, execute, getContext, getKeyspace, getMetadata, getMetrics, getName, isSchemaMetadataEnabled, refreshSchema, refreshSchemaAsync, setSchemaMetadataEnabled

Methods inherited from interface com.datastax.oss.driver.api.core.AsyncAutoCloseable

close, closeAsync, closeFuture, forceCloseAsync, isClosed

Method Detail

executeAsync

@NonNull
default CompletionStage<AsyncResultSet> executeAsync(@NonNull
                                                              Statement<?> statement)

Executes a CQL statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).

Parameters:

statement - the CQL query to execute (that can be any Statement).

Returns:

a CompletionStage that, once complete, will produce the async result set.

executeAsync

@NonNull
default CompletionStage<AsyncResultSet> executeAsync(@NonNull
                                                              String query)

Executes a CQL statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).

This is an alias for executeAsync(Statement) executeAsync(SimpleStatement.newInstance(query))}.

Parameters:

query - the CQL query to execute.

Returns:

a CompletionStage that, once complete, will produce the async result set.

See Also:

SimpleStatement.newInstance(String)

executeAsync

@NonNull
default CompletionStage<AsyncResultSet> executeAsync(@NonNull
                                                              String query,
                                                              @NonNull
                                                              Object... values)

Executes a CQL statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).

This is an alias for executeAsync(Statement) executeAsync(SimpleStatement.newInstance(query, values))}.

Parameters:

query - the CQL query to execute.

values - the values for placeholders in the query string. Individual values can be null, but the vararg array itself can't.

Returns:

a CompletionStage that, once complete, will produce the async result set.

See Also:

SimpleStatement.newInstance(String, Object...)

executeAsync

@NonNull
default CompletionStage<AsyncResultSet> executeAsync(@NonNull
                                                              String query,
                                                              @NonNull
                                                              Map<String,Object> values)

Executes a CQL statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).

This is an alias for executeAsync(Statement) executeAsync(SimpleStatement.newInstance(query, values))}.

Parameters:

query - the CQL query to execute.

values - the values for named placeholders in the query string. Individual values can be null, but the map itself can't.

Returns:

a CompletionStage that, once complete, will produce the async result set.

See Also:

SimpleStatement.newInstance(String, Map)

prepareAsync

@NonNull
default CompletionStage<PreparedStatement> prepareAsync(@NonNull
                                                                 SimpleStatement statement)

Prepares a CQL statement asynchronously (the call returns as soon as the prepare query was sent, generally before the statement is prepared).

Note that the bound statements created from the resulting prepared statement will inherit some of the attributes of query; see SyncCqlSession.prepare(SimpleStatement) for more details.

The result of this method is cached (see SyncCqlSession.prepare(SimpleStatement) for more explanations).

Parameters:

statement - the CQL query to prepare (that can be any SimpleStatement).

Returns:

a CompletionStage that, once complete, will produce the prepared statement.

prepareAsync

@NonNull
default CompletionStage<PreparedStatement> prepareAsync(@NonNull
                                                                 String query)

Prepares a CQL statement asynchronously (the call returns as soon as the prepare query was sent, generally before the statement is prepared).

The result of this method is cached (see SyncCqlSession.prepare(SimpleStatement) for more explanations).

Parameters:

query - the CQL query string to prepare.

Returns:

a CompletionStage that, once complete, will produce the prepared statement.

prepareAsync

@NonNull
default CompletionStage<PreparedStatement> prepareAsync(PrepareRequest request)

Prepares a CQL statement asynchronously (the call returns as soon as the prepare query was sent, generally before the statement is prepared).

This variant is exposed in case you use an ad hoc PrepareRequest implementation to customize how attributes are propagated when you prepare a SimpleStatement (see SyncCqlSession.prepare(SimpleStatement) for more explanations). Otherwise, you should rarely have to deal with PrepareRequest directly.

The result of this method is cached (see SyncCqlSession.prepare(SimpleStatement) for more explanations).

Parameters:

request - the PrepareRequest to prepare.

Returns:

a CompletionStage that, once complete, will produce the prepared statement.