Package io.vertx.rxjava.sqlclient

Class SqlConnection

java.lang.Object

io.vertx.rxjava.sqlclient.SqlClient

io.vertx.rxjava.sqlclient.SqlConnection

Direct Known Subclasses:

DB2Connection, MSSQLConnection, MySQLConnection, OracleConnection, PgConnection

public class SqlConnection
extends SqlClient

A connection to the database server.

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	Description
static TypeArg<SqlConnection>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
SqlConnection(io.vertx.sqlclient.SqlConnection delegate)
SqlConnection(Object delegate)

Method Summary

Modifier and Type	Method	Description
void	begin()	Begin a transaction and returns a Transaction for controlling and tracking this transaction.
void	begin(io.vertx.core.Handler<io.vertx.core.AsyncResult<Transaction>> handler)	Begin a transaction and returns a Transaction for controlling and tracking this transaction.
void	close()	Close the current connection after all the pending commands have been processed.
void	close(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)	Close the current connection after all the pending commands have been processed.
SqlConnection	closeHandler(io.vertx.core.Handler<Void> handler)	Set an handler called when the connection is closed.
DatabaseMetadata	databaseMetadata()
boolean	equals(Object o)
SqlConnection	exceptionHandler(io.vertx.core.Handler<Throwable> handler)	Set an handler called with connection errors.
io.vertx.sqlclient.SqlConnection	getDelegate()
int	hashCode()
boolean	isSSL()
static SqlConnection	newInstance(io.vertx.sqlclient.SqlConnection arg)
SqlConnection	prepare(String sql)	Create a prepared statement using the given sql string.
SqlConnection	prepare(String sql, io.vertx.core.Handler<io.vertx.core.AsyncResult<PreparedStatement>> handler)	Create a prepared statement using the given sql string.
SqlConnection	prepare(String sql, io.vertx.sqlclient.PrepareOptions options)	Create a prepared statement using the given sql string.
SqlConnection	prepare(String sql, io.vertx.sqlclient.PrepareOptions options, io.vertx.core.Handler<io.vertx.core.AsyncResult<PreparedStatement>> handler)	Create a prepared statement using the given sql string.
rx.Single<Transaction>	rxBegin()	Begin a transaction and returns a Transaction for controlling and tracking this transaction.
rx.Single<Void>	rxClose()	Close the current connection after all the pending commands have been processed.
rx.Single<PreparedStatement>	rxPrepare(String sql)	Create a prepared statement using the given sql string.
rx.Single<PreparedStatement>	rxPrepare(String sql, io.vertx.sqlclient.PrepareOptions options)	Create a prepared statement using the given sql string.
String	toString()
Transaction	transaction()

Methods inherited from class io.vertx.rxjava.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 TypeArg<SqlConnection> __TYPE_ARG

Constructor Detail

SqlConnection

public SqlConnection(io.vertx.sqlclient.SqlConnection delegate)

SqlConnection

public SqlConnection(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class SqlClient

equals

public boolean equals(Object o)

Overrides:

equals in class SqlClient

hashCode

public int hashCode()

Overrides:

hashCode in class SqlClient

getDelegate

public io.vertx.sqlclient.SqlConnection getDelegate()

Overrides:

getDelegate in class SqlClient

prepare

public SqlConnection prepare(String sql,
                             io.vertx.core.Handler<io.vertx.core.AsyncResult<PreparedStatement>> handler)

Create a prepared statement using the given sql string.

Parameters:

sql - the sql

handler - the handler notified with the prepared query asynchronously

Returns:

prepare

public SqlConnection prepare(String sql)

Create a prepared statement using the given sql string.

Parameters:

sql - the sql

Returns:

rxPrepare

public rx.Single<PreparedStatement> rxPrepare(String sql)

Create a prepared statement using the given sql string.

Parameters:

sql - the sql

Returns:

prepare

public SqlConnection prepare(String sql,
                             io.vertx.sqlclient.PrepareOptions options,
                             io.vertx.core.Handler<io.vertx.core.AsyncResult<PreparedStatement>> handler)

Create a prepared statement using the given sql string.

Parameters:

sql - the sql

options -

handler - the handler notified with the prepared query asynchronously

Returns:

prepare

public SqlConnection prepare(String sql,
                             io.vertx.sqlclient.PrepareOptions options)

Create a prepared statement using the given sql string.

Parameters:

sql - the sql

options -

Returns:

rxPrepare

public rx.Single<PreparedStatement> rxPrepare(String sql,
                                              io.vertx.sqlclient.PrepareOptions options)

Create a prepared statement using the given sql string.

Parameters:

sql - the sql

options -

Returns:

exceptionHandler

public SqlConnection exceptionHandler(io.vertx.core.Handler<Throwable> handler)

Set an handler called with connection errors.

Parameters:

handler - the handler

Returns:

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

closeHandler

public SqlConnection closeHandler(io.vertx.core.Handler<Void> handler)

Set an handler called when the connection is closed.

Parameters:

handler - the handler

Returns:

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

begin

public void begin(io.vertx.core.Handler<io.vertx.core.AsyncResult<Transaction>> handler)

Begin a transaction and returns a Transaction for controlling and tracking this transaction.

When the connection is explicitely closed, any inflight transaction is rollbacked.

Parameters:

handler -

begin

public void begin()

Begin a transaction and returns a Transaction for controlling and tracking this transaction.

When the connection is explicitely closed, any inflight transaction is rollbacked.

rxBegin

public rx.Single<Transaction> rxBegin()

Begin a transaction and returns a Transaction for controlling and tracking this transaction.

When the connection is explicitely closed, any inflight transaction is rollbacked.

Returns:

transaction

public Transaction transaction()

Returns:

the current transaction if it exists, otherwise null

isSSL

public boolean isSSL()

Returns:

whether the connection uses SSL

close

public void close(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)

Close the current connection after all the pending commands have been processed.

Overrides:

close in class SqlClient

Parameters:

handler - the completion handler

close

public void close()

Close the current connection after all the pending commands have been processed.

Overrides:

close in class SqlClient

rxClose

public rx.Single<Void> rxClose()

Close the current connection after all the pending commands have been processed.

Overrides:

rxClose in class SqlClient

Returns:

databaseMetadata

public DatabaseMetadata databaseMetadata()

Returns:

The static metadata about the backend database server for this connection

newInstance

public static SqlConnection newInstance(io.vertx.sqlclient.SqlConnection arg)