From the Database tool window (for any node within a DB data source):
-
on the title bar if the toolbar is hidden
-
on the toolbar if the toolbar is shown
- Console from the context menu
- Ctrl+Shift+F10
From the Scratches view of the Project tool window:
- F4
On this page:
See also, Working with Database Consoles.
Overview
The input pane of a database console opens as a separate editor tab. This is where you compose your SQL statements.
When you
execute your first statement
(),
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.
(The tab showing retrieved data may be labeled Result # or,
if appropriate, the table name may be shown.)
Otherwise, only the output pane is shown.
Additionally, you can open the Parameters pane ()
to manage parameters in
SQL statements.
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 | ||
![]() | Ctrl+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. |
![]() | Ctrl+Alt+E |
Use this icon or shortcut to open a dialog that shows all the
statements that you have run for the corresponding data source.
See also, Executing auto-memorized statements. |
![]() | Use this icon to open or close the Parameters pane. | |
![]() | Use this icon to open the Database page of the Settings dialog to view or edit the settings for your database consoles, 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. | |
![]() | If the autocommit mode is off, use this icon to commit the current transaction. | |
![]() | If the autocommit mode is off, use this icon to roll back the current transaction. | |
![]() | Ctrl+F2 | Use this icon or shortcut to terminate execution of the current statement or statements. |
<schema> |
A list for selecting the default schema or database (may be unavailable).
| |
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. | |
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:
See also, Changing the SQL dialect. |
Toolbar of the Database Console tool window
To hide or show the toolbar, click on the title bar and select Show Toolbar.
Item | Shortcut | Description |
---|---|---|
![]() | Use this icon to open the Database page of the Settings dialog to view or edit the settings for your database consoles, the Table Editor and the Database tool window. | |
![]() | Ctrl+F8 | For Oracle: use this icon or shortcut to enable or disable showing the contents of the DBMS_OUTPUT buffer in the output pane. |
![]() | Use this icon to open or close the Parameters pane. | |
![]() | Use this icon to restore the original tool window layout (after the rearrangements that you have made). | |
![]() | Ctrl+F2 | Use this icon or shortcut to terminate execution of the current statement or statements. |
![]() | Ctrl+Shift+F4 | 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
, wherex
is the time taken to receive the data, andy
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+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 |
---|---|---|
![]() ![]() ![]() ![]() |
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
The result set page size is set on the Database page of the Settings dialog. | |
![]() | Use this icon or command to switch to the first of the result set pages to see the first series of rows. | |
![]() | Ctrl+Alt+Up | Use this icon, command or shortcut to switch to the previous result set page to see the previous series of rows. |
![]() | Ctrl+Alt+Down | Use this icon, command or shortcut to switch to the next result set page to see the next series of rows. |
![]() | Use this icon or command to switch to the last of the result set pages to see the last series of rows. | |
![]() | Ctrl+R |
Use this icon, command or shortcut to refresh the current table view.
Use this function to:
|
![]() | Alt+Insert |
Use this icon, command or shortcut to add a new row to the table.
Complete entering a value into a cell by pressing Enter. To save the new row, select Submit New Row from the context menu or press Ctrl+Enter. If inappropriate in the current context (i.e. for the table currently shown), this function is not available. See also, Adding a row. |
![]() | Ctrl+Y | 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. |
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. | |
![]() | If the autocommit mode is off, use this icon or command to commit the current transaction. | |
![]() | If the autocommit mode is off, use this icon or command to roll back the current transaction. | |
![]() | Ctrl+F2 | Use this icon or shortcut to terminate execution of the current query. |
![]() |
Use this icon or command to pin the tab to the tool window to keep the query result.
See also, Pinning the Result tab. | |
![]() |
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.) | |
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 Escape. | |
![]() |
This icon provides access to the following commands:
| |
Clone Row | Ctrl+D | Use this command or shortcut to create a copy of the selected row. |
Edit Value | F2, Enter 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 or simply start typing.)
To save the modified value, press Enter. To cancel editing, press Escape. See also, Modifying cell contents. |
Quick Documentation | Ctrl+Q | Use this command or shortcut to open the quick documentation view. To close the view, press Escape. For more information, see Using the quick documentation view. |
Go To | Row | Ctrl+G | 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 | F4 |
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+F7 |
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:
The command is not available if there are no records that reference the current one. |
Copy All To Clipboard |
Use this command to copy the table data onto the clipboard.
Note:
| |
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:
| |
Save LOB |
Use this command to save the large object
(LOB![]() |
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: .
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: .
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: .
Finally, when you click the cell for the third time, the initial state is resorted.
That is, sorting by the corresponding column is canceled: .
Here is an example of a table where data are sorted by two of its columns.
To restore the initial "unsorted" state for the table,
click and select Reset View.
To reorder columns, use drag-and-drop for the corresponding cells in the header row.
To restore the initial order of columns,
click and select Reset View.
To hide a column, right-click the corresponding header cell and select Hide column.
To show a hidden column:
-
Do one of the following:
- Right-click any of the cells in the header row and select Column List.
- Press Ctrl+F12.
In the list that appears, the names of hidden columns are shown struck through.
- Select (highlight) the column name of interest and press Space.
- Press Enter or Escape to close the list.
To show all the columns,
click and select Reset View.
See also, Using the Structure view to sort data, and hide and show columns.
Parameters pane
To open or close the Parameters pane,
use on the toolbar.
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, Enter or Alt+Enter. To indicate that you have finished editing a value, press Enter or click a different cell. To quit the editing mode and restore an initial value, press Escape.
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.