https://github.com/jdorn/sql-formatter

A lightweight php class for formatting sql statements. Handles automatic indentation and syntax highlighting.
https://github.com/jdorn/sql-formatter

Last synced: 26 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jdorn/sql-formatter
• Owner: jdorn
• License: mit
• Created: 2012-04-30T06:33:10.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2023-05-26T00:23:48.000Z (over 1 year ago)
• Last Synced: 2024-10-29T19:24:29.207Z (about 2 months ago)
• Language: HTML
• Homepage: http://jdorn.github.com/sql-formatter/
• Size: 910 KB
• Stars: 3,888
• Watchers: 40
• Forks: 186
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-starred-test - jdorn/sql-formatter - A lightweight php class for formatting sql statements. Handles automatic indentation and syntax highlighting. (HTML)

README

        
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

= NOW()) )

    GROUP BY Column1 ORDER BY Column3 DESC LIMIT 5,10";

echo SqlFormatter::format($query);

```

Output:

![](http://jdorn.github.com/sql-formatter/format-highlight.png)

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