io.asyncer.r2dbc.mysql.api

Interface MySqlTransactionDefinition

All Superinterfaces:

io.r2dbc.spi.TransactionDefinition

public interface MySqlTransactionDefinition
extends io.r2dbc.spi.TransactionDefinition

TransactionDefinition for a MySQL database.

Since:

1.1.3

Field Summary

Fields

Modifier and Type	Field and Description
static io.r2dbc.spi.Option<String>	CONSISTENT_SNAPSHOT_ENGINE Use WITH CONSISTENT [engine] SNAPSHOT for Facebook/MySQL or similar property.
static io.r2dbc.spi.Option<Long>	CONSISTENT_SNAPSHOT_FROM_SESSION Use WITH CONSISTENT SNAPSHOT FROM SESSION [session_id] for Percona/MySQL or similar property.
static io.r2dbc.spi.Option<Boolean>	WITH_CONSISTENT_SNAPSHOT Use WITH CONSISTENT SNAPSHOT property.

Fields inherited from interface io.r2dbc.spi.TransactionDefinition

ISOLATION_LEVEL, LOCK_WAIT_TIMEOUT, NAME, READ_ONLY

Method Summary

Modifier and Type	Method and Description
MySqlTransactionDefinition	consistent() Creates a MySqlTransactionDefinition retaining all configured options and applying to with consistent snapshot.
MySqlTransactionDefinition	consistent(String engine) Creates a MySqlTransactionDefinition retaining all configured options and applying to with consistent engine snapshot.
MySqlTransactionDefinition	consistent(String engine, long sessionId) Creates a MySqlTransactionDefinition retaining all configured options and applying to with consistent engine snapshot from session.
MySqlTransactionDefinition	consistentFromSession(long sessionId) Creates a MySqlTransactionDefinition retaining all configured options and applying to with consistent snapshot from session.
static MySqlTransactionDefinition	empty() Gets an empty MySqlTransactionDefinition.
static MySqlTransactionDefinition	from(io.r2dbc.spi.IsolationLevel isolationLevel)
MySqlTransactionDefinition	isolationLevel(io.r2dbc.spi.IsolationLevel isolationLevel) Creates a MySqlTransactionDefinition retaining all configured options and applying IsolationLevel.
MySqlTransactionDefinition	lockWaitTimeout(Duration timeout) Creates a MySqlTransactionDefinition retaining all configured options and applying a lock wait timeout.
static MySqlTransactionDefinition	mutability(boolean readWrite) Creates a MySqlTransactionDefinition specifying transaction mutability.
MySqlTransactionDefinition	readOnly() Creates a MySqlTransactionDefinition retaining all configured options and using read-only transaction semantics.
MySqlTransactionDefinition	readWrite() Creates a MySqlTransactionDefinition retaining all configured options and using explicitly read-write transaction semantics.
MySqlTransactionDefinition	withoutConsistent() Creates a MySqlTransactionDefinition retaining all configured options and applying to without consistent snapshot.
MySqlTransactionDefinition	withoutIsolationLevel() Creates a MySqlTransactionDefinition retaining all configured options and using the default isolation level.
MySqlTransactionDefinition	withoutLockWaitTimeout() Creates a MySqlTransactionDefinition retaining all configured options and applying to use the default lock wait timeout.
MySqlTransactionDefinition	withoutMutability() Creates a MySqlTransactionDefinition retaining all configured options and avoid to using explicitly mutability.

Methods inherited from interface io.r2dbc.spi.TransactionDefinition

getAttribute

Field Detail

WITH_CONSISTENT_SNAPSHOT

static final io.r2dbc.spi.Option<Boolean> WITH_CONSISTENT_SNAPSHOT

Use WITH CONSISTENT SNAPSHOT property.

The option starts a consistent read for storage engines such as InnoDB and XtraDB that can do so, the same as if a START TRANSACTION followed by a SELECT ... from any InnoDB table was issued.

CONSISTENT_SNAPSHOT_ENGINE

static final io.r2dbc.spi.Option<String> CONSISTENT_SNAPSHOT_ENGINE

Use WITH CONSISTENT [engine] SNAPSHOT for Facebook/MySQL or similar property. Only available when WITH_CONSISTENT_SNAPSHOT is set to true.

Note: This is an extended syntax based on specific distributions. Please check whether the server supports this property before using it.

CONSISTENT_SNAPSHOT_FROM_SESSION

static final io.r2dbc.spi.Option<Long> CONSISTENT_SNAPSHOT_FROM_SESSION

Use WITH CONSISTENT SNAPSHOT FROM SESSION [session_id] for Percona/MySQL or similar property. Only available when WITH_CONSISTENT_SNAPSHOT is set to true.

The session_id is received by SHOW COLUMNS FROM performance_schema.processlist, it should be an unsigned 64-bit integer. Use SHOW PROCESSLIST to find session identifier of the process list.

