DataGrip 2016.3 Help

Using 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).

Prerequisite

For language injection features to be available, the IntelliLang plugin must be enabled. (This plugin is bundled with the IDE and enabled by default.)

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 /help/img/idea/2016.3/intentionBulb.png or press Alt+Enter, select Inject language or reference, and then select HTML (HTML files).
    /help/img/idea/2016.3/sql_inject_html.png
  6. Type:
    <body><h1>Hello, World!</h1></body>
    /help/img/idea/2016.3/sql_injected_html_added.png

    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.
    /help/img/idea/2016.3/sql_injected_html_edit.png

    Here is the result:

    /help/img/idea/2016.3/sql_injected_html_editor.png

    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.

    /help/img/idea/2016.3/sql_html_uninjected.png

    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" (/help/img/idea/2016.3/intentionBulb.png 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).
    /help/img/idea/2016.3/sql_injection_comment_html.png

    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.
    /help/img/idea/2016.3/sql_auto_inject_xml.png

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).
    /help/img/idea/2016.3/sql_inject_mydata_by_type.png
  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.)
    /help/img/idea/2016.3/sql_injection_type_pattern.png
  5. Check the light bulb menu (Alt+Enter) to see that XML has been injected for the MYDATA value.
    /help/img/idea/2016.3/sql_mydata_xml_injected.png

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

Injecting a language may be accompanied with adding a prefix and a suffix. The prefix is added before the injected fragment, and the suffix - after the fragment.

Adding the prefix and the suffix is "imaginary". It doesn't change the actual string value. The prefix and the suffix act as a "wrapper" and their main purpose is to turn the injected fragment into a syntactically complete language unit. In this way, you give DataGrip a broader context for validating the injected code fragment.

When editing your code, you can see the prefix and the suffix only in the fragment editor; the prefix and the suffix are not shown in the main editor.

The prefix and the suffix can be included in the injection comment whose complete form is

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

where the prefix and the suffix 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.
    /help/img/idea/2016.3/sql_inject_html_prefix_and_suffix.png

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

See Also

Last modified: 19 January 2017