Connection
class Connection implements IConnection
Dibi connection.
Properties
| array | $onEvent | ||
| int read-only | $affectedRows | ||
| int read-only | $insertId |
Methods
Connection options: (see driver-specific options too)
- lazy (bool) => if true, connection will be established only when required
- result (array) => result set options
- formatDateTime => date-time format (if empty, DateTime objects will be returned)
- profiler (array)
- run (bool) => enable profiler?
- file => file to log
- substitutes (array) => map of driver specific substitutes (under development)
- onConnect (array) => list of SQL queries to execute (by Connection::query()) after connection is established
Automatically frees the resources allocated for this result set.
Connects to a database.
Disconnects from a database.
Returns true when connection was established.
Returns configuration variable. If no $key is passed, returns the entire array.
Generates SQL query.
Generates and prints SQL query.
Generates (translates) and returns SQL query as DataSource.
Generates SQL query.
Executes the SQL query.
Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.
Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.
Begins a transaction (if supported).
Commits statements in a transaction.
Rollback changes in a transaction.
Returns substitution hashmap.
Provides substitution.
Executes SQL query and fetch result - shortcut for query() & fetch().
Executes SQL query and fetch results - shortcut for query() & fetchAll().
Executes SQL query and fetch first column - shortcut for query() & fetchSingle().
Executes SQL query and fetch pairs - shortcut for query() & fetchPairs().
No description
Import SQL dump from file.
Gets a information about the current database.
Prevents unserialization.
Prevents serialization.
No description
Details
at line 54
__construct(array $config, string $name = null)
Connection options: (see driver-specific options too)
- lazy (bool) => if true, connection will be established only when required
- result (array) => result set options
- formatDateTime => date-time format (if empty, DateTime objects will be returned)
- profiler (array)
- run (bool) => enable profiler?
- file => file to log
- substitutes (array) => map of driver specific substitutes (under development)
- onConnect (array) => list of SQL queries to execute (by Connection::query()) after connection is established
at line 107
__destruct()
Automatically frees the resources allocated for this result set.
at line 118
final void
connect()
Connects to a database.
at line 162
final void
disconnect()
Disconnects from a database.
at line 174
final bool
isConnected()
Returns true when connection was established.
at line 185
final mixed
getConfig(string $key = null, $default = null)
Returns configuration variable. If no $key is passed, returns the entire array.
at line 196
final Driver
getDriver()
Returns the driver and connects to a database in lazy mode.
at line 210
final Result
query(...$args)
Generates (translates) and executes SQL query.
at line 221
final string
translate(mixed ...$args)
Generates SQL query.
at line 231
final bool
test(mixed ...$args)
Generates and prints SQL query.
at line 253
final DataSource
dataSource(mixed ...$args)
Generates (translates) and returns SQL query as DataSource.
at line 262
protected string
translateArgs(array $args)
Generates SQL query.
at line 275
final Result
nativeQuery(string $sql)
Executes the SQL query.
at line 305
int
getAffectedRows()
Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.
at line 321
int
affectedRows()
deprecated
deprecated
No description
at line 332
int
getInsertId(string $sequence = null)
Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.
at line 348
int
insertId(string $sequence = null)
deprecated
deprecated
No description
at line 358
void
begin(string $savepoint = null)
Begins a transaction (if supported).
at line 382
void
commit(string $savepoint = null)
Commits statements in a transaction.
at line 406
void
rollback(string $savepoint = null)
Rollback changes in a transaction.
at line 430
Result
createResultSet(ResultDriver $resultDriver)
Result set factory.
at line 441
Fluent
command()
No description
at line 447
Fluent
select(...$args)
No description
at line 456
Fluent
update(string|string[] $table, iterable $args)
No description
at line 462
Fluent
insert(string $table, iterable $args)
No description
at line 472
Fluent
delete(string $table)
No description
at line 484
HashMap
getSubstitutes()
Returns substitution hashmap.
at line 493
string
substitute(string $value)
Provides substitution.
at line 509
Row|null
fetch(mixed ...$args)
Executes SQL query and fetch result - shortcut for query() & fetch().
at line 521
array
fetchAll(mixed ...$args)
Executes SQL query and fetch results - shortcut for query() & fetchAll().
at line 533
mixed
fetchSingle(mixed ...$args)
Executes SQL query and fetch first column - shortcut for query() & fetchSingle().
at line 544
array
fetchPairs(mixed ...$args)
Executes SQL query and fetch pairs - shortcut for query() & fetchPairs().
at line 550
static Literal
literal(string $value)
No description
at line 556
static Expression
expression(...$args)
No description
at line 570
int
loadFile(string $file, callable $onProgress = null)
Import SQL dump from file.
at line 579
Database
getDatabaseInfo()
Gets a information about the current database.
at line 591
__wakeup()
Prevents unserialization.
at line 600
__sleep()
Prevents serialization.
at line 606
protected void
onEvent($arg)
No description
Traits
Better OOP experience.