Use Run configurations
DataGrip uses run/debug configurations to run, debug, and test your code. Each configuration is a named set of startup properties that define what to execute and what parameters and environment should be used.
There are two types of run configurations:
Temporary — created every time you select from the context menu. To call the context menu, right-click an object or an area.
Permanent — created explicitly from a template or by saving a temporary configuration. Permanent configurations remain as part of your project until you remove them.
Whenever you run, debug, or test your code, DataGrip either uses an existing permanent run/debug configuration or creates a new temporary one.
Permanent configurations have opaque icons while the icons of temporary configurations are semi-transparent. The red cross over the configuration icon indicates an error in configuration settings.
The maximum number of temporary configurations is 5. The older ones are automatically deleted when new ones are added. If necessary, you can increase this limit in .
Create permanent run/debug configurations
DataGrip provides the following ways to create a permanent run/debug configuration:
Create from a template or copy an existing configuration.
Save a temporary configuration as permanent
Select a temporary configuration in the run configuration switcher, click
/
and select Save Configuration.
Alternatively, select a temporary configuration in the Run/debug configurations dialog and click
on the toolbar.
DataGrip provides run/debug configuration templates for different languages, tools, and frameworks. The list of available templates varies depending on the installed and enabled plugins.
Create a run/debug configuration from a template
Go to . Alternatively, press Alt+Shift+F10, then 0.
Click .
In the Run/Debug Configurations dialog, click the Add New Configuration icon (
) and select Database Script. Target data source / schema: databases or schemas against which you want to run your database scripts. This setting is dialect-dependent.
If you select a data source as a target, DataGrip displays a schema in which the script will be run. It is the default schema.
Script text: script that you want to run.
Script files: SQL files that you want to run. To add files, click the Add button (
) and navigate to files that you want to run. If a script contains schema switching, you will see a warning (
).
For more information about settings of the Database Script configuration type, refer to Database script.
Select Allow multiple instances if you want to allow multiple instances of the configuration to run at the same time.
In the Before launch section, define whether you want to perform any specific actions before launching the application, for example, launch an external tool or disconnect from a data source.
You can either run the configuration right away or save the configuration to run it later.
To save the run configuration for later, click OK.
To run the configuration right away, click Run.
Before launch
In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Item | Shortcut | Description |
|---|---|---|
| Alt+Insert | Click this icon to add one of the following available tasks:
|
| Alt+Delete | Click this icon to remove the selected task from the list. |
| Enter | Click this icon to edit the selected task. Make the necessary changes in the dialog that opens. |
| Alt+Up Alt+Down | Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list. |
Show this page | Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration. | |
Activate tool window | By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration. Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5. |
Share run/debug configurations
You might want to share your run configurations so that your teammates could run the application using the same configuration or enable them to remotely attach to the process you are running.
DataGrip provides a mechanism to store your run configurations as project files and share them through VCS. The same mechanism can also be used when you want to send your configuration as a file to someone else, create a local backup of your run/debug configurations, or import them from a file.
Legacy .ipr-based projects do not support individual run configurations. With legacy projects, you can only share all configurations at once by adding the .ipr file to the VCS.
Go to . Alternatively, press Alt+Shift+F10, then 0.
Select the run configuration you want to share, enable the Store as project file option, and specify the location where the configuration file will be stored.
You can configure any location unless compatibility with DataGrip 2019.3 and earlier is required. For compatibility with these versions, store the file in the suggested location.
(Optional) If the .idea directory is added to VCS ignored files, the .idea/runConfigurations subfolder will be ignored, too. If the project uses Git, you can share .idea/runConfigurations and leave .idea ignored by modifying .gitignore as follows:
/.idea/* !/.idea/runConfigurations
Run/debug configuration templates
All run/debug configurations are based on templates, which implement the startup logic, define the list of parameters and their default values. The list of available templates is predefined in the installation and can only be extended via plugins. However, you can edit default parameter values in each template to facilitate the setup of new run/debug configurations.
Configure the default values for a template
Go to . Alternatively, press Alt+Shift+F10, then 0.
In the left-hand pane of the run configuration dialog, click Edit configuration templates.
In the Run/Debug Configuration Templates dialog that opens, select a configuration type.
Specify the desired default parameters and click OK to save the template.
Run/debug configuration folders
When there are many run configurations of the same type, you can group them in folders for easier access.
Create a folder for run configurations
Go to . Alternatively, press Alt+Shift+F10, then 0.
In the Run/Debug Configurations dialog, select a configuration type and click
on the toolbar. A new empty folder for the selected type is created.Specify the folder name in the text field to the right or accept the default name.
Select the desired run configurations and move them under the target folder.
Apply the changes. If a folder is empty, it will not be saved.
When you no longer need a folder, you can delete it Delete. The run configurations grouped under this folder will be moved under the root of the corresponding run configuration type.