Added ScanQueryMode for Table::scanQuery

Author: ilyakharev

CHANGELOG.md

@@ -1,3 +1,5 @@
+* added `ScanQueryMode` for `Table::scanQuery`
+
 ## 1.13.2
 ### Bugs
 

protos/Ydb/Table/ExecuteScanQueryRequest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace YdbPlatform\Ydb\Enums;
+
+use UnexpectedValueException;
+use Ydb\Table\ExecuteScanQueryRequest\Mode;
+
+class ScanQueryMode
+{
+    const MODE_UNSPECIFIED = Mode::MODE_UNSPECIFIED;
+    const MODE_EXPLAIN = Mode::MODE_EXPLAIN;
+    const MODE_EXEC = Mode::MODE_EXEC;
+    private static $valueToName = [
+        self::MODE_UNSPECIFIED => 'MODE_UNSPECIFIED',
+        self::MODE_EXPLAIN => 'MODE_EXPLAIN',
+        self::MODE_EXEC => 'MODE_EXEC',
+    ];
+
+    public static function name($value)
+    {
+        if (!isset(self::$valueToName[$value])) {
+            throw new UnexpectedValueException(sprintf(
+                'Enum %s has no name defined for value %s', __CLASS__, $value));
+        }
+        return self::$valueToName[$value];
+    }
+
+
+    public static function value($name)
+    {
+        $const = __CLASS__ . '::' . strtoupper($name);
+        if (!defined($const)) {
+            throw new UnexpectedValueException(sprintf(
+                'Enum %s has no value defined for name %s', __CLASS__, $name));
+        }
+        return constant($const);
+    }
+}

src/Enums/ScanQueryMode.php

@@ -8,6 +8,7 @@
 use Ydb\Table\Query;
 use Ydb\Table\V1\TableServiceClient as ServiceClient;
 use YdbPlatform\Ydb\Contracts\SessionPoolContract;
+use YdbPlatform\Ydb\Enums\ScanQueryMode;
 use YdbPlatform\Ydb\Exceptions\Grpc\InvalidArgumentException;
 use YdbPlatform\Ydb\Exceptions\Grpc\UnknownException;
 use YdbPlatform\Ydb\Exceptions\NonRetryableException;
@@ -395,14 +396,16 @@ public function describeTable($table)
 
     /**
      * @param string $yql
+     * @param ScanQueryMode $mode
      * @return \Generator
      */
-    public function scanQuery($yql)
+    public function scanQuery($yql, $mode = ScanQueryMode::MODE_EXEC)
     {
         $q = new Query(['yql_text' => $yql]);
 
         return $this->streamRequest('StreamExecuteScanQuery', [
             'query' => $q,
+            'mode'  => $mode
         ]);
     }
 

src/Table.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace YdbPlatform\Ydb\Test;
+
+use PHPUnit\Framework\TestCase;
+use YdbPlatform\Ydb\Auth\Implement\AnonymousAuthentication;
+use YdbPlatform\Ydb\Enums\ScanQueryMode;
+use YdbPlatform\Ydb\Ydb;
+use YdbPlatform\Ydb\YdbTable;
+
+class ScanQueryTest extends TestCase
+{
+
+    function testScanQueryWith()
+    {
+        self::expectNotToPerformAssertions();
+
+        $config = [
+
+            // Database path
+            'database' => '/local',
+
+            // Database endpoint
+            'endpoint' => 'localhost:2136',
+
+            // Auto discovery (dedicated server only)
+            'discovery' => true,
+
+            // IAM config
+            'iam_config' => [
+                'insecure' => true,
+            ],
+
+            'credentials' => new AnonymousAuthentication()
+        ];
+        $ydb = new Ydb($config, new \YdbPlatform\Ydb\Logger\SimpleStdLogger(7));
+        $table = $ydb->table();
+
+        $table->retrySession(function (\YdbPlatform\Ydb\Session $session){
+            $session->createTable(
+                'episodes',
+                YdbTable::make()
+                    ->addColumn('series_id', 'UINT64')
+                    ->addColumn('title', 'UTF8')
+                    ->addColumn('episode_id', 'UINT64')
+                    ->addColumn('season_id', 'UINT64')
+                    ->primaryKey('series_id')
+            );
+        }, true);
+
+        $yql = 'SELECT series_id, season_id, title, first_aired
+FROM seasons
+WHERE series_id = 1;';
+
+        $scanWithOutParam = $table->scanQuery($yql);
+        $scanWithExplainParam = $table->scanQuery($yql, ScanQueryMode::MODE_EXPLAIN);
+        $scanWithExecParam = $table->scanQuery($yql, ScanQueryMode::MODE_EXEC);
+
+        // These `foreach` needs for requests
+        foreach ($scanWithOutParam as $value){}
+        foreach ($scanWithExplainParam as $value){}
+        foreach ($scanWithExecParam as $value){}
+    }
+}