io.vertx.mysqlclient

Interface MySQLConnection

All Superinterfaces:

SqlClient, SqlConnection

public interface MySQLConnection
extends SqlConnection

A connection to MySQL server.

Method Summary

Modifier and Type	Method and Description
MySQLConnection	changeUser(MySQLAuthOptions options, Handler<AsyncResult<Void>> handler) Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
MySQLConnection	closeHandler(Handler<Void> handler) Set an handler called when the connection is closed.
static void	connect(Vertx vertx, MySQLConnectOptions connectOptions, Handler<AsyncResult<MySQLConnection>> handler) Create a connection to MySQL server with the given connectOptions.
static void	connect(Vertx vertx, String connectionUri, Handler<AsyncResult<MySQLConnection>> handler) Like connect(Vertx, MySQLConnectOptions, Handler) with options build from connectionUri.
MySQLConnection	debug(Handler<AsyncResult<Void>> handler) Send a DEBUG command to dump debug information to the server's stdout.
MySQLConnection	exceptionHandler(Handler<Throwable> handler) Set an handler called with connection errors.
MySQLConnection	getInternalStatistics(Handler<AsyncResult<String>> handler) Send a STATISTICS command to get a human readable string of the server internal status.
MySQLConnection	ping(Handler<AsyncResult<Void>> handler) Send a PING command to check if the server is alive.
MySQLConnection	prepare(String sql, Handler<AsyncResult<PreparedStatement>> handler) Create a prepared query.
MySQLConnection	resetConnection(Handler<AsyncResult<Void>> handler) Send a RESET_CONNECTION command to reset the session state.
MySQLConnection	setOption(MySQLSetOption option, Handler<AsyncResult<Void>> handler) Send a SET_OPTION command to set options for the current connection.
MySQLConnection	specifySchema(String schemaName, Handler<AsyncResult<Void>> handler) Send a INIT_DB command to change the default schema of the connection.

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,
                    MySQLConnectOptions connectOptions,
                    Handler<AsyncResult<MySQLConnection>> handler)

Create a connection to MySQL 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<MySQLConnection>> handler)

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

prepare

MySQLConnection 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

MySQLConnection 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

MySQLConnection 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

MySQLConnection 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

specifySchema

MySQLConnection specifySchema(String schemaName,
                              Handler<AsyncResult<Void>> handler)

Send a INIT_DB command to change the default schema of the connection.

Parameters:

schemaName - name of the schema to change to

handler - the handler notified with the execution result

Returns:

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

getInternalStatistics

MySQLConnection getInternalStatistics(Handler<AsyncResult<String>> handler)

Send a STATISTICS command to get a human readable string of the server internal status.

Parameters:

handler - the handler notified with the execution result

Returns:

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

setOption

MySQLConnection setOption(MySQLSetOption option,
                          Handler<AsyncResult<Void>> handler)

Send a SET_OPTION command to set options for the current connection.

Parameters:

option - the options to set

handler - the handler notified with the execution result

Returns:

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

resetConnection

MySQLConnection resetConnection(Handler<AsyncResult<Void>> handler)

Send a RESET_CONNECTION command to reset the session state.

Parameters:

handler - the handler notified with the execution result

Returns:

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

debug

MySQLConnection 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

changeUser

MySQLConnection changeUser(MySQLAuthOptions options,
                           Handler<AsyncResult<Void>> handler)

Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.

Parameters:

options - authentication options

handler - the handler

Returns:

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