A very lightweight PHP class that reformats unreadable and computer-generated SQL query statements to human-friendly, readable text.
A very lightweight PHP class that re-formats unreadable or computer-generated SQL query statements to human-friendly readable text.
The recommended way to install the SQL Query Formatter is through Composer. Run the following command to install it:
php composer.phar require nilportugues/sql-query-formatter
Human readable SQL formatting
- Human readable plain text. No colours, no highlighting. Plain text is good enough in most cases.
Data Binding Awareness
- SQL Query Formatter takes data binding seriously.
- Placeholder syntax such as
?is taken into account and is preserved when formatting.
<?php use NilPortugues\Sql\QueryFormatter\Formatter; $query = <<<SQL SELECT user.user_id, user.username, (SELECT role.role_name FROM role WHERE (role.role_id = :v1) LIMIT :v2, :v3 ) AS user_role, (SELECT role.role_name FROM role WHERE (role.role_id = :v4) LIMIT :v5, :v6 ) AS role FROM user WHERE (user.user_id = :v7) SQL; $formatter = new Formatter(); echo $formatter->format($query);
SELECT user.user_id, user.username, ( SELECT role.role_name FROM role WHERE (role.role_id = :v1) LIMIT :v2, :v3 ) AS user_role, ( SELECT role.role_name FROM role WHERE (role.role_id = :v4) LIMIT :v5, :v6 ) AS role FROM user WHERE (user.user_id = :v7)
To run the test suite, you need Composer:
php composer.phar install --dev bin/phpunit
Nil Portugués Calderó
I would like to thank the following people:
SQL Query Formatter is licensed under the MIT license.
Copyright (c) 2015 Nil Portugués Calderó Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.