io.vertx.db2client

Interface DB2Connection

All Superinterfaces:

SqlClient, SqlConnection

public interface DB2Connection
extends SqlConnection

A connection to DB2 server.

Method Summary

Modifier and Type	Method and Description
DB2Connection	closeHandler(Handler<Void> handler) Set an handler called when the connection is closed.
static void	connect(Vertx vertx, DB2ConnectOptions connectOptions, Handler<AsyncResult<DB2Connection>> handler) Create a connection to DB2 server with the given connectOptions.
static void	connect(Vertx vertx, String connectionUri, Handler<AsyncResult<DB2Connection>> handler) Like connect(Vertx, DB2ConnectOptions, Handler) with options build from connectionUri.
DB2Connection	debug(Handler<AsyncResult<Void>> handler) Send a DEBUG command to dump debug information to the server's stdout.
DB2Connection	exceptionHandler(Handler<Throwable> handler) Set an handler called with connection errors.
DB2Connection	ping(Handler<AsyncResult<Void>> handler) Send a PING command to check if the server is alive.
DB2Connection	prepare(String sql, Handler<AsyncResult<PreparedStatement>> handler) Create a prepared query.

Methods inherited from interface io.vertx.sqlclient.SqlConnection

begin, close, databaseMetadata, isSSL

Methods inherited from interface io.vertx.sqlclient.SqlClient

preparedQuery, query

Method Detail

connect

static void connect(Vertx vertx,
                    DB2ConnectOptions connectOptions,
                    Handler<AsyncResult<DB2Connection>> handler)

Create a connection to DB2 server with the given connectOptions.

Parameters:

vertx - the vertx instance

connectOptions - the options for the connection

handler - the handler called with the connection or the failure

connect

static void connect(Vertx vertx,
                    String connectionUri,
                    Handler<AsyncResult<DB2Connection>> handler)

Like connect(Vertx, DB2ConnectOptions, Handler) with options build from connectionUri.

prepare

DB2Connection prepare(String sql,
                      Handler<AsyncResult<PreparedStatement>> handler)

Description copied from interface: SqlConnection

Create a prepared query.

Specified by:

prepare in interface SqlConnection

Parameters:

sql - the sql

handler - the handler notified with the prepared query asynchronously

exceptionHandler

DB2Connection exceptionHandler(Handler<Throwable> handler)

Description copied from interface: SqlConnection

Set an handler called with connection errors.

Specified by:

exceptionHandler in interface SqlConnection

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

closeHandler

DB2Connection closeHandler(Handler<Void> handler)

Description copied from interface: SqlConnection

Set an handler called when the connection is closed.

Specified by:

closeHandler in interface SqlConnection

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

ping

DB2Connection ping(Handler<AsyncResult<Void>> handler)

Send a PING command to check if the server is alive.

Parameters:

handler - the handler notified when the server responses to client

Returns:

a reference to this, so the API can be used fluently

debug

DB2Connection debug(Handler<AsyncResult<Void>> handler)

Send a DEBUG command to dump debug information to the server's stdout.

Parameters:

handler - the handler notified with the execution result

Returns:

a reference to this, so the API can be used fluently