phossa2/query

A SQL query builder library with concise syntax for PHP.

Thursday, January 19, 2017
by phossa2
Repository
2 Watchers
2 Stars
4 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
2 Versions
0 % Grown

phossa2/query

, _(*1)

phossa2/query is a SQL query builder library with concise syntax for PHP. It supports Mysql dialect and more coming., _(*2)

It requires PHP 5.4, supports PHP 7.0+ and HHVM. It is compliant with PSR-1, PSR-2, PSR-3, PSR-4, and the proposed PSR-5., _(*3)

Features

Support SELECT, INSERT, UPDATE, REPLACE, DELETE., _(*4)
Complex sql building with expr(), raw(), before() etc., _(*5)
Statement with positioned or named parameters., _(*6)
Beautiful output with different settings., _(*7)
Ongoing support for different dialects like Mysql and more., _(*8)

Installation

Install via the composer utility., _(*9)

composer require "phossa2/query"

or add the following lines to your composer.json, _(*10)

{
    "require": {
       "phossa2/query": "2.*"
    }
}

Usage

Getting started, _(*11)

Start with a query builder first, then query., _(*12)

use Phossa2\Query\Builder;

// a builder default to table 'Users' and Mysql as default dialect
$builder = new Builder();
$users = $builder->table('Users');

// SELECT * FROM `Users` LIMIT 10
$sql = $users->select()->limit(10)->getSql();

// INSERT INTO `Users` (`usr_name`) VALUES ('phossa')
$sql = $users->insert(['usr_name' => 'phossa'])->getSql();

// reset builder to table 'Sales' as 's'
$sales = $users->table('Sales', 's');

// SELECT * FROM `Sales` AS `s` WHERE `user_id` = 12
$qry = $sales->select()->where('user_id', 12);

// SELECT * FROM `Sales` AS `s` WHERE `user_id` = ?
$sql = $qry->getStatement(); // with positioned parameters

// [12]
var_dump($qry->getBindings());

SELECT, _(*13)

Columns/fields

Columns can be specified in the select($col, ...), col($col, $alias) or col(array $cols)., _(*14)

// SELECT * FROM `Users`
$qry = $users->select();

// SELECT `user_id`, `user_name` FROM `Users`
$qry = $users->select('user_id', 'user_name');

// SELECT `user_id`, `user_name` AS `n` FROM `Users`
$qry = $users->select()->col('user_id')->col('user_name', 'n');

// same as above
$qry = $users->select()->col(['user_id', 'user_name' => 'n']);

Raw string can be provided using colRaw($string, array $parameters), _(*15)

// SELECT COUNT(user_id) AS cnt FROM `Users`
$qry = $users->select()->colRaw('COUNT(user_id) AS cnt');

// SELECT CONCAT(user_name, 'x') AS con FROM `Users`
$qry = $users->select()->colRaw('CONCAT(user_name, ?) AS con', ['x']);

Common functions like cnt($col, $alias), min($col, $alias), max($col, $alias), avg($col, $alias), sum($col, $alias) can also be used directly., _(*16)

// SELECT MAX(`user_id`) AS `maxId` FROM `Users`
$qry = $users->select()->max('user_id', 'maxId');

Generic column template by using colTpl($template, $cols, $alias),, _(*17)

// SELECT SUM(DISTINCT `score`) AS `s` FROM `Users`
$qry = $users->select()->colTpl('SUM(DISTINCT %s)', 'score', 's');

// SELECT CONCAT(`fname`, ' ', `lname`) AS `fullName` FROM `Users`
$qry = $users->select()->colTpl("CONCAT(%s, ' ', %s)", ['fname', 'lname'], 'fullName');

Subquery can also be use in col(),, _(*18)

// SELECT (SELECT MAX(`user_id`) FROM `oldUsers`) AS `maxId` FROM `Users`
$qry = $users->select()->col(
    $users->select()->max('user_id')->table('oldUsers'),
    'maxId'
);

Distinct

DISTINCT can be specified with distinct(...),, _(*19)

// SELECT DISTINCT `user_alias` FROM `Users`
$qry = $users->select()->distinct('user_alias');

// SELECT DISTINCT `user_alias` AS `a` FROM `Users`
$qry = $users->select()->distinct()->col('user_alias', 'a');

From

from($table, $alias) or table($table, $alias) can be used with $builder object or query object such as $builder->select()., _(*20)

Using table() to replace any existing tables,, _(*21)

// $sales is a clone of builder $users with table replaced
$sales = $users->table('Sales');

// or replace table in the select query object
$select = $users->select()->table('Sales', 's');

