SQL Formatter VSCode

Official VSCode Extension of the SQL Formatter library.

Note: This extension is a direct successor of Prettier SQL VSCode extension, which is no more maintained.

Setup

By default the formatter relies on VSCode to provide it information about the SQL dialect you're using, but this depends heavily on your VSCode environment and other extensions you have installed.

When it fails do detect any specific dialect it will default to "generic" SQL. This will work for the most basic and common SQL statements.

To get better results when formatting, please configure the dialect you're using by setting the dialect option in extension settings to target one of the following:

• BigQuery
• DB2 for LUW (Linux, Unix, Windows)
• DB2 for IBM iSystem
• Hive
• MariaDB
• MySQL
• N1QL
• PL/SQL
• PostgresQL
• Amazon Redshift
• SingleStoreDB
• Snowflake
• Spark
• SQLite
• Trino (Presto)
• TransactSQL

Configuration

• dialect: The SQL dialect to use when parsing the SQL files for formatting.

• ignoreTabSettings: Whether to ignore VSCode user/workspace settings for tabSize and insertSpaces

• tabSizeOverride: Overrides tabSize if ignoreTabSettings is enabled

• insertSpacesOverride: Overrides insertSpaces if ignoreTabSettings is enabled

• keywordCase: Whether to print keywords in ALL CAPS or lowercase

• dataTypeCase: Whether to print data types in ALL CAPS or lowercase

• functionCase: Whether to print function names in ALL CAPS or lowercase

• identifierCase: Whether to print identifiers in ALL CAPS or lowercase (experimental)

• indentStyle: Switched between standard keyword positioning vs maintaining a central space column

• logicalOperatorNewline: Whether to break before or after AND and OR

• expressionWidth: Number of characters allowed in each line before breaking

• linesBetweenQueries: How many newlines to place between each query / statement

• denseOperators: Whether to strip whitespace around operators such as + or >=

• newlineBeforeSemicolon: Whether to place semicolon on its own line or on previous line

• paramTypes: Specifies parameter placeholders types to support

Having a problem?

Please report issues to SQL Formatter library Github page.

This extension and the sql-formatter library share the same issue tracker, as the authors of both are the same and the bugs reported about the VSCode extension are really mostly bugs in the underlying formatter library.

Don't worry about this difference though when reporting problems. But do read the FAQ before filing your report.