Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/girgias/query-builder
Library to build valid SQL queries
https://github.com/girgias/query-builder
database php query-builder sql
Last synced: about 6 hours ago
JSON representation
Library to build valid SQL queries
- Host: GitHub
- URL: https://github.com/girgias/query-builder
- Owner: Girgias
- License: mit
- Created: 2018-12-17T22:13:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-10T15:31:46.000Z (almost 6 years ago)
- Last Synced: 2024-05-01T16:34:01.366Z (7 months ago)
- Topics: database, php, query-builder, sql
- Language: PHP
- Size: 53.7 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQL Query Builder
[](https://travis-ci.org/Girgias/query-builder)
[](https://codeclimate.com/github/Girgias/query-builder/maintainability)
[](https://codeclimate.com/github/Girgias/query-builder/test_coverage)
A fluent SQL Query Builder which **ONLY** builds a valid SQL query with the SQL
clauses it has been asked to provide.
## Installing
```shell
composer require girgias/query-builder
```
## Features
This Query Builder can build a variety of SQL queries which are database agnostic
as it uses the ANSI standardized syntax.
Every sort of query has its own class which extends from the base ``Query`` class,
They all have the same constructor signature which requires the table name
on which to execute the query.
To build a SELECT query with table join use the ``SelectJoin`` class.
An example can be seen below on how to use this class.
It is possible to directly provide scalar values to WHERE clauses and while binding a field.
It is also possible to specify the named parameter against which the value will be bounded.
In case no named parameter has been provided a random one will be generated.
To retrieve the named parameters with their associated values use the ``getParameters``
method which will return an associative array ``parameter => value``.
### Examples
A basic ``SELECT`` query:
```php
$query = (new \Girgias\QueryBuilder\Select('demo'))
->limit(10, 20)
->order('published_date')
->getQuery();
```
Will output:
```sql
SELECT * FROM demo ORDER BY published_date ASC LIMIT 10 OFFSET 20
```
A more complex ``SELECT`` query:
```php
$start = new \DateTime('01/01/2016');
$end = new \DateTime('01/01/2017');
$query = (new \Girgias\QueryBuilder\Select('demo'))
->select('title', 'slug')
->selectAs('name_author_post', 'author')
->whereBetween('date_published', $start, $end)
->order('date_published', 'DESC')
->limit(25)
->getQuery();
```
Will output:
```sql
SELECT title, slug, name_author_post AS author FROM demo WHERE date_published BETWEEN '2016-01-01 00:00:00' AND '2017-01-01 00:00:00' ORDER BY date_published DESC LIMIT 25
```
An example with the ``whereOr`` method:
```php
$query = (new \Girgias\QueryBuilder\Select('demo'))
->where('author', '=', 'Alice', 'author')
->whereOr('editor', '=', 'Alice', 'editor')
->getQuery();
```
Will output:
```sql
SELECT * FROM demo WHERE (author = :author OR editor = :editor)
```
``UPDATE`` query example:
```php
$query = (new \Girgias\QueryBuilder\Update('posts'))
->where('id', '=', 1, 'id')
->bindField('title', 'This is a title', 'title')
->bindField('content', 'Hello World', 'content')
->bindField('date_last_edited', (new \DateTimeImmutable()), 'nowDate')
->getQuery();
```
Will output:
```sql
UPDATE posts SET title = :title, content = :content, date_last_edited = :now_date WHERE id = :id
```
A ``SELECT`` query with an ``INNER JOIN``:
```php
$query = (new \Girgias\QueryBuilder\SelectJoin('comments', 'posts'))
->tableAlias('co')
->select('co.user', 'co.content', 'p.title')
->joinTableAlias('p')
->innerJoin('post_id', 'id')
->getQuery();
```
Will output:
```sql
SELECT co.user, co.content, p.title FROM comments AS co INNER JOIN posts AS p ON comments.post_id = posts.id
```
## Future scope
Possible features that will be added to this library
* WHERE subqueries
## Contributing
If you found an invalid SQL name which **DOESN'T** throw a Runtime exception
or a valid SQL name which does please add a test case into the
``tests/CheckSqlNamesTest.php`` file.
If you found an example where this library returns an invalid SQL query
please add (or fix) a test case in the relevant Query test case or if it's
a general error please use the ``tests/QueryTest`` file.
If a RunTime exception should be thrown please add a test in the relevant test file
or if it is specific to ``SELECT`` Query please add a test in the
``tests/SelectThrowExceptionsTest.php`` file.
If you'd like to contribute, please fork the repository and use a feature
branch. Pull requests are warmly welcome.
### Notes
When contributing please assure that Psalm runs without error
and all unit tests pass.
Moreover if you add functionality please add corresponding unit tests to cover
at least 90% of your code and that these tests cover any edge cases if they exist.
## Links
- Repository: https://github.com/girgias/query-builder/
- Issue tracker: https://github.com/girgias/query-builder/issues
- In case of sensitive bugs like security vulnerabilities, please contact
[email protected] directly instead of using the issue tracker.
## Licensing
The code in this project is licensed under MIT license.