io.r2dbc.mssql.api

Interface MssqlTransactionDefinition

All Superinterfaces:

TransactionDefinition

public interface MssqlTransactionDefinition
extends TransactionDefinition

TransactionDefinition for a SQL Server database.

Since:

0.9

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
static Option<String>	MARK The WITH MARK description is a string that marks the transaction in the transaction log and being stored in the msdb.dbo.logmarkhistory table.

Fields inherited from interface io.r2dbc.spi.TransactionDefinition

ISOLATION_LEVEL, LOCK_WAIT_TIMEOUT, NAME, READ_ONLY

Method Summary

Modifier and Type	Method and Description
static MssqlTransactionDefinition	from(IsolationLevel isolationLevel) Creates a MssqlTransactionDefinition given IsolationLevel.
MssqlTransactionDefinition	isolationLevel(IsolationLevel isolationLevel) Creates a MssqlTransactionDefinition retaining all configured options and applying IsolationLevel.
MssqlTransactionDefinition	lockTimeout(Duration timeout) Creates a MssqlTransactionDefinition retaining all configured options and applying lock timeout.
MssqlTransactionDefinition	mark(String mark) Creates a MssqlTransactionDefinition retaining all configured options and using the given transaction mark.
MssqlTransactionDefinition	name(String name) Creates a MssqlTransactionDefinition retaining all configured options and using the given transaction name.
static MssqlTransactionDefinition	named(String name) Creates a MssqlTransactionDefinition specifying the transaction name.

Methods inherited from interface io.r2dbc.spi.TransactionDefinition

getAttribute

Field Detail

MARK

static final Option<String> MARK

The WITH MARK description is a string that marks the transaction in the transaction log and being stored in the msdb.dbo.logmarkhistory table.

Method Detail

from

static MssqlTransactionDefinition from(IsolationLevel isolationLevel)

Creates a MssqlTransactionDefinition given IsolationLevel.

Parameters:

isolationLevel - the isolation level to use during the transaction.

Returns:

a new MssqlTransactionDefinition using IsolationLevel.

Throws:

IllegalArgumentException - if isolationLevel is null.

named

static MssqlTransactionDefinition named(String name)

Creates a MssqlTransactionDefinition specifying the transaction name.

Parameters:

name - the transaction name. Must not exceed 32 characters. The name is always case sensitive, even when the instance of SQL Server is not case sensitive

Returns:

a new MssqlTransactionDefinition using transaction name.

isolationLevel

MssqlTransactionDefinition isolationLevel(IsolationLevel isolationLevel)

Creates a MssqlTransactionDefinition retaining all configured options and applying IsolationLevel.

Parameters:

isolationLevel - the isolation level to use during the transaction.

Returns:

a new MssqlTransactionDefinition retaining all configured options and applying IsolationLevel.

Throws:

IllegalArgumentException - if isolationLevel is null.

lockTimeout

MssqlTransactionDefinition lockTimeout(Duration timeout)

Creates a MssqlTransactionDefinition retaining all configured options and applying lock timeout.

Parameters:

timeout - the lock timeout.

Returns:

a new MssqlTransactionDefinition retaining all configured options and applying lock timeout.

Throws:

IllegalArgumentException - if timeout is null.

name

MssqlTransactionDefinition name(String name)

Creates a MssqlTransactionDefinition retaining all configured options and using the given transaction name.

Parameters:

name - the transaction name. Must not exceed 32 characters. The name is always case sensitive, even when the instance of SQL Server is not case sensitive

Returns:

a new MssqlTransactionDefinition retaining all configured options and using the given transaction name.

Throws:

IllegalArgumentException - if name is null.

mark

MssqlTransactionDefinition mark(String mark)

Creates a MssqlTransactionDefinition retaining all configured options and using the given transaction mark. Specifies that the transaction is marked in the log. This method updates the transaction name to mark if no name was set.

If WITH MARK is used, a transaction name must be specified. WITH MARK allows for restoring a transaction log to a named mark.

Parameters:

mark - describes the mark. A description longer than 128 characters is truncated to 128 characters before being stored in the msdb.dbo.logmarkhistory table.

Returns:

a new MssqlTransactionDefinition retaining all configured options and using the given transaction mark.

Throws:

IllegalArgumentException - if mark is null.