atk4/dsql

Dynamic SQL Builder in PHP

⚠️ repo was integrated into atk4/data ⚠️

DSQL is a composable SQL query builder. You can write multi-vendor queries in PHP profiting from better security, clean syntax and avoid human errors., _(*1)

Hold on! Why yet another query builder?

Obviously because existing ones are not good enough. DSQL tries to do things differently:, _(*2)

1. Composability. Unlike other libraries, we render queries recursively allowing many levels of sub-selects.
2. Small footprint. We don't duplicate query code for all vendors, instead we use clever templating system.
3. Extensibility. We have 3 different ways to extend DSQL as well as 3rd party vendor driver support.
4. Any Query - any query with any complexity can be expressed through DSQL.
5. Almost no dependencies. Use DSQL in any PHP application or framework.
6. NoSQL support. In addition to supporting PDO, DSQL can be extended to deal with SQL-compatible NoSQL servers.

DSQL Is Stable!

DSQL has been in production since 2006, initially included in AModules2 and later Agile Toolkit. We simply forked it and cleaned it up for you:, _(*3)

, _(*4)

DSQL Is Simple and Powerful

``` php $query = new Atk4\Dsql\Query(); $query ->table('employees') ->where('birth_date','1961-05-02') ->field('count(*)') ; echo "Employees born on May 2, 1961: ".$query->getOne();, <sub>(*5)</sub>

If the basic query is not fun, how about more complex one?

``` php
// Establish a query looking for a maximum salary
$salary = new Atk4\Dsql\Query(['connection'=>$pdo]);

// Create few expression objects
$e_ms = $salary->expr('max(salary)');
$e_df = $salary->expr('TimeStampDiff(month, from_date, to_date)');

// Configure our basic query
$salary
    ->table('salary')
    ->field(['emp_no', 'max_salary'=>$e_ms, 'months'=>$e_df])
    ->group('emp_no')
    ->order('-max_salary')

// Define sub-query for employee "id" with certain birth-date
$employees = $salary->dsql()
    ->table('employees')
    ->where('birth_date','1961-05-02')
    ->field('emp_no')
    ;

// use sub-select to condition salaries
$salary->where('emp_no', $employees);

// Join with another table for more data
$salary
    ->join('employees.emp_id','emp_id')
    ->field('employees.first_name');


// finally, fetch result
foreach ($salary as $row) {
    echo "Data: ".json_encode($row)."\n";
}

This builds and executes a single query that looks like this:, <sub>(*6)</sub>

``` sql SELECT emp_no, max(salary) max_salary, TimeStampDiff(month, from_date, to_date) months FROM salary JOIN employees on employees.emp_id = salary.emp_id WHERE salary.emp_no in (select id from employees where birth_date = :a) GROUP BY emp_no ORDER BY max_salary desc, <sub>(*7)</sub>

:a = "1961-05-02", <sub>(*8)</sub>

## DSQL is part of Agile Data

Building SQL queries might be fun, but why not take it to the next level?

### Domain Model

[Agile Data](https://github.com/atk4/data) is my other project, which implements Domain Model
Persistence on top of DSQL. You still maintain control over your queries while also benefiting
from database abstraction.

Next example uses Agile Data's method "[action](http://agile-data.readthedocs.io/en/develop/quickstart.html?highlight=action#actions)()"
to pre-populate DSQL object:

``` php
$m = new Client($db);
echo $m->addCondition('vip', true)
  ->ref('Order')
  ->ref('Line')
  ->action('fx', ['sum', 'total'])
  ->getDebugQuery();

select sum(`price`*`qty`) from `order_line` `O_L` where `order_id` in (
  select `id` from `order` `O` where `client_id` in (
    select `id` from `client` where `vip` = :a
  )
)

User Inerface

Agile UI is my other project that focuses on data visualization., <sub>(*9)</sub>

, <sub>(*10)</sub>

If you wonder what's the most efficient way to display table like that on your page, with Agile UI, Agile Data and DSQL you can do it in less than 10 lines:, <sub>(*11)</sub>

``` php require 'vendor/autoload.php';, <sub>(*12)</sub>

$db = new \Atk4\Data\Persistence_SQL('mysql:dbname=atkui;host=localhost','root','root');, <sub>(*13)</sub>

$app = new \Atk4\Ui\App('My First App'); $app->initLayout('Centered');, <sub>(*14)</sub>

$g = $layout->add(new \Atk4\Ui\Grid()); $g->setModel(new Employee($db), false); ```, <sub>(*15)</sub>

Limitations of DSQL

Our team intentionally keeps DSQL simple. The following features are deliberately excluded:, <sub>(*16)</sub>

• no knowledge of your database schema (see https://github.com/atk4/schema).
• no reliance on any usage pattern in your database or presence of specific tables.
• no decision making based on supplied data values.
• no active record or object relational mapping

If you need features above, I strongly advise you to look into Agile Data., <sub>(*17)</sub>

Documentation cheat-sheet

DSQL has extensive documentation at http://dsql.readthedocs.org, but below we have linked some of the frequent topics:, <sub>(*18)</sub>

• querying data from table() or sub-select with join(), where(), order(), group(), limit(), having() and option()
• update/replace single or multiple records with set(), where() and option()
• insert one or multiple records with set() or setAll() and option()
• delete records with where()
• iterate through result-set or getRows() all data
• supporting sub-queries and expressions anywhere

Community and Support

, <sub>(*19)</sub>