This package is for working with Redis streams for php
- add messages in a stream
- delete messages from a stream
- find a message by the id of the message from a stream
- get a collection of a message from a stream
- create a group consumer for stream
- delete a group consumer from stream
- delete a consumer from a group
- listen to a stream, implemented based on (https://github.com/reactphp/event-loop)
Need version Redis >= 5.0
composer require asiries335/redis-stream-php
Start working
<?php use Asiries335\redisSteamPhp\Dto\StreamCommandCallTransporter; // Example use in your app. class Config implements \Asiries335\redisSteamPhp\ClientRedisStreamPhpInterface { private $client; public function __construct() { $this->client = new \Redis(); $this->client->connect('127.0.0.1', '6379'); } /** * Method for run command of redis * * @param StreamCommandCallTransporter $commandCallTransporter * * @return mixed * * @throws \Dto\Exceptions\InvalidDataTypeException * @throws \Dto\Exceptions\InvalidKeyException */ public function call(StreamCommandCallTransporter $commandCallTransporter) { // Example use. return $this->client->rawCommand( $commandCallTransporter->get('command')->toScalar(), ...$commandCallTransporter->get('args')->toArray() ); } } $client = new \Asiries335\redisSteamPhp\Client(new Config());Add a message to stream
$client->stream('test')->add( 'key', [ 'id' => 123, 'name' => 'Barney', 'age' => 25, ] );Find a message by id
$message = $client->stream('test')->findById('1599404282894-0'); // result. Asiries335\redisSteamPhp\Data\Message { -_id: "1599404282894-0" -_key: "user" -_body: "{"id":123,"name":"Barney","age":25}" }Delete a message
$client->stream('test')->delete('key');see more https://redis.io/commands/xdel
Get a collection of messages from the stream
// Get data from stream. $collection = $client->stream('test')->get(); // result. Asiries335\redisSteamPhp\Data\Collection { -_name: "test" -_messages: [ 0 => Asiries335\redisSteamPhp\Data\Message { -_id: "1588098124977-0" -_key: "key" -_body: "{"id":123,"name":"Barney","age":25}" } 1 => Asiries335\redisSteamPhp\Data\Message { -_id: "1588098124977-1" -_key: "key" -_body: "{"id":124,"name":"Smith","age":30}" } 2 => Asiries335\redisSteamPhp\Data\Message { -_id: "1588500979608-0" -_key: "key" -_body: "{"id":163,"name":"Alex","age":20}" } ] }Listen to a stream
functional works on a package basis https://github.com/reactphp/event-loop
$client->stream('test')->listen( function (\Asiries335\redisSteamPhp\Data\Message $message) { // Your code... } );Create a new consumer group
$streamName = 'test'; $groupName = 'demo-group-1'; $isShowFullHistoryStream = false; // return bool or ErrorException. $client->streamGroupConsumer($streamName)->create($groupName, $isShowFullHistoryStream);Destroy a consumer group
$streamName = 'test'; $groupName = 'demo-group-1'; // return bool or ErrorException. $client->streamGroupConsumer($streamName)->destroy($groupName);Delete a consumer from a group
$streamName = 'test'; $groupName = 'demo-group-1'; $consumerName = 'consumer-name'; // return bool or ErrorException. $client->streamGroupConsumer($streamName)->deleteConsumer($groupName, $consumerName);