For information about where and how to view query results, see Query results.
Run statements and procedures
Run statements in a query console
You can relate to a query console as to a terminal where you type and run your code.
In the Database tool window ( ), click the data source.
Press F4 to open a query console. For more information about working with consoles, see Working with consoles.
Type or paste the statement that you want to execute.
Press Ctrl+Enter. Alternatively, click the Execute icon on the toolbar.
If you have several statements, select whether you want to execute all statements or a single statement. The suggestion list always contains an item for running all the statements.
Run statements from an open file
In WebStorm, you can open and run a file. Limitation for the file size is 20 MB. When you open a file that is larger than 20 MB, you see only first 2.5 MB of the file.
Open the Project tool window ( ) and double-click an SQL file.
Click the statement that you want to execute.
Also, you can select (highlight) the fragment of code that you want to execute. It can be a subquery or a group of statements. WebStorm executes only the selection.
Press Ctrl+Enter or select Execute from the context menu.
To customize query execution settings, click the Сustomize link. Alternatively, open settings by pressing Ctrl+Alt+S and navigate to .
(Optional) If the SQL file is not connected to a data source, select or create a connection session in the <session> list. For more information about sessions, see Managing connection sessions.
In the Statements window, press Enter to run the selected statement. You can switch between other entries to run another set of statements. Statements that you are going to execute are highlighted in a query editor.
For another example of running script files, see the following video at youtube.com.
Running parameterized statements
If you have parameters in your statement, you must specify the values of the parameters before you execute the statement.
To execute a parameterized statement, click the Execute button on the toolbar and enter values in the second column. Alternatively, to open the Parameters dialog, click the View Parameters button .
Run stored procedures
A stored procedure is a set of SQL statements with an assigned name. You can execute stored procedures in PostgreSQL, Microsoft SQL Server, Oracle, and MySQL.
Right-click a stored function that you want to execute.
In the Execute Routine window, type all the necessary parameter values, and click OK.
Run SELECT statements and save results into files
(Optional) If the file is not connected to a data source, select a data source from the list of data sources on the toolbar. Then select the connection session from the Sessions list. For more information about connection sessions, see Change a data source and a connection session.
Select Execute to File and select the output format.
In the Export Data dialog, specify the extractor that you want to use and other settings. For more information about the Export Data dialog, see Export data.
Cancel running statements
Before WebStorm 2022.1, when you clicked the stop button several times, it looked like the query was terminated, but in fact the request continued its execution in the database.
On the first click, WebStorm sent a cancellation request to the database, while on the second click WebStorm canceled the JDBC Driver process to terminate all connections to the data source (deactivate the data source). As a result, WebStorm received an error for the first cancellation request because the connection was lost, not because the cancellation was actually completed.
Starting with WebStorm 2022.1, the progress indicator on the gutter shows a red square while the request is being canceled. A canceling progress bar is shown, which clarifies the data source and the session.
WebStorm displays a warning to verify that you want to deactivate the data source. The warning is displayed to ensure safety as deactivation might be potentially dangerous for some processes happening simultaneously. So, if you click the Cancel Running Statements button two times, WebStorm displays a warning where you can terminate the remote process or wait a bit longer.
Also, the IDE displays a warning after 10 seconds of idle canceling.
Canceling running statements
Click the Cancel Running Statements button.
Before WebStorm 2022.1, when you attempted to abort a request at the stage of creating a connection, the data source was deactivated. Deactivation means that WebStorm canceled the JDBC Driver process to terminate all connections to the data source.
Starting with WebStorm 2022.1, you can interrupt not only the execution of a request, but also the creation of a connection. This is especially relevant for the very first query in the console, which also creates a connection.
You can now stop the process of creating a connection without deactivating the data source: if you click the Cancel Running Statements button while the connection is being created, the connection will be stopped, and you will see the Connection canceled message.
In order to run SQL scripts, treat the usages of the database objects as links, and provide you with correct code completion, WebStorm must resolve the database objects in your code to a certain context. By default, IDE uses one of the following as a starting point to resolve the database objects to: <schema> selector, or the default database (if none of the above is set).
Depending on whether your code is a single script or it has multiple unconnected SQL statements, select one of the following resolve modes to resolve the database objects properly:
Playground: default mode for query consoles. All the database objects are resolved to the same context.
Use this mode if your code is a set of unconnected SQL statements which are not meant to be run as a single script.
Script: default mode for local SQL files. The
USESQL statement (
SET search_path TOfor PostgreSQL) overrides the default context that the database objects are resolved to.
Use this mode if your code is meant to be run as a single script.
View history of executed statements
Using the History dialog
WebStorm stores history of all statements that you have run.
To open the History dialog, click or press Ctrl+Alt+E.
In the History dialog, you can perform the following operations:
To filter information, start typing your search query.
To paste the query from the History dialog to the console, double-click the query in the left pane of the History dialog.
To delete a record from history, select the record and press Delete.
Tips and tricks
Browse query history
To view history of all the queries that you ran in a query console, click the Browse query history button (). Alternatively, press Ctrl+Alt+E.
Execute a file from the search dialog
Press Shift twice.
In the Search Everywhere dialog, type the filename.
Select a file by using Up and Down arrows.
In the Edit Configuration window, click the Add button () and select data sources or schemes against which you want to run selected files.