io.vertx.rxjava.oracleclient

## Class OraclePool

- java.lang.Object
- - io.vertx.rxjava.sqlclient.SqlClient
  - - io.vertx.rxjava.sqlclient.Pool
    - - io.vertx.rxjava.oracleclient.OraclePool

-     public class OraclePool
      extends Pool

  Represents a pool of connection to interact with an Oracle database.

  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<OraclePool>` | `__TYPE_ARG`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `OraclePool(io.vertx.oracleclient.OraclePool delegate)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `OraclePool` | `connectHandler(Handler<SqlConnection> handler)` Set an handler called when the pool has established a connection to the database.
    `OraclePool` | `connectionProvider(java.util.function.Function<Context,Future<SqlConnection>> provider)` Replace the default pool connection provider, the new `provider` returns a future connection for a given .
    `boolean` | `equals(Object o)`
    `io.vertx.oracleclient.OraclePool` | `getDelegate()`
    `int` | `hashCode()`
    `static OraclePool` | `newInstance(io.vertx.oracleclient.OraclePool arg)`
    `static OraclePool` | `pool(io.vertx.oracleclient.OracleConnectOptions connectOptions, PoolOptions poolOptions)`
    `static OraclePool` | `pool(java.util.function.Supplier<Future<io.vertx.oracleclient.OracleConnectOptions>> databases, PoolOptions poolOptions)` Create a connection pool to the Oracle `databases`.
    `static OraclePool` | `pool(Vertx vertx, io.vertx.oracleclient.OracleConnectOptions connectOptions, PoolOptions poolOptions)` Like `pool(io.vertx.oracleclient.OracleConnectOptions, io.vertx.sqlclient.PoolOptions)` with a specific instance.
    `static OraclePool` | `pool(Vertx vertx, java.util.function.Supplier<Future<io.vertx.oracleclient.OracleConnectOptions>> databases, PoolOptions poolOptions)` Like `pool(io.vertx.oracleclient.OracleConnectOptions, io.vertx.sqlclient.PoolOptions)` with a specific instance.
    `String` | `toString()`

    - ### Methods inherited from class io.vertx.rxjava.sqlclient.Pool

      `close, close, getConnection, getConnection, newInstance, pool, pool, pool, preparedQuery, query, rxClose, rxGetConnection, rxWithConnection, rxWithTransaction, rxWithTransaction, size, withConnection, withConnection, withTransaction, withTransaction, withTransaction, withTransaction`

    - ### Methods inherited from class io.vertx.rxjava.sqlclient.SqlClient

      `newInstance, preparedQuery`

    - ### 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<OraclePool> __TYPE_ARG

  - ### Constructor Detail

    - #### OraclePool

          public OraclePool(io.vertx.oracleclient.OraclePool delegate)

  - ### Method Detail

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Pool`

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `Pool`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Pool`

    - #### getDelegate

          public io.vertx.oracleclient.OraclePool getDelegate()

      Overrides:
        `getDelegate` in class `Pool`

    - #### pool

          public static OraclePool pool(io.vertx.oracleclient.OracleConnectOptions connectOptions,
                                        PoolOptions poolOptions)

    - #### pool

          public static OraclePool pool(Vertx vertx,
                                        io.vertx.oracleclient.OracleConnectOptions connectOptions,
                                        PoolOptions poolOptions)

      Like `pool(io.vertx.oracleclient.OracleConnectOptions, io.vertx.sqlclient.PoolOptions)` with a specific instance.
      Parameters:
        `vertx` -
        `connectOptions` -
        `poolOptions` -
      Returns:

    - #### connectHandler

          public OraclePool connectHandler(Handler<SqlConnection> handler)

      Description copied from class: `Pool`
      Set an handler called when the pool has established a connection to the database.

      This handler allows interactions with the database before the connection is added to the pool.

      When the handler has finished, it must call `SqlClient.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)` to release the connection to the pool.

      Overrides:
        `connectHandler` in class `Pool`
      Parameters:
        `handler` - the handler
      Returns:
        a reference to this, so the API can be used fluently

    - #### connectionProvider

          public OraclePool connectionProvider(java.util.function.Function<Context,Future<SqlConnection>> provider)

      Description copied from class: `Pool`
      Replace the default pool connection provider, the new `provider` returns a future connection for a given .

      A `ConnectionFactory` can be used as connection provider.

      Overrides:
        `connectionProvider` in class `Pool`
      Parameters:
        `provider` - the new connection provider
      Returns:
        a reference to this, so the API can be used fluently

    - #### pool

          public static OraclePool pool(java.util.function.Supplier<Future<io.vertx.oracleclient.OracleConnectOptions>> databases,
                                        PoolOptions poolOptions)

      Create a connection pool to the Oracle `databases`. The supplier is called to provide the options when a new connection is created by the pool.
      Parameters:
        `databases` - the databases supplier
        `poolOptions` - the options for creating the pool
      Returns:
        the connection pool

    - #### pool

          public static OraclePool pool(Vertx vertx,
                                        java.util.function.Supplier<Future<io.vertx.oracleclient.OracleConnectOptions>> databases,
                                        PoolOptions poolOptions)

      Like `pool(io.vertx.oracleclient.OracleConnectOptions, io.vertx.sqlclient.PoolOptions)` with a specific instance.
      Parameters:
        `vertx` -
        `databases` -
        `poolOptions` -
      Returns:

    - #### newInstance

          public static OraclePool newInstance(io.vertx.oracleclient.OraclePool arg)

Copyright © 2023 Eclipse. All rights reserved.