// SELECT * FROM `Users` AS `u`, `Accounts` AS `a`
$qry = $users->select()->table(['Users' => 'u', 'Accounts' => 'a']);

Using from() to append to any existing tables,, _(*22)

// SELECT * FROM `Users`, `Sales` AS `s`
$select = $users->select()->from('Sales', 's');

// builder has two tables now
$usersAndSales = $users->from('Sales', 's');

Subqueries can be used in from() or table(),, _(*23)

// SELECT * FROM (SELECT `user_id` FROM `oldUsers`) AS `u`
$qry = $users->select()->table(
    $users->select('user_id')->table('oldUsers'),
    'u'
);

Group

Group result with group($col, ...),, _(*24)

// SELECT `grp_id`, COUNT(*) AS `cnt` FROM `Users` GROUP BY `grp_id`
$qry = $users->select()->col('grp_id')->cnt('*', 'cnt')->group('grp_id');

Multiple group() and groupRaw($str, array $params),, _(*25)

// SELECT `grp_id`, `age`, COUNT(*) AS `cnt` FROM `Users` GROUP BY `grp_id`, age ASC
$qry = $users->select('grp_id', 'age')->cnt('*', 'cnt')
    ->group('grp_id')->groupRaw('age ASC');

Template can also be used with groupTpl($template, $cols),, _(*26)

// GROUP BY `year` WITH ROLLUP
$users->select()->groupTpl('%s WITH ROLLUP', 'year')

Join

Join using join($table, $col),, _(*27)

// SELECT * FROM `Users` INNER JOIN `Accounts`
$qry = $users->select()->join('Accounts');

// SELECT * FROM `Users` INNER JOIN `Accounts` ON `Users`.`id` = `Accounts`.`id`
$qry = $users->select()->join('Accounts', 'id');

Specify alias for the joined table,, _(*28)

// SELECT * FROM `Users` INNER JOIN `Accounts` AS `a` ON `Users`.`id` = `a`.`id`
$qry = $users->select()->join(['Accounts', 'a'], 'id');

Join table with different column name,, _(*29)

// SELECT * FROM `Users` INNER JOIN `Accounts` AS `a` ON `Users`.`id` = `a`.`user_id`
$qry = $users->select()->join(['Accounts'], 'a'], ['id', 'user_id']);

// same as above
$qry = $users->select()->join(['Accounts'], 'a'], ['Users.id', 'a.user_id']);

Join with operator specified,, _(*30)

// SELECT * FROM `Users` INNER JOIN `Accounts` AS `a` ON `Users`.`id` <> `a`.`user_id`
$qry = $users->select()->join(['Accounts', 'a'], ['id', '<>', 'user_id']);

Multiple joins,, _(*31)

// SELECT * FROM `Users`
// INNER JOIN `Sales` AS `s` ON `Users`.`uid` = `s`.`uid`
// INNER JOIN `Orders` AS `o` ON `Users`.`uid` = `o`.`oid`
$qry = $users->select()
            ->join(['Sales', 's'], ['uid', '=', 'uid'])
            ->join(['Orders', 'o'], ['uid', 'o.oid']);

Subqueries in join,, _(*32)

// SELECT * FROM `Users` INNER JOIN (SELECT `uid` FROM `oldUsers`) AS `x` ON `Users`.`uid` = `x`.`uid`
$qry = $users->select()->join(
    [$builder->select('uid')->from('oldUsers'), 'x'],
    'uid'
);

Other joins leftJoin(), rightJoin(), outerJoin(), leftOuterJoin(), rightOuterJoin(), crossJoin() are supported. If want to use your own join, joinRaw() is handy., _(*33)

// SELECT * FROM `Users` OUTER JOIN `Accounts` AS `a` ON `Users`.`id` = `a`.`id`
$qry = $users->select()->outerJoin(['Accounts', 'a'], 'id');

// SELECT * FROM `Users` NATURAL JOIN Accounts AS a ON Users.id = a.id
$qry = $users->select()->joinRaw('NATURAL JOIN', 'Accounts AS a ON Users.id = a.id');

Limit

LIMIT and OFFSET are supported,, _(*34)

// SELECT * FROM `Users` LIMIT 30 OFFSET 10
$qry = $users->select()->limit(30, 10);

// SELECT * FROM `Users` LIMIT 20 OFFSET 15
$qry = $users->select()->limit(20)->offset(15);

Or use page($pageNum, $pageLength) where $pageNum starts from 1,, _(*35)

// SELECT * FROM `Users` LIMIT 30 OFFSET 60
$qry = $users->select()->page(3, 30);

