Class DB2Connection
- All Implemented Interfaces:
MutinyDelegate
original
non Mutiny-ified interface using Vert.x codegen.-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDB2Connection
(io.vertx.db2client.DB2Connection delegate) DB2Connection
(Object delegate) -
Method Summary
Modifier and TypeMethodDescriptionstatic DB2Connection
cast
(SqlConnection sqlConnection) closeHandler
(Runnable handler) static io.smallrye.mutiny.Uni<DB2Connection>
Create a connection to DB2 server with the givenconnectOptions
.static io.smallrye.mutiny.Uni<DB2Connection>
Likeconnect(io.vertx.mutiny.core.Vertx, io.vertx.db2client.DB2ConnectOptions)
with options build fromconnectionUri
.static DB2Connection
connectAndAwait
(Vertx vertx, io.vertx.db2client.DB2ConnectOptions connectOptions) Blocking variant ofconnect(io.vertx.mutiny.core.Vertx,DB2ConnectOptions)
.static DB2Connection
connectAndAwait
(Vertx vertx, String connectionUri) Blocking variant ofconnect(io.vertx.mutiny.core.Vertx,String)
.static void
connectAndForget
(Vertx vertx, io.vertx.db2client.DB2ConnectOptions connectOptions) Variant ofconnect(io.vertx.mutiny.core.Vertx,DB2ConnectOptions)
that ignores the result of the operation.static void
connectAndForget
(Vertx vertx, String connectionUri) Variant ofconnect(io.vertx.mutiny.core.Vertx,String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
debug()
Send a DEBUG command to dump debug information to the server's stdout.Blocking variant ofdebug()
.Variant ofdebug()
that ignores the result of the operation.boolean
exceptionHandler
(Consumer<Throwable> handler) io.vertx.db2client.DB2Connection
int
hashCode()
static DB2Connection
newInstance
(io.vertx.db2client.DB2Connection arg) io.smallrye.mutiny.Uni<Void>
ping()
Send a PING command to check if the server is alive.Blocking variant ofping()
.Variant ofping()
that ignores the result of the operation.io.smallrye.mutiny.Uni<PreparedStatement>
Create a prepared statement using the givensql
string.prepareAndAwait
(String sql) Blocking variant ofSqlConnection.prepare(String)
.prepareAndForget
(String sql) Variant ofSqlConnection.prepare(String)
that ignores the result of the operation.toString()
Methods inherited from class io.vertx.mutiny.sqlclient.SqlConnection
begin, beginAndAwait, beginAndForget, close, closeAndAwait, closeAndForget, databaseMetadata, isSSL, newInstance, prepare, prepareAndAwait, prepareAndForget, transaction
Methods inherited from class io.vertx.mutiny.sqlclient.SqlClient
newInstance, preparedQuery, preparedQuery, query
-
Field Details
-
__TYPE_ARG
-
-
Constructor Details
-
DB2Connection
public DB2Connection(io.vertx.db2client.DB2Connection delegate) -
DB2Connection
-
-
Method Details
-
getDelegate
public io.vertx.db2client.DB2Connection getDelegate()- Specified by:
getDelegate
in interfaceMutinyDelegate
- Overrides:
getDelegate
in classSqlConnection
- Returns:
- the delegate used by this Mutiny object of generated type
-
toString
- Overrides:
toString
in classSqlConnection
-
equals
- Overrides:
equals
in classSqlConnection
-
hashCode
public int hashCode()- Overrides:
hashCode
in classSqlConnection
-
connect
@CheckReturnValue public static io.smallrye.mutiny.Uni<DB2Connection> connect(Vertx vertx, io.vertx.db2client.DB2ConnectOptions connectOptions) Create a connection to DB2 server with the givenconnectOptions
.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
vertx
- the vertx instanceconnectOptions
- the options for the connection- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
connectAndAwait
public static DB2Connection connectAndAwait(Vertx vertx, io.vertx.db2client.DB2ConnectOptions connectOptions) Blocking variant ofconnect(io.vertx.mutiny.core.Vertx,DB2ConnectOptions)
.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).
- Parameters:
vertx
- the vertx instanceconnectOptions
- the options for the connection- Returns:
- the DB2Connection instance produced by the operation.
-
connectAndForget
public static void connectAndForget(Vertx vertx, io.vertx.db2client.DB2ConnectOptions connectOptions) Variant ofconnect(io.vertx.mutiny.core.Vertx,DB2ConnectOptions)
that ignores the result of the operation.This method subscribes on the result of
connect(io.vertx.mutiny.core.Vertx,DB2ConnectOptions)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromconnect(io.vertx.mutiny.core.Vertx,DB2ConnectOptions)
but you don't need to compose it with other operations.- Parameters:
vertx
- the vertx instanceconnectOptions
- the options for the connection
-
connect
@CheckReturnValue public static io.smallrye.mutiny.Uni<DB2Connection> connect(Vertx vertx, String connectionUri) Likeconnect(io.vertx.mutiny.core.Vertx, io.vertx.db2client.DB2ConnectOptions)
with options build fromconnectionUri
.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
vertx
-connectionUri
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
connectAndAwait
Blocking variant ofconnect(io.vertx.mutiny.core.Vertx,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).
- Parameters:
vertx
-connectionUri
-- Returns:
- the DB2Connection instance produced by the operation.
-
connectAndForget
Variant ofconnect(io.vertx.mutiny.core.Vertx,String)
that ignores the result of the operation.This method subscribes on the result of
connect(io.vertx.mutiny.core.Vertx,String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromconnect(io.vertx.mutiny.core.Vertx,String)
but you don't need to compose it with other operations.- Parameters:
vertx
-connectionUri
-
-
prepare
Description copied from class:SqlConnection
Create a prepared statement using the givensql
string.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Overrides:
prepare
in classSqlConnection
- Parameters:
sql
- the sql- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
prepareAndAwait
Description copied from class:SqlConnection
Blocking variant ofSqlConnection.prepare(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).
- Overrides:
prepareAndAwait
in classSqlConnection
- Parameters:
sql
- the sql- Returns:
- the PreparedStatement instance produced by the operation.
-
prepareAndForget
Description copied from class:SqlConnection
Variant ofSqlConnection.prepare(String)
that ignores the result of the operation.This method subscribes on the result of
SqlConnection.prepare(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromSqlConnection.prepare(String)
but you don't need to compose it with other operations.- Overrides:
prepareAndForget
in classSqlConnection
- Parameters:
sql
- the sql- Returns:
- the instance of SqlConnection to chain method calls.
-
exceptionHandler
- Overrides:
exceptionHandler
in classSqlConnection
- Parameters:
handler
- the handler- Returns:
-
closeHandler
- Overrides:
closeHandler
in classSqlConnection
- Parameters:
handler
- the handler- Returns:
-
ping
Send a PING command to check if the server is alive.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.
-
pingAndAwait
Blocking variant ofping()
.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.
-
pingAndForget
Variant ofping()
that ignores the result of the operation.This method subscribes on the result of
ping()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromping()
but you don't need to compose it with other operations.- Returns:
- the instance of DB2Connection to chain method calls.
-
debug
Send a DEBUG command to dump debug information to the server's stdout.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.
-
debugAndAwait
Blocking variant ofdebug()
.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.
-
debugAndForget
Variant ofdebug()
that ignores the result of the operation.This method subscribes on the result of
debug()
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromdebug()
but you don't need to compose it with other operations.- Returns:
- the instance of DB2Connection to chain method calls.
-
cast
- Parameters:
sqlConnection
- the connection to cast- Returns:
- a
instance
-
newInstance
-