io.micronaut.r2dbc.rxjava2

Interface RxConnection

All Superinterfaces:

io.r2dbc.spi.Closeable, io.r2dbc.spi.Connection

public interface RxConnection
extends io.r2dbc.spi.Connection

Specialization of Connection for RxJava.

Since:

1.0.0

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
io.reactivex.Flowable<java.lang.Void>	beginTransaction() Begins a new transaction.
io.reactivex.Flowable<java.lang.Void>	close() Release any resources held by the Connection.
io.reactivex.Flowable<java.lang.Void>	commitTransaction() Commits the current transaction.
RxBatch	createBatch() Creates a new RxBatch instance for building a batched request.
io.reactivex.Flowable<java.lang.Void>	createSavepoint(java.lang.String name) Creates a savepoint in the current transaction.
RxStatement	createStatement(java.lang.String sql) Creates a new statement for building a statement-based request.
io.reactivex.Flowable<java.lang.Void>	releaseSavepoint(java.lang.String name) Releases a savepoint in the current transaction.
io.reactivex.Flowable<java.lang.Void>	rollbackTransaction() Rolls back the current transaction.
io.reactivex.Flowable<java.lang.Void>	rollbackTransactionToSavepoint(java.lang.String name) Rolls back to a savepoint in the current transaction.
io.reactivex.Flowable<java.lang.Void>	setAutoCommit(boolean autoCommit) Configures the auto-commit mode for the current transaction.
io.reactivex.Flowable<java.lang.Void>	setTransactionIsolationLevel(io.r2dbc.spi.IsolationLevel isolationLevel) Configures the isolation level for the current transaction.
io.reactivex.Flowable<java.lang.Boolean>	validate(io.r2dbc.spi.ValidationDepth depth) Validates the connection according to the given ValidationDepth.

Methods inherited from interface io.r2dbc.spi.Connection

getMetadata, getTransactionIsolationLevel, isAutoCommit

Method Detail

createBatch

@NonNull
RxBatch createBatch()

Creates a new RxBatch instance for building a batched request.

Specified by:

createBatch in interface io.r2dbc.spi.Connection

Returns:

a new RxBatch instance

createStatement

@NonNull
RxStatement createStatement(@NonNull
                                     java.lang.String sql)

Creates a new statement for building a statement-based request.

Specified by:

createStatement in interface io.r2dbc.spi.Connection

Parameters:

sql - the SQL of the statement

Returns:

a new RxStatement instance

Throws:

java.lang.IllegalArgumentException - if sql is null

beginTransaction

@NonNull
io.reactivex.Flowable<java.lang.Void> beginTransaction()

Begins a new transaction. Calling this method disables auto-commit mode.

Specified by:

beginTransaction in interface io.r2dbc.spi.Connection

Returns:

a Flowable that indicates that the transaction is open

close

@NonNull
io.reactivex.Flowable<java.lang.Void> close()

Release any resources held by the Connection.

Specified by:

close in interface io.r2dbc.spi.Closeable

Specified by:

close in interface io.r2dbc.spi.Connection

Returns:

a Flowable that termination is complete

commitTransaction

@NonNull
io.reactivex.Flowable<java.lang.Void> commitTransaction()

Commits the current transaction.

Specified by:

commitTransaction in interface io.r2dbc.spi.Connection

Returns:

a Flowable that indicates that a transaction has been committed

createSavepoint

@NonNull
io.reactivex.Flowable<java.lang.Void> createSavepoint(java.lang.String name)

Creates a savepoint in the current transaction.

Specified by:

createSavepoint in interface io.r2dbc.spi.Connection

Parameters:

name - the name of the savepoint to create

Returns:

a Flowable that indicates that a savepoint has been created

Throws:

java.lang.IllegalArgumentException - if name is null

java.lang.UnsupportedOperationException - if savepoints are not supported

releaseSavepoint

@NonNull
io.reactivex.Flowable<java.lang.Void> releaseSavepoint(@NonNull
                                                                java.lang.String name)

Releases a savepoint in the current transaction. Calling this for drivers not supporting savepoint release results in a no-op.

Specified by:

releaseSavepoint in interface io.r2dbc.spi.Connection

Parameters:

name - the name of the savepoint to release

Returns:

a Flowable that indicates that a savepoint has been released

Throws:

java.lang.IllegalArgumentException - if name is null

rollbackTransaction

@NonNull
io.reactivex.Flowable<java.lang.Void> rollbackTransaction()

Rolls back the current transaction.

Specified by:

rollbackTransaction in interface io.r2dbc.spi.Connection

Returns:

a Flowable that indicates that a transaction has been rolled back

rollbackTransactionToSavepoint

@NonNull
io.reactivex.Flowable<java.lang.Void> rollbackTransactionToSavepoint(@NonNull
                                                                              java.lang.String name)

Rolls back to a savepoint in the current transaction.

Specified by:

rollbackTransactionToSavepoint in interface io.r2dbc.spi.Connection

Parameters:

name - the name of the savepoint to rollback to

Returns:

a Flowable that indicates that a savepoint has been rolled back to

Throws:

java.lang.IllegalArgumentException - if name is null

java.lang.UnsupportedOperationException - if savepoints are not supported

setAutoCommit

@NonNull
io.reactivex.Flowable<java.lang.Void> setAutoCommit(boolean autoCommit)

Configures the auto-commit mode for the current transaction. If a connection is in auto-commit mode, then all Statements will be executed and committed as individual transactions. Otherwise, in explicit transaction mode, transactions have to be started explicitly. A transaction needs to be either committed or rolled back to clean up the transaction state.

Calling this method during an active transaction and the auto-commit mode is changed, the transaction is committed. Calling this method without changing auto-commit mode this invocation results in a no-op.

Specified by:

setAutoCommit in interface io.r2dbc.spi.Connection

Parameters:

autoCommit - the isolation level for this transaction

Returns:

a Flowable that indicates that auto-commit mode has been configured

setTransactionIsolationLevel

@NonNull
io.reactivex.Flowable<java.lang.Void> setTransactionIsolationLevel(@NonNull
                                                                            io.r2dbc.spi.IsolationLevel isolationLevel)

Configures the isolation level for the current transaction.

Isolation level is typically one of the following constants:

• IsolationLevel.READ_UNCOMMITTED
• IsolationLevel.READ_COMMITTED
• IsolationLevel.REPEATABLE_READ
• IsolationLevel.SERIALIZABLE

IsolationLevel is extensible so drivers can accept a vendor-specific IsolationLevel.

Specified by:

setTransactionIsolationLevel in interface io.r2dbc.spi.Connection

Parameters:

isolationLevel - the isolation level for this transaction

Returns:

a Flowable that indicates that a transaction level has been configured

Throws:

java.lang.IllegalArgumentException - if isolationLevel is null

validate

@NonNull
io.reactivex.Flowable<java.lang.Boolean> validate(@NonNull
                                                           io.r2dbc.spi.ValidationDepth depth)

Validates the connection according to the given ValidationDepth. Emits true if the validation was successful or false if the validation failed. Does not emit errors and does not complete empty.

Specified by:

validate in interface io.r2dbc.spi.Connection

Parameters:

depth - the validation depth

Returns:

a Flowable that indicates whether the validation was successful

Throws:

java.lang.IllegalArgumentException - if depth is null