README.md

SQL Query Builder

A fluent SQL Query Builder which ONLY builds a valid SQL query with the SQL clauses it has been asked to provide.

Installing

composer require girgias/query-builder

Features

This Query Builder can build a variety of SQL queries which are database agnostic because 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.

Examples

A basic select query:

$query = (new \Girgias\QueryBuilder\Select("demo"))
    ->limit(10, 20)
    ->order("published_date")
    ->getQuery();

Will output:

SELECT * FROM demo ORDER BY published_date ASC LIMIT 10 OFFSET 20

A more complex select query:

$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:

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:

$query = (new \Girgias\QueryBuilder\Select("demo"))
    ->where("author", "=", "author")
    ->whereOr("editor", "=", "editor")
    ->getQuery();

Will output:

SELECT * FROM demo WHERE (author = :author OR editor = :editor)

Update example:

$query = (new \Girgias\QueryBuilder\Update("posts"))
    ->where("id", SqlOperators::EQUAL, "id")
    ->bindField("title", "title")
    ->bindField("content", "content")
    ->bindField("date_last_edited", "now_date")
    ->getQuery();

Will output:

UPDATE posts SET title = :title, content = :content, date_last_edited = :now_date WHERE id = :id

ToDos

There are some features that are still waiting to be implementing

• WHERE IN and WHERE NOT IN clauses
• Table joins

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 tests/QueryTest file.

If a RunTime exception should be thrown please add a test in the tests/QueryThrowExceptionsTest.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 you should make sure 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 theses tests make sure of 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.