io.vertx.mssqlclient

Interface MSSQLPool

All Superinterfaces:

Pool, SqlClient

public interface MSSQLPool
extends Pool

A pool of SQL Server connections.

Method Summary

Modifier and Type	Method and Description
MSSQLPool	connectHandler(Handler<SqlConnection> handler) Set an handler called when the pool has established a connection to the database.
MSSQLPool	connectionProvider(java.util.function.Function<Context,Future<SqlConnection>> provider) Replace the default pool connection provider, the new provider returns a future connection for a given Context.
static MSSQLPool	pool(List<MSSQLConnectOptions> databases, PoolOptions options) Create a connection pool to the SQL Server databases with round-robin selection.
static MSSQLPool	pool(MSSQLConnectOptions database, PoolOptions options) Create a connection pool to the SQL server database configured with the given options.
static MSSQLPool	pool(String connectionUri) Like pool(String, PoolOptions) with default options.
static MSSQLPool	pool(String connectionUri, PoolOptions options) Like pool(MSSQLConnectOptions, PoolOptions) with database built from connectionUri.
static MSSQLPool	pool(java.util.function.Supplier<Future<MSSQLConnectOptions>> databases, PoolOptions options) Create a connection pool to the SQL Server databases.
static MSSQLPool	pool(Vertx vertx, List<MSSQLConnectOptions> databases, PoolOptions options) Like pool(List, PoolOptions) with a specific Vertx instance.
static MSSQLPool	pool(Vertx vertx, MSSQLConnectOptions database, PoolOptions options) Like pool(MSSQLConnectOptions, PoolOptions) with a specific Vertx instance.
static MSSQLPool	pool(Vertx vertx, String connectionUri) Like pool(Vertx, String, PoolOptions) with default options.
static MSSQLPool	pool(Vertx vertx, String connectionUri, PoolOptions options) Like pool(Vertx, MSSQLConnectOptions, PoolOptions) with database built from connectionUri.
static MSSQLPool	pool(Vertx vertx, java.util.function.Supplier<Future<MSSQLConnectOptions>> databases, PoolOptions options) Like pool(Supplier, PoolOptions) with a specific Vertx instance.

Methods inherited from interface io.vertx.sqlclient.Pool

close, getConnection, getConnection, pool, pool, pool, preparedQuery, query, size, withConnection, withConnection, withTransaction, withTransaction, withTransaction, withTransaction

Methods inherited from interface io.vertx.sqlclient.SqlClient

close, preparedQuery

Method Detail

pool

static MSSQLPool pool(String connectionUri)

Like pool(String, PoolOptions) with default options.

pool

static MSSQLPool pool(String connectionUri,
                      PoolOptions options)

Like pool(MSSQLConnectOptions, PoolOptions) with database built from connectionUri.

pool

static MSSQLPool pool(Vertx vertx,
                      String connectionUri)

Like pool(Vertx, String, PoolOptions) with default options.

pool

static MSSQLPool pool(Vertx vertx,
                      String connectionUri,
                      PoolOptions options)

Like pool(Vertx, MSSQLConnectOptions, PoolOptions) with database built from connectionUri.

pool

static MSSQLPool pool(MSSQLConnectOptions database,
                      PoolOptions options)

Create a connection pool to the SQL server database configured with the given options.

Parameters:

database - the options for the connection

options - the options for creating the pool

Returns:

the connection pool

pool

static MSSQLPool pool(Vertx vertx,
                      MSSQLConnectOptions database,
                      PoolOptions options)

Like pool(MSSQLConnectOptions, PoolOptions) with a specific Vertx instance.

pool

static MSSQLPool pool(List<MSSQLConnectOptions> databases,
                      PoolOptions options)

Create a connection pool to the SQL Server databases with round-robin selection. Round-robin is applied when a new connection is created by the pool.

Parameters:

databases - the list of databases

options - the options for creating the pool

Returns:

the connection pool

pool

static MSSQLPool pool(Vertx vertx,
                      List<MSSQLConnectOptions> databases,
                      PoolOptions options)

Like pool(List, PoolOptions) with a specific Vertx instance.

pool

static MSSQLPool pool(java.util.function.Supplier<Future<MSSQLConnectOptions>> databases,
                      PoolOptions options)

Create a connection pool to the SQL Server databases. The supplier is called to provide the options when a new connection is created by the pool.

Parameters:

databases - the databases supplier

options - the options for creating the pool

Returns:

the connection pool

pool

static MSSQLPool pool(Vertx vertx,
                      java.util.function.Supplier<Future<MSSQLConnectOptions>> databases,
                      PoolOptions options)

Like pool(Supplier, PoolOptions) with a specific Vertx instance.

connectHandler

MSSQLPool connectHandler(Handler<SqlConnection> handler)

Description copied from interface: Pool

Set an handler called when the pool has established a connection to the database.

This handler allows interactions with the database before the connection is added to the pool.

When the handler has finished, it must call SqlClient.close() to release the connection to the pool.

Specified by:

connectHandler in interface Pool

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

connectionProvider

MSSQLPool connectionProvider(java.util.function.Function<Context,Future<SqlConnection>> provider)

Description copied from interface: Pool

Replace the default pool connection provider, the new provider returns a future connection for a given Context.

A ConnectionFactory can be used as connection provider.

Specified by:

connectionProvider in interface Pool

Parameters:

provider - the new connection provider

Returns:

a reference to this, so the API can be used fluently