Package io.vertx.mutiny.mssqlclient

Class MSSQLConnection

java.lang.Object

io.vertx.mutiny.sqlclient.SqlClient

io.vertx.mutiny.sqlclient.SqlConnection

io.vertx.mutiny.mssqlclient.MSSQLConnection

public class MSSQLConnection
extends SqlConnection

A connection to Microsoft SQL Server.

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

Field Summary

Fields

Modifier and Type	Field	Description
static TypeArg<MSSQLConnection>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
MSSQLConnection(io.vertx.mssqlclient.MSSQLConnection delegate)
MSSQLConnection(Object delegate)

Method Summary

Modifier and Type	Method	Description
static MSSQLConnection	cast(SqlConnection sqlConnection)
MSSQLConnection	closeHandler(Runnable handler)
static io.smallrye.mutiny.Uni<MSSQLConnection>	connect(Vertx vertx, io.vertx.mssqlclient.MSSQLConnectOptions connectOptions)	Create a connection to SQL Server with the given connectOptions.
static io.smallrye.mutiny.Uni<MSSQLConnection>	connect(Vertx vertx, String connectionUri)	Like connect(io.vertx.mutiny.core.Vertx, io.vertx.mssqlclient.MSSQLConnectOptions) with options built from connectionUri.
static MSSQLConnection	connectAndAwait(Vertx vertx, io.vertx.mssqlclient.MSSQLConnectOptions connectOptions)	Blocking variant of connect(io.vertx.mutiny.core.Vertx,MSSQLConnectOptions).
static MSSQLConnection	connectAndAwait(Vertx vertx, String connectionUri)	Blocking variant of connect(io.vertx.mutiny.core.Vertx,String).
static void	connectAndForget(Vertx vertx, io.vertx.mssqlclient.MSSQLConnectOptions connectOptions)	Variant of connect(io.vertx.mutiny.core.Vertx,MSSQLConnectOptions) that ignores the result of the operation.
static void	connectAndForget(Vertx vertx, String connectionUri)	Variant of connect(io.vertx.mutiny.core.Vertx,String) that ignores the result of the operation.
boolean	equals(Object o)
MSSQLConnection	exceptionHandler(Consumer<Throwable> handler)
io.vertx.mssqlclient.MSSQLConnection	getDelegate()
int	hashCode()
MSSQLConnection	infoHandler(Consumer<io.vertx.mssqlclient.MSSQLInfo> handler)
static MSSQLConnection	newInstance(io.vertx.mssqlclient.MSSQLConnection arg)
io.smallrye.mutiny.Uni<PreparedStatement>	prepare(String s)	Unlike the bare Vert.x variant, this method returns a Uni.
PreparedStatement	prepareAndAwait(String s)	Blocking variant of prepare(String).
MSSQLConnection	prepareAndForget(String s)	Variant of prepare(String) that ignores the result of the operation.
String	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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<MSSQLConnection> __TYPE_ARG

Constructor Detail

MSSQLConnection

public MSSQLConnection(io.vertx.mssqlclient.MSSQLConnection delegate)

MSSQLConnection

public MSSQLConnection(Object delegate)

Method Detail

getDelegate

public io.vertx.mssqlclient.MSSQLConnection getDelegate()

Overrides:

getDelegate in class SqlConnection

toString

public String toString()

Overrides:

toString in class SqlConnection

equals

public boolean equals(Object o)

Overrides:

equals in class SqlConnection

hashCode

public int hashCode()

Overrides:

hashCode in class SqlConnection

connect

@CheckReturnValue
public static io.smallrye.mutiny.Uni<MSSQLConnection> connect(Vertx vertx,
                                                              io.vertx.mssqlclient.MSSQLConnectOptions connectOptions)

Create a connection to SQL Server with the given connectOptions.

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 instance

connectOptions - 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 MSSQLConnection connectAndAwait(Vertx vertx,
                                              io.vertx.mssqlclient.MSSQLConnectOptions connectOptions)

Blocking variant of connect(io.vertx.mutiny.core.Vertx,MSSQLConnectOptions).

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 instance

connectOptions - the options for the connection

Returns:

the MSSQLConnection instance produced by the operation.

connectAndForget

public static void connectAndForget(Vertx vertx,
                                    io.vertx.mssqlclient.MSSQLConnectOptions connectOptions)

Variant of connect(io.vertx.mutiny.core.Vertx,MSSQLConnectOptions) that ignores the result of the operation.

This method subscribes on the result of connect(io.vertx.mutiny.core.Vertx,MSSQLConnectOptions), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from connect(io.vertx.mutiny.core.Vertx,MSSQLConnectOptions) but you don't need to compose it with other operations.

Parameters:

vertx - the vertx instance

connectOptions - the options for the connection

connect

@CheckReturnValue
public static io.smallrye.mutiny.Uni<MSSQLConnection> connect(Vertx vertx,
                                                              String connectionUri)

Like connect(io.vertx.mutiny.core.Vertx, io.vertx.mssqlclient.MSSQLConnectOptions) with options built from connectionUri.

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

public static MSSQLConnection connectAndAwait(Vertx vertx,
                                              String connectionUri)

Blocking variant of connect(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 MSSQLConnection instance produced by the operation.

connectAndForget

public static void connectAndForget(Vertx vertx,
                                    String connectionUri)

Variant of connect(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 from connect(io.vertx.mutiny.core.Vertx,String) but you don't need to compose it with other operations.

Parameters:

vertx -

connectionUri -

prepare

@CheckReturnValue
public io.smallrye.mutiny.Uni<PreparedStatement> prepare(String s)

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 class SqlConnection

Parameters:

s -

Returns:

the uni firing the result of the operation when completed, or a failure if the operation failed.

prepareAndAwait

public PreparedStatement prepareAndAwait(String s)

Blocking variant of 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 class SqlConnection

Parameters:

s -

Returns:

the PreparedStatement instance produced by the operation.

prepareAndForget

public MSSQLConnection prepareAndForget(String s)

Variant of prepare(String) that ignores the result of the operation.

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

Overrides:

prepareAndForget in class SqlConnection

Parameters:

s -

Returns:

the instance of MSSQLConnection to chain method calls.

exceptionHandler

public MSSQLConnection exceptionHandler(Consumer<Throwable> handler)

Overrides:

exceptionHandler in class SqlConnection

Parameters:

handler -

Returns:

closeHandler

public MSSQLConnection closeHandler(Runnable handler)

Overrides:

closeHandler in class SqlConnection

Parameters:

handler -

Returns:

infoHandler

public MSSQLConnection infoHandler(Consumer<io.vertx.mssqlclient.MSSQLInfo> handler)

Parameters:

handler - the handler

Returns:

cast

public static MSSQLConnection cast(SqlConnection sqlConnection)

Parameters:

sqlConnection - the connection to cast

Returns:

a instance

newInstance

public static MSSQLConnection newInstance(io.vertx.mssqlclient.MSSQLConnection arg)