## Uses of Interface
io.vertx.sqlclient.SqlClient

- Packages that use SqlClient
  Package | Description
  --- | ---
  io.vertx.db2client |
  io.vertx.ext.auth.sqlclient |
  io.vertx.jdbcclient |
  io.vertx.mssqlclient |
  io.vertx.mysqlclient |
  io.vertx.pgclient |
  io.vertx.reactivex.sqlclient |
  io.vertx.rxjava.sqlclient |
  io.vertx.rxjava3.sqlclient |
  io.vertx.sqlclient |
  io.vertx.sqlclient.templates |

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

    Subinterfaces of SqlClient in io.vertx.db2client
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `DB2Connection` A connection to DB2 server.
    `interface` | `DB2Pool` A pool of DB2 connections.

    Methods in io.vertx.db2client that return SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `static SqlClient` | DB2Pool.`client(DB2ConnectOptions database, PoolOptions options)` Create a pooled client to the DB2 `database` configured with the given `options`.
    `static SqlClient` | DB2Pool.`client(List<DB2ConnectOptions> databases, PoolOptions options)` Create a client backed by a connection pool to the DB2 `databases` with round-robin selection.
    `static SqlClient` | DB2Pool.`client(String connectionUri)` Like `DB2Pool.client(String, PoolOptions)` with default options.
    `static SqlClient` | DB2Pool.`client(String connectionUri, PoolOptions options)` Like `DB2Pool.client(DB2ConnectOptions, PoolOptions)` with `database` build from `connectionUri`.
    `static SqlClient` | DB2Pool.`client(Vertx vertx, DB2ConnectOptions database, PoolOptions options)` Like `DB2Pool.client(DB2ConnectOptions, PoolOptions)` with a specific `Vertx` instance.
    `static SqlClient` | DB2Pool.`client(Vertx vertx, List<DB2ConnectOptions> databases, PoolOptions options)` Like `DB2Pool.client(List, PoolOptions)` with a specific `Vertx` instance.
    `static SqlClient` | DB2Pool.`client(Vertx vertx, String connectionUri)` Like `DB2Pool.client(Vertx, String, PoolOptions)` with default options.
    `static SqlClient` | DB2Pool.`client(Vertx vertx, String connectionUri, PoolOptions options)` Like `DB2Pool.client(Vertx, DB2ConnectOptions, PoolOptions)` with `database` build from `connectionUri`.

  - ### Uses of SqlClient in io.vertx.ext.auth.sqlclient

    Methods in io.vertx.ext.auth.sqlclient with parameters of type SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `static SqlUserUtil` | SqlUserUtil.`create(SqlClient client)` Create an instance of the user helper.
    `static SqlAuthorization` | SqlAuthorization.`create(SqlClient client)` Create a JDBC authorization provider implementation
    `static SqlAuthentication` | SqlAuthentication.`create(SqlClient client)` Create a JDBC auth provider implementation
    `static SqlAuthentication` | SqlAuthentication.`create(SqlClient client, SqlAuthenticationOptions options)` Create a JDBC auth provider implementation
    `static SqlAuthorization` | SqlAuthorization.`create(SqlClient client, SqlAuthorizationOptions options)` Create a JDBC authorization provider implementation
    `static SqlUserUtil` | SqlUserUtil.`create(SqlClient client, String insertUserSQL, String insertUserRoleSQL, String insertRolePermissionSQL)` Create an instance of the user helper with custom queries.

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

    Subinterfaces of SqlClient in io.vertx.jdbcclient
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `JDBCPool` JDBCPool is the interface that allows using the Sql Client API with plain JDBC.

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

    Subinterfaces of SqlClient in io.vertx.mssqlclient
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `MSSQLConnection` A connection to Microsoft SQL Server.
    `interface` | `MSSQLPool` A `pool` of `SQL Server connections`.

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

    Subinterfaces of SqlClient in io.vertx.mysqlclient
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `MySQLConnection` An interface which represents a connection to MySQL server.
    `interface` | `MySQLPool` A `pool` of `MySQL Connections`.

    Methods in io.vertx.mysqlclient that return SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `static SqlClient` | MySQLPool.`client(List<MySQLConnectOptions> databases, PoolOptions options)` Create a client backed by a connection pool to the MySQL `databases` with round-robin selection.
    `static SqlClient` | MySQLPool.`client(MySQLConnectOptions connectOptions, PoolOptions poolOptions)` Create a client backed by a connection pool to the database configured with the given `connectOptions` and `poolOptions`.
    `static SqlClient` | MySQLPool.`client(String connectionUri)` Like `MySQLPool.client(String, PoolOptions)` with a default `poolOptions`.
    `static SqlClient` | MySQLPool.`client(String connectionUri, PoolOptions poolOptions)` Like `MySQLPool.client(MySQLConnectOptions, PoolOptions)` with `connectOptions` build from `connectionUri`.
    `static SqlClient` | MySQLPool.`client(java.util.function.Supplier<Future<MySQLConnectOptions>> databases, PoolOptions options)` Create a client backed by a connection pool to the MySQL `databases`.
    `static SqlClient` | MySQLPool.`client(Vertx vertx, List<MySQLConnectOptions> mySQLConnectOptions, PoolOptions options)` Like `MySQLPool.client(List, PoolOptions)` with a specific `Vertx` instance.
    `static SqlClient` | MySQLPool.`client(Vertx vertx, MySQLConnectOptions connectOptions, PoolOptions poolOptions)` Like `MySQLPool.client(MySQLConnectOptions, PoolOptions)` with a specific `Vertx` instance.
    `static SqlClient` | MySQLPool.`client(Vertx vertx, String connectionUri)` Like `MySQLPool.client(Vertx, String,PoolOptions)` with a default `poolOptions`.
    `static SqlClient` | MySQLPool.`client(Vertx vertx, String connectionUri, PoolOptions poolOptions)` Like `MySQLPool.client(Vertx, MySQLConnectOptions, PoolOptions)` with `connectOptions` build from `connectionUri`.
    `static SqlClient` | MySQLPool.`client(Vertx vertx, java.util.function.Supplier<Future<MySQLConnectOptions>> mySQLConnectOptions, PoolOptions options)` Like `MySQLPool.client(Supplier, PoolOptions)` with a specific `Vertx` instance.

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

    Subinterfaces of SqlClient in io.vertx.pgclient
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `PgConnection` A connection to Postgres.
    `interface` | `PgPool` A `pool` of `PostgreSQL connections`.

    Methods in io.vertx.pgclient that return SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `static SqlClient` | PgPool.`client()` Like `PgPool.client(PoolOptions)` with default options.
    `static SqlClient` | PgPool.`client(List<PgConnectOptions> databases, PoolOptions options)` Create a client backed by a connection pool to the PostgreSQL `databases` with round-robin selection.
    `static SqlClient` | PgPool.`client(PgConnectOptions database, PoolOptions options)` Create a client backed by a connection pool to the PostgreSQL `database` configured with the given `options`.
    `static SqlClient` | PgPool.`client(PoolOptions options)` Like `PgPool.client(PgConnectOptions, PoolOptions)` with `database` retrieved from the environment variables.
    `static SqlClient` | PgPool.`client(String connectionUri)` Like `PgPool.pool(String, PoolOptions)` with default options.
    `static SqlClient` | PgPool.`client(String connectionUri, PoolOptions options)` Like `PgPool.client(PgConnectOptions, PoolOptions)` with `database` retrieved from the `connectionUri`.
    `static SqlClient` | PgPool.`client(java.util.function.Supplier<Future<PgConnectOptions>> databases, PoolOptions options)` Create a client backed by a connection pool to the PostgreSQL `databases`.
    `static SqlClient` | PgPool.`client(Vertx vertx, List<PgConnectOptions> databases, PoolOptions options)` Like `PgPool.client(List, PoolOptions)` with a specific `Vertx` instance.
    `static SqlClient` | PgPool.`client(Vertx vertx, PgConnectOptions database, PoolOptions options)` Like `PgPool.client(PgConnectOptions, PoolOptions)` with a specific `Vertx` instance.
    `static SqlClient` | PgPool.`client(Vertx vertx, PoolOptions poolOptions)` Like `PgPool.client(Vertx, PgConnectOptions, PoolOptions)` with `database` retrieved from the environment variables.
    `static SqlClient` | PgPool.`client(Vertx vertx, String connectionUri)` Like `PgPool.client(Vertx, String,PoolOptions)` with default options.
    `static SqlClient` | PgPool.`client(Vertx vertx, String connectionUri, PoolOptions options)` Like `PgPool.client(Vertx, PgConnectOptions, PoolOptions)` with `database` build from `connectionUri`.
    `static SqlClient` | PgPool.`client(Vertx vertx, java.util.function.Supplier<Future<PgConnectOptions>> databases, PoolOptions options)` Like `PgPool.client(Supplier, PoolOptions)` with a specific `Vertx` instance.

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

    Methods in io.vertx.reactivex.sqlclient that return SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `SqlClient` | SqlClient.`getDelegate()`

    Methods in io.vertx.reactivex.sqlclient with parameters of type SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `static SqlClient` | SqlClient.`newInstance(SqlClient arg)`

    Constructors in io.vertx.reactivex.sqlclient with parameters of type SqlClient
    Constructor and Description
    `SqlClient(SqlClient delegate)`

  - ### Uses of SqlClient in io.vertx.rxjava.sqlclient

    Methods in io.vertx.rxjava.sqlclient that return SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `SqlClient` | SqlClient.`getDelegate()`

    Methods in io.vertx.rxjava.sqlclient with parameters of type SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `static SqlClient` | SqlClient.`newInstance(SqlClient arg)`

    Constructors in io.vertx.rxjava.sqlclient with parameters of type SqlClient
    Constructor and Description
    `SqlClient(SqlClient delegate)`

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

    Methods in io.vertx.rxjava3.sqlclient that return SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `SqlClient` | SqlClient.`getDelegate()`

    Methods in io.vertx.rxjava3.sqlclient with parameters of type SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `static SqlClient` | SqlClient.`newInstance(SqlClient arg)`

    Constructors in io.vertx.rxjava3.sqlclient with parameters of type SqlClient
    Constructor and Description
    `SqlClient(SqlClient delegate)`

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

    Subinterfaces of SqlClient in io.vertx.sqlclient
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `Pool` A connection pool which reuses a number of SQL connections.
    `interface` | `SqlConnection` A connection to the database server.

  - ### Uses of SqlClient in io.vertx.sqlclient.templates

    Methods in io.vertx.sqlclient.templates with parameters of type SqlClient
    Modifier and Type | Method and Description
    --- | ---
    `static SqlTemplate<Map<String,Object>,RowSet<Row>>` | SqlTemplate.`forQuery(SqlClient client, String template)` Create an SQL template for query purpose consuming map parameters and returning `Row`.
    `static SqlTemplate<Map<String,Object>,SqlResult<Void>>` | SqlTemplate.`forUpdate(SqlClient client, String template)` Create an SQL template for query purpose consuming map parameters and returning void.

Copyright © 2024 Eclipse. All rights reserved.