Class yii\redis\Cache

Redis Cache implements a cache application component based on redis key-value store.

Redis Cache requires redis version 2.6.12 or higher to work properly.

It needs to be configured with a redis yii\redis\Connection. By default it will use the redis application component.

Note: It is recommended to use separate database for cache and do not share it with other components. If you need to share database, you should set $shareDatabase to true and make sure that $keyPrefix has unique value which will allow to distinguish between cache keys and other data in database.

See yii\caching\Cache manual for common cache operations that redis Cache supports.

Unlike the yii\caching\Cache, redis Cache allows the expire parameter of set(), add(), mset() and madd() to be a floating point number, so you may specify the time in milliseconds (e.g. 0.1 will be 100 milliseconds).

To use redis Cache as the cache application component, configure the application as follows,

[
    'components' => [
        'cache' => [
            'class' => 'yii\redis\Cache',
            'redis' => [
                'hostname' => 'localhost',
                'port' => 6379,
                'database' => 0,
            ]
        ],
    ],
]

Or if you have configured the redis yii\redis\Connection as an application component, the following is sufficient:

[
    'components' => [
        'cache' => [
            'class' => 'yii\redis\Cache',
            // 'redis' => 'redis' // id of the connection application component
        ],
    ],
]

If you have multiple redis replicas (e.g. AWS ElasticCache Redis) you can configure the cache to send read operations to the replicas. If no replicas are configured, all operations will be performed on the master connection configured via the $redis property.

[
    'components' => [
        'cache' => [
            'class' => 'yii\redis\Cache',
            'enableReplicas' => true,
            'replicas' => [
                // config for replica redis connections, (default class will be yii\redis\Connection if not provided)
                // you can optionally put in master as hostname as well, as all GET operation will use replicas
                'redis',//id of Redis [[Connection]] Component
                ['hostname' => 'redis-slave-002.xyz.0001.apse1.cache.amazonaws.com'],
                ['hostname' => 'redis-slave-003.xyz.0001.apse1.cache.amazonaws.com'],
            ],
        ],
    ],
]

If you're using redis in cluster mode and want to use MGET and MSET effectively, you will need to supply a hash tag to allocate cache keys to the same hash slot.

\Yii::$app->cache->multiSet([
    'posts{user1}' => 123,
    'settings{user1}' => [
        'showNickname' => false,
        'sortBy' => 'created_at',
    ],
    'unreadMessages{user1}' => 5,
]);