PyCharm 2023.3 Help

Injected SQL statements

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in PyCharm by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

  1. Press Ctrl+Alt+S to open the IDE settings and then select Plugins.

  2. Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

Temporarily inject a language

  1. Place the caret inside a string literal, tag, or attribute, in which you want to inject a language and press Alt+Enter (or use the intention action icon Intention action icon).

  2. Select Inject language or reference and choose the language you want to inject.

Temporarily inject a language

Open a code fragment in the dedicated editor section

  1. Place the caret within the injected code piece and press Alt+Enter (or use the intention action icon Intention action icon).

  2. Select Edit <language ID> Fragment.

    PyCharm will open a dedicated editor section for editing the code with the injected language. This editor provides full coding assistance, including code completion, inspections, intentions and code style actions.

    Open a code fragment in the dedicated editor section

Inject PL/Python code

You can have PyCharm highlight PL/Python language injections for PostgreSQL in CREATE FUNCTIONand CREATE PROCEDURE operators.

  1. Define plpythonu explicitly as the language of the function.

  2. Make sure the injected Python code is indented relative to the containing function.

PL/Python code injection highlighted

Cancel injections

  1. Place the caret at the code fragment and press Alt+Enter (or use the intention action icon the Intention action button).

  2. Select Uninject language or reference.

Configure injection rules

You can configure language injection rules on the Editor | Language Injections page of the IDE settingsĀ  Ctrl+Alt+S.

All pre-defined injection rules are configured for the Built-in scope. In other words, they are global (and therefore available in all PyCharm projects). Custom rules can be configured for the IDE or for one project only. To change the scope of custom injections, use the Move to Project/IDE Scope icon the Move to Project/IDE Scope icon.

To configure custom injection rules, click the Add icon the Add icon to add a new rule, or copy a predefined rule and change its settings.

Language injections settings
    Last modified: 07 March 2024