laravel/bundles/docs/pages/database/redis.md

Redis

Contents

• The Basics
• Configuration
• Usage

The Basics

Redis is an open source, advanced key-value store. It is often referred to as a data structure server since keys can contain strings, hashes, lists, sets, and sorted sets.

Configuration

The Redis configuration for your application lives in the application/config/database.php file. Within this file, you will see a redis array containing the Redis servers used by your application:

'redis' => array(

    'default' => array('host' => '127.0.0.1', 'port' => 6379),

),

The default server configuration should suffice for development. However, you are free to modify this array based on your environment. Simply give each Redis server a name, and specify the host and port used by the server.

Usage

You may get a Redis instance by calling the db method on the Redis class:

$redis = Redis::db();

This will give you an instance of the default Redis server. You may pass the server name to the db method to get a specific server as defined in your Redis configuration:

$redis = Redis::db('redis_2');

Great! Now that we have an instance of the Redis client, we may issue any of the Redis commands to the instance. Laravel uses magic methods to pass the commands to the Redis server:

$redis->set('name', 'Taylor');

$name = $redis->get('name');

$values = $redis->lrange('names', 5, 10);

Notice the arguments to the comment are simply passed into the magic method. Of course, you are not required to use the magic methods, you may also pass commands to the server using the run method:

$values = $redis->run('lrange', array(5, 10));

Just want to execute commands on the default Redis server? You can just use static magic methods on the Redis class:

Redis::set('name', 'Taylor');

$name = Redis::get('name');

$values = Redis::lrange('names', 5, 10);

Note: Redis cache and session drivers are included with Laravel.