1. class
  2. SilverStripe
  3. \
  4. ORM
  5. \
  6. Connect
  7. \
  8. MySQLTransactionManager

MySQLTransactionManager

class MySQLTransactionManager implements TransactionManager

TransactionManager that executes MySQL-compatible transaction control queries

Methods

__construct(Database $dbConn)

No description

bool
transactionStart(string|boolean $transactionMode = false, string|boolean $sessionCharacteristics = false)

Start a prepared transaction

bool
transactionEnd($chain = false)

Complete a transaction

bool
transactionRollback(string $savepoint = null)

Roll-back a transaction

transactionSavepoint(string $savepoint)

Create a new savepoint

int
transactionDepth()

Return the depth of the transaction For unnested transactions returns 1 while in a transaction, 0 otherwise

boolean
supportsSavepoints()

Return true if savepoints are supported by this transaction manager.

Details

at line 16
__construct(Database $dbConn)

Parameters

Database $dbConn

at line 21
bool transactionStart(string|boolean $transactionMode = false, string|boolean $sessionCharacteristics = false)

Start a prepared transaction

Parameters

string|boolean $transactionMode Transaction mode, or false to ignore. Deprecated and will be removed in SS5.
string|boolean $sessionCharacteristics Session characteristics, or false to ignore. Deprecated and will be removed in SS5.

Return Value

bool True on success

Exceptions

DatabaseException on failure

at line 51
bool transactionEnd($chain = false)

Complete a transaction

Parameters

$chain

Return Value

bool True on success

Exceptions

DatabaseException on failure

at line 70
bool transactionRollback(string $savepoint = null)

Roll-back a transaction

Parameters

string $savepoint If set, roll-back to the named savepoint

Return Value

bool True on success

Exceptions

DatabaseException on failure

at line 86
transactionSavepoint(string $savepoint)

Create a new savepoint

Parameters

string $savepoint The savepoint name

Exceptions

DatabaseException on failure

at line 91
int transactionDepth()

Return the depth of the transaction For unnested transactions returns 1 while in a transaction, 0 otherwise

Return Value

int

at line 96
boolean supportsSavepoints()

Return true if savepoints are supported by this transaction manager.

Savepoints aren't supported by all database connectors (notably PDO doesn't support them) and should be used with caution.

Return Value

boolean