init

Author: alexv14vvv

README.md

@@ -5,6 +5,8 @@ Adapter to Laravel and Lumen of the most popular libraries:
 - https://github.com/smi2/phpClickHouse - for connections and perform queries
 - https://github.com/the-tinderbox/ClickhouseBuilder - good query builder
 
+Based on https://github.com/glushkovds/phpclickhouse-laravel
+
 ## Features
 
 No dependency, only Curl (support php >=7.1 )
@@ -13,7 +15,7 @@ More: https://github.com/smi2/phpClickHouse#features
 
 ## Prerequisites
 
-- PHP 7.1
+- PHP 7.1, 8.0
 - Laravel/Lumen 7+
 - Clickhouse server
 
@@ -22,7 +24,7 @@ More: https://github.com/smi2/phpClickHouse#features
 **1.**  Install via composer
 
 ```sh
-$ composer require glushkovds/phpclickhouse-laravel
+$ composer require opiy-org/phpclickhouse-laravel
 ```
 
 **2.** Add new connection into your config/database.php:
@@ -274,4 +276,4 @@ class MyTable extends BaseModel
 ```php
 // Array data type
 MyTable::insertAssoc([[1,'str',new InsertArray(['a','b'])]]);
-```
+```

composer.json

@@ -1,23 +1,27 @@
 {
-  "name": "glushkovds/phpclickhouse-laravel",
+  "name": "opiy-org/phpclickhouse-laravel",
   "description": "Adapter of the most popular library https://github.com/smi2/phpClickHouse to Laravel",
   "keywords": [
     "php",
     "laravel",
     "clickhouse"
   ],
-  "homepage": "https://github.com/glushkovds/phpClickHouse-laravel",
+  "homepage": "https://github.com/opiy-org/phpClickHouse-laravel",
   "type": "library",
   "license": "MIT",
   "authors": [
     {
       "name": "Denis Glushkov",
       "email": "[email protected]",
       "homepage": "https://github.com/glushkovds"
+    },
+    {
+      "name": "opiy",
+      "homepage": "https://github.com/opiy-org"
     }
   ],
   "require": {
-    "php": ">=7.1.0",
+    "php": ">=7.1.0|>=8.0",
     "smi2/phpclickhouse": "^1.3",
     "the-tinderbox/clickhouse-builder": "^3.0|^4.0",
     "illuminate/support": "^7.0|^8.0|^9.0",
@@ -30,4 +34,4 @@
       "PhpClickHouseLaravel\\": "src/"
     }
   }
-}
+}

src/BaseModel.php

@@ -1,10 +1,12 @@
 <?php
 
+declare(strict_types=1);
 
 namespace PhpClickHouseLaravel;
 
-
 use ClickHouseDB\Client;
+use ClickHouseDB\Statement;
+use Exception;
 use Illuminate\Database\Eloquent\Concerns\HasAttributes;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Str;
@@ -13,7 +15,6 @@
 
 class BaseModel
 {
-
     use HasAttributes;
 
     /**
@@ -50,7 +51,7 @@ class BaseModel
      *
      * @return string
      */
-    public function getTable()
+    public function getTable(): string
     {
         return $this->table ?? Str::snake(Str::pluralStudly(class_basename($this)));
     }
@@ -60,7 +61,7 @@ public function getTable()
      *
      * @return string
      */
-    public function getTableForInserts()
+    public function getTableForInserts(): string
     {
         return $this->tableForInserts ?? $this->getTable();
     }
@@ -69,15 +70,15 @@ public function getTableForInserts()
      * Use this field for OPTIMIZE TABLE OR ALTER TABLE (also DELETE) queries
      * @return string
      */
-    public function getTableSources()
+    public function getTableSources(): string
     {
         return $this->tableSources ?? $this->getTable();
     }
 
     /**
      * @return Client
      */
-    public static function getClient()
+    public static function getClient(): Client
     {
         return DB::connection('clickhouse')->getClient();
     }
@@ -87,23 +88,25 @@ public static function getClient()
      * @param array $attributes
      * @return static
      */
-    public static function make($attributes = [])
+    public static function make(array $attributes = [])
     {
         $model = new static;
         $model->fill($attributes);
+
         return $model;
     }
 
     /**
      * Save a new model and return the instance.
      * @param array $attributes
      * @return static
-     * @throws \Exception
+     * @throws Exception
      */
-    public static function create($attributes = [])
+    public static function create(array $attributes = [])
     {
         $model = static::make($attributes);
         $model->save();
+
         return $model;
     }
 
@@ -112,36 +115,38 @@ public static function create($attributes = [])
      * @param array $attributes
      * @return $this
      */
-    public function fill(array $attributes)
+    public function fill(array $attributes): self
     {
         foreach ($attributes as $key => $value) {
             $this->setAttribute($key, $value);
         }
+
         return $this;
     }
 
     /**
      * Save the model to the database.
      * @param array $options
      * @return bool
-     * @throws \Exception
+     * @throws Exception
      */
-    public function save(array $options = [])
+    public function save(array $options = []): bool
     {
         if ($this->exists) {
-            throw new \Exception("Clickhouse does not allow update rows");
+            throw new Exception("Clickhouse does not allow update rows");
         }
         $this->exists = !static::insertAssoc([$this->getAttributes()])->isError();
+
         return $this->exists;
     }
 
     /**
      * Bulk insert into Clickhouse database
      * @param array[] $rows
-     * @return \ClickHouseDB\Statement
+     * @return Statement
      * @deprecated use insertBulk
      */
-    public static function insert($rows)
+    public static function insert(array $rows): Statement
     {
         return static::getClient()->insert((new static)->getTableForInserts(), $rows);
     }
@@ -150,10 +155,10 @@ public static function insert($rows)
      * Bulk insert into Clickhouse database
      * @param array[] $rows
      * @param array $columns
-     * @return \ClickHouseDB\Statement
+     * @return Statement
      * @example MyModel::insertBulk([['model 1', 1], ['model 2', 2]], ['model_name', 'some_param']);
      */
-    public static function insertBulk($rows, $columns = [])
+    public static function insertBulk(array $rows, array $columns = []): Statement
     {
         return static::getClient()->insert((new static)->getTableForInserts(), $rows, $columns);
     }
@@ -162,21 +167,23 @@ public static function insertBulk($rows, $columns = [])
      * Prepare each row by calling static::prepareFromRequest to bulk insert into database
      * @param array[] $rows
      * @param array $columns
-     * @return \ClickHouseDB\Statement
+     * @return Statement
      */
-    public static function prepareAndInsert($rows, $columns = [])
+    public static function prepareAndInsert(array $rows, array $columns = []): Statement
     {
         $rows = array_map('static::prepareFromRequest', $rows, $columns);
-        return static::getClient()->insert((new static)->getTableForInserts(), $rows, $columns);
+
+        return static::getClient()
+            ->insert((new static)->getTableForInserts(), $rows, $columns);
     }
 
     /**
      * Bulk insert rows as associative array into Clickhouse database
      * @param array[] $rows
-     * @return \ClickHouseDB\Statement
+     * @return Statement
      * @example MyModel::insertAssoc([['model_name' => 'model 1', 'some_param' => 1], ['model_name' => 'model 2', 'some_param' => 2]]);
      */
-    public static function insertAssoc($rows)
+    public static function insertAssoc(array $rows): Statement
     {
         $rows = array_values($rows);
         if (isset($rows[0]) && isset($rows[1])) {
@@ -191,9 +198,9 @@ public static function insertAssoc($rows)
     /**
      * Prepare each row by calling static::prepareAssocFromRequest to bulk insert into database
      * @param array[] $rows
-     * @return \ClickHouseDB\Statement
+     * @return Statement
      */
-    public static function prepareAndInsertAssoc($rows)
+    public static function prepareAndInsertAssoc(array $rows): Statement
     {
         $rows = array_map('static::prepareAssocFromRequest', $rows);
         return static::insertAssoc($rows);
@@ -206,7 +213,7 @@ public static function prepareAndInsertAssoc($rows)
      * @param array $columns
      * @return array
      */
-    public static function prepareFromRequest($row, $columns = [])
+    public static function prepareFromRequest(array $row, array $columns = []): array
     {
         return $row;
     }
@@ -217,7 +224,7 @@ public static function prepareFromRequest($row, $columns = [])
      * @param array $row
      * @return array
      */
-    public static function prepareAssocFromRequest($row)
+    public static function prepareAssocFromRequest(array $row): array
     {
         return $row;
     }
@@ -226,7 +233,7 @@ public static function prepareAssocFromRequest($row)
      * @param array $select optional = ['*']
      * @return Builder
      */
-    public static function select($select = ['*'])
+    public static function select(array $select = ['*']): Builder
     {
         return (new Builder)->select($select)->from((new static)->getTable());
     }
@@ -235,7 +242,7 @@ public static function select($select = ['*'])
      * Necessary stub for HasAttributes trait
      * @return array
      */
-    public function getCasts()
+    public function getCasts(): array
     {
         return $this->casts;
     }
@@ -244,7 +251,7 @@ public function getCasts()
      * Necessary stub for HasAttributes trait
      * @return bool
      */
-    public function usesTimestamps()
+    public function usesTimestamps(): bool
     {
         return false;
     }
@@ -265,7 +272,7 @@ public function getRelationValue($key)
      * @param string $key
      * @return mixed
      */
-    public function __get($key)
+    public function __get(string $key)
     {
         return $this->getAttribute($key);
     }
@@ -277,7 +284,7 @@ public function __get($key)
      * @param mixed $value
      * @return void
      */
-    public function __set($key, $value)
+    public function __set(string $key, $value): void
     {
         $this->setAttribute($key, $value);
     }
@@ -287,9 +294,9 @@ public function __set($key, $value)
      * @source https://clickhouse.tech/docs/ru/sql-reference/statements/optimize/
      * @param bool $final
      * @param string|null $partition
-     * @return \ClickHouseDB\Statement
+     * @return Statement
      */
-    public static function optimize($final = false, $partition = null)
+    public static function optimize(bool $final = false, ?string $partition = null): Statement
     {
         $sql = "OPTIMIZE TABLE " . (new static)->getTableSources();
         if ($partition) {
@@ -298,6 +305,7 @@ public static function optimize($final = false, $partition = null)
         if ($final) {
             $sql .= " FINAL";
         }
+
         return static::getClient()->write($sql);
     }
 
@@ -320,20 +328,21 @@ public static function where($column, $operator = null, $value = null, string $c
         } else {
             $builder->where($column, $operator, $value, $concatOperator);
         }
+
         return $builder;
     }
 
     /**
      * @param string $expression
      * @return Builder
      */
-    public static function whereRaw(string $expression)
+    public static function whereRaw(string $expression):Builder
     {
         $static = new static;
+
         return (new Builder)->select(['*'])
             ->from($static->getTable())
             ->setSourcesTable($static->getTableSources())
             ->whereRaw($expression);
     }
-
 }