Connection Settings

Appsmith needs the following parameters for connecting to a Mongo database:

Connection

You need to fill in the following parameters:

• Connection Mode*: You must choose one of the following two modes:

  • Read Only: Choosing this mode gives Appsmith read-only permission on the database. This allows you to only fetch data from the database.

  • Read / Write: Choosing this mode gives Appsmith both read and write permissions on the database. This allows you to execute all CRUD queries.

• Connection Type*: You must choose one of the following connection types:

  • Direct Connection: Choose this connection type to connect directly to a mongo instance

  • Replicate Set: Choose this connection type to connect to a set of mongo instances.

• Host Address / Port*: Fill in the database host’s address and port. If you don’t specify a port, Appsmith

  will try to connect to port 27017. You can specify multiple host addresses for a replicate set. In case you have

  an SRV URL please follow these steps to connect to your mongodb instance.

• Default Database Name*: Fill in the name of the database that you want to connect to. This is your database’s name in your mongo server.

Connect using SRV URL

• Set Connection Type field to Replica set.

• An SRV URL is of

  the format `mongodb+srv://:<your_password>@/?

  authSource=…` . Please extract and copy the fields as below:

  • <connection_url> to the Host Address field

  • <defaultDbName> to the Default Database Name field

  • <your_username> to the Username field

  • <your_password> to the Password field

  • <authDbName> to the Database Name field under the Authentication sub-section.

Authentication

You need to fill in the following parameters:

• Database Name: Fill in the name of the database against which you want to authenticate. This is typically admin for most MongoDB instances.

• Authentication Type*: Choose the authentication mechanism with which to connect to your database. This can be one of SCRAM-SHA-1, SCRAM-SHA-256, MONGO-CR.

• Username: Fill username required for authenticating connection requests to your database. Set this to empty if you won't want to specify a username to authenticate with.

• Password: Fill password required for authenticating connection requests for the given username to the database. Set this to empty if you want to login without a password (please ensure your database accepts such connections).

SSL

You need to fill in the following parameters:

• Authentication Mechanism: Choose the SSL method of authentication or select No SSL if none is required.

• CA Certificate: Upload your CA certificate here.

Querying Mongo

All mongo queries return an array of objects where each object is a mongo document and properties of the object are the keys of the document.

Appsmith provides template queries to help with the syntax

• ​Insert Query​

• ​Find Query​

• ​Update Query​

• ​Delete Query​

Using Queries in applications

Once you have successfully run a Query, you can use it in your application to

• ​Display Data​

• ​Capture Data​