Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rexshijaku/sql-to-laravel-builder
SQL to Laravel Query Builder
https://github.com/rexshijaku/sql-to-laravel-builder
laravel laravel-builder laravel8 query-builder sql-query
Last synced: 27 days ago
JSON representation
SQL to Laravel Query Builder
- Host: GitHub
- URL: https://github.com/rexshijaku/sql-to-laravel-builder
- Owner: rexshijaku
- License: mit
- Created: 2021-05-16T14:45:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-23T20:52:53.000Z (over 1 year ago)
- Last Synced: 2024-09-28T19:41:29.195Z (about 1 month ago)
- Topics: laravel, laravel-builder, laravel8, query-builder, sql-query
- Language: PHP
- Homepage:
- Size: 107 KB
- Stars: 189
- Watchers: 4
- Forks: 29
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Marwan - SQL To Laravel Builder
SQL to Laravel Query Builder, A Converter written in PHP
## Support
### Features
- Converts SQL Queries to Laravel Query Builder.
- Assists on building queries as instructed in Laravel Documentation.
- Provides options to interact with, for generating different results.
### Supports
Laravel 8
### Demo
##### Online demo
Live demo and free usage is available here.
### Get Started
##### Install by manual download:
Download the repository and install required packages by composer.json :
##### Packagist
You can also install it from packagist by running the following command :
```html
composer require rexshijaku/sql-to-laravel-builder
```
### Usage
##### Simple example
#
```php
'DB::');
$converter = new SQLToLaravelBuilder($options);
$sql = "SELECT COUNT(*) FROM members";
echo $converter->convert($sql);
```
This will produce the following result:
```php
DB::table('members')->count();
```
##### A more complex example :
```php
$sql = "SELECT
department_id,
count(*)
FROM
members
LEFT JOIN details AS d ON d.member_id = members.member_id
WHERE
( age = 25 OR ( salary = 2000 AND gender = 'm' ) )
AND id > 15
GROUP BY
department_id
HAVING
height > 1.60";
echo $converter->convert($sql);
```
and this will generate the result below :
```php
DB::table('members')
->select('department_id', DB::raw('count(*)'))
->leftJoin('details AS d', 'd.member_id', '=', 'members.member_id')
->where(function ($query) {
$query->where('age', '=', 25)
->orWhere(function ($query) {
$query->where('salary', '=', 2000)
->where('gender', '=', 'm');
});
})
->where('id', '>', 15)
->groupBy('department_id')
->having('height', '>', 1.60)
->get();
```
##### Notice
If you need to change options, or get more comprehensive understanding of provided options then see the following section of Options.
There are dozens of examples for every use case explained in the Query Builder documentation of Laravel 8, which are located in the examples folder.
### Options
Some important options are briefly explained below:
| Argument | DataType | Default | Description |
| ----- |:----------:| -----:| -----:|
| facade | string | DB:: | Facade which allows the access to the Database functionality. |
| group | boolean | true | Whether it should group key value pairs into a php array, or generate separate commands for each pair. See an example here. |
### How does it works ?
SQL-To-Laravel-Builder is built on top of PHP-SQL-Parser. While PHP-SQL-Parser is responsible for parsing the given SQL Query as input. The result of the PHP-SQL-Parser is the input of SQL-To-Laravel-Builder.
The structure has three main parts :
1) Extractors classes - which help to pull out SQL Query parts in a way which are more understandable and processable by Builders.
2) Builder classes - which help to construct Query Builder methods.
3) Creator - which orchestrates the process between Extractors and Builders in order to produce parts of Query Builder.
### Known issues
- It is not tested in all cases.
- Poor error handling.
### Contributions
Feel free to contribute on development, testing or eventual bug reporting.
### Support
For general questions about Marwan - SQL-To-Laravel-Builder, tweet at @rexshijaku or write me an email on [email protected].
To have a quick tutorial check the examples folder provided in the repository.
### Author
##### Rexhep Shijaku
- Email : [email protected]
- Twitter : https://twitter.com/rexshijaku
### Thank you
All contributors who created and are continuously improving PHP-SQL-Parser, without it, this project would be much harder to be realized.
### In memoriam
For the innocent lives lost (including Marwan al-Masri, aged just six) during the 2021 Israel–Palestine crisis.
### License
MIT License
Copyright (c) 2021 | Rexhep Shijaku
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.