MongoDB connector¶
Summary¶
The MongoDB connector establishes access to MongoDB.
The MongoDB connector provides an interface for creating a MongoDB connection, the foundation used for generating instances of MongoDB activities. These activities, once configured, interact with a MongoDB database through the connection.
The MongoDB connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).
Connector overview¶
This connector is used to first configure a MongoDB connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).
Together, a specific MongoDB connection and its activities are referred to as a MongoDB endpoint:
-
Query: Retrieves data from a MongoDB collection and is intended to be used as a source in an operation.
-
Upsert: Updates existing data or inserts new data into a MongoDB collection and is intended to be used as a target in an operation.
-
Insert: Inserts new data into a MongoDB collection and is intended to be used as a target in an operation.
-
Update: Updates existing data in a MongoDB collection and is intended to be used as a target in an operation.
-
Delete: Deletes data from a MongoDB collection and is intended to be used as a target in an operation.
Note
This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.
Prerequisites and supported API versions¶
The MongoDB connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.
The MongoDB connector uses the MongoDB Java Driver v4.1. Refer to the driver documentation and the MongoDB reference for information on the schema nodes and fields.
To use the MongoDB connector, you need the following as described in MongoDB prerequisites:
- A MongoDB cluster and valid credentials to access it.
- The hostname of the cluster.
- The name of the database with an existing collection.
- Have any relevant agent IP addresses added to the cluster's allowlist.
Troubleshooting¶
If you experience issues with the MongoDB connector, these troubleshooting steps are recommended:
-
Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).
-
Check the operation logs for any information written during execution of the operation.
-
Enable operation debug logging (for cloud agents or for private agents) to generate additional log files and data.
-
If using private agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:
<logger name="org.jitterbit.connector.mongodb" level="DEBUG"/>
-
If using private agents, you can check the agent logs for more information.
-
For additional troubleshooting considerations, see Operation troubleshooting.