DataGrip 2017.3 Help

Language injections

You can inject a language (such as HTML, XML, JSON, RegExp, etc.) into a string value in your SQL code (i.e. a fragment enclosed in quotation marks) and, as a result, get comprehensive coding assistance when editing that value (fragment).

Example: Injecting HTML. Opening a fragment editor

To get an impression of how language injections work:

  1. Create an SQL file and open it in the editor.
  2. Specify PostgreSQL as an SQL dialect for that file.
  3. Type:
    CREATE TABLE test ( my_html VARCHAR(100) DEFAULT '' );
  4. Place the cursor between the quotation marks.
  5. Click quick fix large or press Alt+Enter, select Inject language or reference, and then select HTML (HTML files).
    sql inject html
  6. Type:
    <body><h1>Hello, World!</h1></body>
    sql injected html added

    When typing, note that auto-completion for HTML tags is now available. Also note how the HTML code is highlighted.

  7. Let's now open a fragment editor for the injected HTML code: press Alt+Enter and select Edit HTML Fragment.
    sql injected html edit

    Here is the result:

    sql injected html editor

    You can use the fragment editor as an alternative (or in addition) to editing injected fragments in the "main editor".

  8. To complete the example, let's cancel the injection: switch to the main editor, press Alt+Enter and select Un-inject Language/Reference.

    Note that the text between the quotation marks has become green which is the default color for string values. This indicates that the value in the quotation marks is now treated simply as text.

    sql html uninjected

    Don't close the editor yet. Later in this topic, we'll use our SQL file for showing other language injection features.

Accessing language injection functions

Most of the functions related to language injections are accessed through a "light bulb menu" (quick fix large or Alt+Enter).

Ways to inject a language

You can inject a language by using:

Using language injection comments

To inject a language by means of an injection comment, on a separate line before the statement that contains the target string value, add:

-- language=<language_ID>

e.g.

-- language=HTML

Example

  1. On the line preceding CREATE TABLE test (, type -- language=HTML.
  2. Check the light bulb menu (Alt+Enter).
    sql injection comment html

    As you can see, HTML has been injected into the string value.

  3. Remove the commented line (e.g. Ctrl+Y) to come back to the previous state.

Language IDs

The language IDs, generally, are intuitive, e.g. JSON, HTML, XML. If not sure about the language ID, use the suggestion list for the Inject language or reference command. What precedes the opening parentheses there is the language IDs.

See also, Using language injection prefixes and suffixes.

Using auto-injection for XML and JSON

For values defined as XML and JSON types, the corresponding languages are injected automatically.

Example

  1. Replace VARCHAR(100) with XML.
  2. Place the cursor within the value in the quotation marks.
  3. Check the light bulb menu (Alt+Enter) to see that XML has been auto-injected.
    sql auto inject xml

Using pattern-based injections for user-defined data types

You can create patterns - e.g. for user-defined data types - and associate those patterns with languages. As a result, DataGrip, when it comes across a data type that matches the pattern, will inject the language specified for that pattern.

In the following example, we'll create a pattern for a data type ending in DATA and associate that pattern with XML.

Example

  1. Replace XML with MYDATA.
  2. Place the cursor within the value in the quotation marks.
  3. Press Alt+Enter, select Inject by Type, and then select XML (XML files).
    sql inject mydata by type
  4. In the dialog that opens, in the Type pattern field, specify (?i).*DATA. (The type patterns are specified using regular expressions. In this example, (?i) turns the case-insensitive mode on; .* stands for any number of any characters.)
    sql injection type pattern
  5. Check the light bulb menu (Alt+Enter) to see that XML has been injected for the MYDATA value.
    sql mydata xml injected

Accessing injection settings

To access the language injection settings:

  1. Open the Settings / Preferences dialog (e.g. Ctrl+Alt+S).
  2. Go to the Language Injections page: Editor | Language Injections.

For more info, see Language Injections page.

Using language injection prefixes and suffixes

A language fragment may be combined with a prefix and a suffix which together act as a wrapper, thereby turning the fragment into a syntactically complete language unit. When editing your code, you can see the prefix and the suffix only in the fragment editor. They are not shown in the main editor.

The prefix and the suffix can be included in the injection comment as follows:

-- language=<language_ID> prefix=<prefix> suffix=<suffix>

The prefix and suffix attributes are optional.

Example

In this example, we'll remove the opening and closing <body> tags from the injected code fragment and add these tags to the injection comment as the prefix and suffix.

  1. Remove the opening and closing <body> tags: e.g. place the cursor within the injected fragment, press Ctrl+Shift+Delete and select Remove Enclosing Tag body.
  2. On the line preceding CREATE TABLE test (, type -- language=HTML prefix=<body> suffix=</body>
  3. For the injected fragment, open the fragment editor.
    sql inject html prefix and suffix

    Compare the fragments shown in the main and in the fragment editors.

Last modified: 4 April 2018
Working with delimiter-separated valuesExtending DataGrip functionality

See Also

Reference:

Getting Started: