PhpStorm 8.0.0 Web Help

From the Database tool window (for any node within a DB data source):

  • ConsoleOnTitleBar on the title bar
  • runJdbcConsole on the toolbar (if the toolbar is not currently hidden)
  • Console from the context menu
  • Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+Shift+F10Shift Command F10Shift Command F10Shift Command F10

For each of your DB data sources, you can open an individual console.


When you open the database console, first, the input pane opens as a separate editor tab. This is where you compose your SQL statements.

DBConsoleInput

Then, when you execute your first statement (runBuild), the Database Console tool window opens. If the executed statement retrieves data (e.g. SELECT), there are two panes in the tool window shown on the Output and the Result tabs.

DBConsoleResult

Otherwise, only the output pane is shown.

DBConsoleOutputOnly

Additionally, you can open the Parameters pane (property_yellow) to manage parameters in SQL statements.

DBConsoleOutputAndParams

On this page:

See also, Working with the Database Console.

Input pane

Use the input pane to compose and execute your SQL statements as well as to perform other, associated tasks.

The available functions are accessed by means of the toolbar icons, keyboard shortcuts and context menu commands.

Item Shortcut Description
Toolbar icons and shortcuts
runBuild Execute Ctrl+EnterCtrl+EnterCtrl+EnterCtrl+EnterCtrl+EnterCtrl+EnterCtrl+EnterCtrl+EnterCommand EnterCommand EnterCommand Enter Use this icon or shortcut to execute the selected (highlighted) SQL statement or statements.

If nothing is selected, the current statement is executed. (Which statement is the current one is defined by the cursor position.)

Note that the minimal unit of execution for this command is a statement. That is, if only part of a statement is selected, the overall statement will be executed anyway. See also, Execute Selection.

consoleHistory Browse History Ctrl+Alt+ECtrl+Alt+ECtrl+Alt+ECtrl+Alt+ECtrl+Alt+ECtrl+Alt+ECtrl+Alt+ECtrl+Alt+EAlt Command EAlt Command EAlt Command E Use this icon or shortcut to open a dialog that shows all the statements that you have run in the console.

See also, Executing auto-memorized statements.

property_yellow View Parameters Use this icon to open or close the Parameters pane.
settings Settings Use this icon to open the Database page of the Settings dialog to view or edit the settings for the Database console, the Table Editor and the Database tool window.
Auto-commit Use this check box 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 or rollback 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.

DBCommit Commit If the autocommit mode is off, use this icon to commit the current transaction.
DBRollback Rollback If the autocommit mode is off, use this icon to roll back the current transaction.
stop Cancel Running Statements Ctrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteShift Alt Command DeleteShift Alt Command DeleteShift Alt Command Delete Use this icon or shortcut to terminate execution of the current statement or statements.
Most useful context menu commands
Execute Selection Use this command to execute precisely what is selected (highlighted) in the input pane. In this way, you can execute only part of a statement, for example, a subquery.

If nothing is currently selected in the input pane, the current statement is executed (as in the case of the Execute command).

Change '<current_dialect_name>' dialect to Use this command to change the SQL dialect being used. Select the necessary dialect from the list.

In addition to particular dialects, also the following option is available:

  • <Generic>. Basic SQL92-based support is provided including completion and highlighting for SQL keywords, and table and column names. Syntax error highlighting is not available. So all the statements in the input pane are always shown as syntactically correct.

See also, Changing the SQL dialect.

Toolbar of the Database Console tool window

