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

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

- - ### Uses of SqlConnectOptions in io.vertx.db2client

    Subclasses of SqlConnectOptions in io.vertx.db2client
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `DB2ConnectOptions` | Connect options for configuring `DB2Connection` or `DB2Builder`.

    Methods in io.vertx.db2client with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static DB2ConnectOptions` | DB2ConnectOptions.`wrap​(SqlConnectOptions options)` |

    Constructors in io.vertx.db2client with parameters of type SqlConnectOptions
    Constructor | Description
    --- | ---
    `DB2ConnectOptions​(SqlConnectOptions other)` |

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

    Methods in io.vertx.db2client.spi with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | DB2Driver.`acceptsOptions​(SqlConnectOptions options)` |
    `DB2ConnectOptions` | DB2Driver.`downcast​(SqlConnectOptions connectOptions)` |

  - ### Uses of SqlConnectOptions in io.vertx.mssqlclient

    Subclasses of SqlConnectOptions in io.vertx.mssqlclient
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `MSSQLConnectOptions` | Connect options for configuring `MSSQLConnection`.

    Methods in io.vertx.mssqlclient with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static MSSQLConnectOptions` | MSSQLConnectOptions.`wrap​(SqlConnectOptions options)` |

    Constructors in io.vertx.mssqlclient with parameters of type SqlConnectOptions
    Constructor | Description
    --- | ---
    `MSSQLConnectOptions​(SqlConnectOptions other)` |

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

    Methods in io.vertx.mssqlclient.spi with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | MSSQLDriver.`acceptsOptions​(SqlConnectOptions options)` |
    `MSSQLConnectOptions` | MSSQLDriver.`downcast​(SqlConnectOptions connectOptions)` |

  - ### Uses of SqlConnectOptions in io.vertx.mysqlclient

    Subclasses of SqlConnectOptions in io.vertx.mysqlclient
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `MySQLConnectOptions` | Connect options for configuring `MySQLConnection` or `MySQLBuilder`.

    Methods in io.vertx.mysqlclient with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static MySQLConnectOptions` | MySQLConnectOptions.`wrap​(SqlConnectOptions options)` |

    Constructors in io.vertx.mysqlclient with parameters of type SqlConnectOptions
    Constructor | Description
    --- | ---
    `MySQLConnectOptions​(SqlConnectOptions other)` |

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

    Methods in io.vertx.mysqlclient.spi with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | MySQLDriver.`acceptsOptions​(SqlConnectOptions options)` |
    `MySQLConnectOptions` | MySQLDriver.`downcast​(SqlConnectOptions connectOptions)` |

  - ### Uses of SqlConnectOptions in io.vertx.oracleclient

    Subclasses of SqlConnectOptions in io.vertx.oracleclient
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `OracleConnectOptions` |

    Methods in io.vertx.oracleclient with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static OracleConnectOptions` | OracleConnectOptions.`wrap​(SqlConnectOptions options)` |

    Constructors in io.vertx.oracleclient with parameters of type SqlConnectOptions
    Constructor | Description
    --- | ---
    `OracleConnectOptions​(SqlConnectOptions options)` |

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

    Methods in io.vertx.oracleclient.spi with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | OracleDriver.`acceptsOptions​(SqlConnectOptions options)` |
    `OracleConnectOptions` | OracleDriver.`downcast​(SqlConnectOptions connectOptions)` |

  - ### Uses of SqlConnectOptions in io.vertx.pgclient

    Subclasses of SqlConnectOptions in io.vertx.pgclient
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `PgConnectOptions` |

    Methods in io.vertx.pgclient with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `static PgConnectOptions` | PgConnectOptions.`wrap​(SqlConnectOptions options)` |

    Constructors in io.vertx.pgclient with parameters of type SqlConnectOptions
    Constructor | Description
    --- | ---
    `PgConnectOptions​(SqlConnectOptions other)` |

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

    Methods in io.vertx.pgclient.spi with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | PgDriver.`acceptsOptions​(SqlConnectOptions options)` |
    `PgConnectOptions` | PgDriver.`downcast​(SqlConnectOptions connectOptions)` |

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

    Methods in io.vertx.reactivex.sqlclient with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `ClientBuilder<C>` | ClientBuilder.`connectingTo​(SqlConnectOptions database)` | Configure the `database` the client should connect to.
    `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 connectOptions)` | Like `Pool.pool(io.vertx.sqlclient.SqlConnectOptions)` with default options.
    `static Pool` | Pool.`pool​(SqlConnectOptions database, PoolOptions options)` | Like `Pool.pool(io.vertx.sqlclient.SqlConnectOptions)` with a Vert.x instance created automatically.

    Method parameters in io.vertx.reactivex.sqlclient with type arguments of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `ClientBuilder<C>` | ClientBuilder.`connectingTo​(java.util.function.Supplier<Future<SqlConnectOptions>> supplier)` | Configure the `database` the client should connect to.
    `ClientBuilder<C>` | ClientBuilder.`connectingTo​(List<SqlConnectOptions> databases)` | Configure the `database` the client should connect to.

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

    Methods in io.vertx.rxjava3.sqlclient with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `ClientBuilder<C>` | ClientBuilder.`connectingTo​(SqlConnectOptions database)` | Configure the `database` the client should connect to.
    `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 connectOptions)` | Like `Pool.pool(io.vertx.sqlclient.SqlConnectOptions)` with default options.
    `static Pool` | Pool.`pool​(SqlConnectOptions database, PoolOptions options)` | Like `Pool.pool(io.vertx.sqlclient.SqlConnectOptions)` with a Vert.x instance created automatically.

    Method parameters in io.vertx.rxjava3.sqlclient with type arguments of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `ClientBuilder<C>` | ClientBuilder.`connectingTo​(java.util.function.Supplier<Single<SqlConnectOptions>> supplier)` | Configure the `database` the client should connect to.
    `ClientBuilder<C>` | ClientBuilder.`connectingTo​(List<SqlConnectOptions> databases)` | Configure the `database` the client should connect to.

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

    Methods in io.vertx.sqlclient that return SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `SqlConnectOptions` | SqlConnectOptions.`addProperty​(String key, String value)` | Add a property for this client, which will be sent to server at the connection start.
    `static SqlConnectOptions` | SqlConnectOptions.`fromUri​(String connectionUri)` | Provide a `SqlConnectOptions` subclass configured from `connectionUri`.
    `SqlConnectOptions` | SqlConnectOptions.`merge​(JsonObject other)` | Returns new options created after this object and merged with the `other` json config.
    `SqlConnectOptions` | SqlConnectOptions.`setCachePreparedStatements​(boolean cachePreparedStatements)` | Set whether prepared statements cache should be enabled.
    `SqlConnectOptions` | SqlConnectOptions.`setDatabase​(String database)` | Specify the default database for the connection.
    `SqlConnectOptions` | SqlConnectOptions.`setHost​(String host)` | Specify the host for connecting to the server.
    `SqlConnectOptions` | SqlConnectOptions.`setMetricsName​(String metricsName)` | Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.
    `SqlConnectOptions` | SqlConnectOptions.`setPassword​(String password)` | Specify the user password to be used for the authentication.
    `SqlConnectOptions` | SqlConnectOptions.`setPort​(int port)` | Specify the port for connecting to the server.
    `SqlConnectOptions` | SqlConnectOptions.`setPreparedStatementCacheMaxSize​(int preparedStatementCacheMaxSize)` | Set the maximum number of prepared statements that the connection will cache.
    `SqlConnectOptions` | SqlConnectOptions.`setPreparedStatementCacheSqlFilter​(java.util.function.Predicate<String> predicate)` | Set a predicate filtering prepared statements that the connection will cache.
    `SqlConnectOptions` | SqlConnectOptions.`setPreparedStatementCacheSqlLimit​(int preparedStatementCacheSqlLimit)` | Set the maximum length of prepared statement SQL string that the connection will cache.
    `SqlConnectOptions` | SqlConnectOptions.`setProperties​(Map<String,​String> properties)` | Set properties for this client, which will be sent to server at the connection start.
    `SqlConnectOptions` | SqlConnectOptions.`setReconnectAttempts​(int attempts)` | Set the value of reconnect attempts
    `SqlConnectOptions` | SqlConnectOptions.`setReconnectInterval​(long interval)` | Set the reconnect interval
    `SqlConnectOptions` | SqlConnectOptions.`setSslOptions​(ClientSSLOptions sslOptions)` |
    `SqlConnectOptions` | SqlConnectOptions.`setTracingPolicy​(TracingPolicy tracingPolicy)` | Set the tracing policy for the client behavior when Vert.x has tracing enabled.
    `SqlConnectOptions` | SqlConnectOptions.`setUser​(String user)` | Specify the user account to be used for the authentication.

    Methods in io.vertx.sqlclient with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `ClientBuilder<C>` | ClientBuilder.`connectingTo​(SqlConnectOptions database)` | Configure the `database` the client should connect to.
    `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 connectOptions)` | Like `Pool.pool(SqlConnectOptions, PoolOptions)` with default options.
    `static Pool` | Pool.`pool​(SqlConnectOptions database, PoolOptions options)` | Like `Pool.pool(Vertx, SqlConnectOptions, PoolOptions)` with a Vert.x instance created automatically.

    Method parameters in io.vertx.sqlclient with type arguments of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `ClientBuilder<C>` | ClientBuilder.`connectingTo​(java.util.function.Supplier<Future<SqlConnectOptions>> supplier)` | Configure the `database` the client should connect to.
    `ClientBuilder<C>` | ClientBuilder.`connectingTo​(List<SqlConnectOptions> databases)` | Configure the `database` the client should connect to.

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

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

    Classes in io.vertx.sqlclient.spi with type parameters of type SqlConnectOptions
    Modifier and Type | Interface | Description
    --- | --- | ---
    `interface` | `ConnectionFactory<C extends SqlConnectOptions>` | A connection factory, can be obtained from `Driver.createConnectionFactory(io.vertx.core.Vertx, io.vertx.core.net.NetClientOptions)`
    `interface` | `Driver<C extends SqlConnectOptions>` | An entry point to the Vertx Reactive SQL Client Every driver must implement this interface.

    Methods in io.vertx.sqlclient.spi that return SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `SqlConnectOptions` | Driver.`parseConnectionUri​(String uri)` |

    Methods in io.vertx.sqlclient.spi with parameters of type SqlConnectOptions
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | Driver.`acceptsOptions​(SqlConnectOptions connectOptions)` |
    `C` | Driver.`downcast​(SqlConnectOptions connectOptions)` | Downcast the connect options to the specific driver options.