Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/db-redis
Yii DBAL Redis connection
https://github.com/yiisoft/db-redis
database db hacktoberfest optionalforframeworkannounce redis yii3
Last synced: about 1 month ago
JSON representation
Yii DBAL Redis connection
- Host: GitHub
- URL: https://github.com/yiisoft/db-redis
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2018-08-02T16:05:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-14T07:56:57.000Z (almost 2 years ago)
- Last Synced: 2024-04-13T23:13:22.106Z (7 months ago)
- Topics: database, db, hacktoberfest, optionalforframeworkannounce, redis, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 109 KB
- Stars: 16
- Watchers: 19
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii DBAL Redis connection
[](https://packagist.org/packages/yiisoft/db-redis)
[](https://packagist.org/packages/yiisoft/db-redis)
[](https://scrutinizer-ci.com/g/yiisoft/db-redis/?branch=master)
[](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
| PHP | Redis Version | CI-Actions |
|-----|---------------|------------|
|**7.4 - 8.0**| **4 - 6**|[](https://github.com/yiisoft/db-redis/actions?query=workflow%3Abuild) [](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/db-redis/master) [](https://github.com/yiisoft/db-redis/actions?query=workflow%3A%22static+analysis%22) [](https://shepherd.dev/github/yiisoft/db-redis)
## Requirements
- Redis version 2.6.12 or higher.
- `Filter` PHP extension.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/db-redis
```
## General usage
Using `yiisoft/composer-config-plugin` automatically get the settings of `EventDispatcherInterface::class` and `LoggerInterface::class`.
Di-Container:
```php
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
```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:
```php
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:
```php
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
- 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
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
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)