Class \Prado\Data\TDbConnection

TDbConnection class

TDbConnection represents a connection to a database.

TDbConnection works together with TDbCommand, TDbDataReader and TDbTransaction to provide data access to various DBMS in a common set of APIs. They are a thin wrapper of the PDO PHP extension.

To establish a connection, set \Prado\Data\setActive to true after specifying \Prado\Data\setConnectionString, \Prado\Data\setUsername and \Prado\Data\setPassword.

Since 3.1.2, the connection charset can be set (for MySQL and PostgreSQL databases only) using the \Prado\Data\setCharset property. The value of this property is database dependant. e.g. for mysql, you can use 'latin1' for cp1252 West European, 'utf8' for unicode, ...

The following example shows how to create a TDbConnection instance and establish the actual connection:

$connection=new TDbConnection($dsn,$username,$password);
$connection->Active=true;

After the DB connection is established, one can execute an SQL statement like the following:

$command=$connection->createCommand($sqlStatement);
$command->execute();   // a non-query SQL statement execution
// or execute an SQL query and fetch the result set
$reader=$command->query();

// each $row is an array representing a row of data
foreach($reader as $row) ...

One can do prepared SQL execution and bind parameters to the prepared SQL:

$command=$connection->createCommand($sqlStatement);
$command->bindParameter($name1,$value1);
$command->bindParameter($name2,$value2);
$command->execute();

To use transaction, do like the following:

$transaction=$connection->beginTransaction();
try
{
   $connection->createCommand($sql1)->execute();
   $connection->createCommand($sql2)->execute();
   //.... other SQL executions
   $transaction->commit();
}
catch(Exception $e)
{
   $transaction->rollBack();
}

TDbConnection provides a set of methods to support setting and querying of certain DBMS attributes, such as \Prado\Data\getNullConversion.

Class hierarchy

\Prado\Data\TDbConnection

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`__construct([string $dsn = '' ][, string $username = '' ][, string $password = '' ][, string $charset = '' ]) : mixed` Constructor. Note, the DB connection is not established when this connection instance is created. Set \Prado\Data\setActive property to true to establish the connection. Since 3.1.2, you can set the charset for MySql connection
`public`	`__sleep() : mixed` Close the connection when serializing.
`public`	`beginTransaction() : TDbTransaction` Starts a transaction.
`public`	`createCommand(string $sql) : TDbCommand` Creates a command for execution.
`public`	`getActive() : bool`
`public`	`getAttribute(int $name) : mixed` Obtains a specific DB connection attribute information.
`public`	`getAutoCommit() : bool`
`public static`	`getAvailableDrivers() : array<string\|int, mixed>`
`public`	`getCharset() : string`
`public`	`getClientVersion() : string`
`public`	`getColumnCase() : TDbColumnCaseMode`
`public`	`getConnectionStatus() : string`
`public`	`getConnectionString() : string`
`public`	`getCurrentTransaction() : TDbTransaction`
`public`	`getDbMetaData() : TDbMetaData`
`public`	`getDriverName() : string`
`public`	`getLastInsertID([string $sequenceName = '' ]) : string` Returns the ID of the last inserted row or sequence value.
`public`	`getNullConversion() : TDbNullConversionMode`
`public`	`getPassword() : string`
`public`	`getPdoInstance() : PDO`
`public`	`getPersistent() : bool`
`public`	`getPrefetch() : bool`
`public`	`getServerInfo() : string`
`public`	`getServerVersion() : string`
`public`	`getTimeout() : int`
`public`	`getTransactionClass() : string`
`public`	`getUsername() : string`
`public`	`quoteColumnAlias(string $name) : string` Quotes a column alias for use in a query.
`public`	`quoteColumnName(string $name) : string` Quotes a column name for use in a query.
`public`	`quoteString(string $str) : string` Quotes a string for use in a query.
`public`	`quoteTableName(string $name) : string` Quotes a table name for use in a query.
`public`	`setActive(bool $value) : mixed` Open or close the DB connection.
`public`	`setAttribute(int $name, mixed $value) : mixed` Sets an attribute on the database connection.
`public`	`setAutoCommit(bool $value) : mixed`
`public`	`setCharset(string $value) : mixed`
`public`	`setColumnCase(TDbColumnCaseMode $value) : mixed`
`public`	`setConnectionString(string $value) : mixed`
`public`	`setNullConversion(TDbNullConversionMode $value) : mixed`
`public`	`setPassword(string $value) : mixed`
`public`	`setPersistent(bool $value) : mixed`
`public`	`setTransactionClass(string $value) : mixed`
`public`	`setUsername(string $value) : mixed`
`protected`	`close() : mixed` Closes the currently active DB connection. It does nothing if the connection is already closed.
`protected`	`open() : mixed` Opens DB connection if it is currently not
`protected`	`setConnectionCharset() : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Constants summary
`public mixed`	`DEFAULT_TRANSACTION_CLASS`	`\Prado\Data\TDbTransaction::class`

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Data\TDbConnection

Class hierarchy