Order

Order by ASC or DESC, _(*36)

// SELECT * FROM `Users` ORDER BY `age` ASC, `score` DESC
$qry = $users->select()->order('age')->orderDesc('score');

Or raw mode, _(*37)

// SELECT * FROM `Users` ORDER BY age ASC, score DESC
$qry = $users->select()->orderRaw('age ASC, score DESC');

Where

Simple where clauses,, _(*38)

// SELECT * FROM `Users` WHERE age > 18
$qry = $users->select()->where('age > 18');

// SELECT * FROM `Users` WHERE `age` = 18
$qry = $users->select()->where('age', 18);

// SELECT * FROM `Users` WHERE `age` < 18
$qry = $users->select()->where('age', '<', 18);

Multiple wheres,, _(*39)

// SELECT * FROM `Users` WHERE `age` > 18 AND `gender` = 'male'
$qry = $users->select()->where(['age' => ['>', 18], 'gender' => 'male']);

// same as above
$qry = $users->select()->where('age', '>', 18)->andWhere('gender','male');

Complex where,, _(*40)

// SELECT * FROM `Users` WHERE (`id` = 1 OR (`id` < 20 OR `id` > 100)) OR `name` = 'Tester'
$qry = $users->select()->where(
            $users->expr()->where('id', 1)->orWhere(
                $users->expr()->where('id', '<', 20)->orWhere('id', '>', 100)
            )
         )->orWhere('name', 'Tester');

Raw mode,, _(*41)

// SELECT * FROM `Users` WHERE age = 18 OR score > 90
$qry = $users->select()->whereRaw('age = 18')->orWhereRaw('score > 90');

with NOT,, _(*42)

// SELECT * FROM `Users` WHERE NOT `age` = 18 OR NOT `score` > 90
$qry = $users->select()->whereNot('age', 18)->orWhereNot('score', '>', 90);

Where IN and BETWEEN, _(*43)

// SELECT * FROM `Users` WHERE `age` IN (10,12,15,18,20)
$qry = $users->select()->where('age', 'IN', [10,12,15,18,20]);

// SELECT * FROM `Users` WHERE `age` NOT BETWEEN 10 AND 20
$qry = $users->select()->where('age', 'NOT BETWEEN', [10,20]);

IS NULL,, _(*44)

// SELECT * FROM `Users` WHERE `age` IS NULL
$qry = $users->select()->where('age', 'IS', NULL);

EXISTS,, _(*45)

// SELECT * FROM `Sales` WHERE EXISTS (SELECT `user_id` FROM `Users`)
$sql = $sales->select()->where('', 'EXISTS', $users->select('user_id'))->getSql();

Having

Similar to WHERE clause,, _(*46)

// SELECT * FROM `Users` HAVING `age` = 10 OR `level` > 20
$qry = $users->select()->having('age', 10)->orHaving('level', '>', 20);

Union

union() or unionAll() can be used with builder or query object,, _(*47)

// SELECT * FROM `Users`
// UNION
//     SELECT * FROM `oldUsers1`
// UNION ALL
//     SELECT `user_id` FROM `oldUsers2`
$sql = $users->select()
        ->union()
            ->select()->table('oldUsers1')
        ->unionAll()
            ->select('user_id')->table('oldUsers2')
        ->getSql()

// (SELECT * FROM `Users`) UNION (SELECT * FROM `oldUesrs`) ORDER BY `user_id` ASC LIMIT 10
$sql = $builder->union(
    $builder->select()->table('Users'),
    $builder->select()->table('oldUsers')
)->order('user_id')->limit(10)->getSql();

INSERT, _(*48)

Single insert statement,, _(*49)

// INSERT INTO `users` (`uid`, `uname`) VALUES (2, 'phossa')
$sql = $users->insert(['uid' => 2, 'uname' => 'phossa'])->getSql();

// same as above
$sql = $users->insert()->set('uid', 2)->set('uname', 'phossa')->getSql();

// same as above
$sql = $users->insert()->set(['uid' => 2, 'uname' => 'phossa'])->getSql();

Multiple data rows,, _(*50)

// INSERT INTO `Users` (`uid`, `uname`) VALUES (2, 'phossa'), (3, 'test')
$qry = $users->insert()
        ->set(['uid' => 2, 'uname' => 'phossa'])
        ->set(['uid' => 3, 'uname' => 'test']);

Insert with DEFAULT values, _(*51)

// INSERT INTO `Users` (`uid`, `uname`, `phone`) VALUES (2, 'phossa', DEFAULT), (3, 'test', '1234')
$qry = $users->insert([
  ['uid' => 2, 'uname' => 'phossa'],
  ['uid' => 3, 'uname' => 'test', 'phone' => '1234']
]);