Item Shortcut Description
settings Settings Use this icon to open the Database page of the Settings dialog to view or edit the settings for the Database console, the Table Editor and the Database tool window.
DBConsoleEnableDBMSOutputIcon Enable SYS.DBMS_OUTPUT Ctrl+F8Ctrl+F8Ctrl+8Ctrl+F8Ctrl+F8F9Ctrl+F8Ctrl+Shift+B or Ctrl+F8Command F8Command F8Shift Command B For Oracle: use this icon or shortcut to enable or disable showing the contents of the DBMS_OUTPUT buffer in the output pane.
property_yellow View Parameters Use this icon to open or close the Parameters pane.
DBConsoleTWLayout Restore Layout Use this icon to restore the original tool window layout (after the rearrangements that you have made).
stop Cancel Running Statements Ctrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteCtrl+Shift+Alt+DeleteShift Alt Command DeleteShift Alt Command DeleteShift Alt Command Delete Use this icon or shortcut to terminate execution of the current statement or statements.
close Close Ctrl+Shift+F4Ctrl+Shift+F4Ctrl+Shift+4Ctrl+Shift+F4Ctrl+Shift+F4Ctrl+Shift+F4Ctrl+Shift+F4Ctrl+WControl Shift F4Control Shift F4Command W Use this icon or shortcut to close the database console (i.e. the corresponding editor tab and the tool window).

Output pane

This pane shows the SQL statements that you have run as well as information about other operations performed in the console. These include turning the autocommit mode on or off, committing or rolling back a transaction, etc.

The information about the errors that occur is also shown in this pane.

For each of the events (i.e. statements, other operations and errors), the following information is provided:

  • Timestamp, that is, when the event took place.
  • For data definition and data manipulation operations - how many rows were affected (e.g. added, changed or deleted). For data retrieval operations - how many rows were retrieved.
  • Duration in milliseconds. If the statement execution involves processing the data received from the database, the execution time is shown as x/y ms, where x is the time taken to receive the data, and y is the total time of generating the query result which includes both receiving and processing the data.

Use the following context menu commands:

  • Copy (Ctrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCtrl+Insert, Alt+C or Escape, WCtrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCtrl+C or Ctrl+InsertCommand C or Command InsertCommand C or Command InsertCommand C or Command Insert) to copy the text selected in the output pane to the clipboard.
  • Compare with Clipboard to compare the text selected in the output pane with the contents of the clipboard.
  • Clear All to clear all the contents of the output pane.

Result pane

This pane shows the data retrieved from the database in table format. You can sort, add, edit and remove the data as well as perform other, associated tasks.

Main functions. Most of the functions in the Result pane are accessed by means of controls on the toolbar, context menu commands for the data cells, and associated keyboard shortcuts.

Item Shortcut Description
dataSourceTableEditorFirstPage, dataSourceTableEditorPreviousPage, dataSourceTableEditorNextPage and dataSourceTableEditorLastPage These icons and corresponding commands are for switching between the result set pages, i.e. the pages that show the retrieved data.

A fixed number of rows shown simultaneously is referred to as a result set page. If this number is less than the number of rows that satisfy the query, only a subset of all the rows is shown at a time.

In such cases, you can use dataSourceTableEditorFirstPage, dataSourceTableEditorPreviousPage, dataSourceTableEditorNextPage and dataSourceTableEditorLastPage to switch between the subsets. (If all the rows are currently shown, these icons and the corresponding commands are inactive.)

The result set page size is set on the Database page of the Settings dialog.

dataSourceTableEditorFirstPage First Page Use this icon or command to switch to the first of the result set pages to see the first series of rows.
dataSourceTableEditorPreviousPage Previous Page Ctrl+Alt+UpCtrl+Alt+UpCtrl+Alt+UpCtrl+Alt+UpCtrl+Alt+UpCtrl+Alt+UpCtrl+Alt+UpCtrl+Alt+UpAlt Command UpAlt Command UpAlt Command Up Use this icon, command or shortcut to switch to the previous result set page to see the previous series of rows.
dataSourceTableEditorNextPage Next Page Ctrl+Alt+DownCtrl+Alt+DownCtrl+Alt+DownCtrl+Alt+DownCtrl+Alt+DownCtrl+Alt+DownCtrl+Alt+DownCtrl+Alt+DownAlt Command DownAlt Command DownAlt Command Down Use this icon, command or shortcut to switch to the next result set page to see the next series of rows.
dataSourceTableEditorLastPage Last Page Use this icon or command to switch to the last of the result set pages to see the last series of rows.
refresh Reload Page Ctrl+RCtrl+RCtrl+RCtrl+RCtrl+RCtrl+RCtrl+RCtrl+RConsole.TableResult.ReloadConsole.TableResult.ReloadConsole.TableResult.Reload Use this icon, command or shortcut to refresh the current table view. Use this function to:
  • Synchronize the data shown with the actual contents of the database.
  • Apply the Result set page size setting after its change.
