sad_spirit/pg_builder

This is a query builder for Postgres backed by a partial PHP reimplementation of PostgreSQL’s own query parser. All syntax available for SELECT (and VALUES), INSERT, UPDATE, DELETE, and MERGE queries in Postgres 18 is supported with minor omissions.

Contents:

• Overview
  • Requirements
  • Installation
  • Related packages
• Typical workflow
  • Start building a query
  • Add elements to the query
  • Analyze and transform the query
  • Generate SQL
  • Execute the generated SQL: pg_wrapper
  • Execute the generated SQL: PDO
• StatementFactory helper class
  • Public API
  • Constructor methods and getters
  • Conversion methods
  • Creating Statements
• Classes representing SQL statements
  • Class hierarchy
  • Statement methods and properties
    • nodes\WithClause
  • Delete properties
  • Insert properties
  • Merge properties
  • Update properties
  • SelectCommon methods and properties
    • Methods for set operators
  • Select properties
  • SetOpSelect properties
  • Values properties
• Base node classes and interfaces
  • Node interface
    • Parent node references
    • Handling “any child”
    • nodes\ScalarExpression interface
    • nodes\FunctionLike interface
    • nodes\GenericNode class
  • NodeList interface
    • Parseable and ElementParseable interfaces
    • nodes\lists\GenericNodeList class
    • Notable NodeList implementations
• Helper methods of node classes
  • SelectCommon
  • nodes\range\FromElement
  • nodes\WhereOrHavingClause
• Parsing SQL
  • Parser API
    • parseSomething() methods
    • Caching of ASTs
  • Lexer API
• Modifying AST and building SQL
  • TreeWalker interface
  • Extending BlankWalker
  • ParameterWalker class
  • SqlBuilderWalker class
• Executing the built queries
  • NativeStatement class
  • Converting types for query parameters
    • converters\TypeNameNodeHandler interface
    • converters\BuilderSupportDecorator class
  • Executing queries using pg_wrapper
  • Executing queries using PDO
  • Caching NativeStatement instances
• Exception classes
• Internals: Parser implementation
  • Lexer class
  • TokenType enum
  • Keyword enum
  • Token interface and its implementations
  • TokenStream
  • Parser