WebStorm
 
2022.2
Shortcuts: Windows
Get WebStorm
You are viewing the documentation for an earlier version of WebStorm.
  1. Database tools and SQL
  2. Configure settings
  3. Configure the SQL code style

Configure the SQL code style

Last modified: 19 May 2022

This feature is available with the Database Tools and SQL plugin installed on the Settings/Preferences | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains repository.

Please note that it is a paid plugin.

You can apply and customize the SQL code style that satisfies code guidelines of your company. To see the description of SQL style options, see Code Style. SQL.

Change code style settings

Customize formatting rules for the SQL code: alignment, wrapping, and indentation.

  1. Open settings by pressing Ctrl+Alt+S and navigate to Editor | Code Style | SQL.

  2. Expand the SQL node and select a dialect.

  3. Select all the necessary code style settings on the available tabs.

  4. Click Apply.

    Code style settings

tip

When you apply the rule, WebStorm updates the SQL code and highlights all modified parts in the Preview pane.

Create a code style for a dialect

  1. Open settings by pressing Ctrl+Alt+S and navigate to Editor | Code Style | SQL.

  2. Expand the SQL node and select a dialect.

  3. Click the Show Scheme Actions icon (The Show Scheme Actions icon), and select Duplicate.

  4. Type a name for a new style, and press Enter.

  5. Select all the necessary code style settings, and click Apply.

    Create a code style for SQL

Configure code styles per data source

After you created a style for a dialect, you can apply this style to the data source that uses this dialect.

  1. Right-click a data source and select Properties.

  2. Click the Options tab.

  3. In the Code style drop-down menu, select a style that you want to apply.

  4. Click Apply.

Apply a code style in the editor

  • Right-click any area in the editor and select Reformat. Alternatively, press Ctrl+Alt+L.

    Apply a code style in the editor

Import code style settings

  1. Open settings by pressing Ctrl+Alt+S and navigate to Editor | Code Style | SQL.

  2. Expand the SQL node and select a dialect.

  3. Click the Set from link and select the style that you want to import.

    You can select preconfigured styles like Modern, Joe Celko, Allman (DDL only)), Whitesmiths (DDL only)), Egypt, Old Idea. Or, import settings from the dialect that you configured.

    Import code style settings

Apply code style to the Generic dialect

  1. Open settings by pressing Ctrl+Alt+S and navigate to Code Style | SQL | SQL:2016, Generic.

  2. Clear the Inherit general SQL style checkbox.

  3. Apply code style settings. For more information about code style settings, see Code Style. SQL.

Apply the original case from the declaration

WebStorm can format names of variables, procedures, and functions as you defined them initially. For example, if you defined the get_Amount function in the CREATE PACKAGE statement, you want the same case throughout your code, not GET_AMOUNT or get_amount.

To apply this case throughout the file, WebStorm must find the declaration of these variables, procedures, and functions (for example, in the CREATE PACKAGE statement). To apply the case in multiple files, create a DDL data source from these files.

Apply the declaration case for a file

  1. Open settings by pressing Ctrl+Alt+S and navigate to Editor | SQL.

  2. Select the dialect in which you want to apply the original case from the declaration.

  3. Click the Case tab and select the Use original case checkbox.

  4. Click OK.

  5. Click Code | Reformat Code or press Ctrl+Alt+L.

    On the following image, you can see Pack_1.sql and Pack_2.sql with identical code. Pack_1.sql is not reformatted. Pack_2.sql was reformatted with the Use original case checkbox enabled. In Pack_2.sql, the case from the package declaration was applied throughout the whole file.

    Enable the declaration case for a file

Apply the declaration case in multiple files

  1. Create a DDL data source from the files for which you want to apply the declaration case.

  2. Open settings by pressing Ctrl+Alt+S and navigate to Editor | SQL.

  3. Select the dialect in which you want to apply the declaration case settings.

  4. Click the Case tab and select the Use original case checkbox .

  5. Click OK.

  6. Click Code | Reformat Code or press Ctrl+Alt+L to apply the declaration case in any file of the DDL data source.

    On the following image, you can see Pack_1.sql and View_1.sql. Both files are in the DDL data source. With the Use original case checkbox enabled, when you reformat code in View_1.sql, the original case from the package declaration in Pack_1.sql is applied.