Warning: You are browsing the documentation for Symfony 4.3, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

PDO & Doctrine DBAL Cache Adapter

4.3 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

PDO & Doctrine DBAL Cache Adapter¶

This adapter stores the cache items in an SQL database. It requires a PDO, Doctrine DBAL Connection, or Data Source Name (DSN) as its first parameter, and optionally a namespace, default cache lifetime, and options array as its second, third, and forth parameters:

use Symfony\Component\Cache\Adapter\PdoAdapter;

$cache = new PdoAdapter(

    // a PDO, a Doctrine DBAL connection or DSN for lazy connecting through PDO
    $databaseConnectionOrDSN,

    // the string prefixed to the keys of the items stored in this cache
    $namespace = '',

    // the default lifetime (in seconds) for cache items that do not define their
    // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
    // until the database table is truncated or its rows are otherwise deleted)
    $defaultLifetime = 0,

    // an array of options for configuring the database table and connection
    $options = []
);

The table where values are stored is created automatically on the first call to the save() method. You can also create this table explicitly by calling the createTable() method in your code.

Tip

When passed a Data Source Name (DSN) string (instead of a database connection class instance), the connection will be lazy-loaded when needed.

Note

Since Symfony 3.4, this adapter implements Symfony\Component\Cache\PruneableInterface, allowing for manual pruning of expired cache entries by calling its prune() method.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.