Exasol Hybrid Runner

This section provides guides and references for using the Exasol connector. Configure and schedule Exasol metadata from the Collate UI:

How to Run the Connector Externally

To run the Ingestion via the UI you’ll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

External Schedulers

Get more information about running the Ingestion Framework Externally

Collate 1.6.1 or later

To deploy Collate, check the Deployment guides.

Requirements

The connector requires Exasol version 7.1 or higher to function correctly. Ensure your Exasol instance meets this minimum version requirement before proceeding.

Database privilege requirements

To ingest basic metadata, an Exasol user must have the following privileges:

USAGE privilege on Schema
SELECT privilege on Tables

To use the lineage workflow, Collate fetches query logs by querying EXA_DBA_AUDIT_SQL and joining EXA_DBA_AUDIT_SESSIONS. To access these system tables, an Exasol user must have the SELECT ANY DICTIONARY system privilege, and auditing must be enabled on the database. For more information about Exasol auditing, see Auditing.

Metadata Ingestion

To ingest metadata from Exasol, you need to create a service connection. The service connects Exasol with Collate. Once you create a service, Collate automatically starts ingesting metadata.

Step 1: Add New Service

In the left navigation, click Connections.
On the Connections page, click Add New Service.

Step 2: Select a Service and Connector

From the service type dropdown, select Database Services, then click the Exasol connector tile.

Step 3: Add Service Name and Description

Enter a unique, descriptive Service Name. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other Exasol services you are ingesting metadata from.
Optional: Enter a Description for the service.

Note: The service name cannot be changed after it is set.

Step 4: Configure Connection Options

Specify where ingestion runs, provide your source credentials, and verify the connection.

Select Ingestion Runner

Select an Ingestion Runner: the runner where the ingestion pipeline will execute.

Enter Connection Details

Enter the connection details for Exasol. The right-hand panel in the UI displays inline help for each field.

Connection Scheme: Specifies the SQLAlchemy driver scheme options required to connect to Exasol.
Username: The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol.
Password: The password associated with the user connecting to Exasol.
Host and Port: Defines the host and port of the Exasol instance. Provide this as a string in the format hostname:port. For example: localhost:8563
- If running the Collate ingestion in a Docker container and your services are hosted on localhost, use host.docker.internal:8563.
SSL/TLS Settings: Specifies the mode or settings for SSL/TLS validation during the connection. Available options:
- validate-certificate (Default): Enables Transport Layer Security (TLS) and validates the server certificate using system certificate stores.
- ignore-certificate: Enables Transport Layer Security (TLS) but disables validation of the server certificate.
Tip: This mode should not be used in production. It is useful for testing with self-signed certificates.
- disable-tls: Disables Transport Layer Security (TLS). Data is sent in plain text (no encryption).
Important: This mode is not recommended for production and should only be used in debugging scenarios.

Tip: Ensure that the appropriate TLS setting is chosen based on your security and deployment requirements.

Advanced Configuration

Database Services have an Advanced Configuration section, where you can pass extra arguments to the connector and, if needed, change the connection Scheme. This would only be required to handle advanced connectivity scenarios or customizations.

Connection Options (Optional): Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as Key-Value pairs.

Tip: When using a Hybrid Ingestion Runner, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format:

password: secret:/my/database/password

This applies only to fields marked as secrets in the connection form (these typically mask input and show a visibility toggle icon). For more information about managing secrets in hybrid setups, see the Hybrid Ingestion Runner Secret Management Guide

Test Connection

Once the credentials have been added, click on Test Connection and Save the changes.

Step 5: Configure Ingestion Options

In the What to Ingest step, use filter patterns to control which assets Collate ingests from your database service. Filter patterns use regular expressions applied to asset names.

How Filter Patterns Work

Include: Add one or more comma-separated regular expressions. Collate ingests only assets whose names match at least one expression. Leave blank to include all assets.
Exclude: Add one or more comma-separated regular expressions. Collate skips any asset whose name matches an expression. Leave blank to exclude nothing.

Rules match asset names using one of five expressions:

contains: matches any name containing the value. For example, sales matches my_sales_data and sales_2024.
starts with: matches names beginning with the value. For example, prod_ matches prod_db and prod_schema.
ends with: matches names ending with the value. For example, _raw matches events_raw and logs_raw.
is exactly: matches the exact name only. For example, analytics matches only analytics.
matches regex: matches names using a regular expression. For example, ^prod_.*_v\d+$ matches prod_events_v1.

When both Include and Exclude are set, Exclude takes priority.

Tip: Leave all filter patterns empty to ingest all databases, schemas, and tables available in the source.

Filter Options The Database, Schema, Table, and Stored Procedure sections each include the following filter options:

Database: Controls which databases Collate ingests from the source.
Schema: Controls which schemas within the ingested databases are included.
Table: Controls which tables and views within the ingested schemas are included.
Stored Procedure: Controls which stored procedures are included in metadata ingestion.

