{"id":15649748,"url":"https://github.com/nilportugues/php-sql-query-formatter","last_synced_at":"2025-04-14T16:17:29.444Z","repository":{"id":57027239,"uuid":"21231823","full_name":"nilportugues/php-sql-query-formatter","owner":"nilportugues","description":"A very lightweight PHP class that re-formats unreadable or computer-generated SQL query statements to human-friendly readable text.","archived":false,"fork":false,"pushed_at":"2019-05-10T09:42:36.000Z","size":101,"stargazers_count":37,"open_issues_count":1,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T04:51:17.130Z","etag":null,"topics":["formatter","mssql","mysql","php","php7","sql","sql-format","sql-query-formatter","sqlite"],"latest_commit_sha":null,"homepage":"http://nilportugues.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nilportugues.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-26T07:23:59.000Z","updated_at":"2024-08-12T11:07:16.000Z","dependencies_parsed_at":"2022-08-23T16:30:10.393Z","dependency_job_id":null,"html_url":"https://github.com/nilportugues/php-sql-query-formatter","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilportugues%2Fphp-sql-query-formatter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilportugues%2Fphp-sql-query-formatter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilportugues%2Fphp-sql-query-formatter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilportugues%2Fphp-sql-query-formatter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nilportugues","download_url":"https://codeload.github.com/nilportugues/php-sql-query-formatter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788925,"owners_count":21161727,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["formatter","mssql","mysql","php","php7","sql","sql-format","sql-query-formatter","sqlite"],"created_at":"2024-10-03T12:31:40.580Z","updated_at":"2025-04-14T16:17:29.402Z","avatar_url":"https://github.com/nilportugues.png","language":"PHP","readme":"SQL Query Formatter\n=================\n\n[![Build Status](https://travis-ci.org/nilportugues/php-sql-query-formatter.svg)](https://travis-ci.org/nilportugues/php-sql-query-formatter)\n[![Coverage Status](https://img.shields.io/coveralls/nilportugues/sql-query-formatter.svg)](https://coveralls.io/r/nilportugues/sql-query-formatter?branch=master)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nilportugues/sql-query-formatter/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nilportugues/sql-query-formatter/?branch=master) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/a57aa8f3-bbe1-43a5-941e-689d8435ab20/mini.png)](https://insight.sensiolabs.com/projects/a57aa8f3-bbe1-43a5-941e-689d8435ab20)\n[![Latest Stable Version](https://poser.pugx.org/nilportugues/sql-query-formatter/v/stable)](https://packagist.org/packages/nilportugues/sql-query-formatter)\n[![Total Downloads](https://poser.pugx.org/nilportugues/sql-query-formatter/downloads)](https://packagist.org/packages/nilportugues/sql-query-formatter)\n[![License](https://poser.pugx.org/nilportugues/sql-query-formatter/license)](https://packagist.org/packages/nilportugues/sql-query-formatter) \n[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://paypal.me/nilportugues)\n\nA very lightweight PHP class that re-formats unreadable or computer-generated SQL query statements to human-friendly readable text.\n\n* [1.Installation](#block1)\n* [2. Features](#block2)\n* [3. Usage](#block3)\n* [4. Code Quality](#block5)\n* [5. Author](#block6)\n* [6. Special Thanks](#block6)\n* [7. License](#block7)\n\n\u003ca name=\"block1\"\u003e\u003c/a\u003e\n## 1.Installation\nThe recommended way to install the SQL Query Formatter is through [Composer](http://getcomposer.org). Run the following command to install it:\n\n```sh\nphp composer.phar require nilportugues/sql-query-formatter\n```\n\n\u003ca name=\"block2\"\u003e\u003c/a\u003e\n## 2. Features\n\n**Human readable SQL formatting**\n\n- Human readable plain text. No colours, no highlighting. Plain text is good enough in most cases.\n\n**Data Binding Awareness**\n\n- SQL Query Formatter takes data binding seriously.\n- Placeholder syntax such as `:variable` or `?` is taken into account and is preserved when formatting.\n\n\n\u003ca name=\"block3\"\u003e\u003c/a\u003e\n## 3. Usage\n\nSample code:\n```php\n\u003c?php\nuse NilPortugues\\Sql\\QueryFormatter\\Formatter;\n\n$query = \u003c\u003c\u003cSQL\nSELECT user.user_id, user.username, (SELECT \nrole.role_name FROM role WHERE (role.role_id = :v1) \nLIMIT :v2, :v3 ) AS user_role, (SELECT \nrole.role_name FROM role WHERE (role.role_id = :v4)\nLIMIT :v5, :v6 ) AS role FROM user WHERE (user.user_id = :v7)\nSQL;\n\n$formatter = new Formatter();\necho $formatter-\u003eformat($query);\n```\n\nReal output:\n```sql\nSELECT\n    user.user_id,\n    user.username,\n    (\n        SELECT\n            role.role_name\n        FROM\n            role\n        WHERE\n            (role.role_id = :v1)\n        LIMIT\n            :v2,\n            :v3\n    ) AS user_role,\n    (\n        SELECT\n            role.role_name\n        FROM\n            role\n        WHERE\n            (role.role_id = :v4)\n        LIMIT\n            :v5,\n            :v6\n    ) AS role\nFROM\n    user\nWHERE\n    (user.user_id = :v7)\n\n```\n\n\u003ca name=\"block4\"\u003e\u003c/a\u003e\n## 4. Fully tested\nTesting has been done using PHPUnit and [Travis-CI](https://travis-ci.org). All code has been tested to be compatible from PHP 5.4 up to PHP 5.6 and [HHVM (nightly release)](http://hhvm.com/).\n\nTo run the test suite, you need [Composer](http://getcomposer.org):\n\n```bash\n    php composer.phar install --dev\n    bin/phpunit\n```\n\n\n\u003ca name=\"block5\"\u003e\u003c/a\u003e\n## 5. Author\nNil Portugués Calderó\n\n - \u003ccontact@nilportugues.com\u003e\n - [http://nilportugues.com](http://nilportugues.com)\n\n\n\u003ca name=\"block6\"\u003e\u003c/a\u003e\n## 6. Special Thanks\nI would like to thank the following people:\n\n- [Jeremy Dorn](mailto:jeremy@jeremydorn.com) for his [sql-formatter](https://github.com/jdorn/sql-formatter) implementation I used as a basis for building this version.\n\n\n\u003ca name=\"block7\"\u003e\u003c/a\u003e\n## 7. License\nSQL Query Formatter is licensed under the MIT license.\n\n```\nCopyright (c) 2015 Nil Portugués Calderó\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n```\n","funding_links":["https://paypal.me/nilportugues"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnilportugues%2Fphp-sql-query-formatter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnilportugues%2Fphp-sql-query-formatter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnilportugues%2Fphp-sql-query-formatter/lists"}