Package io.github.zero88.jooqx.provider

Interface SQLClientProvider<S>

Type Parameters:
S - Type of SQL client
All Known Subinterfaces:
DB2PoolProvider, JDBCLegacyAgroalProvider, JDBCLegacyC3P0Provider, JDBCLegacyHikariProvider, JDBCPoolAgroalProvider, JDBCPoolC3P0Provider, JDBCPoolHikariProvider, JDBCPoolProvider<P>, JooqxSQLClientProvider<S>, LegacySQLClientProvider<P>, MSSQLPoolProvider, MySQLConnProvider, MySQLPoolProvider, PgConnProvider, PgPoolProvider
public interface SQLClientProvider<S>
SQL client provider
Since:
2.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull io.vertx.core.Future<Void>
    close(S sqlClient)
    Close SQL client
    @NotNull io.vertx.core.Future<S>
    open(io.vertx.core.Vertx vertx, io.vertx.core.json.JsonObject connOptions, @Nullable io.vertx.core.json.JsonObject poolOptions)
    Create and open SQL client
    String
    sqlClientClass()
    Defines SQL client class.

  • Method Details

    • sqlClientClass

      String sqlClientClass()
      Defines SQL client class.

      It helps for detecting and scanning in runtime

      Returns:
      SQL client class

    • open

      @NotNull @NotNull io.vertx.core.Future<S> open(io.vertx.core.Vertx vertx, io.vertx.core.json.JsonObject connOptions, @Nullable @Nullable io.vertx.core.json.JsonObject poolOptions)
      Create and open SQL client
      Parameters:
      vertx - vertx
      connOptions - SQL connection options
      poolOptions - SQL pool options
      Returns:
      the SQL client future

    • close

      @NotNull @NotNull io.vertx.core.Future<Void> close(S sqlClient)
      Close SQL client
      Parameters:
      sqlClient - SQL client
      Returns:
      void future