io.asyncer.r2dbc.mysql.api

Interface MySqlConnection

All Superinterfaces:

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

public interface MySqlConnection
extends io.r2dbc.spi.Connection, io.r2dbc.spi.Lifecycle

A Connection for connecting to a MySQL database.

Since:

1.1.3

Method Summary

Modifier and Type	Method and Description
Mono<Void>	beginTransaction()
Mono<Void>	beginTransaction(io.r2dbc.spi.TransactionDefinition definition)
Mono<Void>	close()
Mono<Void>	commitTransaction()
MySqlBatch	createBatch()
Mono<Void>	createSavepoint(String name)
MySqlStatement	createStatement(String sql)
MySqlConnectionMetadata	getMetadata()
Mono<Void>	postAllocate()
Mono<Void>	preRelease()
Mono<Void>	releaseSavepoint(String name)
Mono<Void>	rollbackTransaction()
Mono<Void>	rollbackTransactionToSavepoint(String name)
Mono<Void>	setAutoCommit(boolean autoCommit)
Mono<Void>	setLockWaitTimeout(Duration timeout)
Mono<Void>	setStatementTimeout(Duration timeout)
Mono<Void>	setTransactionIsolationLevel(io.r2dbc.spi.IsolationLevel isolationLevel)
Mono<Boolean>	validate(io.r2dbc.spi.ValidationDepth depth)

Methods inherited from interface io.r2dbc.spi.Connection

getTransactionIsolationLevel, isAutoCommit

Method Detail

beginTransaction

Mono<Void> beginTransaction()

Note: MySQL server will disable the auto-commit mode automatically when a transaction is started.

Specified by:

beginTransaction in interface io.r2dbc.spi.Connection

Returns:

a Mono that indicates that the transaction has begun

beginTransaction

Mono<Void> beginTransaction(io.r2dbc.spi.TransactionDefinition definition)

Note: MySQL server will disable the auto-commit mode automatically when a transaction is started.

Specified by:

beginTransaction in interface io.r2dbc.spi.Connection

Parameters:

definition - the transaction definition, must not be null

Returns:

a Mono that indicates that the transaction has begun

Throws:

IllegalArgumentException - if definition is null

close

Mono<Void> close()

Specified by:

close in interface io.r2dbc.spi.Closeable

Specified by:

close in interface io.r2dbc.spi.Connection

Returns:

a Mono that indicates that the connection has been closed

commitTransaction

Mono<Void> commitTransaction()

Specified by:

commitTransaction in interface io.r2dbc.spi.Connection

Returns:

a Mono that indicates that the transaction has been committed

createBatch

MySqlBatch createBatch()

Specified by:

createBatch in interface io.r2dbc.spi.Connection

Returns:

a MySqlBatch that can be used to execute a batch of statements

createSavepoint

Mono<Void> createSavepoint(String name)

Specified by:

createSavepoint in interface io.r2dbc.spi.Connection

Parameters:

name - the savepoint name, must not be null

Returns:

a Mono that indicates that the savepoint has been created

Throws:

IllegalArgumentException - if name is null

createStatement

MySqlStatement createStatement(String sql)

Specified by:

createStatement in interface io.r2dbc.spi.Connection

Parameters:

sql - the SQL to execute, must not be null

Returns:

a new MySqlStatement instance

Throws:

IllegalArgumentException - if sql is null

getMetadata

MySqlConnectionMetadata getMetadata()

Specified by:

getMetadata in interface io.r2dbc.spi.Connection

Returns:

a MySqlConnectionMetadata that contains the connection metadata

releaseSavepoint

Mono<Void> releaseSavepoint(String name)

Specified by:

releaseSavepoint in interface io.r2dbc.spi.Connection

Parameters:

name - the savepoint name, must not be null

Returns:

a Mono that indicates that the savepoint has been released

Throws:

IllegalArgumentException - if name is null

rollbackTransaction

Mono<Void> rollbackTransaction()

Specified by:

rollbackTransaction in interface io.r2dbc.spi.Connection

Returns:

a Mono that indicates that the transaction has been rolled back

rollbackTransactionToSavepoint

Mono<Void> rollbackTransactionToSavepoint(String name)

Specified by:

rollbackTransactionToSavepoint in interface io.r2dbc.spi.Connection

Parameters:

name - the savepoint name, must not be null

Returns:

a Mono that indicates that the transaction has been rolled back to the savepoint

Throws:

IllegalArgumentException - if name is null

setAutoCommit

Mono<Void> setAutoCommit(boolean autoCommit)

Specified by:

setAutoCommit in interface io.r2dbc.spi.Connection

Parameters:

autoCommit - the auto-commit mode

Returns:

a Mono that indicates that the auto-commit mode has been set

setLockWaitTimeout

Mono<Void> setLockWaitTimeout(Duration timeout)

Note: Currently, it should be used only for InnoDB storage engine.

Specified by:

setLockWaitTimeout in interface io.r2dbc.spi.Connection

Parameters:

timeout - the lock wait timeout, must not be null

Returns:

a Mono that indicates that the lock wait timeout has been set

Throws:

IllegalArgumentException - if timeout is null

setStatementTimeout

Mono<Void> setStatementTimeout(Duration timeout)

Specified by:

setStatementTimeout in interface io.r2dbc.spi.Connection

Parameters:

timeout - the statement timeout, must not be null

Returns:

a Mono that indicates that the statement timeout has been set

Throws:

IllegalArgumentException - if timeout is null

setTransactionIsolationLevel

Mono<Void> setTransactionIsolationLevel(io.r2dbc.spi.IsolationLevel isolationLevel)

Specified by:

setTransactionIsolationLevel in interface io.r2dbc.spi.Connection

Parameters:

isolationLevel - the isolation level, must not be null

Returns:

a Mono that indicates that the isolation level of the current session has been set

Throws:

IllegalArgumentException - if isolationLevel is null

validate

Mono<Boolean> validate(io.r2dbc.spi.ValidationDepth depth)

Specified by:

validate in interface io.r2dbc.spi.Connection

Parameters:

depth - the validation depth, must not be null

Returns:

a Mono that indicates that the connection has been validated

Throws:

IllegalArgumentException - if depth is null

postAllocate

Mono<Void> postAllocate()

Specified by:

postAllocate in interface io.r2dbc.spi.Lifecycle

Returns:

a Mono that indicates that the connection is ready for usage

preRelease

Mono<Void> preRelease()

Specified by:

preRelease in interface io.r2dbc.spi.Lifecycle

Returns:

a Mono that indicates that the connection is ready for release