PhpStorm 2016.3 Help

Writing and Executing SQL Statements

Use the input pane of the database console to compose and execute your SQL statements, and also to perform other, associated tasks. (The input pane is shown as a tab in the editor.)

Selecting the default schema or database

You can select the default schema or database by using the list in the right-hand part of the toolbar. If you do so, you'll be able to omit the name of that schema or database in your statements.

/help/img/idea/2016.3/DBConsoleSchemaSelector.png

Note that you cannot switch schemas like this for read-only MySQL data sources, see Read-only.

See also, Controlling the schema search path for PostgreSQL.

Controlling the schema search path for PostgreSQL

When working with a PostgreSQL data source, you can use the Search Path popup to control the schema search path. To open this popup, click the <schema> button in the right-hand part of the toolbar.

If the search path isn't set and should include only one schema, open the popup and click the necessary schema. In the same way you can replace a schema with another one in a single-schema search path.

To form a search path that includes two or more schemas, open the popup and use:

  • Space to add a highlighted schema to the search path and also to remove a schema from the search path.
  • Alt+Up and Alt+Down to reorder the schemas within the search path.
  • Enter to apply the changes, i.e. to set the search path.
/help/img/idea/2016.3/DBConsoleSchemaSearchPath.png

More instructions and usage hints are available right in the popup.

Composing SQL statements

When composing your SQL statements, use:

  • Predefined patterns (Ctrl+J or Code | Insert Live Template).
    /help/img/idea/2016.3/sqlConsoleLiveTemplates.png
  • Auto-completion and highlighting of SQL keywords, and table and column names.
    /help/img/idea/2016.3/sqlConsoleAutocompletion.png
  • Data type prompts for columns (Ctrl+P or View | Parameter Info).
    /help/img/idea/2016.3/sqlConsoleParameterInfoTooltip.png
  • Advanced find and replace capabilities (Ctrl+F or Edit | Find | Find, and Ctrl+R or Edit | Find | Replace).
    /help/img/idea/2016.3/sqlConsoleFindAndReplace.png
  • The console history (/help/img/idea/2016.3/consoleHistory.png or Ctrl+Alt+E). See Executing auto-memorized statements.
    /help/img/idea/2016.3/sqlConsoleHistory.png

See also, Navigating to a table or column view in the Database tool window.

Editing data for INSERT statements in table format

  1. Select the INSERT statement of interest.
  2. Select Edit as Table from the context menu. As a result, the table editor opens.
    /help/img/idea/2016.3/sqlConsoleTableEditorForInsert.png
  3. Use context menu commands and associated shortcuts for working with the data in the table editor.

Navigating to a table or column view in the Database tool window

When composing a statement, it's sometimes useful to take a look at the structure of a table, or to see the info about a column (field) in the context of the table to which it belongs. For such purposes, PhpStorm provides the ability to switch from the name of a table or column in the input pane to its view in the Database tool window.

The following ways are available for using this feature:

  • Place the cursor within the name of the table or column of interest. Then use Ctrl+B. (Alternatively, you can use Navigate | Declaration from the main menu or Go To | Declaration from the context menu.)
  • Press and hold the Ctrl key, and point to the name of interest. When the text turns into a hyperlink, click the hyperlink.
    /help/img/idea/2016.3/sqlConsole1.png

Configuring the Execute command

The Execute command (/help/img/idea/2016.3/run.png on the toolbar, Ctrl+Enter or Execute from the context menu) is used to run your statements.

PhpStorm provides many options for the Execute command depending on the cursor position and on whether there is a selection.

The options are specified on the Tools | Database page in the Settings / Preferences dialog (File | Settings | Tools | Database on Windows and Linux; PhpStorm | Preferences | Tools | Database on OS X). For more information, see Execute in Console.

Executing an SQL statement

  1. Place the cursor within the statement.
  2. Do one of the following:
    • Click /help/img/idea/2016.3/run.png on the toolbar.
    • Press Ctrl+Enter.
    • Select Execute from the context menu.
  3. Select the statement or statements to be run. (The suggestion list always contains an item for running all the statements.)
/help/img/idea/2016.3/DBSelectStatementToExecute.png

See also, Execute in Console.

Executing parameterized statements

Your statements can contain parameters, however, by the time you execute such statements the values of the parameters must be specified. There are the following ways of specifying the parameter values:

  • Click /help/img/idea/2016.3/run.png on the toolbar or press Ctrl+Enter to execute the statement. In the dialog that opens, specify the parameter values and click OK.
    /help/img/idea/2016.3/sqlConsoleParams.png

    ( To start editing a value, switch to the corresponding table cell and start typing. To indicate that you have finished editing a value, press Enter or switch to a different cell. To quit the editing mode and restore an initial value, press Escape. )

  • Alternatively, you can open the Parameters pane in the Database Console tool window (/help/img/idea/2016.3/property_yellow.png on the toolbar) and specify the corresponding values there. (The values are edited in the same way as in the corresponding dialog.) Then execute the statement (/help/img/idea/2016.3/run.png on the toolbar or Ctrl+Enter).
    /help/img/idea/2016.3/sqlConsoleParamsPane.png

    For more information, see Parameters pane.

