Package io.vertx.rxjava3.sqlclient
Class ClientBuilder<C>
- java.lang.Object
-
- io.vertx.rxjava3.sqlclient.ClientBuilder<C>
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class ClientBuilder<C> extends Object implements io.vertx.lang.rx.RxDelegate
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<ClientBuilder>__TYPE_ARGio.vertx.lang.rx.TypeArg<C>__typeArg_0
-
Constructor Summary
Constructors Constructor Description ClientBuilder(ClientBuilder delegate)ClientBuilder(Object delegate, io.vertx.lang.rx.TypeArg<C> typeArg_0)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Cbuild()Build and return the client.ClientBuilder<C>connectingTo(SqlConnectOptions database)Configure thedatabasethe client should connect to.ClientBuilder<C>connectingTo(String database)Configure thedatabasethe client should connect to.ClientBuilder<C>connectingTo(Supplier<Single<SqlConnectOptions>> supplier)Configure thedatabasethe client should connect to.ClientBuilder<C>connectingTo(List<SqlConnectOptions> databases)Configure thedatabasethe client should connect to.booleanequals(Object o)ClientBuildergetDelegate()inthashCode()static <C> ClientBuilder<C>newInstance(ClientBuilder arg)static <C> ClientBuilder<C>newInstance(ClientBuilder arg, io.vertx.lang.rx.TypeArg<C> __typeArg_C)StringtoString()ClientBuilder<C>using(Vertx vertx)Sets the vertx instance to use.ClientBuilder<C>with(NetClientOptions options)Configure the client pool with the given transportoptions.ClientBuilder<C>with(PoolOptions options)Configure the client with the given pooloptionsClientBuilder<C>withConnectHandler(Handler<SqlConnection> handler)Set a handler called when the pool has established a connection to the database.
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<ClientBuilder> __TYPE_ARG
-
__typeArg_0
public final io.vertx.lang.rx.TypeArg<C> __typeArg_0
-
-
Constructor Detail
-
ClientBuilder
public ClientBuilder(ClientBuilder delegate)
-
-
Method Detail
-
getDelegate
public ClientBuilder getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
with
public ClientBuilder<C> with(PoolOptions options)
Configure the client with the given pooloptions- Parameters:
options- the pool options- Returns:
- a reference to this, so the API can be used fluently
-
with
public ClientBuilder<C> with(NetClientOptions options)
Configure the client pool with the given transportoptions. Note: the SSL options part is ignored, sinceSqlConnectOptionsconfigures the transport SSL.- Parameters:
options- the transport options- Returns:
- a reference to this, so the API can be used fluently
-
connectingTo
public ClientBuilder<C> connectingTo(SqlConnectOptions database)
Configure thedatabasethe client should connect to. The targetdatabaseis specified as aSqlConnectOptionscoordinates.- Parameters:
database- the database coordinates- Returns:
- a reference to this, so the API can be used fluently
-
connectingTo
public ClientBuilder<C> connectingTo(String database)
Configure thedatabasethe client should connect to. The targetdatabaseis specified as aSqlConnectOptionscoordinates.- Parameters:
database- the database URI- Returns:
- a reference to this, so the API can be used fluently
-
connectingTo
public ClientBuilder<C> connectingTo(Supplier<Single<SqlConnectOptions>> supplier)
Configure thedatabasethe client should connect to. When the client needs to connect to the database, it gets fresh database configuration from the databasesupplier.- Parameters:
supplier- the supplier of database coordinates- Returns:
- a reference to this, so the API can be used fluently
-
connectingTo
public ClientBuilder<C> connectingTo(List<SqlConnectOptions> databases)
Configure thedatabasethe client should connect to. When the client needs to connect to the database, it gets a database configuration from the list ofdatabasesusing a round-robin policy.- Parameters:
databases- the list of database coordinates- Returns:
- a reference to this, so the API can be used fluently
-
using
public ClientBuilder<C> using(Vertx vertx)
Sets the vertx instance to use.- Parameters:
vertx- the vertx instance- Returns:
- a reference to this, so the API can be used fluently
-
withConnectHandler
public ClientBuilder<C> withConnectHandler(Handler<SqlConnection> handler)
Set a 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.- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
build
public C build()
Build and return the client.- Returns:
- the client
-
newInstance
public static <C> ClientBuilder<C> newInstance(ClientBuilder arg)
-
newInstance
public static <C> ClientBuilder<C> newInstance(ClientBuilder arg, io.vertx.lang.rx.TypeArg<C> __typeArg_C)
-
-