Skip to content

quick-start.md

Latest commit

 

History

History
73 lines (53 loc) · 2.25 KB

quick-start.md

File metadata and controls

73 lines (53 loc) · 2.25 KB
Raw

Quick Start Guide

Installation

composer require andrew-gos/query-builder

Your First Query

use AndrewGos\QueryBuilder\Grammar\DefaultGrammar;
use AndrewGos\QueryBuilder\Query\Select\SelectQuery;

$grammar = new DefaultGrammar();

$query = (new SelectQuery())
    ->select(['id', 'name', 'email'])
    ->from(['users'])
    ->where(['active' => true]);

$built = $grammar->buildSelectQuery($query);

echo $built->sql;
// SELECT "id", "name", "email" FROM "users" WHERE "active" IS TRUE

Architecture Overview

Every query flows through a consistent pipeline:

  1. Build a Query object — use one of the 6 query classes: SelectQuery, InsertQuery, UpdateQuery, DeleteQuery, ValuesQuery, MergeQuery.
  2. Configure clauses — call fluent methods like ->select(), ->from(), ->where(), ->join(), etc.
  3. Build with a Grammar — pass the query to a grammar's buildXxxQuery() method. The grammar returns a BuiltQuery DTO.
  4. Execute — use the BuiltQuery->sql string and BuiltQuery->params array with your database driver (PDO, etc.).
$pdo = new PDO('pgsql:host=localhost;dbname=mydb');
$stmt = $pdo->prepare($built->sql);
$stmt->execute($built->params);
$rows = $stmt->fetchAll();

Choosing a Grammar

Dialect Class Identifier Escaping
ANSI SQL / Default DefaultGrammar Double quotes ("table")
MySQL MySqlGrammar Backticks (`table`)
PostgreSQL PgSqlGrammar Double quotes ("table") + dialect extensions

Each grammar also requires the corresponding query class for dialect-specific features.

use AndrewGos\QueryBuilder\Grammar\MySql\MySqlGrammar;
use AndrewGos\QueryBuilder\Query\Select\MySql\MySqlSelectQuery;

$grammar = new MySqlGrammar();
$query = (new MySqlSelectQuery())
    ->select(['id'])
    ->from(['users'])
    ->highPriority()       // MySQL-specific
    ->sqlCalcFoundRows();  // MySQL-specific

echo $grammar->buildSelectQuery($query)->sql;
// SELECT HIGH_PRIORITY SQL_CALC_FOUND_ROWS `id` FROM `users`

Next Steps