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)
default int	appendQueryPlaceholder(StringBuilder queryBuilder, int index, int current) Append a parameter placeholder in the query.
ConnectionFactory	createConnectionFactory(Vertx vertx, SqlConnectOptions database) Create a connection factory to the given database.
ConnectionFactory	createConnectionFactory(Vertx vertx, java.util.function.Supplier<? extends Future<? extends SqlConnectOptions>> database) Create a connection factory to the given database.
default Pool	createPool(Vertx vertx, List<? extends SqlConnectOptions> databases, PoolOptions options) Create a connection pool to the database configured with the given connectOptions and poolOptions.
default Pool	createPool(Vertx vertx, java.util.function.Supplier<? extends Future<? extends SqlConnectOptions>> databases, PoolOptions options) Create a connection pool to the database configured with the given connectOptions and poolOptions.
default Pool	newPool(Vertx vertx, List<? extends SqlConnectOptions> databases, PoolOptions options, io.vertx.core.impl.CloseFuture closeFuture) Create a connection pool to the database configured with the given connectOptions and poolOptions.
Pool	newPool(Vertx vertx, java.util.function.Supplier<? extends Future<? extends SqlConnectOptions>> databases, PoolOptions options, io.vertx.core.impl.CloseFuture closeFuture) Create a connection pool to the database configured with the given connectOptions and poolOptions.
SqlConnectOptions	parseConnectionUri(String uri)
default io.vertx.sqlclient.impl.SqlConnectionInternal	wrapConnection(io.vertx.core.impl.ContextInternal context, ConnectionFactory factory, io.vertx.sqlclient.impl.Connection conn)

Method Detail

createPool

default Pool createPool(Vertx vertx,
                        java.util.function.Supplier<? extends Future<? extends SqlConnectOptions>> databases,
                        PoolOptions options)

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

options - the options for creating the pool

Returns:

the connection pool

createPool

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

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

options - the options for creating the pool

Returns:

the connection pool

newPool

default Pool newPool(Vertx vertx,
                     List<? extends SqlConnectOptions> databases,
                     PoolOptions options,
                     io.vertx.core.impl.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, List, 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

closeFuture - the close future

Returns:

the connection pool

newPool

Pool newPool(Vertx vertx,
             java.util.function.Supplier<? extends Future<? extends SqlConnectOptions>> databases,
             PoolOptions options,
             io.vertx.core.impl.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, List, 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

closeFuture - the close future

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

createConnectionFactory

ConnectionFactory createConnectionFactory(Vertx vertx,
                                          java.util.function.Supplier<? extends Future<? extends 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

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

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

wrapConnection

default io.vertx.sqlclient.impl.SqlConnectionInternal wrapConnection(io.vertx.core.impl.ContextInternal context,
                                                                     ConnectionFactory factory,
                                                                     io.vertx.sqlclient.impl.Connection conn)