feat: pass parameters natively via http interface along the query (#224)

simPod · Jan 17, 2024 · 3f2c466 · 3f2c466
1 parent 2cbdc98
commit 3f2c466
Show file tree

Hide file tree

Showing 25 changed files with 773 additions and 60 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ Naming used here is the same as in ClickHouse docs.
 - Works with any HTTP Client implementation ([PSR-18 compliant](https://www.php-fig.org/psr/psr-18/))
 - All [ClickHouse Formats](https://clickhouse.yandex/docs/en/interfaces/formats/) support
 - Logging ([PSR-3 compliant](https://www.php-fig.org/psr/psr-3/))
-- SQL Factory for [parameters "binding"](#parameters-binding)
+- [Native query parameters](#native-query-parameters) support
 
 ## Contents
 
@@ -29,7 +29,7 @@ Naming used here is the same as in ClickHouse docs.
   - [Insert](#insert)
 - [Async API](#async-api)
   - [Select](#select-1)
-- [Parameters "binding"](#parameters-binding)
+- [Native Query Parameters](#native-query-parameters)
 - [Snippets](#snippets)
 
 ## Setup
@@ -227,7 +227,10 @@ If not provided they're not passed either:
 
 ### Select
 
-## Parameters "binding"
+## Native Query Parameters
+
+> [!TIP]
+> [Official docs](https://clickhouse.com/docs/en/interfaces/http#cli-queries-with-parameters)
 
 ```php
 <?php
@@ -238,17 +241,14 @@ use SimPod\ClickHouseClient\Sql\ValueFormatter;
 $sqlFactory = new SqlFactory(new ValueFormatter());
 
 $sql = $sqlFactory->createWithParameters(
-    'SELECT :param',
+    'SELECT {p1:String}',
     ['param' => 'value']
 );
 ```
-This produces `SELECT 'value'` and it can be passed to `ClickHouseClient::select()`.
+This produces `SELECT 'value'` in ClickHouse and it can be passed to `ClickHouseClient::select()`.
 
-Supported types are:
-- scalars
-- DateTimeImmutable (`\DateTime` is not supported because `ValueFormatter` might modify its timezone so it's not considered safe)
-- [Expression](#expression)
-- objects implementing `__toString()`
+All types are supported (except `AggregateFunction`, `SimpleAggregateFunction` and `Nothing` by design).
+You can also pass `DateTimeInterface` into `Date*` types or native array into `Array`, `Tuple`, `Native` and `Geo` types
 
 ### Expression
 

diff --git a/src/Client/ClickHouseClient.php b/src/Client/ClickHouseClient.php
@@ -7,7 +7,8 @@
 use Psr\Http\Client\ClientExceptionInterface;
 use SimPod\ClickHouseClient\Exception\CannotInsert;
 use SimPod\ClickHouseClient\Exception\ServerError;
-use SimPod\ClickHouseClient\Exception\UnsupportedValue;
+use SimPod\ClickHouseClient\Exception\UnsupportedParamType;
+use SimPod\ClickHouseClient\Exception\UnsupportedParamValue;
 use SimPod\ClickHouseClient\Format\Format;
 use SimPod\ClickHouseClient\Output\Output;
 
@@ -27,7 +28,8 @@ public function executeQuery(string $query, array $settings = []): void;
      *
      * @throws ClientExceptionInterface
      * @throws ServerError
-     * @throws UnsupportedValue
+     * @throws UnsupportedParamType
+     * @throws UnsupportedParamValue
      */
     public function executeQueryWithParams(string $query, array $params, array $settings = []): void;
 
@@ -53,7 +55,8 @@ public function select(string $query, Format $outputFormat, array $settings = []
      *
      * @throws ClientExceptionInterface
      * @throws ServerError
-     * @throws UnsupportedValue
+     * @throws UnsupportedParamType
+     * @throws UnsupportedParamValue
      *
      * @template O of Output
      */

diff --git a/src/Client/Http/RequestFactory.php b/src/Client/Http/RequestFactory.php
@@ -10,9 +10,15 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\UriFactoryInterface;
 use Psr\Http\Message\UriInterface;
+use SimPod\ClickHouseClient\Exception\UnsupportedParamType;
+use SimPod\ClickHouseClient\Param\ParamValueConverterRegistry;
+use SimPod\ClickHouseClient\Sql\Type;
 
+use function array_keys;
+use function array_reduce;
 use function http_build_query;
 use function is_string;
+use function preg_match_all;
 use function SimPod\ClickHouseClient\absurd;
 
 use const PHP_QUERY_RFC3986;
@@ -23,6 +29,7 @@ final class RequestFactory
 
     /** @throws InvalidArgumentException */
     public function __construct(
+        private ParamValueConverterRegistry $paramValueConverterRegistry,
         private RequestFactoryInterface $requestFactory,
         UriFactoryInterface|null $uriFactory = null,
         UriInterface|string $uri = '',
@@ -40,6 +47,7 @@ public function __construct(
         $this->uri = $uri;
     }
 
+    /** @throws UnsupportedParamType */
     public function prepareRequest(RequestOptions $requestOptions): RequestInterface
     {
         $query = http_build_query(
@@ -62,7 +70,30 @@ public function prepareRequest(RequestOptions $requestOptions): RequestInterface
 
         $request = $this->requestFactory->createRequest('POST', $uri);
 
+        preg_match_all('~\{([a-zA-Z\d]+):([a-zA-Z\d ]+(\(.+\))?)}~', $requestOptions->sql, $matches);
+
+        $typeToParam = array_reduce(
+            array_keys($matches[1]),
+            static function (array $acc, string|int $k) use ($matches) {
+                $acc[$matches[1][$k]] = Type::fromString($matches[2][$k]);
+
+                return $acc;
+            },
+            [],
+        );
+
         $streamElements = [['name' => 'query', 'contents' => $requestOptions->sql]];
+        foreach ($requestOptions->params as $name => $value) {
+            $type = $typeToParam[$name] ?? null;
+            if ($type === null) {
+                continue;
+            }
+
+            $streamElements[] = [
+                'name' => 'param_' . $name,
+                'contents' => $this->paramValueConverterRegistry->get($type)($value, $type, false),
+            ];
+        }
 
         try {
             $body    = new MultipartStream($streamElements);

diff --git a/src/Client/Http/RequestOptions.php b/src/Client/Http/RequestOptions.php
@@ -10,11 +10,16 @@ final class RequestOptions
     public array $settings;
 
     /**
+     * @param array<string, mixed> $params
      * @param array<string, float|int|string> $defaultSettings
      * @param array<string, float|int|string> $querySettings
      */
-    public function __construct(public string $sql, array $defaultSettings, array $querySettings)
-    {
+    public function __construct(
+        public string $sql,
+        public array $params,
+        array $defaultSettings,
+        array $querySettings,
+    ) {
         $this->settings = $querySettings + $defaultSettings;
     }
 }
diff --git a/src/Client/PsrClickHouseAsyncClient.php b/src/Client/PsrClickHouseAsyncClient.php
@@ -62,25 +62,31 @@ public function selectWithParams(
             $sql
             $formatClause
             CLICKHOUSE,
-            $settings,
-            static fn (ResponseInterface $response): Output => $outputFormat::output($response->getBody()->__toString())
+            params: $params,
+            settings: $settings,
+            processResponse: static fn (ResponseInterface $response): Output => $outputFormat::output(
+                $response->getBody()->__toString(),
+            )
         );
     }
 
     /**
+     * @param array<string, mixed> $params
      * @param array<string, float|int|string> $settings
      * @param (callable(ResponseInterface):mixed)|null $processResponse
      *
      * @throws Exception
      */
     private function executeRequest(
         string $sql,
+        array $params,
         array $settings = [],
         callable|null $processResponse = null,
     ): PromiseInterface {
         $request = $this->requestFactory->prepareRequest(
             new RequestOptions(
                 $sql,
+                $params,
                 $this->defaultSettings,
                 $settings,
             ),

diff --git a/src/Client/PsrClickHouseClient.php b/src/Client/PsrClickHouseClient.php
@@ -12,7 +12,8 @@
 use SimPod\ClickHouseClient\Client\Http\RequestOptions;
 use SimPod\ClickHouseClient\Exception\CannotInsert;
 use SimPod\ClickHouseClient\Exception\ServerError;
-use SimPod\ClickHouseClient\Exception\UnsupportedValue;
+use SimPod\ClickHouseClient\Exception\UnsupportedParamType;
+use SimPod\ClickHouseClient\Exception\UnsupportedParamValue;
 use SimPod\ClickHouseClient\Format\Format;
 use SimPod\ClickHouseClient\Output\Output;
 use SimPod\ClickHouseClient\Sql\Escaper;
@@ -46,13 +47,18 @@ public function __construct(
 
     public function executeQuery(string $query, array $settings = []): void
     {
-        $this->executeRequest($query, settings: $settings);
+        try {
+            $this->executeRequest($query, params: [], settings: $settings);
+        } catch (UnsupportedParamType) {
+            absurd();
+        }
     }
 
     public function executeQueryWithParams(string $query, array $params, array $settings = []): void
     {
         $this->executeRequest(
             $this->sqlFactory->createWithParameters($query, $params),
+            params: $params,
             settings: $settings,
         );
     }
@@ -61,7 +67,7 @@ public function select(string $query, Format $outputFormat, array $settings = []
     {
         try {
             return $this->selectWithParams($query, params: [], outputFormat: $outputFormat, settings: $settings);
-        } catch (UnsupportedValue) {
+        } catch (UnsupportedParamValue | UnsupportedParamType) {
             absurd();
         }
     }
@@ -77,6 +83,7 @@ public function selectWithParams(string $query, array $params, Format $outputFor
             $sql
             $formatClause
             CLICKHOUSE,
+            params: $params,
             settings: $settings,
         );
 
@@ -112,14 +119,19 @@ public function insert(string $table, array $values, array|null $columns = null,
 
         $table = Escaper::quoteIdentifier($table);
 
-        $this->executeRequest(
-            <<<CLICKHOUSE
-            INSERT INTO $table
-            $columnsSql
-            VALUES $valuesSql
-            CLICKHOUSE,
-            settings: $settings,
-        );
+        try {
+            $this->executeRequest(
+                <<<CLICKHOUSE
+                INSERT INTO $table
+                $columnsSql
+                VALUES $valuesSql
+                CLICKHOUSE,
+                params: [],
+                settings: $settings,
+            );
+        } catch (UnsupportedParamType) {
+            absurd();
+        }
     }
 
     public function insertWithFormat(string $table, Format $inputFormat, string $data, array $settings = []): void
@@ -128,25 +140,33 @@ public function insertWithFormat(string $table, Format $inputFormat, string $dat
 
         $table = Escaper::quoteIdentifier($table);
 
-        $this->executeRequest(
-            <<<CLICKHOUSE
-            INSERT INTO $table $formatSql $data
-            CLICKHOUSE,
-            settings: $settings,
-        );
+        try {
+            $this->executeRequest(
+                <<<CLICKHOUSE
+                INSERT INTO $table $formatSql $data
+                CLICKHOUSE,
+                params: [],
+                settings: $settings,
+            );
+        } catch (UnsupportedParamType) {
+            absurd();
+        }
     }
 
     /**
+     * @param array<string, mixed> $params
      * @param array<string, float|int|string> $settings
      *
      * @throws ServerError
      * @throws ClientExceptionInterface
+     * @throws UnsupportedParamType
      */
-    private function executeRequest(string $sql, array $settings): ResponseInterface
+    private function executeRequest(string $sql, array $params, array $settings): ResponseInterface
     {
         $request = $this->requestFactory->prepareRequest(
             new RequestOptions(
                 $sql,
+                $params,
                 $this->defaultSettings,
                 $settings,
             ),

diff --git a/src/Exception/UnsupportedParamType.php b/src/Exception/UnsupportedParamType.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\ClickHouseClient\Exception;
+
+use InvalidArgumentException;
+use SimPod\ClickHouseClient\Sql\Type;
+
+final class UnsupportedParamType extends InvalidArgumentException implements ClickHouseClientException
+{
+    public static function fromType(Type $type): self
+    {
+        return new self($type->name);
+    }
+
+    public static function fromString(string $type): self
+    {
+        return new self($type);
+    }
+}
diff --git a/src/Exception/UnsupportedValue.php → src/Exception/UnsupportedParamValue.php b/src/Exception/UnsupportedValue.php → src/Exception/UnsupportedParamValue.php
@@ -11,7 +11,7 @@
 use function sprintf;
 use function var_export;
 
-final class UnsupportedValue extends InvalidArgumentException implements ClickHouseClientException
+final class UnsupportedParamValue extends InvalidArgumentException implements ClickHouseClientException
 {
     public static function type(mixed $value): self
     {