Question 1

How to format SQL for error logs without HTML in PHP?

Accepted Answer

Use SqlFormatter::format($query, false) to get indented SQL with line breaks but no syntax highlighting. This outputs plain text ideal for logging or command-line execution.

Question 2

Can sql-formatter split MySQL queries with DELIMITER or stored procedures?

Accepted Answer

No, the splitQuery method fails with DELIMITER commands and CREATE PROCEDURE statements. For such cases, you need a more advanced parser or to handle splitting manually.

Question 3

Sql-formatter vs other PHP SQL formatting libraries like PhpMyAdmin?

Accepted Answer

SqlFormatter is lighter and simpler, with no dependencies, making it faster to integrate. However, it lacks the extensive features and dialect support of larger libraries like PhpMyAdmin's formatter.

Question 4

How to remove comments from SQL while keeping the original whitespace?

Accepted Answer

Use SqlFormatter::removeComments($query) to strip out all comments while preserving the original indentation and line breaks, useful for clean output without reformatting.

Question 5

Does sql-formatter support syntax highlighting for PostgreSQL or other databases?

Accepted Answer

It provides basic SQL syntax highlighting but isn't tailored for specific database dialects. For advanced highlighting, consider extending the class or using a more specialized tool.

Question 6

How to install sql-formatter in a Laravel or Composer project?

Accepted Answer

Since it's a single file, manually include SqlFormatter.php. For Composer, you might need to set it up as a custom package, as it's not natively available on Packagist.

SQL Formatter

What is SQL Formatter?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions