PyCharm
 
2022.3
Shortcuts: Windows
Get PyCharm
You are viewing the documentation for an earlier version of PyCharm.
  1. Database tools and SQL
  2. File management
  3. User files

User files

Last modified: 21 December 2022

Available only in PyCharm Professional: download to try or compare editions

To work with files from your machine or any other place you have access to, attach the directory you need to the Project tool window.

Running SQL files

Run an SQL file

  • Using a Database tool window context menu action:

    1. Right-click a data source, or a schema and select SQL Scripts | Run SQL Script….

    2. In the file browser window that opens, navigate to the SQL file that you want to apply.

    Run an SQL file

  • Dragging an SQL script file:

    1. Open the Project tool window, navigate to the SQL file, and select it.

    2. Drag the SQL file to the data source or schema in Database tool window that you want to run it against.

Run an SQL file for several data sources

  1. In the Project tool window (Alt+1), select file or files that you want to run.

  2. Right-click the selection and invoke Run <configuration_name> (or press Ctrl+Shift+F10). This action creates a temporary run configuration.

  3. In the Edit Configuration window that opens, click Add the Add button in the Target data source / schema pane and select data sources or schemes against which you want to run the selected files.

    You can click Recent the History button to select data sources that you used recently.

    https://resources.jetbrains.com/help/img/idea/2022.3/db_run_sql_script_select_data_source.png
    Gif

  4. Click Run.

note

You can run individual statements only for one data source at a time.

note

The statements can contain parameters. Before you run these statements, specify values of these parameters.

Run individual statements

  1. Open an SQL file in PyCharm.

  2. Click the statement that you want to execute. If you want to execute more than one statement, select (highlight) the necessary statements.

  3. Press Ctrl+Enter or select Execute from the context menu.

  4. Select the query console where you want to execute the statement.

    Run individual statements

note

Limitation for the SQL file size is 20 MB. When you open a file that is larger than 20 MB, you see only the first 2.5 MB of the file.

tip

In the console menu, you can associate a different console with the file, or remove the association between the file and the console (Detach Console). Otherwise, you can associate a console with a file by selecting Attach Console from the context menu of the file.

Configuring 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.

PyCharm 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.

    Specify an SQL dialect