Get support for yiisoft/db-redis

If you're new to LTH, please see our FAQ for more information on what it is we do.

Support Options

Unfortunately, there are currently no active helpers for this repository on the platform. Until they become available, we reccomend the following actions:

View Open Issues

Take a look to see if anyone else has experienced the same issue as you and if they managed to solve it.

Open an Issue

Make sure to read any relevant guidelines for opening issues on this repo before posting a new issue.

Sponsor directly

Check out the page and see if there are any options to sponsor this project or it's developers directly.

yiisoft/db-redis

Latest Stable Version Total Downloads Scrutinizer Code Quality Code Coverage

This extension provides the redis connection support for the Yii framework.

It includes a Cache and Session storage handler and implements the ActiveRecord pattern that allows you to store active records in redis.

Support version

PHP Redis Version CI-Actions
7.4 - 8.0 4 - 6 Build status Mutation testing badge static analysis type-coverage

Requirements

  • Redis version 2.6.12 or higher.
  • Filter PHP extension.

Installation

The package could be installed with Composer:

composer require yiisoft/db-redis

General usage

Using yiisoft/composer-config-plugin automatically get the settings of EventDispatcherInterface::class and LoggerInterface::class.

Di-Container:

use Yiisoft\Db\Redis\Connection as RedisConnection;

return [
    RedisConnection::class => [
        '__class' => RedisConnection::class,
        'host()' => [$params['yiisoft/db-redis']['dsn']['host']],
        'port()' => [$params['yiisoft/db-redis']['dsn']['port']],
        'database()' => [$params['yiisoft/db-redis']['dsn']['database']],
        'password()' => [$params['yiisoft/db-redis']['password']]
    ]
];

Params.php

return [
    'yiisoft/db-redis' => [
        'dsn' => [
            'driver' => 'redis',
            'host' => '127.0.0.1',
            'database' => 0,
            'port' => 6379
        ],
        'password' => null,
    ]
];

Configuring application

To use this extension, you have to configure the Yiisoft\Db\Redis\Connection|Connection class in your application configuration:

return [
    //....
    'components' => [
        'redis' => [
            'class' => 'Yiisoft\Db\Redis\Connection',
            'hostname' => 'localhost',
            'port' => 6379,
            'database' => 0,
        ],
    ]
];

This provides the basic access to redis storage via the redis application component:

Yii::$app->redis->set('mykey', 'some value');
echo Yii::$app->redis->get('mykey');

See [Yiisoft\Db\Redis\Connection] for a full list of available methods.

Documentation

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii DBAL Redis connection is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack

Our Mission

We want to make open source more sustainable. The entire platform was born from this and everything we do is in aid of this.

Interesting Articles

Thank you for checking out LiveTechHelper |
2025 © lth-dev incorporated

p-e622a1a2