io.vertx.sqlclient

Interface PreparedQuery

public interface PreparedQuery

A prepared query.

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
<R> PreparedQuery	batch(List<Tuple> argsList, java.util.stream.Collector<Row,?,R> collector, Handler<AsyncResult<SqlResult<R>>> handler) Execute a batch.
PreparedQuery	batch(List<Tuple> argsList, Handler<AsyncResult<RowSet<Row>>> handler) Execute a batch.
void	close() Close the prepared query and release its resources.
void	close(Handler<AsyncResult<Void>> completionHandler) Like close() but notifies the completionHandler when it's closed.
RowStream<Row>	createStream(int fetch, Tuple args) Execute the prepared query with a cursor and createStream the result.
default Cursor	cursor()
Cursor	cursor(Tuple args) Create a cursor with the provided arguments.
default <R> PreparedQuery	execute(java.util.stream.Collector<Row,?,R> collector, Handler<AsyncResult<SqlResult<R>>> handler) Calls execute(Tuple, Collector, Handler) with an empty tuple argument.
default PreparedQuery	execute(Handler<AsyncResult<RowSet<Row>>> handler) Calls execute(Tuple, Handler) with an empty tuple argument.
<R> PreparedQuery	execute(Tuple args, java.util.stream.Collector<Row,?,R> collector, Handler<AsyncResult<SqlResult<R>>> handler) Create a cursor with the provided arguments.
PreparedQuery	execute(Tuple args, Handler<AsyncResult<RowSet<Row>>> handler) Create a cursor with the provided arguments.

Method Detail

execute

default PreparedQuery execute(Handler<AsyncResult<RowSet<Row>>> handler)

Calls execute(Tuple, Handler) with an empty tuple argument.

execute

default <R> PreparedQuery execute(java.util.stream.Collector<Row,?,R> collector,
                                  Handler<AsyncResult<SqlResult<R>>> handler)

Calls execute(Tuple, Collector, Handler) with an empty tuple argument.

execute

PreparedQuery execute(Tuple args,
                      Handler<AsyncResult<RowSet<Row>>> handler)

Create a cursor with the provided arguments.

Parameters:

args - the list of arguments

Returns:

the query

execute

<R> PreparedQuery execute(Tuple args,
                          java.util.stream.Collector<Row,?,R> collector,
                          Handler<AsyncResult<SqlResult<R>>> handler)

Create a cursor with the provided arguments. The collector will be provided

Parameters:

args - the list of arguments

collector - the collector

Returns:

the query

cursor

default Cursor cursor()

Returns:

create a query cursor with a fetch size and empty arguments

cursor

Cursor cursor(Tuple args)

Create a cursor with the provided arguments.

Parameters:

args - the list of arguments

Returns:

the query

createStream

RowStream<Row> createStream(int fetch,
                            Tuple args)

Execute the prepared query with a cursor and createStream the result. The createStream opens a cursor with a fetch size to fetch the results.

Note: this requires to be in a transaction, since cursors require it.

Parameters:

fetch - the cursor fetch size

args - the prepared query arguments

Returns:

the createStream

batch

PreparedQuery batch(List<Tuple> argsList,
                    Handler<AsyncResult<RowSet<Row>>> handler)

Execute a batch.

Parameters:

argsList - the list of tuple for the batch

Returns:

the createBatch

batch

<R> PreparedQuery batch(List<Tuple> argsList,
                        java.util.stream.Collector<Row,?,R> collector,
                        Handler<AsyncResult<SqlResult<R>>> handler)

Execute a batch.

Parameters:

argsList - the list of tuple for the batch

collector - the collector

Returns:

the createBatch

close

void close()

Close the prepared query and release its resources.

close

void close(Handler<AsyncResult<Void>> completionHandler)

Like close() but notifies the completionHandler when it's closed.