class Database

Manages database connection and executes SQL queries.

Constants

private Drivers

private TypeConverterOptions

Properties

$onConnect
$onQuery

Methods

static Database
createFromParameters(...$params)

No description

static Database
createFromDsn(string $dsn, string|null $username = null, string|null $password = null, array $options = [])

No description

__construct(Driver|string $driver)

No description

void
connect()

No description

void
reconnect()

Disconnects and connects to database again.

void
disconnect()

Disconnects from database.

string
getDsn()

No description

PDO
getPdo()

No description

getConnection()

No description

getDatabaseEngine()

No description

string
getServerVersion()

No description

getReflection()

No description

getTypeConverter()

No description

setRowNormalizer(callable|null $normalizer)

No description

int|string
getInsertId(string|null $sequence = null)

No description

string
quote(string $string)

Quotes string for use in SQL.

void
beginTransaction()

Starts a transaction.

void
commit()

Commits current transaction.

void
rollBack()

Rolls back current transaction.

mixed
transaction(callable $callback)

Executes callback inside a transaction.

void
setAutoCommit(bool $state)

No description

void
createSavepoint(int $level)

No description

void
releaseSavepoint(int $level)

No description

query(string $sql, ...$params)

Generates and executes SQL query.

queryArgs(string $sql, array $params)

No description

array
preprocess(string $sql, ...$params)

No description

SqlLiteral|null
getLastQuery()

No description

string|null
getLastQueryString()

No description

Row|null
fetch(string $sql, ...$params)

Shortcut for query()->fetch()

array|null
fetchAssoc(string $sql, ...$params)

Shortcut for query()->fetchAssoc()

mixed
fetchField(string $sql, ...$params)

Shortcut for query()->fetchField()

array|null
fetchList(string $sql, ...$params)

Shortcut for query()->fetchList()

array|null
fetchFields(string $sql, ...$params)

Shortcut for query()->fetchList()

array
fetchPairs(string $sql, ...$params)

Shortcut for query()->fetchPairs()

array
fetchAll(string $sql, ...$params)

Shortcut for query()->fetchAll()

static SqlLiteral
literal(string $value, ...$params)

Creates SQL literal value.

table(string $table)

No description

setCache(Cache $cache)

No description

Cache|null
getCache()

No description

setConventions(Conventions $conventions)

No description

getConventions()

No description

getStructure()

No description

Details

at line 52
static Database createFromParameters(...$params)

No description

Parameters

...$params

Return Value

Database

at line 85
static Database createFromDsn(string $dsn, string|null $username = null, string|null $password = null, array $options = [])

No description

Parameters

string $dsn
string|null $username
string|null $password
array $options

Return Value

Database

at line 105
__construct(Driver|string $driver)

No description

Parameters

Driver|string $driver

at line 121
void connect()

No description

Return Value

void

Exceptions

ConnectionException

at line 143
void reconnect()

Disconnects and connects to database again.

Return Value

void

at line 153
void disconnect()

Disconnects from database.

Return Value

void

at line 159
string getDsn()

No description

Return Value

string

at line 166
PDO getPdo()

No description

Return Value

PDO

at line 174
Connection getConnection()

No description

Return Value

Connection

at line 181
Connection getSupplementalDriver()

No description

Return Value

Connection

at line 189
Engine getDatabaseEngine()

No description

Return Value

Engine

at line 195
string getServerVersion()

No description

Return Value

string

at line 201
Reflection getReflection()

No description

Return Value

Reflection

at line 207
TypeConverter getTypeConverter()

No description

Return Value

TypeConverter

at line 213
Database setRowNormalizer(callable|null $normalizer)

No description

Parameters

callable|null $normalizer

Return Value

Database

at line 220
int|string getInsertId(string|null $sequence = null)

No description

Parameters

string|null $sequence

Return Value

int|string

at line 233
string quote(string $string)

Quotes string for use in SQL.

Parameters

string $string

Return Value

string

at line 243
void beginTransaction()

Starts a transaction.

Return Value

void

Exceptions

LogicException

at line 259
void commit()

Commits current transaction.

Return Value

void

Exceptions

LogicException

at line 279
void rollBack()

Rolls back current transaction.

Return Value

void

Exceptions

LogicException

at line 298
mixed transaction(callable $callback)

Executes callback inside a transaction.

Parameters

callable $callback

Return Value

mixed

at line 312
void setAutoCommit(bool $state)

No description

Parameters

bool $state

Return Value

void

at line 333
void createSavepoint(int $level)

No description

Parameters

int $level

Return Value

void

at line 339
void releaseSavepoint(int $level)

No description

Parameters

int $level

Return Value

void

at line 349
Result query(string $sql, ...$params)

Generates and executes SQL query.

Parameters

string $sql
...$params

Return Value

Result

at line 359
Result queryArgs(string $sql, array $params)

No description

Parameters

string $sql
array $params

Return Value

Result

at line 371
array preprocess(string $sql, ...$params)

No description

Parameters

string $sql
...$params

Return Value

array

at line 399
SqlLiteral|null getLastQuery()

No description

Return Value

SqlLiteral|null

at line 405
string|null getLastQueryString()

No description

Return Value

string|null

at line 427
Row|null fetch(string $sql, ...$params)

Shortcut for query()->fetch()

Parameters

string $sql
...$params

Return Value

Row|null

at line 437
array|null fetchAssoc(string $sql, ...$params)

Shortcut for query()->fetchAssoc()

Parameters

string $sql
...$params

Return Value

array|null

at line 447
mixed fetchField(string $sql, ...$params)

Shortcut for query()->fetchField()

Parameters

string $sql
...$params

Return Value

mixed

at line 457
array|null fetchList(string $sql, ...$params)

Shortcut for query()->fetchList()

Parameters

string $sql
...$params

Return Value

array|null

at line 467
array|null fetchFields(string $sql, ...$params)

Shortcut for query()->fetchList()

Parameters

string $sql
...$params

Return Value

array|null

at line 477
array fetchPairs(string $sql, ...$params)

Shortcut for query()->fetchPairs()

Parameters

string $sql
...$params

Return Value

array

at line 487
array fetchAll(string $sql, ...$params)

Shortcut for query()->fetchAll()

Parameters

string $sql
...$params

Return Value

array

at line 496
static SqlLiteral literal(string $value, ...$params)

Creates SQL literal value.

Parameters

string $value
...$params

Return Value

SqlLiteral

at line 505
Selection table(string $table)

No description

Parameters

string $table

Return Value

Selection

at line 511
Database setCache(Cache $cache)

No description

Parameters

Cache $cache

Return Value

Database

at line 522
Cache|null getCache()

internal  
 

No description

Return Value

Cache|null

at line 528
Database setConventions(Conventions $conventions)

No description

Parameters

Conventions $conventions

Return Value

Database

at line 539
Conventions getConventions()

internal  
 

No description

Return Value

Conventions

at line 546
Structure getStructure()

internal  
 

No description

Return Value

Structure