Interface Driver<C extends SqlConnectOptions>

All Known Implementing Classes:
DB2Driver, DriverBase, MSSQLDriver, MySQLDriver, OracleDriver, PgDriver
public interface Driver<C extends SqlConnectOptions>
An entry point to the Vertx Reactive SQL Client Every driver must implement this interface.

  • Method Details

    • createPool

      default Pool createPool(Vertx vertx, 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.

      The returned pool will automatically closed when vertx is not null and is closed or when the creating context is closed (e.g verticle undeployment).

      Parameters:
      vertx - the Vertx instance to be used with the connection pool or null to create an auto closed Vertx instance
      databases - the list of databases
      poolOptions - the options for creating the pool
      transportOptions - the options to configure the TCP client
      connectHandler -
      Returns:
      the connection pool

    • newPool

      Pool newPool(Vertx vertx, 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.

      This method is not meant to be used directly by users, instead they should use createPool(Vertx, Supplier, PoolOptions, NetClientOptions, Handler).

      Parameters:
      vertx - the Vertx instance to be used with the connection pool
      databases - the list of databases
      options - the options for creating the pool
      transportOptions - the options to configure the TCP client
      connectHandler - the connect handler
      closeFuture - the close future
      Returns:
      the connection pool

    • parseConnectionUri

      SqlConnectOptions parseConnectionUri(String uri)
      Returns:
      true if the driver accepts the connectOptions, false otherwise

    • acceptsOptions

      boolean acceptsOptions(SqlConnectOptions connectOptions)
      Returns:
      true if the driver accepts the connectOptions, false otherwise

    • downcast

      C downcast(SqlConnectOptions connectOptions)
      Downcast the connect options to the specific driver options.
      Parameters:
      connectOptions - the options to downcast
      Returns:
      the downcasted options

    • appendQueryPlaceholder

      default int appendQueryPlaceholder(StringBuilder queryBuilder, int index, int current)
      Append a parameter placeholder in the query.

      The index starts at 0.

      • When index == current indicates it is a new parameter and therefore the same * value should be returned.
      • When index < current indicates the builder wants to reuse a parameter. The implementation can either return the same value to indicate the parameter can be reused or return the next index to use (which is shall be the current value
      Parameters:
      queryBuilder - the builder to append to
      index - the parameter placeholder index
      Returns:
      the index at which the parameter placeholder could be added