Add delete method for BaseModel

Author: glushkovds

CHANGELOG.md

@@ -1,7 +1,12 @@
+## 1.12.0 [2022-01-19]
+
+### Features
+1. Add delete method for BaseModel
+
 ## 1.11.0 [2022-01-09]
 
 ### Features
-1. Fix issue #8: Migrations on standalone Clickhouse database 
+1. Fix issue #8: Migrations on standalone Clickhouse database
 
 ## 1.10.0 [2021-09-20]
 

README.md

@@ -235,6 +235,40 @@ class MyTable extends BaseModel
 }
 ```
 
+### OPTIMIZE Statement
+
+See https://clickhouse.com/docs/ru/sql-reference/statements/optimize/
+
+```php
+MyTable::optimize($final = false, $partition = null);
+```
+
+### Deletions
+
+See https://clickhouse.com/docs/en/sql-reference/statements/alter/delete/
+
+```php
+MyTable::where('field_one', 123)->delete();
+```
+
+Using buffer engine and performing OPTIMIZE or ALTER TABLE DELETE
+
+```php
+<?php
+
+namespace App\Models\Clickhouse;
+
+use PhpClickHouseLaravel\BaseModel;
+
+class MyTable extends BaseModel
+{
+    // All SELECT's and INSERT's on $table
+    protected $table = 'my_table_buffer';
+    // OPTIMIZE and DELETE on $tableSources
+    protected $tableSources = 'my_table';
+}
+```
+
 ### Helpers for inserting different data types
 
 ```php

src/BaseModel.php

@@ -8,6 +8,8 @@
 use Illuminate\Database\Eloquent\Concerns\HasAttributes;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Str;
+use Tinderbox\ClickhouseBuilder\Query\Enums\Operator;
+use Tinderbox\ClickhouseBuilder\Query\TwoElementsLogicExpression;
 
 class BaseModel
 {
@@ -29,6 +31,13 @@ class BaseModel
      */
     protected $tableForInserts;
 
+    /**
+     * Use this field for OPTIMIZE TABLE OR ALTER TABLE (also DELETE) queries
+     *
+     * @var string
+     */
+    protected $tableSources;
+
     /**
      * Indicates if the model exists.
      *
@@ -56,6 +65,15 @@ public function getTableForInserts()
         return $this->tableForInserts ?? $this->getTable();
     }
 
+    /**
+     * Use this field for OPTIMIZE TABLE OR ALTER TABLE (also DELETE) queries
+     * @return string
+     */
+    public function getTableSources()
+    {
+        return $this->tableSources ?? $this->getTable();
+    }
+
     /**
      * @return Client
      */
@@ -268,15 +286,54 @@ public function __set($key, $value)
      * Optimize table. Using for ReplacingMergeTree, etc.
      * @source https://clickhouse.tech/docs/ru/sql-reference/statements/optimize/
      * @param bool $final
+     * @param string|null $partition
      * @return \ClickHouseDB\Statement
      */
-    public static function optimize($final = false)
+    public static function optimize($final = false, $partition = null)
     {
-        $sql = "OPTIMIZE TABLE " . (new static)->getTable();
+        $sql = "OPTIMIZE TABLE " . (new static)->getTableSources();
+        if ($partition) {
+            $sql .= " PARTITION $partition";
+        }
         if ($final) {
             $sql .= " FINAL";
         }
         return static::getClient()->write($sql);
     }
 
+    /**
+     * @param TwoElementsLogicExpression|string|Closure $column
+     * @param string|null $operator
+     * @param int|float|string|null $value
+     * @param string $concatOperator Operator::AND for example
+     * @return Builder
+     */
+    public static function where($column, $operator = null, $value = null, string $concatOperator = Operator::AND)
+    {
+        $static = new static;
+        $builder = (new Builder)->select(['*'])
+            ->from($static->getTable())
+            ->setSourcesTable($static->getTableSources());
+        if (is_null($value)) {
+            // Fix func_num_args() in where clause in BaseBuilder
+            $builder->where($column, $operator);
+        } else {
+            $builder->where($column, $operator, $value, $concatOperator);
+        }
+        return $builder;
+    }
+
+    /**
+     * @param string $expression
+     * @return Builder
+     */
+    public static function whereRaw(string $expression)
+    {
+        $static = new static;
+        return (new Builder)->select(['*'])
+            ->from($static->getTable())
+            ->setSourcesTable($static->getTableSources())
+            ->whereRaw($expression);
+    }
+
 }

src/Builder.php

@@ -13,6 +13,9 @@
 class Builder extends BaseBuilder
 {
 
+    /** @var string */
+    protected $tableSources;
+
     public function __construct()
     {
         $this->grammar = new Grammar();
@@ -52,4 +55,28 @@ public function chunk(int $count, callable $callback)
         } while ($rows);
     }
 
+    /**
+     * For delete query
+     * @param string $table
+     * @return $this
+     */
+    public function setSourcesTable(string $table)
+    {
+        $this->tableSources = $table;
+        return $this;
+    }
+
+    /**
+     * Note! This is a heavy operation not designed for frequent use.
+     * @return Statement
+     */
+    public function delete()
+    {
+        $table = $this->tableSources ?? $this->getFrom()->getTable();
+        $sql = "ALTER TABLE $table DELETE " . $this->grammar->compileWheresComponent($this, $this->getWheres());
+        /** @var Client $db */
+        $db = DB::connection('clickhouse')->getClient();
+        return $db->write($sql);
+    }
+
 }