Package io.vertx.mutiny.ext.jdbc

Class JDBCClient

java.lang.Object
io.vertx.mutiny.ext.sql.SQLClient
io.vertx.mutiny.ext.jdbc.JDBCClient
All Implemented Interfaces:
MutinyDelegate, SQLOperations
public class JDBCClient extends SQLClient implements MutinyDelegate
An asynchronous client interface for interacting with a JDBC compliant database

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

  • Field Details

    • __TYPE_ARG

      public static final TypeArg<JDBCClient> __TYPE_ARG

    • DEFAULT_PROVIDER_CLASS

      public static final String DEFAULT_PROVIDER_CLASS
      The default data source provider for this pool, loaded from JVM system properties with the key. The value can be one of:
      • C3P0:
      • Hikari:
      • Agroal:
      When there is no JVM wide defined provider or the value is incorrect, is returned.

    • DEFAULT_DS_NAME

      public static final String DEFAULT_DS_NAME
      The name of the default data source
      See Also:

  • Constructor Details

    • JDBCClient

      public JDBCClient(io.vertx.ext.jdbc.JDBCClient delegate)

    • JDBCClient

      public JDBCClient(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.jdbc.JDBCClient getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Specified by:
      getDelegate in interface SQLOperations
      Overrides:
      getDelegate in class SQLClient
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class SQLClient

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class SQLClient

    • querySingle

      @CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.json.JsonArray> querySingle(String sql)
      Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Specified by:
      querySingle in interface SQLOperations
      Overrides:
      querySingle in class SQLClient
      Parameters:
      sql - the statement to execute
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • querySingleAndAwait

      public io.vertx.core.json.JsonArray querySingleAndAwait(String sql)
      Blocking variant of SQLOperations.querySingle(String).

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Specified by:
      querySingleAndAwait in interface SQLOperations
      Overrides:
      querySingleAndAwait in class SQLClient
      Parameters:
      sql - the statement to execute
      Returns:
      the JsonArray instance produced by the operation.

    • querySingleAndForget

      public SQLOperations querySingleAndForget(String sql)
      Variant of SQLOperations.querySingle(String) that ignores the result of the operation.

      This method subscribes on the result of SQLOperations.querySingle(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from SQLOperations.querySingle(String) but you don't need to compose it with other operations.

      Specified by:
      querySingleAndForget in interface SQLOperations
      Overrides:
      querySingleAndForget in class SQLClient
      Parameters:
      sql - the statement to execute
      Returns:
      the instance of SQLOperations to chain method calls.

    • querySingleWithParams

      @CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.json.JsonArray> querySingleWithParams(String sql, io.vertx.core.json.JsonArray arguments)
      Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned.

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Specified by:
      querySingleWithParams in interface SQLOperations
      Overrides:
      querySingleWithParams in class SQLClient
      Parameters:
      sql - the statement to execute
      arguments - the arguments
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • querySingleWithParamsAndAwait

      public io.vertx.core.json.JsonArray querySingleWithParamsAndAwait(String sql, io.vertx.core.json.JsonArray arguments)
      Blocking variant of SQLOperations.querySingleWithParams(String,JsonArray).

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Specified by:
      querySingleWithParamsAndAwait in interface SQLOperations
      Overrides:
      querySingleWithParamsAndAwait in class SQLClient
      Parameters:
      sql - the statement to execute
      arguments - the arguments
      Returns:
      the JsonArray instance produced by the operation.

    • querySingleWithParamsAndForget

      public SQLOperations querySingleWithParamsAndForget(String sql, io.vertx.core.json.JsonArray arguments)
      Variant of SQLOperations.querySingleWithParams(String,JsonArray) that ignores the result of the operation.

      This method subscribes on the result of SQLOperations.querySingleWithParams(String,JsonArray), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from SQLOperations.querySingleWithParams(String,JsonArray) but you don't need to compose it with other operations.

      Specified by:
      querySingleWithParamsAndForget in interface SQLOperations
      Overrides:
      querySingleWithParamsAndForget in class SQLClient
      Parameters:
      sql - the statement to execute
      arguments - the arguments
      Returns:
      the instance of SQLOperations to chain method calls.

    • create

      public static JDBCClient create(Vertx vertx, io.vertx.core.json.JsonObject config)
      Parameters:
      vertx - the Vert.x instance
      config - the configuration
      Returns:
      the client

    • createShared

      public static JDBCClient createShared(Vertx vertx, io.vertx.core.json.JsonObject config, String dataSourceName)
      Parameters:
      vertx - the Vert.x instance
      config - the configuration
      dataSourceName - the data source name
      Returns:
      the client

    • createShared

      public static JDBCClient createShared(Vertx vertx, io.vertx.core.json.JsonObject config)
      Parameters:
      vertx - the Vert.x instance
      config - the configuration
      Returns:
      the client

    • newInstance

      public static JDBCClient newInstance(io.vertx.ext.jdbc.JDBCClient arg)