JetBrains Rider 2023.3 Help

User files

Enable the Database Tools and SQL plugin

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

  1. Press Ctrl+Alt+S 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.

User files are the files that are stored on your machine or any other place you have access to. To work with them in JetBrains Rider, access the directory that contains them in the Solution Explorer tool window .

You can view, edit, create, and delete the SQL files.

Create an SQL file

  1. In the Solution Explorer tool window ( View | Tool Windows | Explorer) , right-click the directory in which you want to create an SQL file and select New | File.

  2. In the New File dialog, specify the filename with the SQL extension.

Managing directories

To add an external folder to the current solution, right-click the solution in the Explorer window, choose Add | Existing Folder, and then select a folder. The folder will appear in the Solution Explorer marked as attached:

Run SQL files

SQL files are run against the selected databases or schemas using run configurations. To run an SQL file, you can either create a new run configuration, or edit an existing one.

For more information about running an SQL files from your machine, refer to Run SQL files.

Configure a dialect for SQL files

For better coding assistance, assign an SQL dialect to an SQL file. An SQL dialect is a DBMS-specific version of SQL.

JetBrains Rider lets you specify the SQL dialect for an individual file or all SQL and DDL files that can be stored in a directory, in your project, or on your computer.

Specify a dialect for a single SQL file

  1. Click the dialect list, which is in the upper-right corner of the window.

  2. Select a dialect from the dialect list.

    Specify an SQL dialect

Specify a dialect for multiple SQL files

  1. Open settings by pressing Ctrl+Alt+S and navigate to Languages & Frameworks | SQL Dialects.

  2. Click the Add button the Add button and select directories or files for which you want to change a dialect.

  3. Click Open.

  4. Click the SQL Dialect cell and select the necessary dialect.

  5. Apply changes and click OK.

Last modified: 29 February 2024