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)
- formatJson => json format ( "string" for leaving value as is, "object" for decoding json as \stdClass, "array" for decoding json as an array - default )
- profiler (array)
- run (bool) => enable profiler?
- file => file to log
- errorsOnly (bool) => log only errors
- 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 59
__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)
- formatJson => json format ( "string" for leaving value as is, "object" for decoding json as \stdClass, "array" for decoding json as an array - default )
- profiler (array)
- run (bool) => enable profiler?
- file => file to log
- errorsOnly (bool) => log only errors
- 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 98
__destruct()
Automatically frees the resources allocated for this result set.
at line 109
final void
connect()
Connects to a database.
at line 153
final void
disconnect()
Disconnects from a database.
at line 165
final bool
isConnected()
Returns true when connection was established.
at line 176
final mixed
getConfig(string $key = null, $default = null)
Returns configuration variable. If no $key is passed, returns the entire array.
at line 187
final Driver
getDriver()
Returns the driver and connects to a database in lazy mode.
at line 201
final Result
query(...$args)
Generates (translates) and executes SQL query.
at line 212
final string
translate(mixed ...$args)
Generates SQL query.
at line 222
final bool
test(mixed ...$args)
Generates and prints SQL query.
at line 244
final DataSource
dataSource(mixed ...$args)
Generates (translates) and returns SQL query as DataSource.
at line 253
protected string
translateArgs(array $args)
Generates SQL query.
at line 266
final Result
nativeQuery(string $sql)
Executes the SQL query.
at line 296
int
getAffectedRows()
Gets the number of affected rows by the last INSERT, UPDATE or DELETE query.
at line 313
int
getInsertId(string $sequence = null)
Retrieves the ID generated for an AUTO_INCREMENT column by the previous INSERT query.
at line 329
void
begin(string $savepoint = null)
Begins a transaction (if supported).
at line 353
void
commit(string $savepoint = null)
Commits statements in a transaction.
at line 377
void
rollback(string $savepoint = null)
Rollback changes in a transaction.
at line 401
Result
createResultSet(ResultDriver $resultDriver)
Result set factory.
at line 413
Fluent
command()
No description
at line 419
Fluent
select(...$args)
No description
at line 428
Fluent
update(string|string[] $table, iterable $args)
No description
at line 434
Fluent
insert(string $table, iterable $args)
No description
at line 444
Fluent
delete(string $table)
No description
at line 456
HashMap
getSubstitutes()
Returns substitution hashmap.
at line 465
string
substitute(string $value)
Provides substitution.
at line 481
Row|null
fetch(mixed ...$args)
Executes SQL query and fetch result - shortcut for query() & fetch().
at line 493
array
fetchAll(mixed ...$args)
Executes SQL query and fetch results - shortcut for query() & fetchAll().
at line 505
mixed
fetchSingle(mixed ...$args)
Executes SQL query and fetch first column - shortcut for query() & fetchSingle().
at line 516
array
fetchPairs(mixed ...$args)
Executes SQL query and fetch pairs - shortcut for query() & fetchPairs().
at line 522
static Literal
literal(string $value)
No description
at line 528
static Expression
expression(...$args)
No description
at line 542
int
loadFile(string $file, callable $onProgress = null)
Import SQL dump from file.
at line 551
Database
getDatabaseInfo()
Gets a information about the current database.
at line 563
__wakeup()
Prevents unserialization.
at line 572
__sleep()
Prevents serialization.
at line 578
protected void
onEvent($arg)
No description
Traits
Better OOP experience.