MongoDB Connector for Data Prep¶
User Persona: Data Prep User, Data Prep Admin, or Data Source Admin
This document covers all configuration fields available during connector setup. Some fields may have already been filled out by your Administrator at an earlier step of configuration and may not be visible to you. For more information on Data Prep's connector framework, see Data Prep Connector setup. Also, your Admin may have named this connector something else in the list of Data Sources.
Configure Data Prep¶
This connector allows you to connect to MongoDB for browsing and importing available data. The following fields are used to define the connection parameters.
- Name: Name of the data source as it will appear to users in the UI.
- Description: Description of the data source as it will appear to users in the UI.
You can connect Data Prep to multiple MongoDB deployments. Using a descriptive name can be a big help to users in identifying the appropriate data source.
Server: The hostname or IP address of the server hosting the MongoDB instance. If connecting to a replica set, use the hostname or IP address of one of the servers.
Port: The port for connecting to MongoDB. The default port is 27017.
User: The MongoDB user.
Password: The MongoDB user's password.
Use SSL: This field sets whether SSL is enabled.
Timeout: The number of seconds to wait until an operation times out. If set to 0, operations never time out.
Database Type Configuration¶
Database Type: Connect to a standalone MongoDB instance or to a replica set
Database Name: MongoDB database name. The database name is required when connecting to a standalone instance. When connecting to a replica set, if this field is left blank, all available databases will be displayed in the import UI
If connecting to a replica set:
Replica Set: A comma-separated list of secondary servers (server:port). This allows you to specify multiple servers in addition to the one configured in Server and Port
Read Preference: Strategy for reading from a replica set. See Read Preferences for more details.
Data Import Information¶
Browsing will allow you to view a list of databases and collections within MongoDB. If connecting to a MongoDB replica set, all databases can be browsed if no database was specified in the configuration. If a database was specified, only the collections within that database can be browsed.
Via SQL Query¶
Data Prep uses MongoDB as its metadata store. Using this Connector to connect to Data Prep's own MongoDB replica set is not an intended or recommended use case for this Connector. We cannot guarantee the performance and correct functioning of the connector and of Data Prep itself when it is used in this way.
If your intent is to read Data Prep metadata, please periodically create a backup of the data in Data Prep MongoDB metadata store and restore the backup in a separate instance of MongoDB, then point the Connector at that instance.