Aqua 2023.3 Help

HSQLDB

Official documentation

This topic presents a general procedure on how you can create a data source for the connection to your HSQLDB database in Aqua, and run a test connection. It is assumed that you already have the necessary prerequisites and the database is up and running. For example, if you want to run a database on your machine and connect to that database, the corresponding DBMS software must be installed on the machine first.

Connect to an HSQLDB database

  1. To connect to the database, create a data source that will store your connection details. You can do this using one of the following ways:

    • From the main menu, navigate to File | New | Data Source and select HSQLDB.

    • In the Database tool window ( View | Tool Windows | Database) , click the New icon (the New icon) in the toolbar. Navigate to Data Source and select HSQLDB.

    Create a new data source
  2. In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.

    1. From the Driver list, select the JDBC driver for your connection.

      For HSQLDB, the supported drivers are HSQLDB (Local) and HSQLDB (Remote).

    2. From the Connection type list, select the connection type depending on the connection details that you have:

      Connection types for HSQLDB (Local)
      • Embedded: connect by using the path to the database folder.

      • In-memory: connect to a temporary database stored entirely in the main memory.

      • URL only: connect by using only the URL.

      Connection types for HSQLDB (Remote)
      • default: connect by using Host, Port, Database, and URL.

      • URL only: connect by using only the URL.

      For the URL only connection type, the JDBC URL that you enter is used as is.

      For the other connection types, the JDBC URL is broken down into connection details. You can either specify them separately and use the automatically generated URL, or you can enter the URL directly in the corresponding field.

    General tab of the Data Sources and Drivers dialog
  3. Check if there is a Download missing driver files link at the bottom of the connection settings area. Click this link to download drivers that are required to interact with a database. For a direct download link, refer to the JetBrains JDBC drivers page.

    Location for the downloaded JDBC drivers is the Aqua configuration directory.

    The Download missing driver files link

    You can also use your drivers for the database instead of the provided ones. For more information about connecting to a database with your driver, refer to Add a user driver to an existing connection.

    If there is no Download missing driver files link, then you already have the required drivers.

  4. Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.

    Connection types and settings for HSQLDB (Local)
    1. Enter the path to the database file or folder in Path. Alternatively, click the Open icon (the Open button) and navigate to it.

    2. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • User & Password: by using your login and password.

      • No auth: authentication is not required.

    3. In the User and Password fields, type your user credentials.

      To use no password, leave the Password field empty.

      To delete a once entered password, right-click the Password field and select Set Empty.

      the Set Empty context menu action
    4. In the Database field, type the database name to which you want to connect.

    5. To connect to a certain existing database, deselect the If Exists checkbox. If you do not want to create a new database upon connecting, leave the checkbox selected.

    6. In the URL field, Aqua generates the JDBC URL automatically using the values of other connection settings.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:

      • Format: jdbc:hsqldb:file:<path_to_the_file_or_folder>/<database_name>;ifexists=true

      • Example: jdbc:hsqldb:file:/Users/JetBrains/db/myDatabase;ifexists=true

      For more information about the URL format, refer to the HSQLDB official documentation.

    Database connection details
    1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • User & Password: by using your login and password.

      • No auth: authentication is not required.

    2. In the User and Password fields, type your user credentials.

      To use no password, leave the Password field empty.

      To delete a once entered password, right-click the Password field and select Set Empty.

      the Set Empty context menu action
    3. In the Database field, type the database name to which you want to connect.

    4. In the URL field, Aqua generates the JDBC URL automatically using the values of other connection settings.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:

      • Format: jdbc:hsqldb:mem:<database_name>

      • Example: jdbc:hsqldb:mem:myDatabase

      For more information about the URL format, refer to the HSQLDB official documentation.

    Database connection details
    1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • User & Password: by using your login and password.

      • No auth: authentication is not required.

    2. In the User and Password fields, type your user credentials.

      To use no password, leave the Password field empty.

      To delete a once entered password, right-click the Password field and select Set Empty.

      the Set Empty context menu action
    3. In the URL field, Aqua generates the JDBC URL automatically using the values of other connection settings.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field.

      For more information about the URL format, refer to the HSQLDB official documentation.

    Database connection details
    Connection types and settings for HSQLDB (Remote)
    1. In the Host field, type your server address.

    2. In the Port field, type the port of HSQLDB. The default port is 9001.

    3. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • User & Password: by using your login and password.

      • No auth: authentication is not required.

    4. In the User and Password fields, type your user credentials.

      To use no password, leave the Password field empty.

      To delete a once entered password, right-click the Password field and select Set Empty.

      the Set Empty context menu action
    5. In the Database field, type the database name to which you want to connect.

    6. In the URL field, Aqua generates the JDBC URL automatically using the values of other connection settings.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:

      • Format: jdbc:hsqldb:hsql://<host_address>:<port_number>/<database_name>

      • Example: jdbc:hsqldb:hsql://127.0.0.1:9001/myDatabase

      For more information about the URL format, refer to the HSQLDB official documentation.

    Database connection details
    1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:

      • User & Password: by using your login and password.

      • No auth: authentication is not required.

    2. In the User and Password fields, type your user credentials.

      To use no password, leave the Password field empty.

      To delete a once entered password, right-click the Password field and select Set Empty.

      the Set Empty context menu action
    3. In the URL field, Aqua generates the JDBC URL automatically using the values of other connection settings.

      If you need to use a JDBC URL with certain additional settings, paste it in the URL field. The general URL to use is as follows:

      • Format: jdbc:hsqldb:hsql://<host_address>:<port_number>/<database_name>

      • Example: jdbc:hsqldb:hsql://127.0.0.1:9001/myDatabase

      For more information about the URL format, refer to the HSQLDB official documentation.

    Database connection details

    For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (Command I), see Connection settings and DBMS-specific properties.

  5. Ensure that the connection to the database can be established using the provided details. To do that, click the Test Connection link at the bottom of the connection details area.

    Test Connection link

    In case of any connection issues, refer to the Cannot connect to a database page.

  6. (Optional) By default, only the default database and schema are introspected and available to work with. If you also want to work with other databases and schemas, in the Schemas tab, select them for the introspection.

    Schemas tab of the Data Sources and Drivers dialog
  7. Click OK to create the data source.

  8. Find your new data source in the Database tool window (Alt+1) .

    • For more information about the Database tool window, see the corresponding reference topic.

    • For more information about working with database objects in Aqua, refer to Database objects.

    • To write and run queries, open the default query console by clicking the data source and pressing F4.

    • To view and edit data of a database object, open Data editor and viewer by double-clicking the object.

Connection settings and DBMS-specific properties

Connection settings

For the reference information about connection settings (for example, Host, Port, and so on) on the General and other tabs of Data Sources and Drivers dialog (Command I), see Data source settings.

DBMS-specific properties

General tab

Item

Description

Connection type

Path

The path to the database file or folder.

Driver: HSQLDB (Local)

Connection type: Embedded

If Exists

If selected, Aqua will not create a new database if it does not exist already. If deselected, the connection will be established only if a database exists.

Last modified: 20 September 2023