IntelliJ IDEA 2020.2 Help

Configure database connections

When you create a database connection, IntelliJ IDEA connects to a database automatically to receive database objects. Then connection closes. Names of data sources that interact with a database are shown in the Database tool window with a little green circle.

If you want to close a database connection, select a data source and click the Disconnect button the Disconnect button on the toolbar. Alternatively, select a data source and press Ctrl+F2.

Close a database connection

Options for password storage

You can select the following options for storing your password:

  • Never: password is prompted each time you establish a connection with a database.

  • Until restart: password is saved only for the current IntelliJ IDEA run. If you exit IntelliJ IDEA and open it again, you must provide the password again.

  • For session: password is saved only for the current connection session with a database (until you disconnect from it). You can terminate the connection by pressing the Disconnect icon (the
                    Disconnect icon) or Ctrl+F2.

  • Forever: password is saved in the IntelliJ IDEA storage. You do not need to provide the password next time you open IntelliJ IDEA.

Options for password storage

JDBC drivers

Change the driver version

  1. In the Database tool window (View | Tool Windows | Database), click the Data Source Properties icon The Data Source Properties icon. Alternatively, press Shift+Enter.

  2. In the Data Sources and Drivers dialog, select a data source where you want to change a driver, and click the Driver link in data source settings.

    Some data sources have a drop-down list with drivers for different versions (for example, MySQL). In these cases, select Go to driver from the list.

  3. In the Driver files pane, click the version number, and select the driver version that you need.

    Change the driver version

Add a JDBC driver to an existing connection

  1. In the Database tool window (View | Tool Windows | Database), click the Data Source Properties icon The Data Source Properties icon. Alternatively, press Shift+Enter.

  2. In the Data Sources and Drivers dialog, select a data source where you want to change a driver, and click the Driver link in data source settings.

  3. Click the provided driver entry, and click Remove (the Remove button).

    To revert changes, click Reset that is in the upper-right part of the window. Alternatively, click the Add button (the Add button) and select Provided Driver | <database_name> | <driver_version>

  4. In the Driver files pane, click the Add icon (The Add icon) and select Custom JARs.

  5. Navigate to the JAR file of the JDBC driver, select it, and click OK.

  6. In the Class field, specify the value that you want to use for the driver.

  7. Click Apply.

    Add a user driver to an existing connection

Add an icon to a user driver

You can change the default icon of a user driver.

  1. In the Database tool window (View | Tool Windows | Database), click the Data Source Properties icon (The Data Source Properties icon) and select the driver that you created. To create a user driver, see Add a JDBC driver to an existing connection.

  2. Click the Options tab, scroll down to the Other section.

  3. From the Icon list, select an icon that you want to assign to the driver.

  4. Click OK.

Add an icon to the user driver

Connection options

Keep the connection alive

You can keep the connection to a database alive by running a keep-alive query after the specified period. You can define the custom query in the driver settings for unsupported databases.

  1. In the Database tool window (View | Tool Windows | Database), click the Data Source Properties icon The Data Source Properties icon. Alternatively, press Shift+Enter.

  2. Select a data source that you want to modify.

  3. On the Options tab, select the Run keep-alive query each N seconds checkbox, where N is a number of seconds after which IntelliJ IDEA runs a keep-alive query again.

Disconnect from a database in a specified period

You can specify a period in seconds after which IntelliJ IDEA terminates the connection.

  1. In the Database tool window (View | Tool Windows | Database), click the Data Source Properties icon The Data Source Properties icon. Alternatively, press Shift+Enter.

  2. Select a data source that you want to modify and click the Options tab.

  3. On the Options tab, select the Auto-disconnect after N seconds checkbox, where N is a number of seconds after which IntelliJ IDEA terminates the connection.

Run a predefined query as you establish a connection

You can run a predefined query each time you establish a connection.

  1. In the Database tool window (View | Tool Windows | Database), click the Data Source Properties icon The Data Source Properties icon. Alternatively, press Shift+Enter.

  2. Select a data source that you want to modify.

  3. On the Options tab, in the Startup script field, specify the query that you plan to run on a connection to a database.

    Run a predefined query as you establish a connection

Refresh the database state

If someone changed the remote database data or view, the local view of the database might differ from the actual state of the database.

  • To synchronize the database state automatically, in the Database tool window (View | Tool Windows | Database), click the Data Source Properties button the Data Source Properties button and select the data source that you want to change. On the Options tab, select the Auto sync checkbox.

    If the Auto sync checkbox is cleared, the view of the data source in the Database tool window (View | Tool Windows | Database) is synchronized with the actual state of the database only when you click the Refresh icon the Refresh button or press Ctrl+F5.

    Refresh the database state

Filter objects with the object filter

  • Specify filtering options in the Object filter field on the Schemas tab of the Data Sources and Drivers dialog (the Data Sources and Drivers dialog).

    Use the following pattern when you compose an expression for the Object filter field.

    <type>:[-]<pattern>, where:

    <type> might be an aggregate, collation, event, fdw, ftable, mview, operator, package, role, routine, sequence, synonym, table, user, view, vtable.

    <pattern> is a regular expression.To exclude an item, prepend with - (minus). For more information about regular expressions, see Class Patterns at JavaTM 2 Platform Standard Edition 5.0 API Specification.

    The Object Filter field in data source options

Connection modes

Enable read-only mode for a connection

  1. Navigate to File | Data sourcesShift+Enter.

  2. In the Data Sources list, select the necessary data source.

  3. Click the Options tab.

  4. Select the Read-only checkbox.

    Enable read-only mode for a connection

Single connection mode

Single connection mode means that the data source and all consoles use one and the same connection. This mode allows you to see the temporary objects in the database tree, or use the same transaction in different consoles. For more information about consoles, read Query console.

When you apply single connection mode, you must close all existing opened connections. IntelliJ IDEA displays a notification if you have opened connections. To close opened connections for the selected data source, click Yes. To close opened connections for all modified data sources, click Yes for all.

  1. In the Database tool window (View | Tool Windows | Database), click the Data Source Properties icon The Data Source Properties icon. Alternatively, press Shift+Enter.

  2. Select the data source where you want to enable single connection mode.

  3. Click the Options tab.

  4. Select Single connection mode.

  5. Click Apply.

    Enable the single connection mode

Single database mode

When you connect to a data source, IntelliJ IDEA can retrieve and display you all the databases that the data source has. But in some cases (for example, with certain settings of PgBouncer), you can or are allowed to work only with a certain database. With the Single database mode enabled, you see in the database tree view only the database that you specified in the connection settings, not all the databases that were received from the data source.

Consider using this setting, for PostgreSQL, Azure SQL Database, Greenplum, Amazon Redshift.

  1. In the Database tool window (View | Tool Windows | Database), click the Data Source Properties icon The Data Source Properties icon. Alternatively, press Shift+Enter.

  2. Select the data source where you want to enable the single connection mode.

  3. Click the Options tab.

  4. Select Single database mode.

  5. Click Apply.

    Enable the single database mode
Last modified: 19 August 2020