Class SqlConnection

java.lang.Object
io.vertx.reactivex.sqlclient.SqlClient
io.vertx.reactivex.sqlclient.SqlConnection
All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
Direct Known Subclasses:
DB2Connection, JDBCConnection, MSSQLConnection, MySQLConnection, OracleConnection, PgConnection
public class SqlConnection extends SqlClient implements io.vertx.lang.rx.RxDelegate
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 Details

    • __TYPE_ARG

      public static final io.vertx.lang.rx.TypeArg<SqlConnection> __TYPE_ARG

  • Constructor Details

    • SqlConnection

      public SqlConnection(SqlConnection delegate)

    • SqlConnection

      public SqlConnection(Object delegate)

  • Method Details

    • 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 SqlConnection getDelegate()
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate
      Overrides:
      getDelegate in class SqlClient

    • prepare

      public Future<PreparedStatement> prepare(String sql)
      Create a prepared statement using the given sql string.
      Parameters:
      sql - the sql
      Returns:
      a future notified with the prepared statement

    • rxPrepare

      public Single<PreparedStatement> rxPrepare(String sql)
      Create a prepared statement using the given sql string.
      Parameters:
      sql - the sql
      Returns:
      a future notified with the prepared statement

    • prepare

      public Future<PreparedStatement> prepare(String sql, PrepareOptions options)
      Create a prepared statement using the given sql string.
      Parameters:
      sql - the sql
      options -
      Returns:
      a future notified with the prepared statement

    • rxPrepare

      public Single<PreparedStatement> rxPrepare(String sql, PrepareOptions options)
      Create a prepared statement using the given sql string.
      Parameters:
      sql - the sql
      options -
      Returns:
      a future notified with the prepared statement

    • exceptionHandler

      public SqlConnection exceptionHandler(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(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 Future<Transaction> 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.

      Returns:
      a future notified with the transactino

    • rxBegin

      public 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:
      a future notified with the transactino

    • transaction

      public Transaction transaction()
      Returns:
      the current transaction if it exists, otherwise null

    • isSSL

      public boolean isSSL()
      Returns:
      whether the connection uses SSL

    • databaseMetadata

      public DatabaseMetadata databaseMetadata()
      Returns:
      The static metadata about the backend database server for this connection

    • newInstance

      public static SqlConnection newInstance(SqlConnection arg)