Extended TimeSeries by implementing TS.REVRANGE command (#1232)

* Added support for new arguments for BITPOS, BITCOUNT commands (#1045) * Added support for new arguments for EXPIRE, EXPIREAT commands (#1046) * Extended core support by implementing SORT_RO command (#1044) * Added support for SORT_RO command * Codestyle fixes * Added command description --------- Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> * fix deprecated call * Added support for container commands (#1049) * Added support for container commands FUNCTION LOAD, FUNCTION DELETE and FCALL * Changed ContainerInterface and AbstractContainer * Re-implement logic of abstract methods --------- Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> * Added stream commands to KeyPrefixProcessor (#1051) Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> * Fix return type of ReplicationInterface::getSlaves (#1111) * Codestyle fixes * Changed return annotation * Added support for TS.RANGE command * Added support for TS.REVRANGE command --------- Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> Co-authored-by: Till Krüss <till@kruss.io> Co-authored-by: Stephan <glaubinix@users.noreply.github.com>
2026-09-05 07:16:44 +00:00 · 2023-03-28 16:59:08 +03:00
parent dcd188d4dd
commit 4d5bdace66
7 changed files with 223 additions and 0 deletions
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Predis\Client;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\RangeArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.REVRANGE command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$createArguments = (new CreateArguments())->labels('type', 'temp', 'location', 'TLV');
+$createResponse = $client->tscreate('temp:TLV', $createArguments);
+
+echo "Time series creation status: {$createResponse}\n";
+
+// 2. Add samples into time series
+$maddResponse = $client->tsmadd('temp:TLV', 1000, 30, 'temp:TLV', 1010, 35, 'temp:TLV', 1020, 9999, 'temp:TLV', 1030, 40);
+$stringResponse = implode(', ', $maddResponse);
+
+echo "Samples was added with following timestamps: {$stringResponse}\n";
+
+// 3. Query samples by values in the given range
+$rangeArguments = (new RangeArguments())->filterByValue(-100, 100);
+$rangeResponse = $client->tsrevrange('temp:TLV', '-', '+', $rangeArguments);
+
+echo "Samples with temperature in range -100 to 100 degrees in reverse order:\n";
+print_r($rangeResponse);
@@ -253,6 +253,7 @@ use Predis\Command\Container\Search\FTCONFIG;
 * @method $this tsmget(MGetArguments $arguments, string ...$filterExpression)
 * @method $this tsqueryindex(string ...$filterExpression)
 * @method $this tsrange(string $key, $fromTimestamp, $toTimestamp, ?RangeArguments $arguments = null)
+ * @method $this tsrevrange(string $key, $fromTimestamp, $toTimestamp, ?RangeArguments $arguments = null)
 * @method $this zadd($key, array $membersAndScoresDictionary)
 * @method $this zcard($key)
 * @method $this zcount($key, $min, $max)
@@ -263,6 +263,7 @@ use Predis\Response\Status;
 * @method array             tsmget(MGetArguments $arguments, string ...$filterExpression)
 * @method array             tsqueryindex(string ...$filterExpression)
 * @method array             tsrange(string $key, $fromTimestamp, $toTimestamp, ?RangeArguments $arguments = null)
+ * @method array             tsrevrange(string $key, $fromTimestamp, $toTimestamp, ?RangeArguments $arguments = null)
 * @method string            xadd(string $key, array $dictionary, string $id = '*', array $options = null)
 * @method int               xdel(string $key, string ...$id)
 * @method int               xlen(string $key)
@@ -14,6 +14,11 @@ namespace Predis\Command\Redis\TimeSeries;

 use Predis\Command\Command as RedisCommand;

+/**
+ * @see https://redis.io/commands/ts.range/
+ *
+ * Query a range in forward direction.
+ */
 class TSRANGE extends RedisCommand
 {
    public function getId()
@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis\TimeSeries;
+
+/**
+ * @see https://redis.io/commands/ts.revrange/
+ *
+ * Query a range in reverse direction.
+ */
+class TSREVRANGE extends TSRANGE
+{
+    public function getId()
+    {
+        return 'TS.REVRANGE';
+    }
+}
@@ -47,6 +47,14 @@ class TSRANGE_Test extends PredisCommandTestCase
        $this->assertSameValues($expectedArguments, $command->getArguments());
    }

+    /**
+     * @group disconnected
+     */
+    public function testParseResponse(): void
+    {
+        $this->assertSame(1, $this->getCommand()->parseResponse(1));
+    }
+
    /**
     * @group connected
     * @return void
@@ -0,0 +1,142 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis\TimeSeries;
+
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\RangeArguments;
+use Predis\Command\Redis\PredisCommandTestCase;
+use Predis\Response\ServerException;
+
+class TSREVRANGE_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return TSREVRANGE::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'TSREVRANGE';
+    }
+
+    /**
+     * @group disconnected
+     * @dataProvider argumentsProvider
+     */
+    public function testFilterArguments(array $actualArguments, array $expectedArguments): void
+    {
+        $command = $this->getCommand();
+        $command->setArguments($actualArguments);
+
+        $this->assertSameValues($expectedArguments, $command->getArguments());
+    }
+
+    /**
+     * @group disconnected
+     */
+    public function testParseResponse(): void
+    {
+        $this->assertSame(1, $this->getCommand()->parseResponse(1));
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRedisTimeSeriesVersion >= 1.0.0
+     */
+    public function testReturnsQueriedRangeInReverseDirectionFromGivenTimeSeries(): void
+    {
+        $redis = $this->getClient();
+
+        $createArguments = (new CreateArguments())->labels('type', 'temp', 'location', 'TLV');
+        $this->assertEquals('OK', $redis->tscreate('temp:TLV', $createArguments));
+
+        $this->assertSame(
+            [1000, 1010, 1020, 1030],
+            $redis->tsmadd('temp:TLV', 1000, 30, 'temp:TLV', 1010, 35, 'temp:TLV', 1020, 9999, 'temp:TLV', 1030, 40)
+        );
+
+        $rangeArguments = (new RangeArguments())->filterByValue(-100, 100);
+        $this->assertEquals(
+            [[1030, '40'], [1010, '35'], [1000, '30']],
+            $redis->tsrevrange('temp:TLV', '-', '+', $rangeArguments)
+        );
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRedisTimeSeriesVersion >= 1.0.0
+     */
+    public function testThrowsExceptionOnNonExistingKey(): void
+    {
+        $redis = $this->getClient();
+
+        $this->expectException(ServerException::class);
+        $this->expectExceptionMessage('ERR TSDB: the key does not exist');
+
+        $redis->tsrevrange('non_existing_key', 1000, 1000);
+    }
+
+    public function argumentsProvider(): array
+    {
+        return [
+            'with default arguments' => [
+                ['key', 10000, 10001],
+                ['key', 10000, 10001],
+            ],
+            'with LATEST modifier' => [
+                ['key', 10000, 10001, (new RangeArguments())->latest()],
+                ['key', 10000, 10001, 'LATEST'],
+            ],
+            'with FILTER_BY_TS modifier' => [
+                ['key', 10000, 10001, (new RangeArguments())->filterByTs(1000, 1001)],
+                ['key', 10000, 10001, 'FILTER_BY_TS', 1000, 1001],
+            ],
+            'with FILTER_BY_VALUE modifier' => [
+                ['key', 10000, 10001, (new RangeArguments())->filterByValue(1000, 1001)],
+                ['key', 10000, 10001, 'FILTER_BY_VALUE', 1000, 1001],
+            ],
+            'with COUNT modifier' => [
+                ['key', 10000, 10001, (new RangeArguments())->count(100)],
+                ['key', 10000, 10001, 'COUNT', 100],
+            ],
+            'with AGGREGATION modifier - default arguments' => [
+                ['key', 10000, 10001, (new RangeArguments())->aggregation('sum', 100)],
+                ['key', 10000, 10001, 'AGGREGATION', 'sum', 100],
+            ],
+            'with AGGREGATION modifier - with ALIGN' => [
+                ['key', 10000, 10001, (new RangeArguments())->aggregation('sum', 100, 100)],
+                ['key', 10000, 10001, 'ALIGN', 100, 'AGGREGATION', 'sum', 100],
+            ],
+            'with AGGREGATION modifier - with BUCKETTIMESTAMP' => [
+                ['key', 10000, 10001, (new RangeArguments())->aggregation('sum', 100, 0, 1000)],
+                ['key', 10000, 10001, 'AGGREGATION', 'sum', 100, 'BUCKETTIMESTAMP', 1000],
+            ],
+            'with AGGREGATION modifier - with EMPTY' => [
+                ['key', 10000, 10001, (new RangeArguments())->aggregation('sum', 100, 0, 0, true)],
+                ['key', 10000, 10001, 'AGGREGATION', 'sum', 100, 'EMPTY'],
+            ],
+            'with all modifiers' => [
+                ['key', 10000, 10001, (new RangeArguments())->latest()->filterByTs(1000, 1001)->filterByValue(1000, 1001)->count(100)->aggregation('sum', 100)],
+                ['key', 10000, 10001, 'LATEST', 'FILTER_BY_TS', 1000, 1001, 'FILTER_BY_VALUE', 1000, 1001, 'COUNT', 100, 'AGGREGATION', 'sum', 100],
+            ],
+        ];
+    }
+}