Leaf Redis
According to the Redis docs, Redis is an open source (BSD licensed), in-memory data structure store used as a database, cache, message broker, and streaming engine. Redis provides data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes, and streams. Redis has built-in replication, Lua scripting, LRU eviction, transactions, and different levels of on-disk persistence, and provides high availability via Redis Sentinel and automatic partitioning with Redis Cluster.
In simpler terms, Redis is a fast, open source, in-memory key-value store that can be used as a database, cache, and message broker. As a database, Redis allows you to store and retrieve data quickly by keeping it in memory rather than on disk, which makes it ideal for applications that require high-speed access to data. As a cache, Redis can help speed up web applications by storing frequently accessed data in memory, reducing the number of times the application needs to access a slower database.
Leaf includes a Redis module that allows you to easily integrate Redis into your Leaf application.
New to Redis?
We've included some resources to help you get started with Redis.
Redis intro by TechWorld with Nana
Redis Tutorial - the What, Why and How to use Redis as a primary database.
Installation
You can quickly and simply install Leaf Redis through composer or the leaf cli.
composer require leafs/redis
or with the leaf cli:
leaf install redis
Getting Started
To get started with Leaf Redis, you simply need to call the init method and pass in any configuration you need.
Leaf\Redis::init();
This will initialize a new redis connection, from there, you can call any function you need to call.
Aloe CLI
Note
You only need to use this section if you're using Leaf MVC or Leaf API.
Although Leaf Redis can be used outside the Leaf environment, there's more support for Leaf based frameworks. Leaf Redis comes with out of the box support for Aloe CLI which is used in Leaf MVC and Leaf API. To get started, head over to the leaf file in the root directory of your Leaf API/Leaf MVC app or wherever aloe CLI is registered and register a new command.
$console->register(\Leaf\Redis::commands());
From there you should have access to a bunch of new commands from Leaf redis. The available commands are:
redis
redis:install Create leaf redis config and .env variables
redis:server Start redis server
From there, you can run php leaf redis:install to install the redis config and environment variables. You can then run php leaf redis:server to start the redis server.
Config
As mentioned above, the init method takes in an array for configuration. Below is the default config for init.
/*
|--------------------------------------------------------------------------
| Redis host
|--------------------------------------------------------------------------
|
| Set the host for redis connection
|
*/
"host" => "127.0.0.1",
/*
|--------------------------------------------------------------------------
| Redis host port
|--------------------------------------------------------------------------
|
| Set the port for redis host
|
*/
"port" => 6379,
/*
|--------------------------------------------------------------------------
| Redis auth
|--------------------------------------------------------------------------
|
| Set the password for redis connection
|
*/
"password" => null,
/*
|--------------------------------------------------------------------------
| Redis session handler
|--------------------------------------------------------------------------
|
| Set redis as session save handler
|
*/
"session" => false,
/*
|--------------------------------------------------------------------------
| Redis connection timeout
|--------------------------------------------------------------------------
|
| Value in seconds (optional, default is 0.0 meaning unlimited)
|
*/
"connection.timeout" => 0.0,
/*
|--------------------------------------------------------------------------
| Redis connection reserved
|--------------------------------------------------------------------------
|
| should be null if $retryInterval is specified
|
*/
"connection.reserved" => null,
/*
|--------------------------------------------------------------------------
| Redis session handler
|--------------------------------------------------------------------------
|
| Connection retry interval in milliseconds.
|
*/
"connection.retryInterval" => 0,
/*
|--------------------------------------------------------------------------
| Redis connection read timeout
|--------------------------------------------------------------------------
|
| Value in seconds (optional, default is 0 meaning unlimited
|
*/
"connection.readTimeout" => 0.0,
/*
|--------------------------------------------------------------------------
| Redis session save_path
|--------------------------------------------------------------------------
|
| Save path for redis session. Leave null to automatically
| generate the session save path. You can also use multiple save urls
| by passing in an array.
|
*/
"session.savePath" => null,
/*
|--------------------------------------------------------------------------
| Redis session save_path options
|--------------------------------------------------------------------------
|
| Options for session save path. You can pass in multiple options in
| the order of the save path above.
|
*/
"session.saveOptions" => [],
use Leaf\Redis;
Redis::init([
// you can use multiple hosts
"session.savePath" => ["tcp://host1:6379", "tcp://host2:6379"],
// the first array is for the first host, second for the second host
"session.saveOptions" => [["weight" => 1], ["weight" => 2]],
]);
Available Methods
set
This allows you to set a redis entry.
Leaf\Redis::set("key", "value");
// you can also use arrays to set multiple values at once
Leaf\Redis::set(["key" => "value", "key2" => "value"]);
get
This returns a saved redis entry.
$value = Leaf\Redis::get("key");
// You can also get multiple entries at once
$data = Leaf\Redis::get(["key", "key2"]);
// $data => [key => value, key2 => value]
ping
Ping the redis server
Leaf\Redis::ping();