DBAddRow Add New Row Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterCommand N or Control EnterCommand N or Control Enter Use this icon, command or shortcut to add a new row to the table.

Complete entering a value into a cell by pressing EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter or clicking another cell in the row.

If inappropriate in the current context (i.e. for the table currently shown), this function is not available.

DBDeleteRows Delete Selected Rows Ctrl+YCtrl+YCtrl+YCtrl+YCtrl+YCtrl+Shift+LCtrl+ECtrl+DCommand BackspaceCommand BackspaceCommand D Use this icon, command or shortcut to delete the selected row or rows.

Rows are selected by clicking the cells in the column where the row numbers are shown. To select more than one row, use mouse clicks in combination with the Ctrl key.

If inappropriate in the current context (i.e. for the table currently shown), this function is not available.

DataExtractorButton Data Extractor Use this button or command to open a menu in which you can select an active data extractor. The Configure Extractors command in that menu opens the Data Extractors dialog that lets you manage the data extractors and their settings.

(A data extractor is a named set of settings that define how to convert table data into CSV, TSV and other formats.)

Copy All To Clipboard / Save All To File
  • Copy All To Clipboard. Use this command to copy the table data onto the clipboard.
  • Save All To File. Use this command to save the table data in a file. In the dialog that opens, specify the location and name of the file.

Note:

  • The data extractor which is currently active is applied.
  • If only a subset of corresponding rows is currently shown, all the appropriate rows are copied to the clipboard or saved in a file anyway. (The number of rows currently shown may be limited by the Result set page size parameter.)
Save LOB Use this command to save the large object (LOB) currently selected in the table in a file.
Reset Columns Use this command to restore the initial table view after reordering or hiding the columns, or sorting the data. As a result, the data, generally, becomes unsorted, the columns appear in the order they are defined in the corresponding query, and all the columns are shown.
Auto-commit Use this check box 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.

(Each change of a value in the table, or adding or deleting a row results in executing an SQL statement.)

If the autocommit mode is off, transactions are committed or rolled back explicitly by means of the commit or rollback 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.

DBCommit Commit If the autocommit mode is off, use this icon or command to commit the current transaction.
DBRollback Rollback If the autocommit mode is off, use this icon or command to roll back the current transaction.
View Query Use this button to view the query which was used to generate the table. To close the pane where the query is shown, press EscapeEscapeEscapeEscapeEscape, Escape or Ctrl+GEscapeEscapeEscapeEscapeEscapeEscape.
Edit Value F2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt EnterF2 or Alt EnterF2 or Alt Enter Use this command or shortcut to start editing a value in the selected table cell. (Alternatively, you can double-click the cell.)

To save the modified value, press EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter or click a different cell. To cancel editing, press EscapeEscapeEscapeEscapeEscape, Escape or Ctrl+GEscapeEscapeEscapeEscapeEscapeEscape.

Go To | Row Ctrl+GCtrl+GCtrl+GCtrl+GAlt+GCtrl+GCtrl+GCtrl+LCommand LCommand LCommand L Use this command or shortcut to switch to a specified row. In the dialog that opens, specify the row number to go to.
Go To | Related Data F4F4F4F4F4F4F4F12 or Ctrl+Shift+ECommand Down or F4Command Down or F4F3 Use this command or shortcut to switch to a related record. The command options are a combination of those for Go To | Referenced Data and Go To | Referencing Data.

The command is not available if there are no related records.

Go To | Referenced Data Ctrl+B Use this command or shortcut to switch to a record that the current record references. If more than one record is referenced, select the target record in the pop-up that appears.

The command is not available if there are no referenced records.

