Add MongoDB Panel
Overview
The Add MongoDB panel allows administrators and data engineers to securely connect document-oriented MongoDB databases and clusters to the DataFloem platform.
Connections established through this interface serve as operational storage nodes within data pipelines, enabling jobs to query, extract, and transform BSON/JSON document collections or write processed payloads into target MongoDB collections.
Access Requirements
To access this page, the user must either have Administrator privileges or the CREATE permission for the Target module.
The CREATE permission allows users to create new groups. Users without administrator privileges or the required permission cannot access this page.
If you do not have the required permission, ask your administrator to grant it from one of the authorization pages below.
Authorization
Users without the required authorization will receive the following error:
Access Denied
You don't have access to this resource.
Prerequisites
Before establishing a MongoDB connection, ensure that:
- Network line connectivity and firewall policies allow traffic between DataFloem and the MongoDB Endpoint/Port.
- You possess valid user credentials provisioned with sufficient read/write permissions on target databases and collections.
-
You have verified the specific authentication source (
Auth SourceandAuth Database Name).
Form Elements
The fields that need to be configured within the panel are as follows:
| Field | Required? | Description |
|---|---|---|
| Connection Name | Yes | A unique alias identifying this MongoDB connection across the platform. |
| Database Version | Yes (Dropdown) | Selects the precise version mapping to invoke correct client drivers (e.g., v5.0, v6.0). |
| Is Active | Yes (Toggle) |
Defines whether the connection is active immediately upon
deployment. Enabled (on) by default.
|
| Endpoint | Yes | The IP address or domain URL of the target MongoDB instance or cluster router. |
| Port | Yes |
The service communication port (e.g., default MongoDB port
27017).
|
| Username | Yes | The authorized MongoDB account username. |
| Password | Yes | The credential password (Visibility can be toggled using the eye icon). |
| Auth Source | Yes |
The authentication source directive parameter (e.g.,
admin or
scram-sha-256).
|
| Auth Database Name | Yes |
The specific database name against which user credentials are
authenticated (Typically admin).
|
| Test Connection | Button | Simulates an immediate end-to-end handshake with the target MongoDB server. |
| Optional Parameters (Name / Value) | No |
Dynamic entries used to pass fine-grained driver parameters (e.g.,
replicaSet,
readPreference,
ssl).
|
| Is Secret (Optional Parameters) | Yes (Toggle) | Encrypts and masks the specific parameter value within internal stores. |
Test Connection Behavior
-
Clicking the Test Connection button triggers a
real-time verification handshake with the target MongoDB server using
the provided
Endpoint,Port,Username,Password,Auth Source, andAuth Database Nameparameters. - If the handshake succeeds, a green success banner is displayed confirming network connectivity.
- If the handshake fails, a red error prompt appears detailing network or authentication issues. Validating the connection prior to saving is highly recommended.
MongoDB Connection Deployment Process
- Click the Add MongoDB action button on the workspace dashboard to trigger the side panel.
- Enter a unique Connection Name and designate the target Database Version.
- Input your server parameters into the Endpoint and Port fields.
- Fill in your credential parameters including Username, Password, Auth Source, and Auth Database Name.
- If required, add custom key-value arguments under Optional Parameters and toggle Is Secret appropriately.
- Click Test Connection to confirm connectivity to the target database server.
- Once validated, click Save to commit the asset to the platform, or click Cancel to abort the operation.
Validation Rules
- Connection Name, Endpoint, Port, Username, Password, Auth Source, and Auth Database Name fields cannot be left empty.
- The Port field must contain a valid numerical integer within the port range (1-65535).