Package io.vertx.reactivex.sqlclient

Class ClientBuilder<C>

  • public class ClientBuilder<C>
extends Object
    Builder for SqlClient instances.

    NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

    • Constructor Detail

      • ClientBuilder

        public ClientBuilder​(io.vertx.sqlclient.ClientBuilder delegate)

      • ClientBuilder

        public ClientBuilder​(Object delegate,
                     TypeArg<C> typeArg_0)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getDelegate

        public io.vertx.sqlclient.ClientBuilder getDelegate()

      • with

        public ClientBuilder<C> with​(io.vertx.sqlclient.PoolOptions options)
        Configure the client with the given pool options
        Parameters:
        options - the pool options
        Returns:
        a reference to this, so the API can be used fluently

      • connectingTo

        public ClientBuilder<C> connectingTo​(io.vertx.sqlclient.SqlConnectOptions database)
        Configure the database the client should connect to. The target database is specified as a SqlConnectOptions coordinates.
        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 the database the client should connect to. The target database is specified as a SqlConnectOptions coordinates.
        Parameters:
        database - the database URI
        Returns:
        a reference to this, so the API can be used fluently

      • connectingTo

        public ClientBuilder<C> connectingTo​(List<io.vertx.sqlclient.SqlConnectOptions> databases)
        Configure the database the client should connect to. When the client needs to connect to the database, it gets a database configuration from the list of databases using 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​(io.vertx.core.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(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) 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

      • connectingTo

        public ClientBuilder<C> connectingTo​(Supplier<io.vertx.core.Future<io.vertx.sqlclient.SqlConnectOptions>> supplier)
        Configure the database the client should connect to. When the client needs to connect to the database, it gets fresh database configuration from the database supplier.
        Parameters:
        supplier - the supplier of database coordinates
        Returns:
        a reference to this, so the API can be used fluently

      • newInstance

        public static <C> ClientBuilder<C> newInstance​(io.vertx.sqlclient.ClientBuilder arg)

      • newInstance

        public static <C> ClientBuilder<C> newInstance​(io.vertx.sqlclient.ClientBuilder arg,
                                               TypeArg<C> __typeArg_C)