jdorn/sql-formatter
Sql Formatter
This project is a PHP library designed for parsing, beautifying, and syntax-highlighting SQL queries. It provides a set of utilities to improve the readability of database code, facilitate debugging, and assist in the maintenance of complex query structures.
The library distinguishes itself by offering both aesthetic and functional processing capabilities. It can transform raw SQL strings into structured, indented formats for human review, or compress them by removing comments and unnecessary whitespace to optimize them for network transmission and logging. Additionally, it includes a syntax highlighter that injects markup into tokens, allowing for color-coded visual representation of database logic.
Beyond formatting, the tool functions as a query parser capable of splitting batches of database commands into individual, executable statements. It handles these tasks through a state-machine parsing model that tracks query context, such as nested structures and parentheses, ensuring that the original logic remains intact while the string is processed.
Features
- SQL Formatters - Provides a comprehensive PHP library for beautifying, compressing, and syntax highlighting SQL queries.
- SQL Parsers - Parses SQL strings to split batches into individual statements and strip comments for cleaner execution.
- Context-Aware State Parsers - Tracks query context and nested structures using a state-machine model to ensure logic remains intact during processing.
- Delimiter-Aware Batch Splitters - Splits batches of database commands into individual, executable statements by identifying termination characters.
- Database Query Optimizations - Optimizes SQL queries by removing unnecessary whitespace and comments to reduce payload size for transmission.
- Query Readability Formatters - Improves the visual structure of complex database queries through automatic indentation and formatting.
- Query Compression Utilities - Compresses database queries by removing comments and unnecessary whitespace for efficient network transmission.
- SQL Statement Parsing - Splits SQL batches into individual queries by parsing strings based on specific delimiters.
- Batch Statement Execution - Parses multi-statement SQL strings into individual commands to simplify the management of complex migration scripts.
- Regex Token Stream Lexers - Processes raw SQL strings into typed token sequences using regex patterns for keywords, operators, and identifiers.
- SQL Syntax Highlighting - Applies color-coded formatting to SQL queries to make complex logic easier to scan and troubleshoot.
- String-Manipulation - Formats SQL queries for readability.
