Merge branch 'main' of https://github.com/predis/predis

examples/Commands/TimeSeries/ts_incrby.php

@@ -0,0 +1,45 @@
+<?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\AddArguments;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\IncrByArguments;
+
+require __DIR__ . '/../../shared.php';
+
+// Example of TS.INCRBY command usage:
+
+// 1. Create time series
+$client = new Client();
+
+$arguments = (new CreateArguments())
+    ->retention(60000)
+    ->duplicatePolicy(CommonArguments::POLICY_MAX)
+    ->labels('sensor_id', 2, 'area_id', 32);
+
+$client->tscreate('temperature:2:32', $arguments);
+
+// 2. Add sample into newly created time series
+$addArguments = (new AddArguments())
+    ->retention(31536000000);
+
+$response = $client->tsadd('temperature:2:32', 123123123123, 27, $addArguments);
+
+echo "Timeseries was added with timestamp: {$response}\n";
+
+// 3. Increasing value and timestamp
+$client->tsincrby('temperature:2:32', 1, (new IncrByArguments())->timestamp(123123123124));
+$response = $client->tsget('temperature:2:32');
+
+echo "Increased value to - {$response[1]} and timestamp to {$response[0]}";

src/ClientContextInterface.php

@@ -31,6 +31,7 @@ use Predis\Command\Argument\TimeSeries\AddArguments;
 use Predis\Command\Argument\TimeSeries\AlterArguments as TSAlterArguments;
 use Predis\Command\Argument\TimeSeries\CreateArguments as TSCreateArguments;
 use Predis\Command\Argument\TimeSeries\GetArguments;
+use Predis\Command\Argument\TimeSeries\IncrByArguments;
 use Predis\Command\CommandInterface;
 use Predis\Command\Container\FUNCTIONS;
 use Predis\Command\Container\Json\JSONDEBUG;
@@ -241,6 +242,7 @@ use Predis\Command\Container\Search\FTCONFIG;
  * @method $this tscreate(string $key, ?TSCreateArguments $arguments = null)
  * @method $this tsdel(string $key, int $fromTimestamp, int $toTimestamp)
  * @method $this tsget(string $key, GetArguments $arguments = null)
+ * @method $this tsincrby(string $key, float $value, ?IncrByArguments $arguments = null)
  * @method $this zadd($key, array $membersAndScoresDictionary)
  * @method $this zcard($key)
  * @method $this zcount($key, $min, $max)

src/ClientInterface.php

@@ -31,6 +31,7 @@ use Predis\Command\Argument\TimeSeries\AddArguments;
 use Predis\Command\Argument\TimeSeries\AlterArguments as TSAlterArguments;
 use Predis\Command\Argument\TimeSeries\CreateArguments as TSCreateArguments;
 use Predis\Command\Argument\TimeSeries\GetArguments;
+use Predis\Command\Argument\TimeSeries\IncrByArguments;
 use Predis\Command\CommandInterface;
 use Predis\Command\Container\FUNCTIONS;
 use Predis\Command\Container\Json\JSONDEBUG;
@@ -251,6 +252,7 @@ use Predis\Response\Status;
  * @method Status            tscreate(string $key, ?TSCreateArguments $arguments = null)
  * @method int               tsdel(string $key, int $fromTimestamp, int $toTimestamp)
  * @method array             tsget(string $key, GetArguments $arguments = null)
+ * @method int               tsincrby(string $key, float $value, ?IncrByArguments $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)

src/Command/Argument/TimeSeries/IncrByArguments.php

@@ -0,0 +1,41 @@
+<?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\Argument\TimeSeries;
+
+class IncrByArguments extends CommonArguments
+{
+    /**
+     * Is (integer) UNIX sample timestamp in milliseconds or * to set the timestamp according to the server clock.
+     *
+     * @param  string|int $timeStamp
+     * @return $this
+     */
+    public function timestamp($timeStamp): self
+    {
+        array_push($this->arguments, 'TIMESTAMP', $timeStamp);
+
+        return $this;
+    }
+
+    /**
+     * Changes data storage from compressed (default) to uncompressed.
+     *
+     * @return $this
+     */
+    public function uncompressed(): self
+    {
+        $this->arguments[] = 'UNCOMPRESSED';
+
+        return $this;
+    }
+}

src/Command/Redis/TimeSeries/TSINCRBY.php

@@ -0,0 +1,41 @@
+<?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\Command as RedisCommand;
+
+/**
+ * @see https://redis.io/commands/ts.incrby/
+ *
+ * Increase the value of the sample with the maximum existing timestamp,
+ * or create a new sample with a value equal to the value of the sample
+ * with the maximum existing timestamp with a given increment
+ */
+class TSINCRBY extends RedisCommand
+{
+    public function getId()
+    {
+        return 'TS.INCRBY';
+    }
+
+    public function setArguments(array $arguments)
+    {
+        [$key, $value] = $arguments;
+        $commandArguments = (!empty($arguments[2])) ? $arguments[2]->toArray() : [];
+
+        parent::setArguments(array_merge(
+            [$key, $value],
+            $commandArguments
+        ));
+    }
+}

tests/Predis/Command/Argument/TimeSeries/IncrByArgumentsTest.php

