Class Pool
- java.lang.Object
-
- io.vertx.rxjava3.sqlclient.SqlClient
-
- io.vertx.rxjava3.sqlclient.Pool
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
- Direct Known Subclasses:
JDBCPool
public class Pool extends SqlClient implements io.vertx.lang.rx.RxDelegate
A connection pool which reuses a number of SQL connections.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<Pool>__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)Single<SqlConnection>getConnection()Get a connection from the pool.PoolgetDelegate()inthashCode()static PoolnewInstance(Pool arg)static Poolpool(Vertx vertx, SqlConnectOptions database, PoolOptions options)Create a connection pool to thedatabasewith the givenoptions.static Poolpool(SqlConnectOptions connectOptions)Likepool(io.vertx.sqlclient.SqlConnectOptions)with default options.static Poolpool(SqlConnectOptions database, PoolOptions options)Likepool(io.vertx.sqlclient.SqlConnectOptions)with a Vert.x instance created automatically.PreparedQuery<RowSet<Row>>preparedQuery(String sql)A connection is borrowed from the connection pool when the query is executed and then immediately returned to the pool after it completes.Query<RowSet<Row>>query(String sql)A connection is borrowed from the connection pool when the query is executed and then immediately returned to the pool after it completes.Single<SqlConnection>rxGetConnection()Get a connection from the pool.<T> Maybe<T>rxWithConnection(Function<SqlConnection,Maybe<T>> function)Get a connection from the pool and execute the givenfunction.<T> Maybe<T>rxWithTransaction(TransactionPropagation txPropagation, Function<SqlConnection,Maybe<T>> function)LikewithTransaction(java.util.function.Function<io.vertx.rxjava3.sqlclient.SqlConnection, io.reactivex.rxjava3.core.Maybe<T>>)but allows for setting the mode, defining how the acquired connection is managed during the execution of the function.<T> Maybe<T>rxWithTransaction(Function<SqlConnection,Maybe<T>> function)Execute the givenfunctionwithin a transaction.intsize()StringtoString()<T> Maybe<T>withConnection(Function<SqlConnection,Maybe<T>> function)Get a connection from the pool and execute the givenfunction.<T> Maybe<T>withTransaction(TransactionPropagation txPropagation, Function<SqlConnection,Maybe<T>> function)LikewithTransaction(java.util.function.Function<io.vertx.rxjava3.sqlclient.SqlConnection, io.reactivex.rxjava3.core.Maybe<T>>)but allows for setting the mode, defining how the acquired connection is managed during the execution of the function.<T> Maybe<T>withTransaction(Function<SqlConnection,Maybe<T>> function)Execute the givenfunctionwithin a transaction.-
Methods inherited from class io.vertx.rxjava3.sqlclient.SqlClient
close, newInstance, preparedQuery, rxClose
-
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<Pool> __TYPE_ARG
-
-
Method Detail
-
getDelegate
public Pool getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Overrides:
getDelegatein classSqlClient
-
pool
public static Pool pool(SqlConnectOptions connectOptions)
Likepool(io.vertx.sqlclient.SqlConnectOptions)with default options.- Parameters:
connectOptions-- Returns:
-
pool
public static Pool pool(SqlConnectOptions database, PoolOptions options)
Likepool(io.vertx.sqlclient.SqlConnectOptions)with a Vert.x instance created automatically.- Parameters:
database-options-- Returns:
-
pool
public static Pool pool(Vertx vertx, SqlConnectOptions database, PoolOptions options)
Create a connection pool to thedatabasewith the givenoptions.A will be selected among the drivers found on the classpath returning
truewhen applied to the first options of the list.- Parameters:
vertx- the Vertx instance to be used with the connection pooldatabase- the options used to create the connection pool, such as database hostnameoptions- the options for creating the pool- Returns:
- the connection pool
-
getConnection
public Single<SqlConnection> getConnection()
Get a connection from the pool.- Returns:
- a future notified with the
SqlConnection
-
rxGetConnection
public Single<SqlConnection> rxGetConnection()
Get a connection from the pool.- Returns:
- a future notified with the
SqlConnection
-
query
public Query<RowSet<Row>> query(String sql)
A connection is borrowed from the connection pool when the query is executed and then immediately returned to the pool after it completes.
-
preparedQuery
public PreparedQuery<RowSet<Row>> preparedQuery(String sql)
A connection is borrowed from the connection pool when the query is executed and then immediately returned to the pool after it completes.- Overrides:
preparedQueryin classSqlClient- Parameters:
sql-- Returns:
-
withTransaction
public <T> Maybe<T> withTransaction(Function<SqlConnection,Maybe<T>> function)
Execute the givenfunctionwithin a transaction.The
functionis passed a client executing all operations within a transaction. When the future returned by the function- succeeds the transaction commits
- fails the transaction rollbacks
The
handleris given a success result when the function returns a succeeded futures and the transaction commits. Otherwise it is given a failure result.- Parameters:
function- the code to execute- Returns:
- a future notified with the result
-
rxWithTransaction
public <T> Maybe<T> rxWithTransaction(Function<SqlConnection,Maybe<T>> function)
Execute the givenfunctionwithin a transaction.The
functionis passed a client executing all operations within a transaction. When the future returned by the function- succeeds the transaction commits
- fails the transaction rollbacks
The
handleris given a success result when the function returns a succeeded futures and the transaction commits. Otherwise it is given a failure result.- Parameters:
function- the code to execute- Returns:
- a future notified with the result
-
withTransaction
public <T> Maybe<T> withTransaction(TransactionPropagation txPropagation, Function<SqlConnection,Maybe<T>> function)
LikewithTransaction(java.util.function.Function<io.vertx.rxjava3.sqlclient.SqlConnection, io.reactivex.rxjava3.core.Maybe<T>>)but allows for setting the mode, defining how the acquired connection is managed during the execution of the function.- Parameters:
txPropagation-function-- Returns:
-
rxWithTransaction
public <T> Maybe<T> rxWithTransaction(TransactionPropagation txPropagation, Function<SqlConnection,Maybe<T>> function)
LikewithTransaction(java.util.function.Function<io.vertx.rxjava3.sqlclient.SqlConnection, io.reactivex.rxjava3.core.Maybe<T>>)but allows for setting the mode, defining how the acquired connection is managed during the execution of the function.- Parameters:
txPropagation-function-- Returns:
-
withConnection
public <T> Maybe<T> withConnection(Function<SqlConnection,Maybe<T>> function)
Get a connection from the pool and execute the givenfunction.When the future returned by the
functioncompletes, the connection is returned to the pool.The
handleris given a success result when the function returns a succeeded futures. Otherwise it is given a failure result.- Parameters:
function- the code to execute- Returns:
- a future notified with the result
-
rxWithConnection
public <T> Maybe<T> rxWithConnection(Function<SqlConnection,Maybe<T>> function)
Get a connection from the pool and execute the givenfunction.When the future returned by the
functioncompletes, the connection is returned to the pool.The
handleris given a success result when the function returns a succeeded futures. Otherwise it is given a failure result.- Parameters:
function- the code to execute- Returns:
- a future notified with the result
-
size
public int size()
- Returns:
- the current pool size approximation
-
-