## Uses of Class
io.vertx.sqlclient.PoolOptions

- Packages that use PoolOptions
  Package | Description
  --- | ---
  io.vertx.db2client.spi |
  io.vertx.jdbcclient |
  io.vertx.mssqlclient.spi |
  io.vertx.mysqlclient.spi |
  io.vertx.oracleclient.spi |
  io.vertx.pgclient.spi |
  io.vertx.reactivex.jdbcclient |
  io.vertx.reactivex.sqlclient |
  io.vertx.rxjava3.jdbcclient |
  io.vertx.rxjava3.sqlclient |
  io.vertx.sqlclient |
  io.vertx.sqlclient.spi |

- - ### Uses of PoolOptions in io.vertx.db2client.spi

    Methods in io.vertx.db2client.spi with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `Pool` | DB2Driver.`newPool​(Vertx vertx, java.util.function.Supplier<Future<DB2ConnectOptions>> databases, PoolOptions poolOptions, NetClientOptions transportOptions, Handler<SqlConnection> connectHandler, io.vertx.core.internal.CloseFuture closeFuture)` |

  - ### Uses of PoolOptions in io.vertx.jdbcclient

    Methods in io.vertx.jdbcclient with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Pool` | JDBCPool.`pool​(Vertx vertx, JDBCConnectOptions connectOptions, PoolOptions poolOptions)` | Create a JDBC pool which maintains its own data source.
    `static Pool` | JDBCPool.`pool​(Vertx vertx, DataSource dataSource, PoolOptions poolOptions)` | Create a JDBC pool using a pre-initialized data source, note this data source does not need to be a pool.

  - ### Uses of PoolOptions in io.vertx.mssqlclient.spi

    Methods in io.vertx.mssqlclient.spi with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `Pool` | MSSQLDriver.`newPool​(Vertx vertx, java.util.function.Supplier<Future<MSSQLConnectOptions>> databases, PoolOptions options, NetClientOptions transportOptions, Handler<SqlConnection> connectHandler, io.vertx.core.internal.CloseFuture closeFuture)` |

  - ### Uses of PoolOptions in io.vertx.mysqlclient.spi

    Methods in io.vertx.mysqlclient.spi with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `Pool` | MySQLDriver.`newPool​(Vertx vertx, java.util.function.Supplier<Future<MySQLConnectOptions>> databases, PoolOptions options, NetClientOptions transportOptions, Handler<SqlConnection> connectHandler, io.vertx.core.internal.CloseFuture closeFuture)` |

  - ### Uses of PoolOptions in io.vertx.oracleclient.spi

    Methods in io.vertx.oracleclient.spi with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `Pool` | OracleDriver.`newPool​(Vertx vertx, java.util.function.Supplier<Future<OracleConnectOptions>> databases, PoolOptions options, NetClientOptions transportOptions, Handler<SqlConnection> connectHandler, io.vertx.core.internal.CloseFuture closeFuture)` |

  - ### Uses of PoolOptions in io.vertx.pgclient.spi

    Methods in io.vertx.pgclient.spi with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `Pool` | PgDriver.`newPool​(Vertx vertx, java.util.function.Supplier<Future<PgConnectOptions>> databases, PoolOptions poolOptions, NetClientOptions transportOptions, Handler<SqlConnection> connectHandler, io.vertx.core.internal.CloseFuture closeFuture)` |

  - ### Uses of PoolOptions in io.vertx.reactivex.jdbcclient

    Methods in io.vertx.reactivex.jdbcclient with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Pool` | JDBCPool.`pool​(Vertx vertx, JDBCConnectOptions connectOptions, PoolOptions poolOptions)` | Create a JDBC pool which maintains its own data source.
    `static Pool` | JDBCPool.`pool​(Vertx vertx, DataSource dataSource, PoolOptions poolOptions)` | Create a JDBC pool using a pre-initialized data source, note this data source does not need to be a pool.

  - ### Uses of PoolOptions in io.vertx.reactivex.sqlclient

    Methods in io.vertx.reactivex.sqlclient with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Pool` | Pool.`pool​(Vertx vertx, SqlConnectOptions database, PoolOptions options)` | Create a connection pool to the `database` with the given `options`.
    `static Pool` | Pool.`pool​(SqlConnectOptions database, PoolOptions options)` | Like `Pool.pool(io.vertx.sqlclient.SqlConnectOptions)` with a Vert.x instance created automatically.
    `ClientBuilder<C>` | ClientBuilder.`with​(PoolOptions options)` | Configure the client with the given pool `options`

  - ### Uses of PoolOptions in io.vertx.rxjava3.jdbcclient

    Methods in io.vertx.rxjava3.jdbcclient with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Pool` | JDBCPool.`pool​(Vertx vertx, JDBCConnectOptions connectOptions, PoolOptions poolOptions)` | Create a JDBC pool which maintains its own data source.
    `static Pool` | JDBCPool.`pool​(Vertx vertx, DataSource dataSource, PoolOptions poolOptions)` | Create a JDBC pool using a pre-initialized data source, note this data source does not need to be a pool.

  - ### Uses of PoolOptions in io.vertx.rxjava3.sqlclient

    Methods in io.vertx.rxjava3.sqlclient with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Pool` | Pool.`pool​(Vertx vertx, SqlConnectOptions database, PoolOptions options)` | Create a connection pool to the `database` with the given `options`.
    `static Pool` | Pool.`pool​(SqlConnectOptions database, PoolOptions options)` | Like `Pool.pool(io.vertx.sqlclient.SqlConnectOptions)` with a Vert.x instance created automatically.
    `ClientBuilder<C>` | ClientBuilder.`with​(PoolOptions options)` | Configure the client with the given pool `options`

  - ### Uses of PoolOptions in io.vertx.sqlclient

    Methods in io.vertx.sqlclient that return PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `PoolOptions` | PoolOptions.`setConnectionTimeout​(int timeout)` | Set the amount of time a client will wait for a connection from the pool.
    `PoolOptions` | PoolOptions.`setConnectionTimeoutUnit​(TimeUnit timeoutUnit)` | Set the time unit of `setConnectionTimeout(int)`
    `PoolOptions` | PoolOptions.`setEventLoopSize​(int eventLoopSize)` | Set the number of event-loop the pool use.
    `PoolOptions` | PoolOptions.`setIdleTimeout​(int idleTimeout)` | Establish an idle timeout for pooled connections, a value of zero disables the idle timeout.
    `PoolOptions` | PoolOptions.`setIdleTimeoutUnit​(TimeUnit idleTimeoutUnit)` | Establish an idle timeout unit for pooled connections.
    `PoolOptions` | PoolOptions.`setMaxLifetime​(int maxLifetime)` | Establish a max lifetime for pooled connections, a value of zero disables the maximum lifetime.
    `PoolOptions` | PoolOptions.`setMaxLifetimeUnit​(TimeUnit maxLifetimeUnit)` | Establish a max lifetime unit for pooled connections.
    `PoolOptions` | PoolOptions.`setMaxSize​(int maxSize)` | Set the maximum pool size
    `PoolOptions` | PoolOptions.`setMaxWaitQueueSize​(int maxWaitQueueSize)` | Set the maximum connection request allowed in the wait queue, any requests beyond the max size will result in an failure.
    `PoolOptions` | PoolOptions.`setName​(String name)` | Set the pool name, used when the pool shared, otherwise ignored.
    `PoolOptions` | PoolOptions.`setPoolCleanerPeriod​(int poolCleanerPeriod)` | Set the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed.
    `PoolOptions` | PoolOptions.`setShared​(boolean shared)` | Set to `true` to share the pool.

    Methods in io.vertx.sqlclient with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Pool` | Pool.`pool​(Vertx vertx, SqlConnectOptions database, PoolOptions options)` | Create a connection pool to the `database` with the given `options`.
    `static Pool` | Pool.`pool​(SqlConnectOptions database, PoolOptions options)` | Like `Pool.pool(Vertx, SqlConnectOptions, PoolOptions)` with a Vert.x instance created automatically.
    `ClientBuilder<C>` | ClientBuilder.`with​(PoolOptions options)` | Configure the client with the given pool `options`

    Constructors in io.vertx.sqlclient with parameters of type PoolOptions
    Constructor | Description
    --- | ---
    `PoolOptions​(PoolOptions other)` |

  - ### Uses of PoolOptions in io.vertx.sqlclient.spi

    Methods in io.vertx.sqlclient.spi with parameters of type PoolOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `default Pool` | Driver.`createPool​(Vertx vertx, java.util.function.Supplier<Future<C>> databases, PoolOptions poolOptions, NetClientOptions transportOptions, Handler<SqlConnection> connectHandler)` | Create a connection pool to the database configured with the given `connectOptions` and `poolOptions`.
    `Pool` | Driver.`newPool​(Vertx vertx, java.util.function.Supplier<Future<C>> databases, PoolOptions options, NetClientOptions transportOptions, Handler<SqlConnection> connectHandler, io.vertx.core.internal.CloseFuture closeFuture)` | Create a connection pool to the database configured with the given `connectOptions` and `poolOptions`.