PHPackages                             sad\_spirit/pg\_builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. sad\_spirit/pg\_builder

ActiveLibrary[Database & ORM](/categories/database)

sad\_spirit/pg\_builder
=======================

Query builder for Postgres backed by SQL parser

v3.3.1(5mo ago)5933.6k—0.7%61BSD-2-ClausePHPPHP ^8.2CI passing

Since Sep 27Pushed 5mo ago2 watchersCompare

[ Source](https://github.com/sad-spirit/pg-builder)[ Packagist](https://packagist.org/packages/sad_spirit/pg_builder)[ RSS](/packages/sad-spirit-pg-builder/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (5)Versions (35)Used By (1)

sad\_spirit/pg\_builder
=======================

[](#sad_spiritpg_builder)

[![Continuous Integration](https://github.com/sad-spirit/pg-builder/actions/workflows/continuous-integration.yml/badge.svg?branch=master)](https://github.com/sad-spirit/pg-builder/actions/workflows/continuous-integration.yml)[![Static Analysis](https://github.com/sad-spirit/pg-builder/actions/workflows/static-analysis.yml/badge.svg?branch=master)](https://github.com/sad-spirit/pg-builder/actions/workflows/static-analysis.yml)

This is a query builder for Postgres with a twist: it contains a partial[1](#footnote1) reimplementation of PostgreSQL's own query parser. This sets it aside from the usual breed of "write-only" query builders:

- Query is represented as an Abstract Syntax Tree quite similar to PostgreSQL's internal representation.
- Query parts can be added to the AST either as objects or as strings (that will be processed by Parser).
- Nodes can be removed and replaced in AST.
- AST can be analyzed and transformed, the package takes advantage of this to allow named parameters like `:foo` instead of standard PostgreSQL's positional parameters `$1` and to infer parameters' types from SQL typecasts.
- Almost all syntax available for `SELECT` (and `VALUES`) / `INSERT` / `UPDATE` / `DELETE` / `MERGE` in PostgreSQL 18 is supported, query being built is automatically checked for correct syntax.

Substantial effort was made to optimise parsing, but not parsing is faster anyway, so there are means to cache parts of AST and the resultant query.

Usage example
-------------

[](#usage-example)

```
use sad_spirit\pg_builder\{
    Select,
    StatementFactory,
    converters\BuilderSupportDecorator
};
use sad_spirit\pg_wrapper\{
    Connection,
    converters\DefaultTypeConverterFactory
};

$wantPDO = false;

if ($wantPDO) {
    $pdo       = new \PDO('pgsql:host=localhost;user=username;dbname=cms');
    // Uses DB connection properties to set up parsing and building of SQL
    $factory   = StatementFactory::forPDO($pdo);
    // NB: This still requires sad_spirit/pg_wrapper for type conversion code
    $converter = new BuilderSupportDecorator(new DefaultTypeConverterFactory(), $factory->getParser());
} else {
    $connection = new Connection('host=localhost user=username dbname=cms');
    // Uses DB connection properties to set up parsing and building of SQL
    $factory    = StatementFactory::forConnection($connection);
    // Needed for handling type info extracted from query
    $connection->setTypeConverterFactory(new BuilderSupportDecorator(
        $connection->getTypeConverterFactory(),
        $factory->getParser()
    ));
}

// latest 5 news
/** @var Select $query */
$query      = $factory->createFromString(
    'select n.* from news as n order by news_added desc limit 5'
);

// we also need pictures for these...
$query->list[] = 'p.*';
$query->from[0]->leftJoin('pictures as p')->on = 'n.picture_id = p.picture_id';

// ...and need to limit them to only specific rubrics
$query->from[] = 'objects_rubrics as ro';
$query->where->and('ro.rubric_id = any(:rubric::integer[]) and ro.obj_id = n.news_id');

// ...and keep 'em fresh
$query->where->and('age(news_added) < :age::interval');

// $generated contains a query, mapping from named parameters to positional ones, types info
// it can be easily cached to prevent parsing/building SQL on each request
$generated = $factory->createFromAST($query);

// Note that we don't have to specify parameter types, these are extracted from query
if ($wantPDO) {
    $result = $pdo->prepare($generated->getSql());
    $result->execute($converter->convertParameters(
        $generated,
        [
            'rubric' => [19, 20, 21],
            'age'    => 30 * 24 * 3600
        ]
    ));
} else {
    $result = $generated->executeParams(
        $connection,
        [
            'rubric' => [19, 20, 21],
            'age'    => 30 * 24 * 3600
        ]
    );
}

foreach ($result as $row) {
    print_r($row);
}

echo $generated->getSql();
```

the last `echo` statement will output something like

```
select n.*, p.*
from news as n left join pictures as p on n.picture_id = p.picture_id, objects_rubrics as ro
where ro.rubric_id = any($1::pg_catalog.int4[])
    and ro.obj_id = n.news_id
    and age(news_added)