Connection (Database)

void

beginTransaction()

Start a new database transaction.

void

commit()

Commit the active database transaction.

void

rollBack(int|null $toLevel = null)

Rollback the active database transaction.

int

transactionLevel()

Get the number of active transactions.

void

__construct(PDO|Closure $pdo, string $database = '', string $tablePrefix = '', array $config = array())

Create a new database connection instance.

void

useDefaultQueryGrammar()

Set the query grammar to the default implementation.

void

useDefaultSchemaGrammar()

Set the schema grammar to the default implementation.

void

useDefaultPostProcessor()

Set the query post processor to the default implementation.

getSchemaBuilder()

Get a schema builder instance for the connection.

table(string $table)

Begin a fluent query against a database table.

query()

Get a new query builder instance.

mixed

selectOne(string $query, array $bindings = array(), bool $useReadPdo = true)

Run a select statement and return a single result.

array

selectFromWriteConnection(string $query, array $bindings = array())

Run a select statement against the database.

array

select(string $query, array $bindings = array(), bool $useReadPdo = true)

Run a select statement against the database.

Generator

cursor(string $query, array $bindings = array(), bool $useReadPdo = true)

Run a select statement against the database and returns a generator.

bool

insert(string $query, array $bindings = array())

Run an insert statement against the database.

int

update(string $query, array $bindings = array())

Run an update statement against the database.

int

delete(string $query, array $bindings = array())

Run a delete statement against the database.

bool

statement(string $query, array $bindings = array())

Execute an SQL statement and return the boolean result.

int

affectingStatement(string $query, array $bindings = array())

Run an SQL statement and get the number of rows affected.

bool

unprepared(string $query)

Run a raw, unprepared query against the PDO connection.

array

pretend(Closure $callback)

Execute the given callback in "dry run" mode.

void

bindValues(PDOStatement $statement, array $bindings)

Bind values to their parameters in the given statement.

array

prepareBindings(array $bindings)

Prepare the query bindings for execution.

void

logQuery(string $query, array $bindings, float|null $time = null)

Log a query in the connection's query log.

void

reconnect()

Reconnect to the database.

void

disconnect()

Disconnect from the underlying PDO connection.

void

listen(Closure $callback)

Expression

raw(mixed $value)

Get a new raw query expression.

bool

isDoctrineAvailable()

Is Doctrine available?

Column

getDoctrineColumn(string $table, string $column)

Get a Doctrine Schema Column instance.

AbstractSchemaManager

getDoctrineSchemaManager()

Get the Doctrine DBAL schema manager for the connection.

Connection

getDoctrineConnection()

Get the Doctrine DBAL database connection instance.

PDO

getPdo()

Get the current PDO connection.

PDO

getReadPdo()

Get the current PDO connection used for reading.

$this

setPdo(PDO|null $pdo)

Set the PDO connection.

$this

setReadPdo(PDO|null $pdo)

Set the PDO connection used for reading.

$this

setReconnector(callable $reconnector)

Set the reconnect instance on the connection.

string|null

getName()

Get the database connection name.

mixed

getConfig(string|null $option = null)

Get an option from the configuration options.

string

getDriverName()

Get the PDO driver name.

getQueryGrammar()

Get the query grammar used by the connection.

void

setQueryGrammar(Grammar $grammar)

Set the query grammar used by the connection.

getSchemaGrammar()

Get the schema grammar used by the connection.

void

setSchemaGrammar(Grammar $grammar)

Set the schema grammar used by the connection.

Processor

getPostProcessor()

Get the query post processor used by the connection.

void

setPostProcessor(Processor $processor)

Set the query post processor used by the connection.

Dispatcher

getEventDispatcher()

Get the event dispatcher used by the connection.

void

setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance on the connection.

bool

pretending()

Determine if the connection in a "dry run".

array

getQueryLog()

Get the connection query log.

void

flushQueryLog()

Clear the query log.

void

enableQueryLog()

Enable the query log on the connection.

void

disableQueryLog()

Disable the query log on the connection.

bool

logging()

Determine whether we're logging queries.

string

getDatabaseName()

Get the name of the connected database.

string

setDatabaseName(string $database)

Set the name of the connected database.

string

getTablePrefix()

Get the table prefix for the connection.

void

setTablePrefix(string $prefix)

Set the table prefix in use by the connection.

withTablePrefix(Grammar $grammar)

Set the table prefix and return the grammar.

static void

resolverFor(string $driver, Closure $callback)

static mixed

getResolver(string $driver)

Get the connection resolver for the given driver.

Details

mixed transaction(Closure $callback, int $attempts = 1)

Execute a Closure within a transaction.

Parameters

Closure	$callback
int	$attempts

Return Value

mixed

Exceptions

Throwable

void beginTransaction()

Start a new database transaction.

Return Value

void

Exceptions

Exception

void commit()

Commit the active database transaction.

Return Value

void

void rollBack(int|null $toLevel = null)

Rollback the active database transaction.

Parameters

int|null

$toLevel

Return Value

void

int transactionLevel()

Get the number of active transactions.

Return Value

int

void __construct(PDO|Closure $pdo, string $database = '', string $tablePrefix = '', array $config = array())

Create a new database connection instance.

Parameters

PDO\|Closure	$pdo
string	$database
string	$tablePrefix
array	$config

Return Value

void

void useDefaultQueryGrammar()

Set the query grammar to the default implementation.

Return Value

void

void useDefaultSchemaGrammar()

Set the schema grammar to the default implementation.

Return Value

void

void useDefaultPostProcessor()

Set the query post processor to the default implementation.

Return Value

void

Builder getSchemaBuilder()

Get a schema builder instance for the connection.

Return Value

Builder table(string $table)

Begin a fluent query against a database table.

Parameters

string

$table

