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.

Overview

Connector Details

Connector Category

RDBMS

OvalEdge Releases Supported

Release8.1

Connectivity

[How the connection is established with HSQLDB]

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.

HSQLDB Object
HSQLDB Attribute
OvalEdge Attribute
OvalEdge Category
OvalEdge Type

Schema

Schema Name

Schema / Container Identifier

Container

Container

Table

Table Name

Table

Tables

Entity

Views

View Name

View Name

Views

Entity

Function

Function Name

Function Name

Function / Procedure

Function

Procedure

Procedure Name

Procedure Name

Function / Procedure

Procedure

Trigger

Trigger Name

Trigger Name

Trigger

Trigger

Indexes

Index Identifier (table, index name)

Index Identifier

Index

Index

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.

circle-exclamation

Service Account User Permissions

circle-exclamation
circle-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.

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

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

circle-info

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name
Description

Connector Type

By default, "HSQLDB" is displayed as the selected connector type.

Credential Manager*

Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.

Supported Credential Managers:

  • OE Credential Manager

  • AWS Secrets Manager

  • HashiCorp Vault

  • Azure Key Vault

Connector Name*

Enter a unique name for the HSQLDB connection

(Example: "HSQL_DB").

Connector description

Enter a brief description of the connector.

Host*

Enter the HSQLDB host name or IP address.

(Example: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.amazonaws.com or 1xx.xxx.1.x0).

Port*

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.

Database*

Enter the database name to which the service account user has access within the HSQLDB.

Username*

Enter the service account username set up to access the HSQLDB database

(Example: "oesauser").

Password*

Enter the password associated with the service account user.

JDBC Driver Class

Enter fully qualified JDBC driver class name for HSQLDB default: `org.hsqldb.jdbc.JDBCDriver`

Default Governance Roles

Default Governance Roles*

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.

Admin Roles

Admin Roles*

Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.

Bridge

Select Bridge*

If applicable, select the bridge from the drop-down list.

The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.

  1. 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.

  2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl/Profile

circle-exclamation

The Crawl/Profile button allows users to select one or more schemas for crawling.

  1. Navigate to the Connectors page and click Crawl/Profile.

  2. Select the schemas to crawl.

  3. The Crawl option is selected by default.

  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.

    • 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.

S.No.
Error Message(s)
Error Description & Resolution

1

Connection failed: (message from driver/server)

Error Description:

The connection or validation query failed due to incorrect host, port, database, credentials, or network issues.

Resolution:

  • Verify network connectivity to the HSQLDB server, check host, port, and database name, validate username and password, review JDBC driver settings, and retry.

2

Failed to get fields: (message from driver/server)

Error Description:

The system failed to retrieve metadata such as tables, views, columns, and other database objects.

Resolution:

  • Ensure the service account has access to required database objects, verify permissions on schemas and system tables, and retry the crawl or refresh fields.

3

Invalid connection config.

Error Description:

The connection configuration is missing or incomplete.

Resolution:

Open the connector settings, fill in all mandatory fields, and validate the connection again.


Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA

Last updated

Was this helpful?