MySQLConnection (Vert.x Stack

java.lang.Object
- io.vertx.reactivex.sqlclient.SqlClient
- - io.vertx.reactivex.sqlclient.SqlConnection
  - - io.vertx.reactivex.mysqlclient.MySQLConnection

All Implemented Interfaces:

io.vertx.lang.rx.RxDelegate
```
public class MySQLConnection
extends SqlConnection
implements io.vertx.lang.rx.RxDelegate
```
An interface which represents a connection to MySQL server.
The connection object supports all the operations defined in the interface, in addition it provides MySQL utility command support:
- COM_PING
- COM_CHANGE_USER
- COM_RESET_CONNECTION
- COM_DEBUG
- COM_INIT_DB
- COM_STATISTICS
- COM_SET_OPTION
NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields
Modifier and Type Field and Description

static io.vertx.lang.rx.TypeArg<MySQLConnection> __TYPE_ARG

Fields
Modifier and Type	Field and Description
`static io.vertx.lang.rx.TypeArg<MySQLConnection>`	`__TYPE_ARG`

Constructor Summary

Constructors
Constructor and Description

MySQLConnection(MySQLConnection delegate)

MySQLConnection(Object delegate)

Constructors
Constructor and Description
`MySQLConnection(MySQLConnection delegate)`
`MySQLConnection(Object delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MySQLConnection`	`cast(SqlConnection sqlConnection)` Cast a to `MySQLConnection`.
`MySQLConnection`	`changeUser(MySQLAuthOptions options)` Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
`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)` Create a connection to MySQL server with the given `connectOptions`.
`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)` Like `connect(io.vertx.reactivex.core.Vertx, io.vertx.mysqlclient.MySQLConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.mysqlclient.MySQLConnection>>)` with options built from `connectionUri`.
`static void`	`connect(Vertx vertx, String connectionUri, Handler<AsyncResult<MySQLConnection>> handler)` Like `connect(io.vertx.reactivex.core.Vertx, io.vertx.mysqlclient.MySQLConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.mysqlclient.MySQLConnection>>)` with options built from `connectionUri`.
`MySQLConnection`	`debug()` Send a DEBUG command to dump debug information to the server's stdout.
`MySQLConnection`	`debug(Handler<AsyncResult<Void>> handler)` Send a DEBUG command to dump debug information to the server's stdout.
`boolean`	`equals(Object o)`
`MySQLConnection`	`exceptionHandler(Handler<Throwable> handler)` Set an handler called with connection errors.
`MySQLConnection`	`getDelegate()`
`MySQLConnection`	`getInternalStatistics()` Send a STATISTICS command to get a human readable string of the server internal status.
`MySQLConnection`	`getInternalStatistics(Handler<AsyncResult<String>> handler)` Send a STATISTICS command to get a human readable string of the server internal status.
`int`	`hashCode()`
`static MySQLConnection`	`newInstance(MySQLConnection arg)`
`MySQLConnection`	`ping()` Send a PING command to check if the server is alive.
`MySQLConnection`	`ping(Handler<AsyncResult<Void>> handler)` Send a PING command to check if the server is alive.
`MySQLConnection`	`prepare(String sql)` Create a prepared statement using the given `sql` string.
`MySQLConnection`	`prepare(String sql, Handler<AsyncResult<PreparedStatement>> handler)` Create a prepared statement using the given `sql` string.
`MySQLConnection`	`resetConnection()` Send a RESET_CONNECTION command to reset the session state.
`MySQLConnection`	`resetConnection(Handler<AsyncResult<Void>> handler)` Send a RESET_CONNECTION command to reset the session state.
`Completable`	`rxChangeUser(MySQLAuthOptions options)` Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
`static Single<MySQLConnection>`	`rxConnect(Vertx vertx, MySQLConnectOptions connectOptions)` Create a connection to MySQL server with the given `connectOptions`.
`static Single<MySQLConnection>`	`rxConnect(Vertx vertx, String connectionUri)` Like `connect(io.vertx.reactivex.core.Vertx, io.vertx.mysqlclient.MySQLConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.mysqlclient.MySQLConnection>>)` with options built from `connectionUri`.
`Completable`	`rxDebug()` Send a DEBUG command to dump debug information to the server's stdout.
`Single<String>`	`rxGetInternalStatistics()` Send a STATISTICS command to get a human readable string of the server internal status.
`Completable`	`rxPing()` Send a PING command to check if the server is alive.
`Single<PreparedStatement>`	`rxPrepare(String sql)` Create a prepared statement using the given `sql` string.
`Completable`	`rxResetConnection()` Send a RESET_CONNECTION command to reset the session state.
`Completable`	`rxSetOption(MySQLSetOption option)` Send a SET_OPTION command to set options for the current connection.
`Completable`	`rxSpecifySchema(String schemaName)` Send a INIT_DB command to change the default schema of the connection.
`MySQLConnection`	`setOption(MySQLSetOption option)` Send a SET_OPTION command to set options for the current connection.
`MySQLConnection`	`setOption(MySQLSetOption option, Handler<AsyncResult<Void>> handler)` Send a SET_OPTION command to set options for the current connection.
`MySQLConnection`	`specifySchema(String schemaName)` Send a INIT_DB command to change the default schema of the connection.
`MySQLConnection`	`specifySchema(String schemaName, Handler<AsyncResult<Void>> handler)` Send a INIT_DB command to change the default schema of the connection.
`String`	`toString()`

Methods inherited from class io.vertx.reactivex.sqlclient.SqlConnection
begin, begin, close, close, databaseMetadata, isSSL, newInstance, prepare, prepare, rxBegin, rxClose, rxPrepare, transaction

Methods inherited from class io.vertx.reactivex.sqlclient.SqlClient
newInstance, preparedQuery, preparedQuery, query

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __TYPE_ARG
```
public static final io.vertx.lang.rx.TypeArg<MySQLConnection> __TYPE_ARG
```
- Constructor Detail
  - MySQLConnection
```
public MySQLConnection(MySQLConnection delegate)
```
  - MySQLConnection
```
public MySQLConnection(Object delegate)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class SqlConnection
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class SqlConnection
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class SqlConnection
  - getDelegate
```
public MySQLConnection getDelegate()
```
    Specified by:
    
    getDelegate in interface io.vertx.lang.rx.RxDelegate
    
    Overrides:
    
    getDelegate in class SqlConnection
  - connect
```
public 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
```
public static void connect(Vertx vertx,
                           MySQLConnectOptions connectOptions)
```
    Create a connection to MySQL server with the given connectOptions.
    
    Parameters:
    
    vertx - the vertx instance
    
    connectOptions - the options for the connection
  - rxConnect
```
public static Single<MySQLConnection> rxConnect(Vertx vertx,
                                                MySQLConnectOptions connectOptions)
```
    Create a connection to MySQL server with the given connectOptions.
    
    Parameters:
    
    vertx - the vertx instance
    
    connectOptions - the options for the connection
    
    Returns:
  - connect
```
public static void connect(Vertx vertx,
                           String connectionUri,
                           Handler<AsyncResult<MySQLConnection>> handler)
```
    Like connect(io.vertx.reactivex.core.Vertx, io.vertx.mysqlclient.MySQLConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.mysqlclient.MySQLConnection>>) with options built from connectionUri.
    
    Parameters:
    
    vertx -
    
    connectionUri -
    
    handler -
  - connect
```
public static void connect(Vertx vertx,
                           String connectionUri)
```
    Like connect(io.vertx.reactivex.core.Vertx, io.vertx.mysqlclient.MySQLConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.mysqlclient.MySQLConnection>>) with options built from connectionUri.
    
    Parameters:
    
    vertx -
    
    connectionUri -
  - rxConnect
```
public static Single<MySQLConnection> rxConnect(Vertx vertx,
                                                String connectionUri)
```
    Like connect(io.vertx.reactivex.core.Vertx, io.vertx.mysqlclient.MySQLConnectOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.mysqlclient.MySQLConnection>>) with options built from connectionUri.
    
    Parameters:
    
    vertx -
    
    connectionUri -
    
    Returns:
  - prepare
```
public MySQLConnection prepare(String sql,
                               Handler<AsyncResult<PreparedStatement>> handler)
```
    Description copied from class: SqlConnection
    
    Create a prepared statement using the given sql string.
    
    Overrides:
    
    prepare in class SqlConnection
    
    Parameters:
    
    sql -
    
    handler -
    
    Returns:
  - prepare
```
public MySQLConnection prepare(String sql)
```
    Description copied from class: SqlConnection
    
    Create a prepared statement using the given sql string.
    
    Overrides:
    
    prepare in class SqlConnection
    
    Parameters:
    
    sql -
    
    Returns:
  - rxPrepare
```
public Single<PreparedStatement> rxPrepare(String sql)
```
    Description copied from class: SqlConnection
    
    Create a prepared statement using the given sql string.
    
    Overrides:
    
    rxPrepare in class SqlConnection
    
    Parameters:
    
    sql -
    
    Returns:
  - exceptionHandler
```
public MySQLConnection exceptionHandler(Handler<Throwable> handler)
```
    Description copied from class: SqlConnection
    
    Set an handler called with connection errors.
    
    Overrides:
    
    exceptionHandler in class SqlConnection
    
    Parameters:
    
    handler -
    
    Returns:
  - closeHandler
```
public MySQLConnection closeHandler(Handler<Void> handler)
```
    Description copied from class: SqlConnection
    
    Set an handler called when the connection is closed.
    
    Overrides:
    
    closeHandler in class SqlConnection
    
    Parameters:
    
    handler -
    
    Returns:
  - ping
```
public 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
  - ping
```
public MySQLConnection ping()
```
    Send a PING command to check if the server is alive.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxPing
```
public Completable rxPing()
```
    Send a PING command to check if the server is alive.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - specifySchema
```
public 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
  - specifySchema
```
public MySQLConnection specifySchema(String schemaName)
```
    Send a INIT_DB command to change the default schema of the connection.
    
    Parameters:
    
    schemaName - name of the schema to change to
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxSpecifySchema
```
public Completable rxSpecifySchema(String schemaName)
```
    Send a INIT_DB command to change the default schema of the connection.
    
    Parameters:
    
    schemaName - name of the schema to change to
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getInternalStatistics
```
public 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
  - getInternalStatistics
```
public MySQLConnection getInternalStatistics()
```
    Send a STATISTICS command to get a human readable string of the server internal status.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxGetInternalStatistics
```
public Single<String> rxGetInternalStatistics()
```
    Send a STATISTICS command to get a human readable string of the server internal status.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setOption
```
public 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
  - setOption
```
public MySQLConnection setOption(MySQLSetOption option)
```
    Send a SET_OPTION command to set options for the current connection.
    
    Parameters:
    
    option - the options to set
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxSetOption
```
public Completable rxSetOption(MySQLSetOption option)
```
    Send a SET_OPTION command to set options for the current connection.
    
    Parameters:
    
    option - the options to set
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - resetConnection
```
public 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
  - resetConnection
```
public MySQLConnection resetConnection()
```
    Send a RESET_CONNECTION command to reset the session state.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxResetConnection
```
public Completable rxResetConnection()
```
    Send a RESET_CONNECTION command to reset the session state.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - debug
```
public 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
  - debug
```
public MySQLConnection debug()
```
    Send a DEBUG command to dump debug information to the server's stdout.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxDebug
```
public Completable rxDebug()
```
    Send a DEBUG command to dump debug information to the server's stdout.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - changeUser
```
public 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
  - changeUser
```
public MySQLConnection changeUser(MySQLAuthOptions options)
```
    Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
    
    Parameters:
    
    options - authentication options
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxChangeUser
```
public Completable rxChangeUser(MySQLAuthOptions options)
```
    Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
    
    Parameters:
    
    options - authentication options
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - cast
```
public static MySQLConnection cast(SqlConnection sqlConnection)
```
    Cast a to MySQLConnection. This is mostly useful for Vert.x generated APIs like RxJava/Mutiny.
    
    Parameters:
    
    sqlConnection - the connection to cast
    
    Returns:
    
    a instance
  - newInstance
```
public static MySQLConnection newInstance(MySQLConnection arg)
```

Class MySQLConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.vertx.reactivex.sqlclient.SqlConnection

Methods inherited from class io.vertx.reactivex.sqlclient.SqlClient

Methods inherited from class java.lang.Object

Field Detail

__TYPE_ARG

Constructor Detail

MySQLConnection

MySQLConnection

Method Detail

toString

equals

hashCode

getDelegate

connect

connect

rxConnect

connect

connect

rxConnect

prepare

prepare

rxPrepare

exceptionHandler

closeHandler

ping

ping

rxPing

specifySchema

specifySchema

rxSpecifySchema

getInternalStatistics

getInternalStatistics

rxGetInternalStatistics

setOption

setOption

rxSetOption

resetConnection

resetConnection

rxResetConnection

debug

debug

rxDebug

changeUser

changeUser

rxChangeUser

cast

newInstance