Merge pull request #3 from karam-mustafa/main

v1.1.0

Author: karam-mustafa

docs/delete.md

@@ -1,14 +1,34 @@
 Delete helper
 -----------
+#### drop multi tables
 Suppose you want to drop multiple tables by their names in the database, you can do it with the following implementation.
 ```php
 
     QueryHelperFacade::deleteInstance()
-        ->setTables(['posts', 'users' , 'comments']) // tables names.
+        ->setTables(['posts', 'users' , 'comments']) 
+        // tables names.
+        // or you can select all tables that exists in the database from the below function
+        // ->setAllTablesFromDatabase()
         ->dropMultiTables()
         ->executeAll();
 
 ```
+#### truncate multi tables
+
+Suppose you want to truncate multiple tables by their names in the database, you can do it with the following implementation.
+```php
+
+    QueryHelperFacade::deleteInstance()
+        // tables names.
+        ->setTables(['posts', 'users' , 'comments'])
+        // or you can select all tables that exists in the database from the below function
+        // ->setAllTablesFromDatabase()
+        ->truncateMultiTables()
+        ->executeWithoutPrepare();
+
+```
+
+#### delete large data
 If you have a table that contains a large number of data (maybe millions of records)
 and you want to delete everything contained in this table,
 if you execute the command with one query,
@@ -31,6 +51,8 @@ so this function divides the large query into more queries with an easy-to-use s
             return $table->where('id', '<', 100)->pluck('id')->toArray();
         }); //  this will implement the delete process only on the result of this callback.
 ```
+
+#### drop all tables
 If you want to drop all tables from the database.
 ```php
 

src/Classes/BaseHelper.php

@@ -34,6 +34,10 @@ abstract class BaseHelper
      * @var int
      */
     private $allowedWhereInQueryNumber = 0;
+    /**
+     * @var array
+     */
+    private $ignoredTables = ['migrations' , 'password_resets' , 'failed_jobs'];
 
     /**
      * @return int
@@ -162,6 +166,24 @@ public function setTables($tables)
         return $this;
     }
 
+    /**
+     * @return BaseHelper
+     */
+    public function setAllTablesFromDatabase()
+    {
+        $columnName = 'Tables_in_'.env('DB_DATABASE');
+
+        $this->loopThrough(
+            $this->getAllTablesFromDatabase()->getSavedItems(),
+            function ($key, $item) use ($columnName) {
+                if (!in_array($item->$columnName, $this->ignoredTables)) {
+                    $this->setTables($item->$columnName);
+                }
+            });
+
+        return $this;
+    }
+
     /**
      * @return string
      */
@@ -178,6 +200,24 @@ protected function setQuery($query)
         $this->query = $query;
     }
 
+    /**
+     * @param  string  $query
+     */
+    protected function appendToQuery($query)
+    {
+        $this->query .= $query;
+    }
+
+    /**
+     * set the query string in the first of strings.
+     *
+     * @param  string  $query
+     */
+    protected function unshiftInQuery($query)
+    {
+        $this->query = $query." ".$this->query;
+    }
+
     /**
      * @return array
      * @author karam mustafa
@@ -278,13 +318,13 @@ public function setSavedItems($savedItems)
      */
     public function checkIfQueryAllowed($ids, $callbackIfPassed = null, $chunkCountAllowed = null)
     {
-        if (! isset($chunckCountAllowed)) {
+        if (!isset($chunckCountAllowed)) {
             $chunkCountAllowed = $this->getAllowedWhereInQueryNumber();
         }
 
         $items = [];
         $lists = collect($ids)->chunk($chunkCountAllowed + 1);
-        if (! is_null($callbackIfPassed)) {
+        if (!is_null($callbackIfPassed)) {
             foreach ($lists as $index => $list) {
                 $items[] = $callbackIfPassed($list, $index);
             }
@@ -317,7 +357,7 @@ public function executeAll($callback = null)
                 return DB::select(DB::raw($this->getQuery()));
             }
 
-            // if we are not, then execute what evere this statement.
+            // otherwise, then execute what ever this statement.
             DB::statement($this->getQuery());
 
             return $this;
@@ -326,6 +366,27 @@ public function executeAll($callback = null)
         }
     }
 
+    /**
+     * execute query statements without preparing them, this will help us ignore the laravel query preparing.
+     *
+     * @return BaseHelper
+     * @throws \Exception
+     * @author karam mustafa
+     */
+    public function executeWithoutPrepare()
+    {
+        try {
+            $this->executeAll(function () {
+                DB::unprepared($this->getQuery());
+            });
+
+            return $this;
+
+        } catch (\Exception $e) {
+            throw new \Exception($e->getMessage());
+        }
+    }
+
     /**
      * clear all inserted data in class properties.
      * this function ignore the savedDataItems property,
@@ -379,6 +440,25 @@ protected function loopThrough($arr, $callback)
         }
     }
 
+    /**
+     * loop through specific array and each iteration will execute by a callback.
+     *
+     * @param  callable  $callback
+     *
+     * @return void
+     * @author karam mustafa
+     */
+    protected function disableAndEnableForeignChecks($callback)
+    {
+        $this->unshiftInQuery("SET FOREIGN_KEY_CHECKS=0;");
+
+        if (is_callable($callback)) {
+            $callback();
+        }
+
+        $this->appendToQuery("SET FOREIGN_KEY_CHECKS=1;");
+    }
+
     /**
      * return the saved items.
      *
@@ -389,4 +469,16 @@ public function done()
     {
         return $this->getSavedItems();
     }
+
+    /**
+     * fetch all database tables.
+     *
+     * @author karam mustafa
+     */
+    public function getAllTablesFromDatabase()
+    {
+        $this->setSavedItems(DB::select('SHOW TABLES'));
+
+        return $this;
+    }
 }

src/Classes/DeleteHelper.php

@@ -33,6 +33,23 @@ public function dropMultiTables()
         return $this;
     }
 
+    /**
+     * truncate multiple tables by their names in the database
+     *
+     * @return DeleteHelper
+     * @author karam mustafa
+     */
+    public function truncateMultiTables()
+    {
+        $this->disableAndEnableForeignChecks(function () {
+            foreach ($this->tables as $index => $table) {
+                $this->appendToQuery("TRUNCATE $table;");
+            }
+        });
+
+        return $this;
+    }
+
     /**
      * this function is divide the process of deleting data into a number of queries,
      * instead of making a large query that may take longer.
@@ -68,26 +85,10 @@ public function deleteLargeData(\Closure $callback = null)
      */
     public function prepareDataBaseTablesToDrop()
     {
-        $this->getAllTablesFromDatabase();
-
-        $columnName = 'Tables_in_'.env('DB_DATABASE');
-
-        foreach ($this->getSavedItems() as $table) {
-            $this->setTables($table->$columnName);
-        }
-
-        $this->dropMultiTables();
+        $this->getAllTablesFromDatabase()
+            ->dropMultiTables();
 
         return $this;
     }
 
-    /**
-     * fetch all database tables.
-     *
-     * @author karam mustafa
-     */
-    private function getAllTablesFromDatabase()
-    {
-        $this->setSavedItems(DB::select('SHOW TABLES'));
-    }
 }