DataGrip 2021.1 Help

Using run/debug configurations

DataGrip uses run/debug configurations to run, debug, and test applications. A run/debug configuration represents a set of startup properties, such as VM options or JRE, that are used to run the program.

There are two types of run/debug configurations:

  • Temporary – created every time you select Run <item_name> from the context menu. To call the context menu, right-click an object or an area. The maximum number of temporary configurations is 5.

  • Permanent – created explicitly from a template or by saving a temporary configuration. Permanent configurations remain as part of your project until you remove them.

Permanent configurations have opaque icons while the icons of temporary configurations are semi-transparent.

Permanent and temporary configurations have different icons

Whenever you perform run, debug, or test operations, DataGrip either uses an existing run/debug configuration or creates a new temporary one.

Create permanent run/debug configurations

DataGrip provides the following ways to create a permanent run/debug configuration:

Save a temporary configuration as permanent

  • Select the temporary configuration in the run configuration switcher and then click Save Configuration.

    Save a temporary run configuration

Create a run/debug configuration from a template

  1. Click Run | Edit configurations.

  2. In the Run/Debug Configuration dialog, click the Add New Configuration icon (the Add New Configuration icon) and select Database Script.

    The fields that appear in the right-hand pane display the default settings for the selected configuration type.

    • Target data source / schema: databases or schemas against which you want to run your SQL code. 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: code that you want to run.

    • Script files: SQL files that you want to run. To add files, click the Add button (the Add button) and navigate to files that you want to run. If a script contains schema switching, you will see a warning (Warning ).

    • Data source (utPLSQL and tSQLt): a name of a data source. utPLSQL supports Oracle. tSQLt supports Microsoft SQL Server.

    • Database (tSQLt): a name of the Microsoft SQL Server database.

    • Paths (utPLSQL and tSQLt): a qualified path to the testing package.

    • Tags (utPLSQL): tags of tests that you want to run. Use semicolon (;) as separator.

  3. Select Allow parallel run if you want to allow multiple instances of the configuration to run at the same time.

  4. In the Before launch section, define whether you want to perform any specific actions before launching the application, for example, launch any external tool.

  5. Apply the changes and close the dialog.

    database script run configuration

Share run/debug configurations

If you are working in a team, 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.

For these purposes, 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. This saves a lot of time as run configurations sometimes get sophisticated, and keeping them in sync manually would be tedious and error-prone.

  • Go to the properties of the run configuration you want to share (Run | Edit Configurations ), enable the Store as project file option, and specify the location where the file will be stored.

    If compatibility with DataGrip 2019.3 and earlier is required, store the file in the default location.

    Store as project file box

To learn how to use version control systems in DataGrip, refer to the Version control topic.

Run/debug configuration templates

For a run configuration of a particular type, you can set up the default values for one or more parameters and save them as a template. In this case, the next time when you create a new configuration of that type, the corresponding fields of the dialog will already contain the specified values.

Configure the default values for a template

  1. In the left-hand pane of the Run/Debug Configurations dialog, click the Edit configuration templates link and select the desired configuration type.

  2. In the Run/Debug Configuration Templates dialog, select a configuration type.

  3. Specify parameters and click OK to save the template.

    Run configuration templates

Compound run/debug configurations

Suppose you would like to launch multiple run configurations simultaneously. For example, you may want to run scripts that create a schema, then run a statement on that schema, and finally run some tests. You can configure this behavior with a compound run configuration.

When you run or debug your code using a compound configuration, you actually launch a sequence of configurations in the order they are listed.

Create a compound run configuration

  1. Open the Run/Debug configurations dialog. You can access it from the Run | Edit Configurations main menu or using the run configuration switcher on the toolbar.

  2. In the Run/Debug Configurations dialog, click the Add button or press Alt+Insert, then select Compound.

  3. Specify the run/debug configuration name in the Name field. This name will be shown in the list of the available run/debug configurations.

  4. Select Store as project file to make this run configuration available to other team members.

  5. To include a new run configuration into the compound configuration, click Add the Add button and select the desired one from the list.

  6. Apply the changes.

    Create a compound run configuration

Run/debug configuration folders

When there are many run configurations of the same type, you can group them in folders so they become easier to distinguish visually.

Once grouped, the run configurations appear in the list under the corresponding folders.

folders for run configurations

Create a folder for run configurations

  1. In the Run/Debug Configurations, select a configuration type and click the New Folder icon on the toolbar. A new empty folder for the selected type is created.

  2. Specify the folder name in the text field to the right or accept the default name.

  3. Select the desired run configurations and move them under the target folder.

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

Last modified: 06 April 2021