io.vertx.sqlclient.spi

Interface Driver

All Known Implementing Classes:

DB2Driver, MSSQLDriver, MySQLDriver, PgDriver

public interface Driver

An entry point to the Vertx Reactive SQL Client Every driver must implement this interface.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsOptions(SqlConnectOptions connectOptions)
ConnectionFactory	createConnectionFactory(Vertx vertx, SqlConnectOptions database) Create a connection factory to the given database.
Pool	createPool(Vertx vertx, List<? extends SqlConnectOptions> databases, PoolOptions options) Create a connection pool to the database configured with the given connectOptions and poolOptions.

Method Detail

createPool

Pool createPool(Vertx vertx,
                List<? extends SqlConnectOptions> databases,
                PoolOptions options)

Create a connection pool to the database configured with the given connectOptions and poolOptions.

Parameters:

vertx - the Vertx instance to be used with the connection pool

databases - the list of databases

options - the options for creating the pool

Returns:

the connection pool

createConnectionFactory

ConnectionFactory createConnectionFactory(Vertx vertx,
                                          SqlConnectOptions database)

Create a connection factory to the given database.

Parameters:

vertx - the Vertx instance t

database - the database to connect to

Returns:

the connection factory

acceptsOptions

boolean acceptsOptions(SqlConnectOptions connectOptions)

Returns:

true if the driver accepts the connectOptions, false otherwise