Hibernate console

Last modified: 21 June 2023

Required plugins: Jakarta EE: Persistence (JPA) and Hibernate (bundled)

Use the Hibernate console to write and run HQL queries. It provides useful highlighting and completion for JPQL keywords, object and property names.

note
You project should use JDK 8 or later for the Hibernate console to be available.

tip
Associate your session factories with the corresponding data sources. Otherwise, you will have to manually specify the database connection settings when using the JPA console. For more information, see Associate persistence units with data sources.
If you are using custom entity class or database table name mappings that are not fully reflected in your code and configuration files, specify the corresponding NamingStrategy implementation, see Associate persistence units with naming strategies.

Open the Hibernate console

In the Persistence tool window, right-click a session factory or entity and select Console. Alternatively, you can click in the toolbar or press .

The Hibernate console input pane opens as a separate tab where you can write and execute HQL queries.

The Hibernate console toolbar contains the following buttons:

		Run the current query.
		Generate an SQL statement or a DDL script. Generate SQL: Generate an SQL equivalent of the current JPQL statement. Generate DDL: Generate the corresponding `CREATE TABLE`, `ALTER TABLE`, and `DROP TABLE` statements for all the objects (classes) associated with the current persistence unit.
		Open the Database page of the Settings dialog .
		Open the Parameters pane to see the parameters used in your queries and set their values.
		Open the console history dialog that shows all the queries that you have run in this console.
		Restore the original tool window layout after layout changes.
		Select the source for properties.
		Terminate the current console session.
		Close the current console.

Run HQL queries

After you write a query, do one of the following:

Press .
Click in the toolbar.

When you execute a query with parameters, you will need to enter their values. Alternatively, click to open the Parameters pane.

IntelliJ IDEA stores all queries that you execute. Press to see the previously executed commands, starting from the most recent one. To see the full history, press .

Navigate to the declaration of a class or field

When composing a query, it is useful to look at the declaration of the corresponding class or field.

Hold and click the relevant object or property.
Position the caret at the name of the relevant object or property and press or select Navigate | Go to Declaration from the main menu.

Run the Hibernate console with custom JVM options

The Hibernate console is a Java process. If necessary, you can start it with custom JVM options:

Create an Application run configuration
From the main menu, select Run | Edit Configurations, click , and select Application.
In the VM options field, specify the options that you want to pass to the JVM when it starts. The rest of the run configuration settings don't matter and you don't need to specify them.
Click OK to save the run configuration.
When you open the Hibernate console, IntelliJ IDEA will display an additional VM and Env Configuration popup with the available run configurations. Select the one with the necessary JVM options or run with the default settings.

Hibernate console﻿

note

tip

Open the Hibernate console﻿

Run HQL queries﻿

Navigate to the declaration of a class or field﻿

Run the Hibernate console with custom JVM options﻿

Hibernate console

Open the Hibernate console

Run HQL queries

Navigate to the declaration of a class or field

Run the Hibernate console with custom JVM options