https://github.com/angyvolin/predis-commands
Adds some useful commands to Predis.
https://github.com/angyvolin/predis-commands
lua predis redis redis-lua redis-lua-script zpop zrpop
Last synced: 5 months ago
JSON representation
Adds some useful commands to Predis.
- Host: GitHub
- URL: https://github.com/angyvolin/predis-commands
- Owner: angyvolin
- License: mit
- Created: 2017-04-30T18:09:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-01T13:57:27.000Z (about 9 years ago)
- Last Synced: 2025-05-29T11:35:57.759Z (about 1 year ago)
- Topics: lua, predis, redis, redis-lua, redis-lua-script, zpop, zrpop
- Language: PHP
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# predis-commands
Adds some [Lua][4]-based atomic commands to [Predis][3].
## Motivation
Any individual Redis command is always atomic because Redis is single threaded. In some cases you may want to run
several Redis commands atomically.
There are two common ways to achieve this:
- [Redis transactions][1]. It utilizes `MULTI`/`EXEC` Redis commands to run some commands in sequence
It also uses `WATCH`/`DISCARD` Redis commands for `CAS` optimistic concurrency.
- [Redis scripts][2]. This one is transactional by definition: Redis uses the
same Lua interpreter to run all the commands and guarantees that no other script or Redis command will be executed
while a script is being executed.
This project uses Lua Scripting approach as it's usually both simpler and faster.
## Installation
composer require angyvolin/predis-commands
## What's included?
As of now, the `predis-commands` project extends Predis with following commands:
ZPOP - Removes and returns the top value in a zset, with its score.
ZRPOP - Removes and returns the bottom value in a zset, with its score.
## How to use predis-commands ...
### ... in plain PHP
Code snippet below demonstrates how to use `predis-commands` regardless of any framework
```php
getProfile()->defineCommand('zpop', Command\ZSetPop::class);
$client->getProfile()->defineCommand('zrpop', Command\ZSetReversePop::class);
```
### ... in Silex application
Code snippet below demonstrates integration with Silex application
```php
extend('redis', function ($redis) {
/* @var \Predis\Client $redis */
$redis->getProfile()->defineCommand('zpop', Command\ZSetPop::class);
$redis->getProfile()->defineCommand('zrpop', Command\ZSetReversePop::class);
return $redis;
});
}
}
```
## Tests:
Tu run tests execute following command in a root directory of the predis-commands project:
phpunit
## License
[MIT License](LICENSE.md)
[1]: https://redis.io/topics/transactions
[2]: https://redis.io/commands/eval
[3]: https://github.com/nrk/predis
[4]: https://www.lua.org/