Skip to main content
In this section, we provide guides and references to use the Mode connector. Configure and schedule Mode metadata and profiler workflows from the OpenMetadata 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

​
Metadata Mapping

Starting in OpenMetadata 2.0.3, Mode metadata is mapped as follows: Query data models have an empty column list because Mode’s query response does not provide result-column metadata. When the SQL can be parsed and the source tables resolved, lineage connects those tables to the query data model and then to the report dashboard. If data model ingestion is disabled or a query data model is filtered out, lineage connects the tables directly to the dashboard. The API token must have access to the spaces, reports, queries, charts, and data sources you want to ingest.

​
Requirements

OpenMetadata relies on Mode’s API, which is exclusive to members of the Mode Business Workspace. This means that only resources that belong to a Mode Business Workspace can be accessed via the API.

​
Python Requirements

Use a Python version supported by the openmetadata-ingestion package that matches your OpenMetadata server. To find the supported range for your release, check the Requires-Python metadata of that release’s ingestion package. To run the Mode ingestion, you will need to install:

​
Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Mode. In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server. The workflow is modeled around the following JSON Schema

​
1. Define the YAML Config

This is a sample config for Mode:

​
2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.