DataGrip 2020.1 Help

Live Templates

File | Settings | Editor | Live Templates for Windows and Linux

DataGrip | Preferences | Editor | Live Templates for macOS

Use this page to manage live templates and their settings. (A live template is a code fragment pattern that can be quickly inserted in the editor as a whole. For example, there are live templates for the SELECT, CREATE TABLE, UPDATE TABLE and other SQL statements.)

Main settings

Item

Description

By default expand with

Specifies the default invocation key for all templates. Individual expansion keys for the particular templates are defined in the editing area.

If the standard expansion keys (Tab, Enter, or Space) are not desirable, select the Custom option from this list.

When Custom is selected, the Change link appears next to the drop-down, leading you to the Keymap page.

Live Templates

Displays all currently available template abbreviations with their descriptions. The abbreviations are grouped below nodes and sorted alphabetically within each group. To activate a template or an entire group, select the checkbox near the template or the group.

The Add icon

Add Alt+Insert

Adds a new template item to the current group of template. You can define the template abbreviation, description, text, variables, expansion key, and context in the editing area below.

The Remove icon

Remove Delete

Removes the selected live template from the list.

The Duplicate icon

Duplicate

Click this button to create a new template based on the selected template. A new template item is added to the current node and the fields in the Template Text area show the definition of the selected template.

The Restore deleted defaults icon

Restore deleted defaults

Click this button to restore the deleted live templates. This button is only enabled when the changes are applied.

Context menu of a live template

Item

Description

Move

Moves the selected template to a specified group.

Change context

Changes context or contexts where the current template is enabled. When you select this command, a list of supported language contexts is displayed. To make DataGrip consider a context sensitive to the template, select a checkbox next to the context name.

The available context types depend on the enabled plugins.

Copy

Creates a serialized template XML in the system clipboard.

Paste

Pastes an XML representation of the copied templates to the selected group of templates.

Template editing area

The focus is moved to this area in the following cases:

  • When you click the Add The Add icon or Copy  The Copy icon button.

  • When you select a live template in the list.

  • When you select a fragment of code in the editor and choose Tools | Save as Live Template.

Use controls of this area to create new live templates and edit the settings for the existing ones.

You can navigate through the Template Text Area using the hot keys that are marked in the field labels.

Item

Description

Abbreviation

In this field, specify the template abbreviation, i.e a sequence of characters that identify the template in the editor.

Description

In this field, provide optional description of a template or an example of its usage.

Template Text

In this field, type the template body that may contain plain text and variables in the format $<variable name>$. If necessary, click Edit Variables and configure the variables as required. To escape a dollar sign $ in the template text, just duplicate it $$.

Applicable in:

This read-only field shows the languages and/or pieces of code where the editor should be sensitive to the template. Upon pressing Ctrl+J in such context, DataGrip displays a list of templates that are valid for this context.

Change

Click this link to modify the set of contexts where the current template is enabled. Upon clicking the link, a list of supported language contexts is displayed. To make DataGrip consider a context sensitive to the template, select a checkbox next to the context name.

Edit Variables

Open the Edit Template Variables dialog, where you can define how DataGrip should process template variables upon template expansion. For more information, see Live template variables.

Options

In this area, define the behavior of the editor when a template is expanded.

  • Expand with - from this list, choose the key to invoke the template.

  • Reformat according to style - select this checkbox to have DataGrip automatically reformat the expanded text according to the current style settings, defined on the Code Style page.

Last modified: 2 July 2020