@@ -0,0 +1,48 @@
+<?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\Argument\TimeSeries;
+
+use PHPUnit\Framework\TestCase;
+
+class IncrByArgumentsTest extends TestCase
+{
+    /**
+     * @var IncrByArguments
+     */
+    private $arguments;
+
+    protected function setUp(): void
+    {
+        $this->arguments = new IncrByArguments();
+    }
+
+    /**
+     * @return void
+     */
+    public function testCreatesArgumentsWithTimestampModifier(): void
+    {
+        $this->arguments->timestamp('*');
+
+        $this->assertSame(['TIMESTAMP', '*'], $this->arguments->toArray());
+    }
+
+    /**
+     * @return void
+     */
+    public function testCreatesArgumentsWithUncompressedModifier(): void
+    {
+        $this->arguments->uncompressed();
+
+        $this->assertSame(['UNCOMPRESSED'], $this->arguments->toArray());
+    }
+}

tests/Predis/Command/Redis/TimeSeries/TSINCRBY_Test.php

@@ -0,0 +1,184 @@
+<?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\AddArguments;
+use Predis\Command\Argument\TimeSeries\CommonArguments;
+use Predis\Command\Argument\TimeSeries\CreateArguments;
+use Predis\Command\Argument\TimeSeries\IncrByArguments;
+use Predis\Command\Redis\PredisCommandTestCase;
+use Predis\Response\ServerException;
+
+class TSINCRBY_Test extends PredisCommandTestCase
+{
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedCommand(): string
+    {
+        return TSINCRBY::class;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function getExpectedId(): string
+    {
+        return 'TSINCRBY';
+    }
+
+    /**
+     * @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 testIncrByIncreasesValueAndTimestampOfExistingSample(): void
+    {
+        $redis = $this->getClient();
+
+        $arguments = (new CreateArguments())
+            ->retention(60000)
+            ->duplicatePolicy(CommonArguments::POLICY_MAX)
+            ->labels('sensor_id', 2, 'area_id', 32);
+
+        $this->assertEquals(
+            'OK',
+            $redis->tscreate('temperature:2:32', $arguments)
+        );
+
+        $addArguments = (new AddArguments())
+            ->retention(31536000000);
+
+        $this->assertEquals(
+            123123123123,
+            $redis->tsadd('temperature:2:32', 123123123123, 27, $addArguments)
+        );
+
+        $this->assertEquals(
+            123123123124,
+            $redis->tsincrby('temperature:2:32', 28, (new IncrByArguments())->timestamp(123123123124))
+        );
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRedisTimeSeriesVersion >= 1.0.0
+     */
+    public function testIncrByCreateNewSampleIfNotExists(): void
+    {
+        $redis = $this->getClient();
+
+        $arguments = (new CreateArguments())
+            ->retention(60000)
+            ->duplicatePolicy(CommonArguments::POLICY_MAX)
+            ->labels('sensor_id', 2, 'area_id', 32);
+
+        $this->assertEquals(
+            'OK',
+            $redis->tscreate('temperature:2:32', $arguments)
+        );
+
+        $this->assertEquals(
+            123123123123,
+            $redis->tsincrby('temperature:2:32', 27, (new IncrByArguments())->timestamp(123123123123))
+        );
+    }
+
+    /**
+     * @group connected
+     * @return void
+     * @requiresRedisTimeSeriesVersion >= 1.0.0
+     */
+    public function testThrowsExceptionOnOlderTimestampGiven(): void
+    {
+        $redis = $this->getClient();
+
+        $arguments = (new CreateArguments())
+            ->retention(60000)
+            ->duplicatePolicy(CommonArguments::POLICY_MAX)
+            ->labels('sensor_id', 2, 'area_id', 32);
+
+        $this->assertEquals(
+            'OK',
+            $redis->tscreate('temperature:2:32', $arguments)
+        );
+
+        $addArguments = (new AddArguments())
+            ->retention(31536000000);
+
+        $this->assertEquals(
+            123123123123,
+            $redis->tsadd('temperature:2:32', 123123123123, 27, $addArguments)
+        );
+
+        $this->expectException(ServerException::class);
+        $this->expectExceptionMessage('TSDB: for incrby/decrby, timestamp should be newer than the');
+
+        $redis->tsincrby('temperature:2:32', 27, (new IncrByArguments())->timestamp(123123123122));
+    }
+
+    public function argumentsProvider(): array
+    {
+        return [
+            'with default arguments' => [
+                ['key', 1.0],
+                ['key', 1.0],
+            ],
+            'with TIMESTAMP modifier' => [
+                ['key', 1.0, (new IncrByArguments())->timestamp(10)],
+                ['key', 1.0, 'TIMESTAMP', 10],
+            ],
+            'with RETENTION modifier' => [
+                ['key', 1.0, (new IncrByArguments())->retention(100)],
+                ['key', 1.0, 'RETENTION', 100],
+            ],
+            'with UNCOMPRESSED modifier' => [
+                ['key', 1.0, (new IncrByArguments())->uncompressed()],
+                ['key', 1.0, 'UNCOMPRESSED'],
+            ],
+            'with CHUNK_SIZE modifier' => [
+                ['key', 1.0, (new IncrByArguments())->chunkSize(100)],
+                ['key', 1.0, 'CHUNK_SIZE', 100],
+            ],
+            'with LABELS modifier' => [
+                ['key', 1.0, (new IncrByArguments())->labels('label1', 1, 'label2', 2)],
+                ['key', 1.0, 'LABELS', 'label1', 1, 'label2', 2],
+            ],
+            'with all modifiers' => [
+                ['key', 1.0, (new IncrByArguments())->timestamp(10)->retention(100)->uncompressed()->chunkSize(100)->labels('label1', 1, 'label2', 2)],
+                ['key', 1.0, 'TIMESTAMP', 10, 'RETENTION', 100, 'UNCOMPRESSED', 'CHUNK_SIZE', 100, 'LABELS', 'label1', 1, 'label2', 2],
+            ],
+        ];
+    }
+}