connectors

No menu items for this category

Run the MongoDB Connector Externally

FeatureStatus
StageBETA
Metadata
Query Usage
Data Profiler
Data Quality
Stored Procedures
Owners
Tags
DBT
Supported Versions--
FeatureStatus
Lineage
Table-level
Column-level

In this section, we provide guides and references to use the MongoDB connector.

Configure and schedule MongoDB metadata workflows from the OpenMetadata UI:

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 you want to install it manually in an already existing Airflow host, you can follow this guide.

If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to run the Ingestion Framework in any orchestrator 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.

OpenMetadata 0.12 or later

To deploy OpenMetadata, check the Deployment guides.

To fetch the metadata from MongoDB to OpenMetadata, the MongoDB user must have access to perform find operation on collection and listCollection operations on database available in MongoDB.

To run the MongoDB ingestion, you will need to install:

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to MongoDB.

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

This is a sample config for MongoDB:

username: Username to connect to Mongodb. This user must have access to perform find operation on collection and listCollection operations on database available in MongoDB.

password: Password to connect to MongoDB.

hostPort: The hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format hostname:port. E.g., localhost:27017.

connectionURI: MongoDB connection string is a concise string of parameters used to establish a connection between an OpenMetadata and a MongoDB database. For ex. mongodb://username:password@mongodb0.example.com:27017.

databaseName: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.

The sourceConfig is defined here:

markDeletedTables: To flag tables as soft-deleted if they are not present anymore in the source system.

includeTables: true or false, to ingest table data. Default is true.

includeViews: true or false, to ingest views definitions.

databaseFilterPattern, schemaFilterPattern, tableFilterPattern: Note that the filter supports regex as include or exclude. You can find examples here

To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.

The main property here is the openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.

Logger Level

You can specify the loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG will give you far more traces for identifying issues.

JWT Token

JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.

You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.

SSL Configuration

If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL to ignore, or have it as validate, which will require you to set the sslConfig.certificatePath with a local path where your ingestion runs that points to the server certificate file.

Find more information on how to troubleshoot SSL issues here.

Connection Options (Optional): Enter the details for any additional connection options that can be sent to Athena during the connection. These details must be added as Key-Value pairs.

filename.yaml

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.