Package io.vertx.mutiny.sqlclient
Class SqlClient
- java.lang.Object
-
- io.vertx.mutiny.sqlclient.SqlClient
-
- Direct Known Subclasses:
Pool
,SqlConnection
public class SqlClient extends Object
Defines common SQL client operations with a database server. NOTE: This class has been automatically generated from theoriginal
non Mutiny-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<SqlClient>
__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description io.smallrye.mutiny.Uni<Void>
close()
Close the client and release the associated resources.Void
closeAndAwait()
Blocking variant ofclose()
.void
closeAndForget()
Variant ofclose()
that ignores the result of the operation.boolean
equals(Object o)
io.vertx.sqlclient.SqlClient
getDelegate()
int
hashCode()
static SqlClient
newInstance(io.vertx.sqlclient.SqlClient arg)
PreparedQuery<RowSet<Row>>
preparedQuery(String sql)
PreparedQuery<RowSet<Row>>
preparedQuery(String sql, io.vertx.sqlclient.PrepareOptions options)
Query<RowSet<Row>>
query(String sql)
String
toString()
-
-
-
Constructor Detail
-
SqlClient
public SqlClient(io.vertx.sqlclient.SqlClient delegate)
-
SqlClient
public SqlClient(Object delegate)
-
-
Method Detail
-
getDelegate
public io.vertx.sqlclient.SqlClient getDelegate()
-
preparedQuery
public PreparedQuery<RowSet<Row>> preparedQuery(String sql)
- Parameters:
sql
-- Returns:
- the prepared query
-
preparedQuery
public PreparedQuery<RowSet<Row>> preparedQuery(String sql, io.vertx.sqlclient.PrepareOptions options)
- Parameters:
sql
-options
-- Returns:
- the prepared query
-
close
@CheckReturnValue public io.smallrye.mutiny.Uni<Void> close()
Close the client and release the associated resources.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
closeAndAwait
public Void closeAndAwait()
Blocking variant ofclose()
.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).
- Returns:
- the Void instance produced by the operation.
-
closeAndForget
public void closeAndForget()
-
newInstance
public static SqlClient newInstance(io.vertx.sqlclient.SqlClient arg)
-
-