Work with the Hibernate console

Use the Hibernate console to write and run HQL queries, analyze the query results, and also to perform other, associated tasks.

Prerequisites

For the Hibernate console to be fully functional, you should:

Associate your session factory with the corresponding data source, see Associating persistence units and session factories with data sources.
If you are using custom entity class/db table name mappings which are not fully reflected in your code and/or configuration files, specify the corresponding NamingStrategy implementation, see Associating a session factory with a NamingStrategy implementation class (Hibernate).

Opening the Hibernate console

Open the Persistence tool window (e.g. View | Tool Windows | Persistence).
Expand the Hibernate facet node.
Select the session factory for which you want to open the console or any node within that session factory.
Do one of the following:
- Click on the title bar.
- Select Console from the context menu.
- Press Ctrl+Shift+F10.

Modify console settings

Open a console and click the Open Database Settings icon ().

Composing HQL queries

When composing your queries in the input pane, use auto-completion and highlighting of HQL keywords, and object and property names.

Navigating to the declaration of a class or field

You

When composing a query, it's sometimes useful to take a look at the declaration of a class or field for an object or property referenced in the input pane. To navigate to the corresponding declaration, do one of the following:

Place the cursor within the name of the object or property of interest. Then use Ctrl+B. (Alternatively, you can use Navigate | Declaration from the main menu.)
Press and hold the Ctrl key, and point to the name of interest. When the text turns into a hyperlink, click the hyperlink.

As a result, the necessary source file opens in the editor and the cursor is placed within the declaration of the corresponding class or the getter method for the corresponding field.

Running a query

To run the current query, do one of the following:

Click on the toolbar.
Press Ctrl+Enter.

Running parameterized queries

If you have parameters in your statement, you must specify the values of the parameters before you execute the statement.

To execute a parameterized statement, click the Execute button on the toolbar and enter values in the second column. Alternatively, to open the Parameters dialog, click the View Parameters button .

Running auto-memorized queries

IntelliJ IDEA stores history of all statements that you have run.

To open the History dialog, click or press Ctrl+Alt+E.

To filter information, start typing your search query.
To paste the query from the History dialog to the console, double-click the query in the left pane of the History dialog.
To delete a record from history, select the record and press Delete.

Terminating query execution

To terminate execution of the current statement or statements, click the Disconnect button or press Ctrl+F2.

Generating SQL statements and DDL SQL scripts

You can generate SQL statements for your HQL queries and DDL SQL scripts for your session factory:

To generate an SQL equivalent of the current query, do one of the following:
- Click on the toolbar.
- Press Ctrl+Shift+Enter.
To generate DDL SQL statements CREATE TABLE, ALTER TABLE and DROP TABLE for all the objects (classes) associated with the corresponding session factory, do one of the following:
- Click on the toolbar and select Generate DDL.
- Press Ctrl+Alt+Shift+Enter.

The generated SQL statements are shown in the output pane.

Pin the tab with query results

If one and the same tab is used to show your query results, and you get the result that you want to keep, you can pin the tab to the tool window.

Right-click the tab and select Pin Active Tab.
Click on the toolbar.

Navigate between subsets of rows

Depending on the value of the Limit page size to parameter, the result set might be divided into several pages. For example, you set the Limit page size to parameter to 100, but your query returned 200 rows. You will have two pages of rows, with 100 rows on each page. To navigate between pages, use the following controls:

: Navigates to the first page of the result set.
: Navigates to the previous page of the result set. ( Ctrl+Alt+Up )
: Navigates to the next page of the result set. ( Ctrl+Alt+Down)
: Navigates to the last page of the result set.

Set a number of rows in the result set

By default, when you issue a query, the number of returned rows is limited to 500. This limitation is introduced to avoid an overload (for example, when your SELECT statement returns one million rows).

To change this limit, open settings settings Ctrl+Alt+S and navigate to Tools | Database | Data Views. In the Limit page size to field, specify a new number. To disable the limitation, clear the Limit page size to checkbox.

Also, you can click the Change page size list in the editor, and select a predefined value.

Go to the specified row

To navigate to a row with a specified number, right-click the table and select Go To | Row Ctrl+G. In the Go to row dialog, specify the row number and click OK.

Sort data

To sort table data in a column, click the corresponding cell in the header row. You can click several header row cells to sort table data on multiple columns.

State	Description
	Indicates that the data is not sorted in this column. The initial state of the sorting marker.
	The data is sorted in the ascending order. 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.
	The data is sorted in the descending order.

Reordering columns

To reorder columns, use drag-and-drop for the corresponding cells in the header row.

Hiding and showing columns

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.

Restoring the initial table view

Click on the toolbar 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 in which they were defined initially, and all the columns are shown.

Using the Structure view to sort data, and hide and show columns

When working with the Result pane, the table structure view is available as the corresponding popup.

The structure view shows the list of all the columns and lets you sort the data as well as hide and show the columns.

To open the structure popup, do one of the following:

Right-click a cell in the table header row and select Column List.
Press Ctrl+F12.

In the popup, select the column of interest and do one of the following:

To sort the data by this column in the ascending order, press Alt+Shift+Up.
To sort the data in the descending order, press Alt+Shift+Down.
To cancel sorting by this column , press Ctrl+Alt+Shift+Backspace.
To hide the column (or show a hidden column), press Space. The names of hidden columns are shown struck through.

The shortcuts for sorting table data (Alt+Shift+Up, Alt+Shift+Down and Ctrl+Alt+Shift+Backspace) can be used in the Result pane without opening the structure view.

Export a table to a file

Open a table or a result set, click the Export Data icon () and click Export To File.

Export a table to a clipboard

On the toolbar, click the Export Data icon () and select Copy To Clipboard.

Configure data output format and options

You can configure how extracted data is converted into text using predefined output formats, customized formats, and scripts. To configure the output for extracted data, right-click any cell in the table and select Choose Data Extractor.

In this menu, you can select the output format (for example, as SQL INSERT statements, HTML table, or in CSV format) or a script that converts data into a specific format.

Additionally, you can configure the following parameters:

Configure CSV Formats. Opens the CSV Formats dialog that you can use to manage your delimiter-separated values formats (for example, CSV or TSV).
Go to Scripts Directory. Opens a directory with the scripts that convert table data into various output formats.

Saving a LOB in a file

You can save a binary large object (BLOB or LOB) from a cell into a file.

Right-click the cell that contains the LOB and select Save LOB.
In the save dialog, specify the name and location of the file and click OK.

Reload data for the table view

You need to reload data for the table view if you want to synchronize the data that you see in the editor with the contents of the database. Or, when you want to apply the page size limit setting after its change.

Click the Reload Page icon on the toolbar.
Right-click the table and select Reload Page from the context menu.
Press Ctrl+F5.

View the query that generated the result set

To see the query that was used to generate the result table, click the Show Options Menu icon () and select View Query. If necessary, you can select the query text and copy it to the clipboard by pressing Ctrl+C.

To close the pane where the query is shown, press Escape.

Closing a console

To close a console, do one of the following:

Click on the toolbar.
Press Ctrl+Shift+F4.

Last modified: 03 September 2020