PhpStorm 2020.3 Help

Query consoles

Query or database consoles are SQL files in which you can compose and execute SQL statements. Unlike scratch files, consoles are attached to a data source. You can use a query console in the same way as you use a terminal. Just type and run your code.

When you create a data source, a query console is created automatically. If necessary, you can create additional consoles. Each console creates a new connection. If you do not want to create new connections, enable single connection mode.

Working with console files

Create a query console

To create a console, use one of the following actions in the Database tool window (View | Tool Windows | Database ).

  • Click a data source and select File | New | Query Console.

  • Right-click a data source and select New | Query Console.

  • Click a data source, press Alt+Insert, and select Console.

  • Click a data source, press Ctrl+Shift+F10, and select New console.

Open a console

When a console is open, you can write SQL here, run it and get the result.

  • In the Project tool window (View | Tool Windows | Project ), navigate to Scratches and Consoles | Database Consoles | <data_source_name>, double-click a console file.

  • In the Database tool window, click the Jump to console icon (the Jump to console icon ) and select a console.

  • Click a data source, press F4, and select the console that you need.

Open a console

Rename a query console

  1. In the Project tool window (View | Tool Windows | Project ), navigate to Scratches and Consoles | Database Consoles.

  2. Expand a data source group that includes your console.

  3. Right-click a console file and select Refactor | Rename.

Group consoles under the data source directory

  1. In the Project tool window (View | Tool Windows | Project ), navigate to Scratches and Consoles | Database Consoles.

  2. Right-click a data source group where you want to create a new directory, select New | Directory.

  3. Specify a name of the directory.

  4. Select and drag console files to the directory.

  5. In the Move dialog, click OK.

Delete a query console

  1. In the Project tool window (View | Tool Windows | Project ), navigate to Scratches and Consoles | Database Consoles.

  2. Expand a data source group that includes your console.

  3. Right-click a console file and select Delete.

Copy a console file to a new location

  1. In the Project tool window (View | Tool Windows | Project ), navigate to Scratches and Consoles | Database Consoles.

  2. Expand a data source group that includes your console.

  3. Right-click a console file and select Refactor | Copy.

  4. In the To directory field, specify a new location for the file.

Configuring console settings

Modify console settings

  • Open a console and click the Open Database Settings icon (the Open Database Settings icon ).

Configuring console dialects

Change the SQL dialect in the editor

  • Right-click the editing area of the input pane and select Change Dialect (<current_dialect>).

    Then select the target dialect.

Disable syntax error highlighting

  • Right-click the editing area of the input pane, select Change Dialect (<current_dialect>), and select <Generic SQL>. <Generic SQL> supports completion and highlighting for SQL keywords, table and column names. Syntax error highlighting for this option is disabled ( statements in the Editor area are shown as syntactically correct).

Productivity tips

View a console history

  • In a console, right-click any area and select Local History | Show History.

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

View the file path of a query console

  • To see the details of a file, hover the cursor over the console tab.

  • Press Alt+F1, select Files View and press Enter.

Rename a console file

  • Right-click a console tab, and select Rename File.

  • Open the Project tool window (View | Tool Windows | Project) and navigate to Scratches and Consoles | Database Consoles. Select the console file, and press Shift+F6.

Last modified: 07 December 2020