PHPackages yiisoft/db-redis - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. yiisoft/db-redis AbandonedArchivedLibrary[Framework](/categories/framework) yiisoft/db-redis ================ Yii Framework Redis Cache, Session and ActiveRecord extension 178.9k8[3 PRs](https://github.com/yiisoft/db-redis/pulls)1PHPCI failing Since Oct 25Pushed 5mo ago15 watchersCompare [ Source](https://github.com/yiisoft/db-redis)[ Packagist](https://packagist.org/packages/yiisoft/db-redis)[ RSS](/packages/yiisoft-db-redis/feed)WikiDiscussions master Synced 2w ago READMEChangelogDependenciesVersions (5)Used By (1) Warning There is no official Redis support planned for Yii3 DB. Use [predis](https://github.com/predis/predis) or [phpredis](https://github.com/phpredis/phpredis) instead. [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) [ ![Redis](https://camo.githubusercontent.com/a409a7d8cae1e591c9ec3830051efeadf052fd5a1a55037f02d5ffb93dcad492/68747470733a2f2f646f776e6c6f61642e72656469732e696f2f72656469732e706e67) ](https://redis.io/) Yii DBAL Redis connection ========================= [](#yii-dbal-redis-connection) [![Latest Stable Version](https://camo.githubusercontent.com/dcb10f2c52352eee56184a5634b7ff1ac8731abefa1c88f186eecc18cfe69ab5/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f64622d72656469732f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/db-redis)[![Total Downloads](https://camo.githubusercontent.com/0d98354b70d4f5814b9da3edf57fe03f4ebc2b9c9a73714ebe8b0a8c2200dc7d/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f64622d72656469732f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/db-redis)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/09460c495961682a1ae791455dcf7e0a216980cf680b9ae64241b71d3358b60c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f64622d72656469732f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/db-redis/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/8fa94657ec660fdd3b344a842e8f6cdd7e233841a3221443036e6e7ef4e24307/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f64622d72656469732f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/db-redis/?branch=master) This extension provides the [redis](https://redis.io/) connection support for the [Yii framework](https://www.yiiframework.com). It includes a `Cache` and `Session` storage handler and implements the `ActiveRecord` pattern that allows you to store active records in redis. Support version --------------- [](#support-version) PHPRedis VersionCI-Actions**7.4 - 8.0****4 - 6**[![Build status](https://github.com/yiisoft/db-redis/workflows/build/badge.svg)](https://github.com/yiisoft/db-redis/actions?query=workflow%3Abuild) [![Mutation testing badge](https://camo.githubusercontent.com/2e829b8ef7a8b0dc13644b8415ae02c68b5188c17f00a9f9e68d2799ca87ad0d/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f667425324664622d72656469732532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/db-redis/master) [![static analysis](https://github.com/yiisoft/db-redis/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/db-redis/actions?query=workflow%3A%22static+analysis%22) [![type-coverage](https://camo.githubusercontent.com/3f6a606607405db24bccd65a1f6b85e2212c8a59a0162253bc20459252e7fc83/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f64622d72656469732f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/db-redis)Requirements ------------ [](#requirements) - Redis version 2.6.12 or higher. - `Filter` PHP extension. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/db-redis ``` General usage ------------- [](#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 ----------------------- [](#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 ------------- [](#documentation) - Guide: [English](docs/guide/en/README.md), [日本語](docs/guide/ja/README.md), [Português - Brasil](docs/guide/pt-BR/README.md), [Русский](docs/guide/ru/README.md), [中国人](docs/guide/zh-CN/README.md) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). License ------- [](#license) The Yii DBAL Redis connection is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). Support the project ------------------- [](#support-the-project) [![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft) Follow updates -------------- [](#follow-updates) [![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack) ### Health Score 36 — LowBetter than 79% of packages Maintenance50 Moderate activity, may be stable Popularity29 Limited adoption so far Community29 Small or concentrated contributor base Maturity34 Early-stage or recently created project Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe) ![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark) ![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire) ![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol) --- Top Contributors [![machour](https://avatars.githubusercontent.com/u/304450?v=4)](https://github.com/machour "machour (16 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (12 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (5 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (4 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (4 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (2 commits)")[![arogachev](https://avatars.githubusercontent.com/u/8326201?v=4)](https://github.com/arogachev "arogachev (2 commits)")[![sartor](https://avatars.githubusercontent.com/u/159053?v=4)](https://github.com/sartor "sartor (1 commits)")[![siamskoi](https://avatars.githubusercontent.com/u/10303702?v=4)](https://github.com/siamskoi "siamskoi (1 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (1 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (1 commits)") --- Tags databasedbhacktoberfestoptionalforframeworkannounceredis ### Embed Badge ![Health badge](/badges/yiisoft-db-redis/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-db-redis/health.svg)](https://phpackages.com/packages/yiisoft-db-redis) ``` ### Alternatives [laravel/dusk Laravel Dusk provides simple end-to-end testing and browser automation. 1.9k39.6M292](/packages/laravel-dusk)[nineinchnick/edatatables Grid widget for the Yii Framework, wrapper for the DataTables jQuery plugin 173.2k](/packages/nineinchnick-edatatables)[link-cloud/fast-hyperf LinkCloud Fast Hyperf 241.2k1](/packages/link-cloud-fast-hyperf) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)