io.vertx.ext.sql

Interface SQLOperations

All Known Subinterfaces:

JDBCClient, SQLClient, SQLConnection

public interface SQLOperations

Represents a SQL query interface to a database

Author:

Paulo Lopes

Method Summary

Modifier and Type	Method and Description
SQLOperations	call(String sql, Handler<AsyncResult<ResultSet>> resultHandler) Calls the given SQL PROCEDURE which returns the result from the procedure.
SQLOperations	callWithParams(String sql, JsonArray params, JsonArray outputs, Handler<AsyncResult<ResultSet>> resultHandler) Calls the given SQL PROCEDURE which returns the result from the procedure.
SQLOperations	query(String sql, Handler<AsyncResult<ResultSet>> resultHandler) Executes the given SQL SELECT statement which returns the results of the query.
default SQLOperations	querySingle(String sql, Handler<AsyncResult<JsonArray>> handler) Execute a one shot SQL statement that returns a single SQL row.
default SQLOperations	querySingleWithParams(String sql, JsonArray arguments, Handler<AsyncResult<JsonArray>> handler) Execute a one shot SQL statement with arguments that returns a single SQL row.
SQLOperations	queryStream(String sql, Handler<AsyncResult<SQLRowStream>> handler) Executes the given SQL SELECT statement which returns the results of the query as a read stream.
SQLOperations	queryStreamWithParams(String sql, JsonArray params, Handler<AsyncResult<SQLRowStream>> handler) Executes the given SQL SELECT statement which returns the results of the query as a read stream.
SQLOperations	queryWithParams(String sql, JsonArray params, Handler<AsyncResult<ResultSet>> resultHandler) Executes the given SQL SELECT prepared statement which returns the results of the query.
SQLOperations	update(String sql, Handler<AsyncResult<UpdateResult>> resultHandler) Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE statement.
SQLOperations	updateWithParams(String sql, JsonArray params, Handler<AsyncResult<UpdateResult>> resultHandler) Executes the given prepared statement which may be an INSERT, UPDATE, or DELETE statement with the given parameters

Method Detail

query

SQLOperations query(String sql,
                    Handler<AsyncResult<ResultSet>> resultHandler)

Executes the given SQL SELECT statement which returns the results of the query.

Parameters:

sql - the SQL to execute. For example SELECT * FROM table ....

resultHandler - the handler which is called once the operation completes. It will return a ResultSet.

See Also:

Statement.executeQuery(String), Statement.executeQuery(String)

queryWithParams

SQLOperations queryWithParams(String sql,
                              JsonArray params,
                              Handler<AsyncResult<ResultSet>> resultHandler)

Executes the given SQL SELECT prepared statement which returns the results of the query.

Parameters:

sql - the SQL to execute. For example SELECT * FROM table ....

params - these are the parameters to fill the statement.

resultHandler - the handler which is called once the operation completes. It will return a ResultSet.

See Also:

Statement.executeQuery(String), Statement.executeQuery(String)

queryStream

SQLOperations queryStream(String sql,
                          Handler<AsyncResult<SQLRowStream>> handler)

Executes the given SQL SELECT statement which returns the results of the query as a read stream.

Parameters:

sql - the SQL to execute. For example SELECT * FROM table ....

handler - the handler which is called once the operation completes. It will return a SQLRowStream.

See Also:

Statement.executeQuery(String), Statement.executeQuery(String)

queryStreamWithParams

SQLOperations queryStreamWithParams(String sql,
                                    JsonArray params,
                                    Handler<AsyncResult<SQLRowStream>> handler)

Executes the given SQL SELECT statement which returns the results of the query as a read stream.

Parameters:

sql - the SQL to execute. For example SELECT * FROM table ....

params - these are the parameters to fill the statement.

handler - the handler which is called once the operation completes. It will return a SQLRowStream.

See Also:

Statement.executeQuery(String), Statement.executeQuery(String)

querySingle

default SQLOperations querySingle(String sql,
                                  Handler<AsyncResult<JsonArray>> handler)

Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

Parameters:

sql - the statement to execute

handler - the result handler

Returns:

self

querySingleWithParams

default SQLOperations querySingleWithParams(String sql,
                                            JsonArray arguments,
                                            Handler<AsyncResult<JsonArray>> handler)

Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

Parameters:

sql - the statement to execute

arguments - the arguments

handler - the result handler

Returns:

self

update

SQLOperations update(String sql,
                     Handler<AsyncResult<UpdateResult>> resultHandler)

Executes the given SQL statement which may be an INSERT, UPDATE, or DELETE statement.

Parameters:

sql - the SQL to execute. For example INSERT INTO table ...

resultHandler - the handler which is called once the operation completes.

See Also:

Statement.executeUpdate(String), Statement.executeUpdate(String)

updateWithParams

SQLOperations updateWithParams(String sql,
                               JsonArray params,
                               Handler<AsyncResult<UpdateResult>> resultHandler)

Executes the given prepared statement which may be an INSERT, UPDATE, or DELETE statement with the given parameters

Parameters:

sql - the SQL to execute. For example INSERT INTO table ...

params - these are the parameters to fill the statement.

resultHandler - the handler which is called once the operation completes.

See Also:

Statement.executeUpdate(String), Statement.executeUpdate(String)

call

SQLOperations call(String sql,
                   Handler<AsyncResult<ResultSet>> resultHandler)

Calls the given SQL PROCEDURE which returns the result from the procedure.

Parameters:

sql - the SQL to execute. For example {call getEmpName}.

resultHandler - the handler which is called once the operation completes. It will return a ResultSet.

See Also:

Statement.execute(String)

callWithParams

SQLOperations callWithParams(String sql,
                             JsonArray params,
                             JsonArray outputs,
                             Handler<AsyncResult<ResultSet>> resultHandler)

Calls the given SQL PROCEDURE which returns the result from the procedure. The index of params and outputs are important for both arrays, for example when dealing with a prodecure that takes the first 2 arguments as input values and the 3 arg as an output then the arrays should be like:

   params = [VALUE1, VALUE2, null]
   outputs = [null, null, "VARCHAR"]
 

Parameters:

sql - the SQL to execute. For example {call getEmpName (?, ?)}.

params - these are the parameters to fill the statement.

outputs - these are the outputs to fill the statement.

resultHandler - the handler which is called once the operation completes. It will return a ResultSet.

See Also:

Statement.execute(String)