io.vertx.sqlclient

Interface SqlClient

All Known Subinterfaces:

DB2Connection, DB2Pool, JDBCPool, MSSQLConnection, MSSQLPool, MySQLConnection, MySQLPool, PgConnection, PgPool, Pool, SqlConnection

public interface SqlClient

Defines common SQL client operations with a database server.

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
Future<Void>	close() Like close(Handler) but returns a Future of the asynchronous result
void	close(Handler<AsyncResult<Void>> handler) Close the client and release the associated resources.
PreparedQuery<RowSet<Row>>	preparedQuery(String sql) Create a prepared query, one of the PreparedQuery.execute(io.vertx.sqlclient.Tuple, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) or PreparedQuery.executeBatch(java.util.List<io.vertx.sqlclient.Tuple>, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) methods must be called to execute the query.
PreparedQuery<RowSet<Row>>	preparedQuery(String sql, PrepareOptions options) Create a prepared query, one of the PreparedQuery.execute(io.vertx.sqlclient.Tuple, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) or PreparedQuery.executeBatch(java.util.List<io.vertx.sqlclient.Tuple>, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) methods must be called to execute the query.
Query<RowSet<Row>>	query(String sql) Create a query, the Query.execute(io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) method must be called to execute the query.

Method Detail

query

Query<RowSet<Row>> query(String sql)

Create a query, the Query.execute(io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) method must be called to execute the query.

Returns:

the query

preparedQuery

PreparedQuery<RowSet<Row>> preparedQuery(String sql)

Create a prepared query, one of the PreparedQuery.execute(io.vertx.sqlclient.Tuple, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) or PreparedQuery.executeBatch(java.util.List<io.vertx.sqlclient.Tuple>, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) methods must be called to execute the query.

Returns:

the prepared query

preparedQuery

PreparedQuery<RowSet<Row>> preparedQuery(String sql,
                                         PrepareOptions options)

Create a prepared query, one of the PreparedQuery.execute(io.vertx.sqlclient.Tuple, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) or PreparedQuery.executeBatch(java.util.List<io.vertx.sqlclient.Tuple>, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) methods must be called to execute the query.

Returns:

the prepared query

close

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

Close the client and release the associated resources.

Parameters:

handler - the completion handler

close

Future<Void> close()

Like close(Handler) but returns a Future of the asynchronous result