Note: This is an extended syntax based on specific distributions. Please check whether the server supports this property before using it.

Method Detail

isolationLevel

MySqlTransactionDefinition isolationLevel(io.r2dbc.spi.IsolationLevel isolationLevel)

Creates a MySqlTransactionDefinition retaining all configured options and applying IsolationLevel.

Parameters:

isolationLevel - the isolation level to use during the transaction.

Returns:

a new MySqlTransactionDefinition with the isolationLevel.

Throws:

IllegalArgumentException - if isolationLevel is null.

withoutIsolationLevel

MySqlTransactionDefinition withoutIsolationLevel()

Creates a MySqlTransactionDefinition retaining all configured options and using the default isolation level. Removes transaction isolation level if configured already.

Returns:

a new MySqlTransactionDefinition without specified isolation level.

readOnly

MySqlTransactionDefinition readOnly()

Creates a MySqlTransactionDefinition retaining all configured options and using read-only transaction semantics. Overrides transaction mutability if configured already.

Returns:

a new MySqlTransactionDefinition with read-only semantics.

readWrite

MySqlTransactionDefinition readWrite()

Creates a MySqlTransactionDefinition retaining all configured options and using explicitly read-write transaction semantics. Overrides transaction mutability if configured already.

Returns:

a new MySqlTransactionDefinition with read-write semantics.

withoutMutability

MySqlTransactionDefinition withoutMutability()

Creates a MySqlTransactionDefinition retaining all configured options and avoid to using explicitly mutability. Removes transaction mutability if configured already.

Returns:

a new MySqlTransactionDefinition without explicitly mutability.

lockWaitTimeout

MySqlTransactionDefinition lockWaitTimeout(Duration timeout)

Creates a MySqlTransactionDefinition retaining all configured options and applying a lock wait timeout. Overrides transaction lock wait timeout if configured already.

Note: for now, it is only available in InnoDB or InnoDB-compatible engines.

Parameters:

timeout - the lock wait timeout.

Returns:

a new MySqlTransactionDefinition with the timeout.

Throws:

IllegalArgumentException - if timeout is null.

withoutLockWaitTimeout

MySqlTransactionDefinition withoutLockWaitTimeout()

Creates a MySqlTransactionDefinition retaining all configured options and applying to use the default lock wait timeout. Removes transaction lock wait timeout if configured already.

Returns:

a new MySqlTransactionDefinition without specified lock wait timeout.

consistent

MySqlTransactionDefinition consistent()

Creates a MySqlTransactionDefinition retaining all configured options and applying to with consistent snapshot. Overrides transaction consistency if configured already.

Returns:

a new MySqlTransactionDefinition with consistent snapshot semantics.

consistent

MySqlTransactionDefinition consistent(String engine)

Creates a MySqlTransactionDefinition retaining all configured options and applying to with consistent engine snapshot. Overrides transaction consistency if configured already.

Parameters:

engine - the consistent snapshot engine, e.g. ROCKSDB.

Returns:

a new MySqlTransactionDefinition with consistent snapshot semantics.

Throws:

IllegalArgumentException - if engine is null.

consistent

MySqlTransactionDefinition consistent(String engine,
                                      long sessionId)

Creates a MySqlTransactionDefinition retaining all configured options and applying to with consistent engine snapshot from session. Overrides transaction consistency if configured already.

Parameters:

engine - the consistent snapshot engine, e.g. ROCKSDB.

sessionId - the session id.

Returns:

a new MySqlTransactionDefinition with consistent snapshot semantics.

Throws:

IllegalArgumentException - if engine is null.

consistentFromSession

MySqlTransactionDefinition consistentFromSession(long sessionId)

Creates a MySqlTransactionDefinition retaining all configured options and applying to with consistent snapshot from session. Overrides transaction consistency if configured already.

Parameters:

sessionId - the session id.

Returns:

a new MySqlTransactionDefinition with consistent snapshot semantics.

withoutConsistent

MySqlTransactionDefinition withoutConsistent()

Creates a MySqlTransactionDefinition retaining all configured options and applying to without consistent snapshot. Removes transaction consistency if configured already.

Returns:

a new MySqlTransactionDefinition without consistent snapshot semantics.

empty

static MySqlTransactionDefinition empty()

Gets an empty MySqlTransactionDefinition.

Returns:

an empty MySqlTransactionDefinition.

mutability

static MySqlTransactionDefinition mutability(boolean readWrite)

Creates a MySqlTransactionDefinition specifying transaction mutability.

Parameters:

readWrite - true for read-write, false to use a read-only transaction.

Returns:

a new MySqlTransactionDefinition using the specified transaction mutability.

from

static MySqlTransactionDefinition from(io.r2dbc.spi.IsolationLevel isolationLevel)