mongodb logo

Prerequisites

  • Access credentials
  • MongoDB database and collection name

Connection Properties

The following table describes the fields available when creating a new MongoDB Connection. Create a connection using the information below and these step-by-step instructions.

FieldRequiredDescription
Access TypeRequiredThe access type is Read-Only.
Connection NameRequiredThe name to identify this connection with, such as 'MongoDB'.
HostRequiredIP or the hostname of the MongoDB server.
PortRequiredHost server port number.
Database NameRequiredName of the database.
Connection String ParameterOptionalThe URI for connections between applications and MongoDB instances. Learn More
Support a DNS-Constructed Seed ListOptionalUsing DNS to construct the available servers list allows more flexibility of deployment and the ability to change the servers in rotation without reconfiguring clients. See MongoDB Connection String URI Format.
Choose CredentialsOptionalChoose from existing credentials or create new credential for connecting to MongoDB server if 'Required Credentials' checkbox is selected.

Credential Properties

The following table describes the fields available when creating a new MongoDB credential.

FieldRequiredDescription
Credential NameRequiredThe name to identify this credential with. This credential will be available as a selection for future use.
Credential TypeRequiredThis field will automatically populate with MongoDB.
UserRequiredUsername for the MongoDB account.
PasswordRequiredPassword for the MongoDB account.

Read Connector Properties

The following table describes the fields available when creating a new MongoDB Read Connector. Create a new Read Connector using the information below and these step-by-step instructions.

FieldRequiredDescription
NameRequiredProvide a name for your connector. We recommend using lowercase with underscores in place of spaces.
DescriptionOptionalDescribes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons.
Collection NameRequiredMongoDB stores documents in collections. Collections are analogous to tables in relational databases. Learn More
Replication StrategyOptionalFull Resync or Change Data Capture. See Database Reading Strategies for more information.