Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

82 lines
3.3 KiB
Markdown
Raw Permalink Normal View History

2024-06-18 15:53:06 +02:00
---
title: MongoDB Connector | OpenMetadata NoSQL Database Integration
2024-06-18 15:53:06 +02:00
slug: /connectors/database/mongodb
---
{% connectorDetailsHeader
name="MongoDB"
stage="PROD"
platform="OpenMetadata"
availableFeatures=["Metadata", "Data Profiler", "Sample Data"]
2024-06-18 15:53:06 +02:00
unavailableFeatures=["Query Usage", "Data Quality", "dbt", "Owners", "Lineage", "Column-level Lineage", "Tags", "Stored Procedures"]
/ %}
In this section, we provide guides and references to use the MongoDB connector.
Configure and schedule MongoDB metadata workflows from the OpenMetadata UI:
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
- [Data Profiler](#data-profiler)
- [Troubleshooting](/connectors/database/mongodb/troubleshooting)
2024-06-18 15:53:06 +02:00
{% partial file="/v1.8/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/mongodb/yaml"} /%}
2024-06-18 15:53:06 +02:00
## Requirements
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.
## Metadata Ingestion
{% partial
file="/v1.8/connectors/metadata-ingestion-ui.md"
2024-06-18 15:53:06 +02:00
variables={
connector: "MongoDB",
selectServicePath: "/images/v1.8/connectors/mongodb/select-service.png",
addNewServicePath: "/images/v1.8/connectors/mongodb/add-new-service.png",
serviceConnectionPath: "/images/v1.8/connectors/mongodb/service-connection.png",
2024-06-18 15:53:06 +02:00
}
/%}
{% stepsContainer %}
{% extraContent parentTagName="stepsContainer" %}
#### Connection Details
- **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.
- **Host Port**: When using the `mongodb` connecion schema, 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`. When using the `mongodb+srv` connection schema, the hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format `hostname`. E.g., `cluster0-abcde.mongodb.net`.
2024-06-18 15:53:06 +02:00
- **databaseName**: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
Using Atlas? Follow [this guide](https://www.mongodb.com/docs/guides/atlas/connection-string/) to get the connection string.
{% partial file="/v1.8/connectors/database/advanced-configuration.md" /%}
2024-06-18 15:53:06 +02:00
{% /extraContent %}
{% partial file="/v1.8/connectors/test-connection.md" /%}
2024-06-18 15:53:06 +02:00
{% partial file="/v1.8/connectors/database/configure-ingestion.md" /%}
2024-06-18 15:53:06 +02:00
{% partial file="/v1.8/connectors/ingestion-schedule-and-deploy.md" /%}
2024-06-18 15:53:06 +02:00
{% /stepsContainer %}
{% partial file="/v1.8/connectors/database/related.md" /%}
2024-06-18 15:53:06 +02:00
## Data Profiler
{%inlineCallout icon="description" bold="OpenMetadata 1.3.1 or later" href="/deployment"%}
To deploy OpenMetadata, check the Deployment guides.
{%/inlineCallout%}
[Profiler deployment](/how-to-guides/data-quality-observability/profiler/workflow)
2024-06-18 15:53:06 +02:00
### Limitations
The MongodDB data profiler current supports only the following features:
1. **Row count**: The number of rows in the collection. Sampling or custom query is not supported.
2. **Sample data:** If a custom query is defined it will be used for sample data.