PyCharm 2019.2 Help

User Parameters

File | Settings | Tools | Database | User Parameters for Windows and Linux
PyCharm | Preferences | Tools | Database | User Parameters for macOS


Generally, only the question mark ? is treated as a parameter in SQL statements. On this page, you can specify which other characters and their sequences should be treated as parameters, and in which places.

The patterns for SQL parameters are specified by means of regular expressions.

Item

Description

Enable in console and SQL files

If the checkbox is selected, the parameter patterns are applied to SQL (in SQL files and database consoles). The usage scope, if necessary, may be limited at the level of individual patterns.

If this checkbox is cleared, the patterns are not used in SOL files and consoles irrespective of which usage scope is specified for individual patterns.

Enable in string literals with SQL injection

If the checkbox is selected, the parameter patterns are applied to string literals injected with SQL. If necessary, you can limit the usage scope at the level of individual patterns.

If this checkbox is cleared, the patterns are not used in string literals irrespective of which usage scope is specified for individual patterns.

Parameter patterns

The table shows the parameter patterns and their usage scopes.

The patterns are specified using regular expressions. Values in parentheses are treated as parameter names. The patterns available initially have the following meanings:

  • \?(\d+) - a question mark followed by one or more digits, for example, ?69 in which case 69 would be the parameter name.

  • :(\w+) - a colon followed by one or more word characters, for example, :x, :value, :parameter_1.

  • %w+ - % followed by one or more word characters, for example, %xyz.

  • \$\{([^$\{\}]*)\} - $, then {, then any character except $, { or } zero or more times, then }, for example, ${}, ${value}.

  • \$\(([^\)]+)\) - $, then (, then any character except ) one or more times, then ), for example, $(x).

  • \$(\w+)\$ - $, then one or more word characters, then $ again, for example, $x1$.

  • \#(\w+)\# - #, then one or more word characters, then # again, for example, #field_3#.

Use the Add button Alt+Insert, the Remove button Alt+Delete, the Previous Occurrence button Alt+Up and the Next Occurrence button Alt+Down to add, delete and reorder the patterns.

To edit a pattern or its usage scope, click the pattern and use the following controls:

  • In scripts: clear this checkbox if the pattern must not be used in SQL files and database consoles.

  • In literals: clear this checkbox if the pattern must not be used in string literals injected with SQL.

  • All languages: click the link and clear language checkboxes where you do not want to use the pattern.

Last modified: 14 October 2019