# Firebird

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

<figure><img src="/files/bKL9syOXshDBDBAIFjoe" 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 Firebird]</p> | JDBC (Firebird over TCP) |
| Verified Firebird Version                                                    | Firebird version 5.0.0   |

{% hint style="info" %}
The Firebird connector has been validated with the mentioned "Verified Firebird Versions" and is expected to be compatible with other supported Firebird versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.
{% endhint %}

#### 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 Firebird and mapped to the corresponding UI assets.

<table><thead><tr><th width="155">Firebird Object</th><th width="165">Firebird Attribute</th><th width="175.4000244140625">OvalEdge Attribute</th><th width="173.5999755859375">OvalEdge Category</th><th width="151.199951171875">OvalEdge Type</th></tr></thead><tbody><tr><td>Database</td><td>Database container</td><td>Container identifier</td><td>Container </td><td>Container</td></tr><tr><td>Table</td><td>Table name</td><td>Table name</td><td>Tables</td><td>Entity</td></tr><tr><td>Views</td><td>View Name</td><td>View name</td><td>View </td><td>Entity</td></tr><tr><td>Stored Procedures</td><td>Procedure name</td><td>Procedure name</td><td>Procedure</td><td>Procedure</td></tr><tr><td>Functions</td><td>Function name</td><td>Function name</td><td>Function</td><td>Function</td></tr><tr><td>Sequences</td><td>Sequence name</td><td>Sequence name</td><td>Sequence </td><td>Sequence </td></tr><tr><td>Indexes</td><td>Index name</td><td>Index identifier</td><td>Index </td><td>Index </td></tr><tr><td>Triggers</td><td>Trigger name</td><td>Trigger identifier</td><td>Trigger</td><td>Trigger</td></tr><tr><td>Columns</td><td>Name, data type</td><td>Column details</td><td>Column </td><td>Column </td></tr></tbody></table>

### Set up a Connection

#### Prerequisites

**Whitelisting Ports**

Ensure the inbound port “3050” is whitelisted for OvalEdge to connect to the Firebird database.

{% hint style="warning" %}
The default port number for Firebird is 3050. 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 Firebird 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 Firebird administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operation                  | Objects                | System Tables                    | Access Permission                |
| -------------------------- | ---------------------- | -------------------------------- | -------------------------------- |
| Connector Validation       | Database               | RDB$DATABASE                     | Run a read-only validation query |
| Crawling                   | Tables                 | RDB$RELATIONS (tables)           | Select                           |
| Crawling                   | Views                  | RDB$RELATIONS (views)            | Select                           |
| Crawling                   | Stored Procedures      | RDB$PROCEDURES                   | Select                           |
| Crawling                   | Functions              | RDB$FUNCTIONS                    | Select                           |
| Crawling                   | Sequences              | RDB$GENERATORS                   | Select                           |
| Crawling                   | Indexes                | RDB$INDICES, RDB$INDEX\_SEGMENTS | Select                           |
| Crawling                   | Triggers               | RDB$TRIGGERS                     | Select                           |
| Crawling                   | Columns (Tables/Views) | RDB$RELATION\_FIELDS, RDB$FIELDS | Select                           |
| Crawling                   | Procedure Parameters   | RDB$PROCEDURE\_PARAMETERS        | Select                           |
| Crawling                   | Function Arguments     | RDB$FUNCTION\_ARGUMENTS          | Select                           |
| Query Sheet / Data Preview | Tables and Views       | User tables/views                | 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 **Firebird**, 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="219.5999755859375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>Firebird</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 Firebird connection              </p><p>(<strong>Example</strong>: "Fire_Bird").</p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Host*</td><td>Enter the Firebird server name or IP address </td></tr><tr><td>Port*</td><td>By default, the port number for the Firebird, "3050" is auto-populated. If required, the port number can be modified as per the custom port number that is configured for your Firebird.</td></tr><tr><td>Database</td><td><p>Enter the database path or alias </p><p>(<strong>Example</strong>: /path/to/db.fdb).</p></td></tr><tr><td>Username*</td><td>Enter the database username set up to access the Firebird database. </td></tr><tr><td>Password*</td><td>Enter the database password.</td></tr><tr><td>Role </td><td>Enter the role name (Optional).</td></tr><tr><td>Character Set</td><td>Enter the character set if required (e.g. UTF8) </td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="272.39996337890625"></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>No of Archive Objects</strong></td><td></td></tr><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></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. For Firebird, the connector exposes a single database container (commonly `default`).
{% 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="87.4000244140625">S.No.</th><th width="257.99993896484375">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Invalid connection config.</td><td><p><strong>Error Description:</strong> </p><ul><li>Required connection details are missing during validation.</li></ul><p><strong>Resolution:</strong></p><ul><li>Open the connector settings.</li><li>Fill in all mandatory fields.</li><li>Click Validate again.</li></ul></td></tr><tr><td>2</td><td>Host is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>The Firebird server host is not provided, and the JDBC URL is not set.</li></ul><p><strong>Resolution:</strong></p><ul><li>Enter a valid Host value.</li><li>Verify the host is reachable.</li><li>Retry validation.</li></ul></td></tr><tr><td>3</td><td>Database is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>Database path or alias is missing and JDBC URL is not set.</li></ul><p><strong>Resolution:</strong></p><ul><li>Enter the correct Database path or alias.</li><li>Verify the database exists.</li><li>Retry validation.</li></ul></td></tr><tr><td>4</td><td>Connection failed: (message from driver/server)</td><td><p><strong>Error Description:</strong> </p><ul><li>JDBC connection or validation query failed.</li></ul><p><strong>Resolution:</strong></p><ul><li>Verify host, port, and database details.</li><li>Check username, password, and firewall access.</li><li>Ensure Firebird service is running and retry.</li></ul></td></tr><tr><td>5</td><td>Failed to get objects: (message from driver/server)</td><td><p><strong>Error Description:</strong> </p><ul><li>Metadata retrieval failed for one or more objects.</li></ul><p><strong>Resolution:</strong></p><ul><li>Verify user has SELECT access to system tables.</li><li>Check database connectivity.</li><li>Retry the crawl operation.</li></ul></td></tr><tr><td>6</td><td>Data preview is supported only for tables/views in Firebird.</td><td><p><strong>Error Description:</strong> </p><ul><li>Data preview is requested for unsupported objects.</li></ul><p><strong>Resolution:</strong></p><ul><li>Select a table or view.</li><li>Run data preview again.</li><li>Use crawl for other object types.</li></ul></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/firebird.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.