Go To | Referencing Data Alt+F7Shift+Alt+7Shift+Alt+7Alt+F7Alt+F7 or Shift+Alt+SShift+Alt+F7Alt+F7Ctrl+GAlt F7Alt F7Shift Command G Use this command or shortcut to see the records that reference the current record. In the pop-up that appears there are two categories for the target records:
  • First Referencing Row. All the rows in the corresponding table will be shown and the first of the rows that references the current row will be selected.
  • All Referencing Rows. Only the rows that reference the current row will be shown.

The command is not available if there are no records that reference the current one.

Ctrl+Q Use this shortcut to open the Value view. Press Ctrl+Q for the second time to open the Transposed Row view. To close the view, press EscapeEscapeEscapeEscapeEscape, Escape or Ctrl+GEscapeEscapeEscapeEscapeEscapeEscape. For more information, see Using the Value and the Transposed views.

Using the header row. In the Result pane, you can use the cells in the header row (i.e. the row where column names are shown) for:

You can sort table data by any of the columns by clicking the cells in the header row.

Each cell in this row has a sorting marker in the right-hand part and, initially, a cell may look something like this: TableEditorHeaderCellUnsorted. The sorting marker in this case indicates that the data is not sorted by this column.

If you click the cell once, the data is sorted by the corresponding column in the ascending order. This is indicated by the sorting marker appearance: TableEditorHeaderCellSortAsc. The number to the right of the marker (1 on the picture) is the sorting level. (You can sort by more than one column. In such cases, different columns will have different sorting levels.)

When you click the cell for the second time, the data is sorted in the descending order. Here is how the sorting marker indicates this order: TableEditorHeaderCellSortDesc.

Finally, when you click the cell for the third time, the initial state is resorted. That is, sorting by the corresponding column is canceled: TableEditorHeaderCellUnsorted.

Here is an example of a table where data are sorted by two of its columns.

TableEditorSortedTable

To restore the initial "unsorted" state for the table, use ResetColumnOrderAndVisibility.

To reorder columns, use drag-and-drop for the corresponding cells in the header row. To restore the initial order of columns, use ResetColumnOrderAndVisibility.

TableEditorReorderColumns

To hide a column, right-click the corresponding header cell and select Hide column.

To show a hidden column:

  1. Do one of the following:
    • Right-click any of the cells in the header row and select Column List.
    • Press Ctrl+F12Ctrl+F12Ctrl+0Ctrl+F12Ctrl+F12Ctrl+F12Ctrl+F12 or Ctrl+Shift+F12Ctrl+F3 or Ctrl+OCommand F12Command F12Command O.

    In the list that appears, the names of hidden columns are shown struck through.

    TableResultPaneHideColumn

  2. Select (highlight) the column name of interest and press SpaceSpaceSpaceSpaceSpaceSpaceSpaceSpaceSpaceSpaceSpace.
  3. Press EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter or EscapeEscapeEscapeEscapeEscape, Escape or Ctrl+GEscapeEscapeEscapeEscapeEscapeEscape to close the list.

To show all the columns, use ResetColumnOrderAndVisibility.

See also, Using the structure view to sort the data, and hide and show the columns.

Parameters pane

To open or close the Parameters pane, use property_yellow on the toolbar of the Database Console tool window.

Shown in the two-column table are all the parameters detected in the input pane along with their values.

The parameters are grouped by SQL statements. A group of parameters pertaining to the same statement has its own header row (Parameter - Value).

To start editing a value, double-click the corresponding table cell, or click the cell and press F2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt+EnterF2 or Alt EnterF2 or Alt EnterF2 or Alt Enter. To indicate that you have finished editing a value, press EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter or click a different cell. To quit the editing mode and restore an initial value, press EscapeEscapeEscapeEscapeEscape, Escape or Ctrl+GEscapeEscapeEscapeEscapeEscapeEscape.

When you click a header row in the table, the corresponding statement is highlighted in the input pane. Similarly, when you select a row containing a parameter, the corresponding parameter is highlighted.

When you place the cursor within a parameter in the input pane, the corresponding row is highlighted in the table.

See Also

Concepts:

Procedures:

Reference:

Getting Started:

Web Resources: