DbCache

API reference › yii › caching › DbCache

class	yii\caching\DbCache
Extends	Cache » yii\base\Component » yii\base\BaseObject
Implements	CacheInterface, yii\base\Configurable
Since	2.0
Source	framework/caching/DbCache.php

DbCache implements a cache application component by storing cached data in a database.

By default, DbCache stores session data in a DB table named ‘cache’. This table must be pre-created. The table name can be changed by setting $cacheTable.

Please refer to Cache for common cache operations that are supported by DbCache.

The following example shows how you can configure the application to use DbCache:

'cache' => [
    'class' => 'yii\caching\DbCache',
    // 'db' => 'mydb',
    // 'cacheTable' => 'my_cache',
]

For more details and usage information on Cache, see the guide article on caching.

Properties

Property	Type	Description	Defined by
$behaviors read-only	array<yii\base\Behavior<static>>	List of behaviors attached to this component.	yii\base\Component
$cacheTable	string	Name of the DB table to store cache content. Default: '{{%cache}}'.	DbCache
$db	yii\db\Connection|array|string	The DB connection object or the application component ID of the DB connection. Default: 'db'.	DbCache
$defaultDuration	int	Default duration in seconds before a cache entry will expire. Default: 0. Available since 2.0.11.	Cache
$gcProbability	int	The probability (parts per million) that garbage collection (GC) should be performed when storing a piece of data in the cache. Default: 100.	DbCache
$keyPrefix	string	A string prefixed to every cache key so that it is unique globally in the whole cache storage. Default: null.	Cache
$serializer	array|null|false	The functions used to serialize and unserialize cached data. Default: null.	Cache

Methods

Method	Description	Defined by
__construct()	Constructor.	yii\base\BaseObject
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
add()	Stores a value identified by a key into cache if the cache does not contain this key.	Cache
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
buildKey()	Builds a normalized cache key from a given key.	Cache
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className() static	Returns the fully qualified name of this class.	yii\base\BaseObject
delete()	Deletes a value with the specified key from cache.	Cache
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
exists()	Checks whether a specified key exists in the cache.	DbCache
flush()	Deletes all values from cache.	Cache
gc()	Removes the expired data values.	DbCache
get()	Retrieves a value from cache with a specified key.	Cache
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getOrSet()	Method combines both set() and get() methods to retrieve value identified by a $key, or to store the result of $callable execution if there is no cache available for the $key.	Cache
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the DbCache component.	DbCache
multiAdd()	Stores multiple items in cache. Each item contains a value identified by a key.	Cache
multiGet()	Retrieves multiple values from cache with the specified keys.	Cache
multiSet()	Stores multiple items in cache. Each item contains a value identified by a key.	Cache
off()	Detaches an existing event handler from this component.	yii\base\Component
offsetExists()	Returns whether there is a cache entry with a specified key.	Cache
offsetGet()	Retrieves the value from cache with a specified key.	Cache
offsetSet()	Stores the value identified by a key into cache.	Cache
offsetUnset()	Deletes the value with the specified key from cache This method is required by the interface ArrayAccess.	Cache
on()	Attaches an event handler to an event.	yii\base\Component
set()	Stores a value identified by a key into cache.	Cache
trigger()	Triggers an event.	yii\base\Component
addValue() protected	Stores a value identified by a key into cache if the cache does not contain this key.	DbCache
addValues() protected	Adds multiple key-value pairs to cache.	Cache
deleteValue() protected	Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.	DbCache
flushValues() protected	Deletes all values from cache.	DbCache
getDataFieldName() protected	Returns the name of the data column read by getValue() and getValues().	DbCache
getDataFieldValue() protected		DbCache
getValue() protected	Retrieves a value from cache with a specified key.	DbCache
getValues() protected	Retrieves multiple values from cache with the specified keys.	DbCache
setValue() protected	Stores a value identified by a key in cache.	DbCache
setValues() protected	Stores multiple key-value pairs in cache.	Cache

Property details

$cacheTable

public string $cacheTable = '{{%cache}}'

Name of the DB table to store cache content.

The table should be pre-created as follows:

CREATE TABLE cache (
    id char(128) NOT NULL PRIMARY KEY,
    expire int(11),
    data BLOB
);

For MSSQL:

CREATE TABLE cache (
    id VARCHAR(128) NOT NULL PRIMARY KEY,
    expire INT(11),
    data VARBINARY(MAX)
);

where ‘BLOB’ refers to the BLOB-type of your preferred DBMS. Below are the BLOB type that can be used for some popular DBMS:

• MySQL: LONGBLOB
• PostgreSQL: BYTEA

When using DbCache in a production server, we recommend you create a DB index for the ‘expire’ column in the cache table to improve the performance.

$db

public yii\db\Connection|array|string $db = 'db'

The DB connection object or the application component ID of the DB connection.

After the DbCache object is created, if you want to change this property, you should only assign it with a DB connection object. Starting from version 2.0.2, this can also be a configuration array for creating the object.

$gcProbability

public int $gcProbability = 100

The probability (parts per million) that garbage collection (GC) should be performed when storing a piece of data in the cache.

Defaults to 100, meaning 0.01% chance. This number should be between 0 and 1000000. A value 0 meaning no GC will be performed at all.

Method details

exists()

public function exists(mixed $key): bool

Checks whether a specified key exists in the cache.

This can be faster than getting the value from the cache if the data is big. Note that this method does not check whether the dependency associated with the cached data, if there is any, has changed. So a call to get() may return false while exists returns true.

Parameters

Parameter	Type	Description
$key	mixed	A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors representing the key.

Returns

bool: True if a value exists in cache, false if the value is not in the cache or expired.

gc()

public function gc(bool $force = false): mixed

Removes the expired data values.

Parameters

Parameter	Type	Description
$force	bool	Whether to enforce the garbage collection regardless of $gcProbability. Defaults to false, meaning the actual deletion happens with the probability as specified by $gcProbability.

Returns

mixed

init()

public function init(): mixed

Initializes the DbCache component.

This method will initialize the $db property to make sure it refers to a valid DB connection.

Returns

mixed

Throws

• yii\base\InvalidConfigException: if $db is invalid.

addValue()

protected function addValue(string $key, string $value, int $duration): bool

Stores a value identified by a key into cache if the cache does not contain this key.

This is the implementation of the method declared in the parent class.

Parameters

Parameter	Type	Description
$key	string	The key identifying the value to be cached
$value	string	The value to be cached. Other types (if you have disabled $serializer) cannot be saved.
$duration	int	The number of seconds in which the cached value will expire. 0 means never expire.

Returns

bool: True if the value is successfully stored into cache, false otherwise

deleteValue()

protected function deleteValue(string $key): bool

Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.

Parameters

Parameter	Type	Description
$key	string	The key of the value to be deleted

Returns

bool: If no error happens during deletion

flushValues()

protected function flushValues(): bool

Deletes all values from cache.

This is the implementation of the method declared in the parent class.

Returns

bool: Whether the flush operation was successful.

getDataFieldName()

protected function getDataFieldName(): string

Returns the name of the data column read by getValue() and getValues().

Override to wrap the column in a database expression aliased as data.

Returns

string: Column name or expression aliased as data.

Since

2.0.42

getDataFieldValue()

protected function getDataFieldValue(mixed $value): mixed

Parameters

Parameter	Type	Description
$value	mixed

Returns

mixed: Value prepared by the data column schema.

Since

2.0.42

getValue()

protected function getValue(string $key): string|false

Retrieves a value from cache with a specified key.

This is the implementation of the method declared in the parent class.

Parameters

Parameter	Type	Description
$key	string	A unique key identifying the cached value

Returns

string|false: The value stored in cache, false if the value is not in the cache or expired.

getValues()

protected function getValues(array $keys): array

Retrieves multiple values from cache with the specified keys.

Parameters

Parameter	Type	Description
$keys	array	A list of keys identifying the cached values.

Returns

array: A list of cached values indexed by the keys.

setValue()

protected function setValue(string $key, string $value, int $duration): bool

Stores a value identified by a key in cache.

This is the implementation of the method declared in the parent class.

Parameters

Parameter	Type	Description
$key	string	The key identifying the value to be cached
$value	string	The value to be cached. Other types (if you have disabled $serializer) cannot be saved.
$duration	int	The number of seconds in which the cached value will expire. 0 means never expire.

Returns

bool: True if the value is successfully stored into cache, false otherwise