Insert NULL instead of default values,, _(*52)

// INSERT INTO `Users` (`uid`, `uname`, `phone`) VALUES (2, 'phossa', NULL), (3, 'test', '1234')
$sql = $qry->getSql(['useNullAsDefault' => true]);

Insert with SELECT subquery,, _(*53)

// INSERT INTO `Users` (`uid`, `uname`) SELECT `user_id`, `user_name` FROM `oldUsers`
$qry = $users->insert()->set(['uid', 'uname'])
  ->select('user_id', 'user_name')->table('oldUsers');

UPDATE, _(*54)

Common update statement,, _(*55)

// UPDATE `Users` SET age = age + 1
$qry = $users->update()->set('age = age + 1');

// UPDATE `Users` SET `user_name` = 'phossa' WHERE `user_id` = 3
$qry = $users->update(['user_name' => 'phossa'])->where('user_id', 3);

// UPDATE `Users` SET `user_name` = 'phossa', `user_addr` = 'xxx' WHERE `user_id` = 3
$qry = $users->update()->set('user_name','phossa')
  ->set('user_addr', 'xxx')->where('user_id', 3);

increment($col, $step) and decrement($col, $step),, _(*56)

// UPDATE `Users` SET `age` = `age` + 2 WHERE `user_id` = 2
$qry = $users->update()->increment('age', 2)->where('user_id', 2);

With Mysql extensions,, _(*57)

// UPDATE IGNORE `Users` SET `user_id` = `user_id` + 10, `user_status` = user_status | 2 ORDER BY `user_id` ASC LIMIT 10
$qry = $users->update()->hint('IGNORE')
  ->setTpl('user_id', '%s + ?', 'user_id', [10])
  ->setRaw('user_status', 'user_status | 2')
  ->order('user_id')->limit(10);

REPLACE, _(*58)

Mysql version of replace,, _(*59)

// REPLACE INTO `Users` (`user_id`, `user_name`) VALUES (3, 'phossa')
$qry = $users->replace(['user_id' => 3, 'user_name' => 'phossa']);

DELETE, _(*60)

Single table deletion,, _(*61)

// DELETE FROM `Users` WHERE `user_id` > 10 ORDER BY `user_id` ASC LIMIT 10
$qry = $users->delete()->where('user_id', '>', 10)
  ->order('user_id')->limit(10);

Multiple tables deletion, _(*62)

// DELETE `u`, `a` FROM `Users` AS `u` INNER JOIN `Accounts` AS `a`
// ON `u`.`user_id` = `a`.`user_id` WHERE `a`.`total_amount` < 10
$qry = $builder->delete('u', 'a')->table('Users', 'u')
  ->join(['Accounts', 'a'], 'user_id')->where('a.total_amount', '<', 10);

Advanced topics

expr(), _(*63)

Expression can be used to construct complex WHERE, _(*64)

// SELECT
//     *
// FROM
//     "Users"
// WHERE
//    ("age" < 18 OR "gender" = 'female')
//    OR ("age" > 60 OR ("age" > 55 AND "gender" = 'female'))
$qry = $builder->select()->table('Users')->where(
  $builder->expr()->where('age', '<', 18)->orWhere('gender', 'female')
)->orWhere(
  $builder->expr()->where('age', '>' , 60)->orWhere(
      $builder->expr()->where('age', '>', 55)->where('gender', 'female')
  )
);

Join with complex ON,, _(*65)

// SELECT * FROM `Users` INNER JOIN `Sales`
// (ON `Users`.`uid` = `Sales`.`s_uid` OR `Users`.`uid` = `Sales`.`puid`)
$sql = $users->select()->join('Sales',
  $builder->expr()->on('Users.uid', 'Sales.s_uid')->orOn('Users.uid', 'Sales.puid')
)->getSql();

raw(), _(*66)

Raw string to bypass the quoting and escaping,, _(*67)

// SELECT score + 10 FROM `Students` WHERE `time` < NOW()
$qry = $builder->select()->colRaw('score + 10')
  ->from("Students")->where('time', '<', $builder->raw('NOW()'));

// SELECT `grp_id`, COUNT(*) AS `cnt` FROM `Users` GROUP BY grp_id ASC
$qry = $users->select()->col('grp_id')->cnt('*', 'cnt')->groupRaw('grp_id ASC');

Raw string with positioned parameters,, _(*68)