Return Value

Builder query()

Get a new query builder instance.

Return Value

mixed selectOne(string $query, array $bindings = array(), bool $useReadPdo = true)

Run a select statement and return a single result.

Parameters

string	$query
array	$bindings
bool	$useReadPdo

Return Value

mixed

array selectFromWriteConnection(string $query, array $bindings = array())

Run a select statement against the database.

Parameters

string	$query
array	$bindings

Return Value

array

array select(string $query, array $bindings = array(), bool $useReadPdo = true)

Run a select statement against the database.

Parameters

string	$query
array	$bindings
bool	$useReadPdo

Return Value

array

Generator cursor(string $query, array $bindings = array(), bool $useReadPdo = true)

Run a select statement against the database and returns a generator.

Parameters

string	$query
array	$bindings
bool	$useReadPdo

Return Value

Generator

bool insert(string $query, array $bindings = array())

Run an insert statement against the database.

Parameters

string	$query
array	$bindings

Return Value

bool

int update(string $query, array $bindings = array())

Run an update statement against the database.

Parameters

string	$query
array	$bindings

Return Value

int

int delete(string $query, array $bindings = array())

Run a delete statement against the database.

Parameters

string	$query
array	$bindings

Return Value

int

bool statement(string $query, array $bindings = array())

Execute an SQL statement and return the boolean result.

Parameters

string	$query
array	$bindings

Return Value

bool

int affectingStatement(string $query, array $bindings = array())

Run an SQL statement and get the number of rows affected.

Parameters

string	$query
array	$bindings

Return Value

int

bool unprepared(string $query)

Run a raw, unprepared query against the PDO connection.

Parameters

string

$query

Return Value

bool

array pretend(Closure $callback)

Execute the given callback in "dry run" mode.

Parameters

Closure

$callback

Return Value

array

void bindValues(PDOStatement $statement, array $bindings)

Bind values to their parameters in the given statement.

Parameters

PDOStatement	$statement
array	$bindings

Return Value

void

array prepareBindings(array $bindings)

Prepare the query bindings for execution.

Parameters

array

$bindings

Return Value

array

void logQuery(string $query, array $bindings, float|null $time = null)

Log a query in the connection's query log.

Parameters

string	$query
array	$bindings
float\|null	$time

Return Value

void

void reconnect()

Reconnect to the database.

Return Value

void

Exceptions

LogicException

void disconnect()

Disconnect from the underlying PDO connection.

Return Value

void

void listen(Closure $callback)

Parameters

Closure

$callback

Return Value

void

Expression raw(mixed $value)

Get a new raw query expression.

Parameters

mixed

$value

Return Value

Expression

bool isDoctrineAvailable()

Is Doctrine available?

Return Value

bool

Column getDoctrineColumn(string $table, string $column)

Get a Doctrine Schema Column instance.

Parameters

string	$table
string	$column

Return Value

Column

AbstractSchemaManager getDoctrineSchemaManager()

Get the Doctrine DBAL schema manager for the connection.

Return Value

AbstractSchemaManager

Connection getDoctrineConnection()

Get the Doctrine DBAL database connection instance.

Return Value

Connection

PDO getPdo()

Get the current PDO connection.

Return Value

PDO

PDO getReadPdo()

Get the current PDO connection used for reading.

Return Value

PDO

$this setPdo(PDO|null $pdo)

Set the PDO connection.

Parameters

PDO|null

$pdo

Return Value

$this

$this setReadPdo(PDO|null $pdo)

Set the PDO connection used for reading.

Parameters

PDO|null

$pdo

Return Value

$this

$this setReconnector(callable $reconnector)

Set the reconnect instance on the connection.

Parameters

callable

$reconnector

Return Value

$this

string|null getName()

Get the database connection name.

Return Value

string|null

mixed getConfig(string|null $option = null)

Get an option from the configuration options.

Parameters

string|null

$option

Return Value

mixed

string getDriverName()

Get the PDO driver name.

Return Value

string

Grammar getQueryGrammar()

Get the query grammar used by the connection.

Return Value

void setQueryGrammar(Grammar $grammar)

Set the query grammar used by the connection.

Parameters

$grammar

Return Value

void

Grammar getSchemaGrammar()

Get the schema grammar used by the connection.

Return Value

void setSchemaGrammar(Grammar $grammar)

Set the schema grammar used by the connection.

Parameters

$grammar

Return Value

void

Processor getPostProcessor()

Get the query post processor used by the connection.

Return Value

Processor

void setPostProcessor(Processor $processor)

Set the query post processor used by the connection.

Parameters

Processor

$processor

Return Value

void

Dispatcher getEventDispatcher()

Get the event dispatcher used by the connection.

Return Value

Dispatcher

void setEventDispatcher(Dispatcher $events)

Set the event dispatcher instance on the connection.

Parameters

Dispatcher

$events

Return Value

void

bool pretending()

Determine if the connection in a "dry run".

Return Value

bool

array getQueryLog()

Get the connection query log.

Return Value

array

void flushQueryLog()

Clear the query log.

Return Value

void

void enableQueryLog()

Enable the query log on the connection.

Return Value

void

void disableQueryLog()

Disable the query log on the connection.

Return Value

void

bool logging()

Determine whether we're logging queries.

Return Value

bool

string getDatabaseName()

Get the name of the connected database.

Return Value

string

string setDatabaseName(string $database)

Set the name of the connected database.

Parameters

string

$database

Return Value

string

string getTablePrefix()

Get the table prefix for the connection.

Return Value

string

void setTablePrefix(string $prefix)

Set the table prefix in use by the connection.

Parameters

string

$prefix

Return Value

void

Grammar withTablePrefix(Grammar $grammar)

Set the table prefix and return the grammar.

Parameters

$grammar

Return Value