See also, User Parameters and Always review parameters before execution.

Executing a group of statements

To execute a group of statements that follow one another in the console, select (highlight) the statements (to select all the statements, use Ctrl+A) and do one of the following:

  • Click /help/img/idea/2016.3/run.png on the toolbar.
  • Press Ctrl+Enter.
  • Select Execute from the context menu.

See also, Using the error notification bar and Execute in Console.

Executing all statements

To execute all the statements contained in a console, as an alternative to the Execute command, you can use the Run console.sql command.

This command is available in the context menu, and its keyboard equivalent is Ctrl+Shift+F10.

The Run console.sql command, generally, runs faster but:

  • The statements with parameters don't run.
  • Retrieved data for the SELECT statements are not shown.

Executing a part of a statement (e.g. a subquery)

To execute a part of a statement (e. g. a subquery), select (highlight) the fragment that you want to execute and do one of the following:

  • Click /help/img/idea/2016.3/run.png on the toolbar.
  • Press Ctrl+Enter.
  • Select Execute from the context menu.

See also, Execute in Console.

Executing auto-memorized statements

As you run SQL statements in the consoles, PhpStorm memorizes them. So, at a later time, you can view the statements you have already run and, if necessary, run them again.

To open the dialog where the auto-memorized statements are shown (the History dialog), do one of the following:

  • Click /help/img/idea/2016.3/consoleHistory.png on the toolbar.
  • Press Ctrl+Alt+E.

There are two panes in the History dialog. The left-hand pane shows the list of the statements that you have run. For "long" statements, only their beginnings are shown. When you select a statement in this pane, the overall statement is shown in the pane to the right.

You can filter the information: just start typing. As a result, only the statements that contain the typed text will be shown.

You can copy the statements from the History dialog into the input pane of the console. To copy a statement, do one of the following:

  • Double-click the statement to be copied.
  • Select the statement of interest and press Enter.
  • Select the statement and click OK.

(Once the statement is in the input pane, you can run it straight away.)

You can delete unnecessary memorized statements. To delete a statement, select the statement in the History dialog and press Delete.

Outputting the result of a SELECT statement into a file

Instead of the Result pane of the Database Console tool window, you can output the result of a SELECT statement into a file.

  1. Right-click the SELECT statement of interest.
  2. Point to Execute to File and select the output format.
  3. Specify the output file location and name.

Using the error notification bar

If when running a statement an error occurs, an error notification bar appears in the lower part of the input pane.

This bar may be particularly useful when executing a sequence of statements (see Executing a group of statements) because in such a case it lets you select how to react.

/help/img/idea/2016.3/DBConsoleErrorNotificationBar.png

The options are:

  • Retry. Execute the sequence of statements starting from the one that caused the error.
  • Ignore. Skip the erroneous statement and execute the sequence starting from the next statement. If another error occurs, the error notification bar will appear again.
  • Ignore All. Skip the erroneous statement and execute the sequence starting from the next statement. If other errors occur, all the erroneous statements will be skipped and the error notification bar won't appear for these statements.
  • Stop. Stop the execution of the sequence.

Showing the error notification bar in the input pane is enabled or disabled in the Settings dialog (the Show error notifications in editor check box on the Database page).

Canceling running statements

To terminate execution of the current statement or statements, do one of the following:

  • Click /help/img/idea/2016.3/stop.gif on the toolbar of the input pane, or on the toolbar of the Dababase Console tool window.
  • Press Ctrl+F2 .

Managing database transactions

The Auto-commit check box, and the Commit /help/img/idea/2016.3/DBCommit.png and Rollback /help/img/idea/2016.3/DBRollback.png icons on the toolbar let you manage database transactions.

The Auto-commit check box is used to turn the autocommit mode for the database connection on or off.

In the autocommit mode, each SQL statement is executed in its own transaction that is implicitly committed. Consequently, the SQL statements executed in this mode cannot be rolled back.

If the autocommit mode is off, transactions are committed or rolled back explicitly by means of the Commit (/help/img/idea/2016.3/DBCommit.png) or Rollback (/help/img/idea/2016.3/DBRollback.png) command. Each commit or rollback starts a new transaction which provides grouping for a series of subsequent SQL statements.

In this case, the data manipulations in the transaction scope are committed or rolled back all at once when the transaction is committed or rolled back.

Showing execution plans

The following context menu commands let you show an execution plan (a.k.a. explain plan) for a statement:

  • Explain Plan. The result is shown in a mixed tree/table format on a dedicated Plan tab.
  • Explain Plan (Raw). The result is shown in table format. (Technically, EXPLAIN <CURRENT_STATEMENT> or similar statement is executed.)

Showing DBMS_OUTPUT for Oracle

For Oracle, you can enable or disable showing the contents of the DBMS_OUTPUT buffer in the output pane. To do that, use /help/img/idea/2016.3/DBConsoleEnableDBMSOutputIcon.png on the toolbar of the Database Console tool window (Ctrl+F8).

/help/img/idea/2016.3/DBConsoleDBMSOutput.png

See Also

Last modified: 1 December 2016