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

Configure the SQL code style

Last modified: 11 February 2024

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in DataSpell by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

  1. Press CtrlAlt0S to open the IDE settings and then select Plugins.

  2. Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

You can apply and customize the SQL code style that satisfies code guidelines of your company.

Change code style settings

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

  1. Open settings by pressing CtrlAlt0S 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, DataSpell 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 CtrlAlt0S 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.

    Configure code styles per data source

Apply a code style in the editor

  • Right-click any area or a selection of code in the editor and select Reformat Code. Alternatively, press CtrlAlt0L.

    Apply a code style in the editor

Import code style settings

  1. Open settings by pressing CtrlAlt0S 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 CtrlAlt0S and navigate to Code Style | SQL | SQL:2016, Generic.

  2. Clear the Inherit general SQL style checkbox.

  3. Apply code style settings.

    Apply code style to the Generic

Apply the original case from the declaration

DataSpell 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, DataSpell 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 CtrlAlt0S 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 CtrlAlt0L.

    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 CtrlAlt0S 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 CtrlAlt0L to apply the declaration case in any file of the DDL data source.