JPA Console Tool Window
From the Persistence tool window (for a persistence unit or any node within it):
on the title bar
Console from the context menu
When you open the JPA Console tool window, first, the input pane opens. This is where you compose your JPQL queries.
When you run your first query (), the output pane opens above the input pane. Basically, this is the log of operations performed in the console.
If your query retrieves data (e.g.
select), also the Result pane opens showing the retrieved data in table format.
Additionally, you can open the Parameters pane () to manage parameters in your queries.
On this page:
See also, Working with the JPA console.
Toolbar icons and shortcuts
Most of the functions in the Hibernate Console tool window are accessed by means of the toolbar icons and associated keyboard shortcuts.
Use this icon or shortcut to run the current query.
| Use this icon or shortcut to generate an SQL equivalent of the current query. |
The generated SQL statement will be shown in the output pane.
| Use this icon or shortcut to generate DDL SQL statements (|
The generated statements will be shown in the output pane.
| Use this icon or shortcut to open a dialog that shows all the queries that you have run in the console. |
See also, Running auto-memorized queries.
Use this icon to open the Database page of the Settings dialog to view or edit the settings for the database, Hibernate and JPA consoles, data editors and the Database tool window.
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).
Use this icon or shortcut to terminate execution of the current query.
Use this icon or shortcut to close the console.
This pane shows the queries that you have run as well as the information about their execution. When errors occur, the corresponding information is also shown in this pane.
For most of the events the following information is provided:
Timestamp, that is, when the event took place.
For data manipulation operations - how many rows were affected (e.g. changed or deleted). For data retrieval operations - how many rows were retrieved.
Duration in milliseconds.
Use the following context menu commands:
Copy (Ctrl+C) 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.
This pane shows the data retrieved from the database in table format. You can sort the data as well as perform other, associated tasks.
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.
, , and
| 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 , , and 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.
Use this icon or command to switch to the first of the result set pages to see the first series of rows.
Use this icon, command or shortcut to switch to the previous result set page to see the previous series of rows.
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.
| Use this icon, command or shortcut to refresh the current table view. Use this function to: |
Data Extractor: <current_format>
| Use this button or command to open a menu in which you can select an output format for your data. |
In addition to output formats, there are also the following options and commands:
Copy All To Clipboard / Save All To File
Use this command to save the large object (LOB) currently selected in the table in a file.
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.
Use this button to view the query which was used to generate the table. To close the pane where the query is shown, pressEscape.
Go To | Row
Use this command or shortcut to switch to a specified row. In the dialog that opens, specify the row number to go to.
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.
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.
The Parameters pane shows the parameters detected in the input pane and lets you edit their values. To open or close this pane, use on the toolbar.
Parameter values can be specified just as text or numbers, or as Groovy expressions that contain object references and method calls. For example, the value for the
date parameter in the query
SELECT o FROM Order o WHERE o.date > :date
could be specified as
new java.sql.Date(System.currentTimeMillis() - 24*3600*1000)
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, pressEscape.
When you select a row in the table, the corresponding parameter is highlighted in the input pane.