Package io.vertx.reactivex.mssqlclient
Class MSSQLPool
- java.lang.Object
-
- io.vertx.reactivex.sqlclient.SqlClient
-
- io.vertx.reactivex.sqlclient.Pool
-
- io.vertx.reactivex.mssqlclient.MSSQLPool
-
public class MSSQLPool extends Pool
A ofSQL Server connections
. NOTE: This class has been automatically generated from theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<MSSQLPool>
__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MSSQLPool
connectHandler(Handler<SqlConnection> handler)
Set an handler called when the pool has established a connection to the database.MSSQLPool
connectionProvider(io.reactivex.functions.Function<Context,io.reactivex.Single<SqlConnection>> provider)
Replace the default pool connection provider, the newprovider
returns a future connection for a given .MSSQLPool
connectionProvider(Function<Context,Future<SqlConnection>> provider)
Replace the default pool connection provider, the newprovider
returns a future connection for a given .boolean
equals(Object o)
MSSQLPool
getDelegate()
int
hashCode()
static MSSQLPool
newInstance(MSSQLPool arg)
static MSSQLPool
pool(MSSQLConnectOptions database, PoolOptions options)
Create a connection pool to the SQL serverdatabase
configured with the givenoptions
.static MSSQLPool
pool(Vertx vertx, MSSQLConnectOptions database, PoolOptions options)
Likepool(java.lang.String)
with a specific instance.static MSSQLPool
pool(Vertx vertx, String connectionUri)
Likepool(java.lang.String)
with default options.static MSSQLPool
pool(Vertx vertx, String connectionUri, PoolOptions options)
static MSSQLPool
pool(Vertx vertx, Supplier<Future<MSSQLConnectOptions>> databases, PoolOptions options)
Likepool(java.lang.String)
with a specific instance.static MSSQLPool
pool(Vertx vertx, List<MSSQLConnectOptions> databases, PoolOptions options)
Likepool(java.lang.String)
with a specific instance.static MSSQLPool
pool(String connectionUri)
Likepool(java.lang.String)
with default options.static MSSQLPool
pool(String connectionUri, PoolOptions options)
static MSSQLPool
pool(Supplier<Future<MSSQLConnectOptions>> databases, PoolOptions options)
Create a connection pool to the SQL Serverdatabases
.static MSSQLPool
pool(List<MSSQLConnectOptions> databases, PoolOptions options)
Create a connection pool to the SQL Serverdatabases
with round-robin selection.String
toString()
-
Methods inherited from class io.vertx.reactivex.sqlclient.Pool
close, close, getConnection, getConnection, newInstance, pool, pool, pool, preparedQuery, query, rxClose, rxGetConnection, rxWithConnection, rxWithConnection, rxWithTransaction, rxWithTransaction, rxWithTransaction, rxWithTransaction, size, withConnection, withConnection, withConnection, withConnection, withTransaction, withTransaction, withTransaction, withTransaction, withTransaction, withTransaction, withTransaction, withTransaction
-
Methods inherited from class io.vertx.reactivex.sqlclient.SqlClient
newInstance, preparedQuery
-
-
-
-
Method Detail
-
getDelegate
public MSSQLPool getDelegate()
- Overrides:
getDelegate
in classPool
-
pool
public static MSSQLPool pool(String connectionUri)
Likepool(java.lang.String)
with default options.- Parameters:
connectionUri
-- Returns:
-
pool
public static MSSQLPool pool(String connectionUri, PoolOptions options)
- Parameters:
connectionUri
-options
-- Returns:
-
pool
public static MSSQLPool pool(Vertx vertx, String connectionUri)
Likepool(java.lang.String)
with default options.- Parameters:
vertx
-connectionUri
-- Returns:
-
pool
public static MSSQLPool pool(Vertx vertx, String connectionUri, PoolOptions options)
- Parameters:
vertx
-connectionUri
-options
-- Returns:
-
pool
public static MSSQLPool pool(MSSQLConnectOptions database, PoolOptions options)
Create a connection pool to the SQL serverdatabase
configured with the givenoptions
.- Parameters:
database
- the options for the connectionoptions
- the options for creating the pool- Returns:
- the connection pool
-
pool
public static MSSQLPool pool(Vertx vertx, MSSQLConnectOptions database, PoolOptions options)
Likepool(java.lang.String)
with a specific instance.- Parameters:
vertx
-database
-options
-- Returns:
-
pool
public static MSSQLPool pool(List<MSSQLConnectOptions> databases, PoolOptions options)
Create a connection pool to the SQL Serverdatabases
with round-robin selection. Round-robin is applied when a new connection is created by the pool.- Parameters:
databases
- the list of databasesoptions
- the options for creating the pool- Returns:
- the connection pool
-
pool
public static MSSQLPool pool(Vertx vertx, List<MSSQLConnectOptions> databases, PoolOptions options)
Likepool(java.lang.String)
with a specific instance.- Parameters:
vertx
-databases
-options
-- Returns:
-
connectHandler
public MSSQLPool connectHandler(Handler<SqlConnection> handler)
Description copied from class: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(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
to release the connection to the pool.- Overrides:
connectHandler
in classPool
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
connectionProvider
public MSSQLPool connectionProvider(Function<Context,Future<SqlConnection>> provider)
Description copied from class:Pool
Replace the default pool connection provider, the newprovider
returns a future connection for a given .A
ConnectionFactory
can be used as connection provider.- Overrides:
connectionProvider
in classPool
- Parameters:
provider
- the new connection provider- Returns:
- a reference to this, so the API can be used fluently
-
connectionProvider
public MSSQLPool connectionProvider(io.reactivex.functions.Function<Context,io.reactivex.Single<SqlConnection>> provider)
Description copied from class:Pool
Replace the default pool connection provider, the newprovider
returns a future connection for a given .A
ConnectionFactory
can be used as connection provider.- Overrides:
connectionProvider
in classPool
- Parameters:
provider
- the new connection provider- Returns:
- a reference to this, so the API can be used fluently
-
pool
public static MSSQLPool pool(Supplier<Future<MSSQLConnectOptions>> databases, PoolOptions options)
Create a connection pool to the SQL Serverdatabases
. The supplier is called to provide the options when a new connection is created by the pool.- Parameters:
databases
- the databases supplieroptions
- the options for creating the pool- Returns:
- the connection pool
-
pool
public static MSSQLPool pool(Vertx vertx, Supplier<Future<MSSQLConnectOptions>> databases, PoolOptions options)
Likepool(java.lang.String)
with a specific instance.- Parameters:
vertx
-databases
-options
-- Returns:
-
-