glensc/php-sql-formatter

A lightweight php class for formatting sql statements. Handles automatic indentation and syntax highlighting.

SqlFormatter

A lightweight php class for formatting sql statements.

It can automatically indent and add line breaks in addition to syntax highlighting.

History

I found myself having to debug auto-generated SQL statements all the time and wanted some way to easily output formatted HTML without having to include a huge library or copy and paste into online formatters.

I was originally planning to extract the formatting code from PhpMyAdmin, but that was 10,000+ lines of code and used global variables.

I saw that other people had the same problem and used Stack Overflow user losif's answer as a starting point. http://stackoverflow.com/a/3924147

Usage

The SqlFormatter class has a static method 'format' which takes a SQL string
as input and returns a formatted HTML block inside a pre tag.

Sample usage:

<?php
require_once('SqlFormatter.php');

$query = "SELECT count(*),`Column1`,`Testing`, `Testing Three` FROM `Table1`
    WHERE Column1 = 'testing' AND ( (`Column2` = `Column3` OR Column4 >= NOW()) )
    GROUP BY Column1 ORDER BY Column3 DESC LIMIT 5,10";

echo SqlFormatter::format($query);

Output:

Formatting Only

If you don't want syntax highlighting and only want the indentations and line breaks, pass in false as the second parameter.

This is useful for outputting to error logs or other non-html formats.

<?php
echo SqlFormatter::format($query, false);

Output:

Syntax Highlighting Only

There is a separate method 'highlight' that preserves all original whitespace and just adds syntax highlighting.

This is useful for sql that is already well formatted and just needs to be a little easier to read.

<?php
echo SqlFormatter::highlight($query);

Output:

Compress Query

The compress method removes all comments and compresses whitespace.

This is useful for outputting queries that can be copy pasted to the command line easily.

-- This is a comment
    SELECT
    /* This is another comment
    On more than one line */
    Id #This is one final comment
    as temp, DateCreated as Created FROM MyTable;

echo SqlFormatter::compress($query)

Output:

SELECT Id as temp, DateCreated as Created FROM MyTable;

Remove Comments

If you want to keep all original whitespace formatting and just remove comments, you can use the removeComments method instead of compress.

-- This is a comment
    SELECT
    /* This is another comment
    On more than one line */
    Id #This is one final comment
    as temp, DateCreated as Created FROM MyTable;

<?php
echo SqlFormatter::removeComments($query);

Output:

    SELECT
    
    Id 
    as temp, DateCreated as Created FROM MyTable;

Split SQL String into Queries

Another feature, which is unrelated to formatting, is the ability to break up a SQL string into multiple queries.

For Example:

DROP TABLE IF EXISTS MyTable;
CREATE TABLE MyTable ( id int );
INSERT INTO MyTable	(id)
	VALUES
	(1),(2),(3),(4);
SELECT * FROM MyTable;

<?php
$queries = SqlFormatter::splitQuery($sql);

Result:

1. DROP TABLE IF EXISTS MyTable;
2. CREATE TABLE MyTable ( id int );
3. INSERT INTO MyTable (id) VALUES (1),(2),(3),(4);
4. SELECT * FROM MyTable;

Why Not Regular Expressions?

Why not just use explode(';', $sql) or a regular expression?

The following example sql and others like it are impossible to split correctly using regular expressions, no matter how complex.

SELECT ";"; SELECT ";\"; a;";
SELECT ";
    abc";
SELECT a,b #comment;
FROM test;

SqlFormatter breaks the string into tokens instead of using regular expressions and will correctly produce:

1. SELECT ";";
2. SELECT ";\"; a;";
3. SELECT "; abc";
4. SELECT a,b #comment; FROM test;

Please note, the splitQuery method will still fail in the following cases:

• The DELIMITER command can be used to change the delimiter from the default ';' to something else.
• The CREATE PROCEDURE command has a ';' in the middle of it
• The USE command is not terminated with a ';'