Package io.vertx.mutiny.sqlclient

Class ClientBuilder<C>

java.lang.Object
io.vertx.mutiny.sqlclient.ClientBuilder<C>
All Implemented Interfaces:
MutinyDelegate
public class ClientBuilder<C> extends Object implements MutinyDelegate
Builder for SqlClient instances.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

See Also:
  • ClientBuilder

  • Field Details

  • Constructor Details

    • ClientBuilder

      public ClientBuilder(io.vertx.sqlclient.ClientBuilder<C> delegate)
      Create a new instance of ClientBuilder delegating to the given (non-null) instance of ClientBuilder.

    • ClientBuilder

      public ClientBuilder(io.vertx.sqlclient.ClientBuilder<C> delegate, TypeArg<C> typeArg_0)

    • ClientBuilder

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

  • Method Details

    • getDelegate

      public io.vertx.sqlclient.ClientBuilder<C> getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • 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

    • with

      public ClientBuilder<C> with(io.vertx.core.net.NetClientOptions options)
      Configure the client pool with the given transport options. Note: the SSL options part is ignored, since SqlConnectOptions configures 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(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(Supplier<io.smallrye.mutiny.Uni<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

    • 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(Consumer<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 SqlConnection.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(io.vertx.sqlclient.ClientBuilder<C> delegate)
      Creates a new instance of the ClientBuilder.

    • newInstance

      public static <C> ClientBuilder<C> newInstance(io.vertx.sqlclient.ClientBuilder<C> delegate, TypeArg<C> typeArg_0)
      Creates a new instance of the ClientBuilder.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object