wip

Author: karam-mustafa

CHANGELOG.md

@@ -1,7 +1,3 @@
-v1.1.0
----------
-* Some features.
-
 v1.0.0
 ---------
 * First release

README.md

@@ -1,54 +1,39 @@
 ![logo](assets/logo.png)
 
-Design a simple and expressive logo with the same model you see above,
-the logo design helps to unify the visual identity and further develop the optimal packages to increase the quality of the software we develop
+# Laravel Query Helper
 
-#NOTES:
-* You should replace all your dependencies into your custom names and files including:
-  * vendor namespace.
-  * composer information.
-  * logo
-  * credit and contributors links
-  * security email
-* To use this template, please click on button above "Use this template".  
-* Delete this section after you have finished developing your package
-# Package Name
-Your package description,Try to be briefly describing the features of the package,
-which versions of Laravel and php it require,
-and if there are external resources for learning or explanation
+Laravel Query Helper was developed for [laravel 7.2+](http://laravel.com/) to help you optimize
+sql queries, this package will contain all advanced SQL queries to Help us write better and faster queries and clean code.
 
+Installation
+------------
 ##### 1 - Dependency
 The first step is using composer to install the package and automatically update your composer.json file, you can do this by running:
-
 ```shell
-composer require vendor_name/package_name
+composer require kmlaravel/laravel-query-helper
 ```
 ##### 2 - Copy the package providers to your local config with the publish command, this will publish the config:
-
-Replace this command with your install command,
-The package must contain an installation command even if it does not do anything,
-this helps with maintenance in the future.
-
 ```shell
-php artisan package:install
+php artisan query-helper:install
 ```
 
 Features
 -----------
-Put the name of the feature and a link to this feature
-- [Any feature](https://github.com/syrian-open-source/laravel-package-template/blob/main/docs/feature.md#usage)
-
+- [Update Helper](https://github.com/Syrian-Open-Source/laravel-query-helper/blob/main/docs/update.md)
+- [Delete Helper](https://github.com/Syrian-Open-Source/laravel-query-helper/blob/main/docs/delete.md)
+- [Insert Helper](https://github.com/Syrian-Open-Source/laravel-query-helper/blob/main/docs/insert.md)
+- [Join Helper](https://github.com/Syrian-Open-Source/laravel-query-helper/blob/main/docs/join.md)
+- [Optimizing Helper](https://github.com/Syrian-Open-Source/laravel-query-helper/blob/main/docs/optimizing.md)
 
 Changelog
 ---------
-Please see the [CHANGELOG](https://github.com/syrian-open-source/laravel-package-template/blob/master/CHANGELOG.md) for more information about what has changed or updated or added recently.
+Please see the [CHANGELOG](https://github.com/Syrian-Open-Source/laravel-query-helper/blob/main/CHANGELOG.md) for more information about what has changed or updated or added recently.
 
 Security
 --------
-If you discover any security related issues, please email them first to "your email", 
-if we do not fix it within a short period of time please open a new issue describing your problem. 
+If you discover any security related issues, please email them first to [email protected], 
+if we do not fix it within a short period of time please open a new issue describe your problem. 
 
 Credits
 -------
-* [your email](https://github.com/syrian-open-source/laravel-package-template/graphs/contributors)
-* [All contributors](https://github.com/syrian-open-source/laravel-package-template/graphs/contributors)
+[karam mustafa](https://www.linkedin.com/in/karam2mustafa)

assets/logo.png

@@ -1,10 +1,12 @@
 {
-    "name": "syrian-open-source/laravel-package-template",
+    "name": "syrian-open-source/laravel-query-helper",
     "description": "Package description",
     "license": "MIT",
     "keywords": [
         "laravel",
-        "syrian open source"
+        "syrian open source",
+        "laravel query helper",
+        "laravel-query-helper"
     ],
     "authors": [
         {
@@ -20,8 +22,8 @@
     },
     "autoload" : {
         "psr-4": {
-            "SOS\\LaravelPackageTemplate\\" : "src",
-            "SOS\\LaravelPackageTemplate\\Tests\\": "src/tests"
+            "SOS\\QueryHelper\\" : "src",
+            "SOS\\QueryHelper\\Tests\\": "src/tests"
         }
     },
     "scripts": {
@@ -32,7 +34,7 @@
     "extra" : {
         "laravel" : {
             "providers" : [
-                "SOS\\LaravelPackageTemplate\\Providers\\LaravelPackageTemplateServiceProviders"
+                "SOS\\QueryHelper\\Providers\\QueryHelperServiceProviders"
             ]
         }
     },

composer.json

@@ -0,0 +1,40 @@
+Delete helper
+-----------
+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.
+        ->dropMultiTables()
+        ->executeAll();
+
+```
+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,
+this query will take a lot of time,
+so this function divides the large query into more queries with an easy-to-use structure.
+```php
+
+    QueryHelperFacade::deleteInstance()
+        ->setField('id') // Set the field that we will query on it.
+        ->setAllowedWhereInQueryNumber(10) // Set the number that the query will delete each time
+        ->setTableName('tests')
+        ->deleteLargeData();
+
+    // and you can implement your custom query by a callback.
+    QueryHelperFacade::deleteInstance()
+        ->setField('id') // Set the field that we will query on it.
+        ->setAllowedWhereInQueryNumber(10) // Set the number that the query will delete each time.
+        ->setTableName('tests')
+        ->deleteLargeData(function ($table) {
+            return $table->where('id', '<', 100)->pluck('id')->toArray();
+        }); //  this will implement the delete process only on the result of this callback.
+```
+If you want to drop all tables from the database.
+```php
+
+    QueryHelperFacade::deleteInstance()
+        ->prepareDataBaseTablesToDrop()
+        ->executeAll();
+```

docs/delete.md

@@ -0,0 +1,37 @@
+Join helper
+-----------
+We provide some function we think that we can implement joins more faster and easier. 
+
+```php
+    // if you need to fast join you can use fastJoin function
+    QueryHelperFacade::joinInstance()
+        // first parameter is the table will fetch the data from it.
+        // second parameter is the selection you want from the database.
+        // third parameter is table to join with.
+        ->fastJoin('users', ['users.id'], 'posts')
+        // you can add more joins.
+        // ->fastJoin('other_main_table', ['id'], 'table_to_join')
+        // ->fastJoin('other_main_table', ['id'], 'table_to_join')
+        // retrieve the query result 
+        ->done();
+
+    // if you want to specify all the options and functions,
+    // join helper class has a strong declarative process,
+    // and this process make you chose what you want to build.
+    QueryHelperFacade::joinInstance()
+        // set the main table that we will select.
+        ->setTableName('users')
+        // set the join type, the default value is 'JOIN'.
+        ->setJoinType('LEFT JOIN')
+        // set the select statement, the default value is ['id'].
+        ->setSelection(['users.id'])
+        // set the table that you want to join with.
+        ->addjoin('tests')
+        // build this join.
+        ->buildJoin()
+        // if you want to get the built query.
+        ->getQuery()       
+        //  return the result
+        ->done();
+
+```

docs/feature.md

@@ -0,0 +1,19 @@
+Optimizing
+-----------
+In some databases, you can't do any process that require more than 65K of parameters,
+so we have to chunk your large query to smaller pieces, and we can do that for you ar effective way.
+```php
+    // Suppose we have a group of users, let say's we have 100k items to insert.
+    $users = [
+    ['name' => 'example 1'],
+    ['name' => 'example 2'],
+    ['name' => 'example 3'],
+    ['name' => 'example 4'],
+    ...
+    ];   
+    QueryHelperFacade::updateInstance()
+        ->setAllowedWhereInQueryNumber(2000) // chunk size and you can update the default value from query_helper.php config file.
+        ->checkIfQueryAllowed($users , function ($data){
+            User::insert($data);
+        });
+```

src/Stubs/example.stub renamed to docs/insert.md

@@ -0,0 +1,100 @@
+Update
+-----------
+Suppose we have a group of users who have an id and a name and we have an array to update each user with a new name 
+as in the following example
+```shell
+    $usersDataBeforeUpdate = [
+        ['id'  => 1, 'name' => 'example before update 1'],
+        ['id'  => 2, 'name' => 'example before update 2'],
+        ['id'  => 3, 'name' => 'example before update 2'],
+     ];
+    $usersDataToUpdate = [
+        ['id'  => 1, 'name' => 'example after update 1'],
+        ['id'  => 2, 'name' => 'example after update 2'],
+        ['id'  => 3, 'name' => 'example after update 2'],
+    ];
+
+    // so the traditional way to that,
+    // loop through $usersDataBeforeUpdate and fetch each user with specific (id, name)
+    // and update his name with new name
+    // and this will execute a query for each record, for the above array, the request will execute 3 queries
+    //  what if we want to update 1000 records previously? 
+    
+    foreah($usersDataToUpdate as $user){
+        User::find($user['id'])->update(['name' => $user['name']]);
+    }
+
+```
+So the query helper will help you optimize this process, see the following explanation:
+```php
+    $usersDataBeforeUpdate = [
+        ['id'  => 1, 'name' => 'example before update 1'],
+        ['id'  => 2, 'name' => 'example before update 2'],
+        ['id'  => 3, 'name' => 'example before update 2'],
+     ];
+
+    $usersDataToUpdate = [
+        ['id'  => 1, 'name' => 'example after update 1'],
+        ['id'  => 2, 'name' => 'example after update 2'],
+        ['id'  => 3, 'name' => 'example after update 2'],
+    ];
+
+    $ids = [];
+    $values = [];
+    $cases = [];
+    $tableName = 'users';
+    $columnToUpdate = 'name';
+    foreach($usersDataToUpdate as $user){
+
+       array_push($ids , $user['id']);
+
+       array_push($values , $user['name']);
+
+       // if you want to set your cases in query.
+       $cases[] = "WHEN id = {$user['id']} then ".$user['name'];
+    }
+
+    // if you want to set your cases in query.
+    $cases = implode(' ', $cases);
+
+    QueryHelperFacade::updateInstance()
+            ->setIds($ids)
+            ->setValues($values)
+            ->setTableName($tableName) // change this parameter value to your database table name.
+            ->setField($columnToUpdate) // change this parameter value to your database column name.
+            ->bindIdsWithValues()
+            ->executeUpdateMultiRows();
+
+    // this will execute only one query.
+```
+What if you want to put your own Cases ?  **okay we support that**.
+```php
+
+    $query = QueryHelperFacade::updateInstance()
+            ->setIds($ids)
+            ->setCasues($cases)
+            ->setTableName($tableName) // change this parameter value to your database table name.
+            ->setField($columnToUpdate) // change this parameter value to your database column name.
+            ->executeUpdateMultiRows();
+```
+What if you want dump the query which will execute ?  **okay we support that**.
+```php
+
+    $query = QueryHelperFacade::updateInstance()
+            ->setIds($ids)
+            ->setValues($values)
+            ->setTableName($tableName) // change this parameter value to your database table name.
+            ->setField($columnToUpdate) // change this parameter value to your database column name.
+            ->buildStatement()
+            ->getQuery();
+    dd($query);
+
+```
+What if you want to reduce these lines in one line ?  **okay we support that**.
+```php
+
+    $query = QueryHelperFacade::updateInstance()
+            ->fastUpdate($tableName , $ids , $values , $columnToUpdate);
+    dd($query);
+
+```