CDbConnection

$connection=new CDbConnection($dsn,$username,$password);
$connection->active=true;

$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) ...

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

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

array(
    'components'=>array(
        'db'=>array(
            'class'=>'CDbConnection',
            'connectionString'=>'sqlite:path/to/dbfile',
        ),
    ),
)

'db'=>array(
    'class'=>'CDbConnection',
    'driverName'=>'mysql',
    'connectionString'=>'odbc:Driver={MySQL};Server=127.0.0.1;Database=test',
    'username'=>'',
    'password'=>'',
),

Property Details

Returns whether the DB connection is established.

Returns the attributes that are previously explicitly set for the DB connection.

Returns whether creating or updating a DB record will be automatically committed. Some DBMS (such as sqlite) may not support this feature.

whether the database connection should be automatically established the component is being initialized. Defaults to true. Note, this property is only effective when the CDbConnection object is used as an application component.

the charset used for database connection. The property is only used for MySQL, MariaDB and PostgreSQL databases. Defaults to null, meaning using default charset as specified by the database.

Note that if you're using GBK or BIG5 then it's highly recommended to update to PHP 5.3.6+ and to specify charset via DSN like 'mysql:dbname=mydatabase;host=127.0.0.1;charset=GBK;'.

Returns the version information of the DB driver.

Returns the case of the column names

Returns the SQL command builder for the current DB connection.

Returns the status of the connection. Some DBMS (such as sqlite) may not support this feature.

The Data Source Name, or DSN, contains the information required to connect to the database.

Returns the currently active transaction.

mapping between PDO driver and schema class name. A schema class can be specified using path alias.

Returns the name of the DB driver.

whether to turn on prepare emulation. Defaults to false, meaning PDO will use the native prepare support if available. For some databases (such as MySQL), this may need to be set true so that PDO can emulate the prepare support to bypass the buggy native prepare support. Note, this property is only effective for PHP 5.1.3 or above. The default value is null, which will not change the ATTR_EMULATE_PREPARES value of PDO.

whether to log the values that are bound to a prepare SQL statement. Defaults to false. During development, you may consider setting this property to true so that parameter values bound to SQL statements are logged for debugging purpose. You should be aware that logging parameter values could be expensive and have significant impact on the performance of your application.

whether to enable profiling the SQL statements being executed. Defaults to false. This should be mainly enabled and used during development to find out the bottleneck of SQL executions.

list of SQL statements that should be executed right after the DB connection is established.

Returns the ID of the last inserted row or sequence value.

Returns how the null and empty strings are converted.

the password for establishing DB connection. Defaults to empty string.

Custom PDO wrapper class.

Returns the PDO instance.

Returns whether the connection is persistent or not. Some DBMS (such as sqlite) may not support this feature.

Returns whether the connection performs data prefetching.

the ID of the cache application component that is used for query caching. Defaults to 'cache' which refers to the primary cache application component. Set this property to false if you want to disable query caching.

the number of SQL statements that need to be cached next. If this is 0, then even if query caching is enabled, no query will be cached. Note that each time after executing a SQL statement (whether executed on DB server or fetched from query cache), this property will be reduced by 1 until 0.

the dependency that will be used when saving query results into cache.

number of seconds that query results can remain valid in cache. Use 0 or negative value to indicate not caching query results (the default behavior).

In order to enable query caching, this property must be a positive integer and queryCacheID must point to a valid cache component ID.

The method cache() is provided as a convenient way of setting this property and queryCachingDependency on the fly.

Returns the database schema for the current connection

the ID of the cache application component that is used to cache the table metadata. Defaults to 'cache' which refers to the primary cache application component. Set this property to false if you want to disable caching table metadata.

number of seconds that table metadata can remain valid in cache. Use 0 or negative value to indicate not caching schema. If greater than 0 and the primary cache is enabled, the table metadata will be cached.

list of tables whose metadata should NOT be cached. Defaults to empty array.

Returns the information of DBMS server.

Returns the version information of DBMS server.

Returns the statistical results of SQL executions. The results returned include the number of SQL statements executed and the total time spent. In order to use this method, enableProfiling has to be set true.

the default prefix for table names. Defaults to null, meaning no table prefix. By setting this property, any token like '{{tableName}}' in CDbCommand::text will be replaced by 'prefixTableName', where 'prefix' refers to this property value.

Returns the timeout settings for the connection.

the username for establishing DB connection. Defaults to empty string.

Method Details

Constructor. Note, the DB connection is not established when this connection instance is created. Set active property to true to establish the connection.

Close the connection when serializing.

Starts a transaction.

Sets the parameters about query caching. This method can be used to enable or disable query caching. By setting the $duration parameter to be 0, the query caching will be disabled. Otherwise, query results of the new SQL statements executed next will be saved in cache and remain valid for the specified duration. If the same query is executed again, the result may be fetched from cache directly without actually executing the SQL statement.

Closes the currently active DB connection. It does nothing if the connection is already closed.

Creates a command for execution.

Creates the PDO instance. When some functionalities are missing in the pdo driver, we may use an adapter class to provide them.

Returns whether the DB connection is established.

Obtains a specific DB connection attribute information.

Returns the attributes that are previously explicitly set for the DB connection.

Returns whether creating or updating a DB record will be automatically committed. Some DBMS (such as sqlite) may not support this feature.

Returns a list of available PDO drivers.

Returns the version information of the DB driver.

Returns the case of the column names

Returns the SQL command builder for the current DB connection.

Returns the status of the connection. Some DBMS (such as sqlite) may not support this feature.

Returns the currently active transaction.

Returns the name of the DB driver.

Returns the ID of the last inserted row or sequence value.

Returns how the null and empty strings are converted.

Returns the PDO instance.

Determines the PDO type for the specified PHP type.

Returns whether the connection is persistent or not. Some DBMS (such as sqlite) may not support this feature.

Returns whether the connection performs data prefetching.

Returns the database schema for the current connection

Returns the information of DBMS server.

Returns the version information of DBMS server.

Returns the statistical results of SQL executions. The results returned include the number of SQL statements executed and the total time spent. In order to use this method, enableProfiling has to be set true.

Returns the timeout settings for the connection.

Initializes the component. This method is required by IApplicationComponent and is invoked by application when the CDbConnection is used as an application component. If you override this method, make sure to call the parent implementation so that the component can be marked as initialized.

Initializes the open db connection. This method is invoked right after the db connection is established. The default implementation is to set the charset for MySQL, MariaDB and PostgreSQL database connections.

Opens DB connection if it is currently not

Quotes a column name for use in a query. If the column name contains prefix, the prefix will also be properly quoted.

Quotes a table name for use in a query. If the table name contains schema prefix, the prefix will also be properly quoted.

Quotes a string value for use in a query.

Quotes a value for use in a query using a given type.

Open or close the DB connection.

Sets an attribute on the database connection.

Sets a set of attributes on the database connection.

Sets whether creating or updating a DB record will be automatically committed. Some DBMS (such as sqlite) may not support this feature.

Sets the case of the column names.

Changes the name of the DB driver. Overrides value extracted from the connectionString, which is behavior by default.

Sets how the null and empty strings are converted.

Sets whether the connection is persistent or not. Some DBMS (such as sqlite) may not support this feature.