# HSQLDB

This article outlines the integration with the HSQLDB connector, enabling metadata management through features such as crawling, querying and data preview. It also ensures secure authentication via Credential Manager.

<figure><img src="/files/mSPd0pjeZCH7aL8mWVEg" alt=""><figcaption></figcaption></figure>

### Overview

#### Connector Details

| Connector Category                                                         | RDBMS      |
| -------------------------------------------------------------------------- | ---------- |
| OvalEdge Releases Supported                                                | Release8.1 |
| <p>Connectivity</p><p>\[How the connection is established with HSQLDB]</p> | JDBC       |

#### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ❌      |
| Query Sheet                                  |       ✅      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ❌      |
| Manual Lineage                               |       ❌      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ❌      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ✅      |

#### Metadata Mapping

The following objects are crawled from HSQLDB and mapped to the corresponding UI assets.

<table><thead><tr><th width="162.39996337890625">HSQLDB Object</th><th width="169">HSQLDB Attribute</th><th width="169.199951171875">OvalEdge Attribute</th><th width="175.2000732421875">OvalEdge Category</th><th width="147.199951171875">OvalEdge Type</th></tr></thead><tbody><tr><td>Schema </td><td>Schema Name</td><td>Schema / Container Identifier</td><td>Container</td><td>Container</td></tr><tr><td>Table</td><td>Table Name</td><td>Table</td><td>Tables</td><td>Entity</td></tr><tr><td>Views</td><td>View Name</td><td>View Name</td><td>Views </td><td>Entity</td></tr><tr><td>Function</td><td>Function Name </td><td>Function Name </td><td>Function / Procedure</td><td>Function</td></tr><tr><td>Procedure</td><td>Procedure Name</td><td>Procedure Name</td><td>Function / Procedure</td><td>Procedure</td></tr><tr><td>Trigger</td><td>Trigger Name</td><td>Trigger Name</td><td>Trigger</td><td>Trigger</td></tr><tr><td>Indexes</td><td>Index Identifier (table, index name)</td><td>Index Identifier</td><td>Index</td><td>Index</td></tr></tbody></table>

### Set up a Connection

#### Prerequisites

The following are the prerequisites to establish a connection:

**Whitelisting Ports**

Ensure the inbound port “9001” is whitelisted for OvalEdge to connect to the HSQLDB Server database.&#x20;

{% hint style="warning" %}
The default port number for HSQLDB Server is 9001. If a different port is used, ensure that the updated port number is specified during connection setup, the port is whitelisted, and communication between the system and HSQLDB is properly established.
{% endhint %}

**Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
👨‍💻 Who can provide these permissions? These permissions are typically granted by the HSQLDB administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operation                  | Objects                | System Tables                         | Access PErmission                               |
| -------------------------- | ---------------------- | ------------------------------------- | ----------------------------------------------- |
| Connection validation      | Schema                 | Information\_schema.system\_users     | Select 1 from Information\_Schema.System\_Users |
| Crawling                   | Schema                 | Information\_schema.schemata          | Select                                          |
| Crawling                   | Tables                 | Information\_schema.tables            | Select                                          |
| Crawling                   | Views                  | Information\_schema.views             | Select                                          |
| Crawling                   | Functions              | Information\_schema.routines          | Select                                          |
| Crawling                   | Function arguments     | Information\_schema.parameters        | Select                                          |
| Crawling                   | Procedures             | Information\_schema.routines          | Select                                          |
| Crawling                   | Trigger Metadata       | Information\_schema.triggers          | Select                                          |
| Crawling                   | Indexes                | Information\_schema.system\_indexinfo | Select                                          |
| Crawling                   | Columns (tables/views) | Information\_schema.columns (+joins)  | Select                                          |
| Query Sheet / Data Preview | User tables and views  | User schemas and objects              | Select                                          |

#### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into OvalEdge, go to **Administration > Connectors**, click **+ (New Connector),** search for **HSQLDB**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="209.20001220703125">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>HSQLDB</strong>" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the HSQLDB connection              </p><p>(<strong>Example</strong>: "HSQL_DB").</p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Host*</td><td><p>Enter the HSQLDB host name or IP address.</p><p>(<strong>Example</strong>: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.amazonaws.com or 1xx.xxx.1.x0).</p></td></tr><tr><td>Port*</td><td>By default, the port number for the HSQLDB, "9001" is auto-populated. If required, the port number can be modified as per the custom port number that is configured for your HSQLDB.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the HSQLDB.</td></tr><tr><td>Username*</td><td><p>Enter the service account username set up to access the HSQLDB database </p><p>(<strong>Example</strong>: "oesauser").</p></td></tr><tr><td>Password*</td><td>Enter the password associated with the service account user.</td></tr><tr><td>JDBC Driver Class</td><td>Enter fully qualified JDBC driver class name for HSQLDB <strong>default:</strong> `org.hsqldb.jdbc.JDBCDriver`</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="238"></th><th></th></tr></thead><tbody><tr><td><strong>Default Governance Roles</strong></td><td></td></tr><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.</td></tr><tr><td><strong>Admin Roles</strong></td><td></td></tr><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr><tr><td><strong>Bridge</strong></td><td></td></tr><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

### Manage Connector Operations

#### Crawl/Profile

{% hint style="warning" %}
To perform crawl operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for **crawling**.&#x20;

1. Navigate to the **Connectors** page and click **Crawl/Profile**.
2. Select the **schemas** to **crawl**.
3. The **Crawl** option is selected by default.&#x20;
4. Click **Run** to collect metadata from the connected source and load it into the OvalEdge **Data Catalog**.
5. After a **successful crawl**, the information appears in the **Data Catalog > Databases/Tables/Table Columns** tab.

The **Schedule** checkbox allows automated crawling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the Select **Period drop-down**.
2. Select a **time period** for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the crawl operation at the scheduled time.

#### Other Operations

The **Connectors** page in OvalEdge provides a centralized view of all configured connectors, including their health status.

**Managing connectors includes:**

* **Connectors Health:** Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing:** Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

* **Edit Connector:** Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings:** Modify connector settings.
  * **Crawler:** Configure data extraction.&#x20;
  * **Query Policies:** Define query execution rules based on roles.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings:** Manage term associations at the connector level.
* **Delete Connector:** Remove a connector with confirmation.

#### Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="85.79998779296875">S.No.</th><th width="299.800048828125">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Connection failed: (message from driver/server)</td><td><p><strong>Error Description:</strong></p><p>The connection or validation query failed due to incorrect host, port, database, credentials, or network issues.</p><p><strong>Resolution:</strong></p><ul><li>Verify network connectivity to the HSQLDB server, check host, port, and database name, validate username and password, review JDBC driver settings, and retry.</li></ul></td></tr><tr><td>2</td><td><p><br></p><p>Failed to get fields: (message from driver/server)</p></td><td><p><strong>Error Description:</strong></p><p>The system failed to retrieve metadata such as tables, views, columns, and other database objects.</p><p><strong>Resolution:</strong></p><ul><li>Ensure the service account has access to required database objects, verify permissions on schemas and system tables, and retry the crawl or refresh fields.</li></ul></td></tr><tr><td>3</td><td>Invalid connection config.</td><td><p><strong>Error Description:</strong> </p><p>The connection configuration is missing or incomplete.</p><p><strong>Resolution:</strong></p><p>Open the connector settings, fill in all mandatory fields, and validate the connection again.</p></td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ovaledge.com/release8.1/connectors/connector-repositories/rdbms/hsqldb.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.