Redis provides low latency and high throughput to support the responsive laravel eCommerce websites. In this article, we are going to see how to use Redis with laravel.
What is Redis?
Redis is an open source (BSD licensed). It is used as a database, cache and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes with radius queries and streams. It is an open source, advanced key-value store.
Redis is written in ANSI C and works in most POSIX systems like Linux, *BSD, OS X without external dependencies. Linux and OS X are the two operating systems where Redis is developed and tested the most, and we recommend using Linux for deploying. Redis may work in Solaris-derived systems like SmartOS, but the support is best effort. There is no official support for Windows builds.
How to use Redis with Laravel?
In order to use Redis with Laravel, firstly yo will have to install the predis/predis package.
You can install it via composer.
Just run this command and you’re done.
|
1 |
composer require predis/predis |
Apart from this, you can also install php redis, a php extension via PECL. This package is comparatively complex to install so it is better to use predis package via composer.
Configuration of Redis for Laravel Application
The Redis configuration for laravel application is present in the config/database.php.
In this file you can see the redis array which contains the Redis servers utilized by laravel application:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
'redis' => [ 'client' => 'predis', 'default' => [ 'host' => env('REDIS_HOST', '127.0.0.1'), 'password' => env('REDIS_PASSWORD', null), 'port' => env('REDIS_PORT', 6379), 'database' => env('REDIS_DB', 0), ], 'cache' => [ 'host' => env('REDIS_HOST', '127.0.0.1'), 'password' => env('REDIS_PASSWORD', null), 'port' => env('REDIS_PORT', 6379), 'database' => env('REDIS_CACHE_DB', 1), ], ], |
You can modify this array based on your environment. Each Redis server defined in your configuration file is required to have a name, host, and port.
Now how to interact with Redis ?
You will have to use a Redis facade for this.
|
1 |
use Illuminate\Support\Facades\Redis; |
The Redis facade supports dynamic methods, meaning you may call any Redis command on the facade and the command will be passed directly to Redis. In this example, we will call the Redis GET command by calling the get method on the Redis facade:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
<?php namespace App\Http\Controllers; use App\Http\Controllers\Controller; use Illuminate\Support\Facades\Redis; class UserController extends Controller { /** * Show the profile for the given user. * * @param int $id * @return Response */ public function showProfile($id) { $user = Redis::get('user:profile:'.$id); return view('company.employee', ['user' => $user]); } } |
You may call any of the Redis commands on the Redis facade. Laravel uses magic methods to pass the commands to the Redis server, so pass the arguments the Redis command expects:
|
1 2 3 |
Redis::set('company', 'Webkul'); $values = Redis::lrange('company', 5, 10); |
Apart from this, you can also pass your commands to the server with the help of command() method.
It accepts the name of the command as its first argument, and an array of values as its second argument:
|
1 |
$values = Redis::command('lrange', ['name', 5, 10]); |
Pipelining
Pipelining is a concept through which one can send many commands to the server in one operation. The pipeline method accepts one argument: a Closure that receives a Redis instance. You may issue all of your commands to this Redis instance and they will all be executed within a single operation:
|
1 2 3 4 5 |
Redis::pipeline(function ($pipe) { for ($i = 0; $i < 1000; $i++) { $pipe->set("key:$i", $i); } }); |
That’s all in this blog for using Redis with laravel. Let us know your thoughts in the comments below.
You can also hire laravel developers to build your custom solutions on laravel.
