Predis guide (PHP)

Connect your PHP application to a Redis database

Predis is the recommended PHP client for Redis. The sections below explain how to install Predis and connect your application to a Redis database.

Note:
Although we provide basic documentation for Predis, it is a third-party client library and is not developed or supported directly by Redis.

Predis requires a running Redis server. See here for Redis Open Source installation instructions.

Install

Use Composer to install the Predis library with the following command line:

composer require predis/predis

Connect and test

Connect to a locally-running server on the standard port (6379) with the following code:

<?php

require 'vendor/autoload.php';

use Predis\Client as PredisClient;

$r = new PredisClient([
                'scheme'   => 'tcp',
                'host'     => '127.0.0.1',
                'port'     => 6379,
                'password' => '',
                'database' => 0,
            ]);

Store and retrieve a simple string to test the connection:

echo $r->set('foo', 'bar'), PHP_EOL;
// >>> OK

echo $r->get('foo'), PHP_EOL;
// >>> bar

Store and retrieve a hash object:

$r->hset('user-session:123', 'name', 'John');
$r->hset('user-session:123', 'surname', 'Smith');
$r->hset('user-session:123', 'company', 'Redis');
$r->hset('user-session:123', 'age', 29);

echo var_export($r->hgetall('user-session:123')), PHP_EOL;
/* >>>
array (
  'name' => 'John',
  'surname' => 'Smith',
  'company' => 'Redis',
  'age' => '29',
)
*/

More information

The Predis wiki on Github has information about the different connection options you can use.

See also the pages in this section for more information and examples:

RATE THIS PAGE
Back to top ↑