A regex used to ignore placeholders or other fragments of the query that'd make it invalid SQL query, e.g.
If you are using ? placeholders in your queries, you must ignore \? pattern as otherwise the string is not going to be recognized as a valid SQL query.
This configuration is relevant for sql/no-unsafe-query to match queries containing placeholders as well as for sql/format when used with {ignoreTagless: false} configuration.
Rules
format
The --fix option on the command line automatically fixes problems reported by this rule.
Matches queries in template literals. Warns when query formatting does not match the configured format (see Options).
This rule is used to format the queries using sql-formatter.
Options
The first option is an object with the following configuration.
configuration
format
default
description
ignoreExpressions
boolean
false
Does not format template literals that contain expressions.
ignoreInline
boolean
true
Does not format queries that are written on a single line.
ignoreStartWithNewLine
boolean
true
Does not remove \n at the beginning of queries.
ignoreTagless
boolean
true
Does not format queries that are written without using sql tag.
Determines the case of keywords (preserve, upper, lower).
dataTypeCase
preserve
Determines the case of data types (preserve, upper, lower).
denseOperators
false
Decides whitespace around operators.
Using Custom Parameter Placeholders
Different SQL dialects support different placeholder styles. By default, sql-formatter uses dialect-specific placeholders (e.g., $1, $2 for PostgreSQL, ? for MySQL). If you're using a different placeholder style like :name, you need to configure paramTypes.
For example, if you're using :name style placeholders with PostgreSQL: