Interface ConnectionInterface

config()source public

config( )

Get the configuration data used to create the connection.

Returns

array

configName()source public

configName( )

Get the configuration name for this connection.

Returns

string

disableConstraints()source public

disableConstraints( callable $operation )

Run an operation with constraints disabled.

Constraints should be re-enabled after the callback succeeds/fails.

Parameters

callable $operation

The callback to execute within a transaction.

Returns

mixed
The return value of the callback.

Throws

Exception

Will re-throw any exception raised in $callback after rolling back the transaction.

logQueries()source public

logQueries( boolean|null $enable null )

Enables or disables query logging for this connection.

Parameters

boolean|null $enable optional null

whether to turn logging on or disable it. Use null to read current value.

Returns

boolean

logger()source public

logger( object|null $instance null )

Sets the logger object instance. When called with no arguments it returns the currently setup logger instance.

Parameters

object|null $instance optional null

logger object instance

Returns

object
logger instance

transactional()source public

transactional( callable $transaction )

Executes a callable function inside a transaction, if any exception occurs while executing the passed callable, the transaction will be rolled back If the result of the callable function is false, the transaction will also be rolled back. Otherwise the transaction is committed after executing the callback.

The callback will receive the connection instance as its first argument.

Parameters

callable $transaction

The callback to execute within a transaction.

Returns

mixed
The return value of the callback.

Throws

Exception

Will re-throw any exception raised in $callback after rolling back the transaction.