// SELECT * FROM `Students` WHERE `age` IN RANGE(1, 1.2)
$qry = $builder->select()->from("Students")->where("age", "IN",
  $builder->raw('RANGE(?, ?)', [1, 1.2]));

// same as above
$qry = $builder->select()->from("Students")
->whereRaw("`age` IN RANGE(?, ?)", [1, 1.2]);

Template with colTpl(), groupTpl() etc., _(*69)

Using template will make quotation of db names possible,, _(*70)

// SELECT MAX(`score`) AS max FROM `Users`
$sql = $users->select()->colTpl('MAX(%s)', 'score', 'max')->getSql();

before(), after(), hint() and option(), _(*71)

Sometimes, non-standard SQL wanted and no methods found. before() and after() will come to rescue., _(*72)

// INSERT INTO "users" ("id", "name") VALUES (3, 'phossa') ON DUPLICATE KEY UPDATE id=id+10
$qry = $users->insert()->set('id', 3)->set('name', 'phossa')
  ->after('VALUES', 'ON DUPLICATE KEY UPDATE id=id+?', [10]);

hint() add hints right after the statement word, and option() will append to the end of sql,, _(*73)

// INSERT IGNORE INTO "users" ("id", "name") VALUES (3, 'phossa') ON DUPLICATE KEY UPDATE id=id+10
$qry = $users->insert()->hint('IGNORE')
  ->set('id', 3)->set('name', 'phossa')
  ->option('ON DUPLICATE KEY UPDATE id=id+?', [10]);

Parameters, _(*74)

phossa2/query can return statement for driver to prepare and use the getBindings() to get the values to bind., _(*75)

$qry = $users->select()->where("user_id", 10);

// SELECT * FROM `Users` WHERE `user_id` = ?
$sql = $qry->getStatement();

// values to bind: [10]
$val = $qry->getBindings();

Or named parameters,, _(*76)

$qry = $users->select()->where("user_name", ':name');

// SELECT * FROM `Users` WHERE `user_name` = :name
$sql = $query->getNamedStatement();

Parameters can be applied to raw or template methods,, _(*77)

// SELECT * FROM `Users` GROUP BY `year` + 10
$sql = $users->select()->groupRaw('`year` + ?', [10])->getSql();

// same as above
$sql = $users->select()->groupTpl('%s + ?', 'year', [10])->getSql();

Settings, _(*78)

Settings can be applied to $builder during instantiation or using setSettings(),, _(*79)
```
// builder instantiation
$users = new Builder('Users', new Mysql(), ['autoQuote' => false]);

// adjust settings
$users->setSettings(['autoQuote' => true]);
```
Or applied when output with getSql() or getStatement(),, _(*80)
```
$sql = $users->select()->getSql(['autoQuote' => false]);
```
Indented sql,, _(*81)
```
// SELECT
//     *
// FROM
//     `Users`
$sql = $users->select()->getSql(['seperator' => "\n", 'indent' => "    "]);
```
List of settings,, _(*82)
- autoQuote: boolean. Quote db identifier or not., _(*83)
- positionedParam: boolean. Output with positioned parameter or not., _(*84)
- namedParam: boolean. Output with named parameter or not., _(*85)
- seperator: string, default to ' '. Seperator between clauses., _(*86)
- indent: string, default to ''. Indent prefix for clauses., _(*87)
- escapeFunction: callabel, default to null. Function used to quote and escape values., _(*88)
- useNullAsDefault: boolean., _(*89)

Change log

Please see CHANGELOG from more information., _(*90)

Testing

$ composer test

Contributing

Please see CONTRIBUTE for more information., _(*91)

Dependencies

PHP >= 5.4.0, _(*92)
phossa2/shared >= 2.0.21, _(*93)

License

MIT License, _(*94)

19/01 2017

dev-master

9999999-dev https://github.com/phossa2/query

A SQL query builder library with concise syntax for PHP.

Sources Download

MIT

The Requires

phossa2/shared ^2.0.21
php >=5.4.0

The Development Requires

by Hong Zhang

query phossa

18/09 2016

2.0.0

2.0.0.0 https://github.com/phossa2/query

A SQL query builder library with concise syntax for PHP.

Sources Download

MIT

The Requires

php ~5.4|~7.0
phossa2/shared ^2.0.21

The Development Requires

by Hong Zhang

query phossa

library query

A SQL query builder library with concise syntax for PHP.

phossa2/query

The README.md

phossa2/query

Features

Installation

Usage

Advanced topics

Change log

Testing

Contributing

Dependencies

License

The Versions

dev-master

The Requires

The Development Requires

by Hong Zhang

2.0.0

The Requires

The Development Requires

by Hong Zhang