Each section provides the following controls:

Scan Mode: You can choose between the following scan modes:
- Scan all: Ingests every asset of that type the connector can access. This is the default.
- Only specific: Enables include rules so only assets matching at least one rule are ingested.
Exclude system toggle: Use this toggle to automatically filter out system-reserved names defined by the connector — for example, Exclude system databases for the Databases section.
Always exclude: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
Preview: Shows a real-time summary of what will be in scope based on your current rules.
Include rules (available only in Only specific mode): Click + Add to define a rule. Added rules appear as chips; an asset is included if it matches any rule.

Tip: If AutoPilot is enabled, usage tracking, data lineage, and other downstream workflows start automatically after the first metadata ingestion completes.

Step 6: Create & Deploy

Click Create & Deploy to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source. To monitor ingestion progress or view the service you just added, go to Connections in the left navigation and select your service.

Configure Metadata Agent and Schedule Ingestion

The Metadata Agent extracts schemas, tables, columns, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets. When you click Create & Deploy, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the Agents tab on the service detail page. To configure the additional Metadata Agent and schedule ingestion, follow these steps:

In the left navigation, click Connections and select your service.
Click the Agents tab.
Click Add Agent and select Metadata from the dropdown. For some services, the dropdown is not available and clicking Add Agent takes you directly to the agent configuration page.

On the Configure Ingestion page, do the following and click Next.

Name this Ingestion: Enter a unique recognizable name for this ingestion pipeline.

Agent Setup: Configure core parameters for metadata extraction. The following fields are available:

Field	Default	Description
Default Owner	—	Owner applied to all entities when no specific level owner is configured. Accepts a user or team name/email.
Service Owner	—	Owner assigned to the service entity.
Database Owner	—	Owner assigned to all ingested databases. Accepts a single owner or a per-database name mapping.
Database Schema Owner	—	Owner assigned to all ingested schemas. Accepts a single owner or a per-schema name mapping.
Table Owner	—	Owner assigned to all ingested tables. Accepts a single owner or a per-table name mapping.
Enable Inheritance	On	When on, child entities inherit the owner from their parent when they have no owner configured.
Query Log Duration	1	Number of days to look back in query logs when processing stored procedure results.
Query Parsing Timeout Limit	300	Timeout in seconds for parsing a single query.
Number of Threads	1	Number of threads to use for parallel table ingestion.
Incremental Extraction	Off	When enabled, subsequent runs only extract entities changed since the last successful run.
Successful Pipeline Run Lookback Days	7	Number of days to search back for a prior successful run to use as a baseline for incremental extraction.
Safety Margin Days	1	Additional days added to the baseline timestamp as a buffer for incremental extraction.
JSON Schema Sample Size	10	Number of rows sampled to infer JSON column schema. Only applies when Extract JSON Schema is enabled in Advanced Config.

Filter Patterns: Apply include or exclude rules to scope which databases, schemas, tables, and stored procedures this agent ingests. For more information about various filter options, see Step 5: Configure Ingestion Options.

Scope & Behaviour: Control how the agent handles metadata during ingestion. Toggle each option on or off based on your needs:

Toggle	Default	Description
Include Tables	On	Ingest table metadata from the source. Turn off to skip tables entirely.
Include Tags	On	Ingest tags from the source.
Include Stored Procedures	On	Ingest stored procedure metadata.
Include DDL Statements	Off	Ingest DDL statements alongside table metadata.
Include Owners	Off	Assign owners to ingested entities when the source owner’s email matches a user in Collate. Does not overwrite an existing owner.
Include Custom Properties	Off	Ingest connector-specific custom properties onto entities.
Mark Deleted Tables	On	Soft-delete tables in Collate when they are removed from the source. Applies only within the currently ingested schema.
Mark Deleted Stored Procedures	On	Soft-delete stored procedures in Collate when they are removed from the source.
Mark Deleted Schemas	Off	Soft-delete schemas and all their child assets when removed from the source.
Mark Deleted Databases	Off	Soft-delete databases and all their child assets when removed from the source.
Override Metadata	Off	When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value.
Enable Debug Log	Off	Sets the ingestion log level to DEBUG. Useful for troubleshooting.

Note: Available toggles vary by connector. Stored procedure options only appear for connectors that support stored procedures.

Advanced Config: Optional connector-specific settings such as Include Views and Extract JSON Schema.

On the Schedule Interval page, set when the agent runs:
- Schedule: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
- On-Demand: No automatic schedule; trigger the agent manually when needed.
Click Add to deploy the agent.

Troubleshooting

Exasol Troubleshooting

Learn more about how to troubleshoot common Exasol connector issues and resolve configuration or ingestion errors.

Connectors

Connectors

How to Run the Connector Externally

External Schedulers

Collate 1.6.1 or later