The following document assumes that you understand the basics of connecting to databases on Appsmith. If not, please go over them before reading further.
Appsmith needs the following parameters for connecting to a Mongo database:
All required fields are suffixed with an asterisk (*).
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.
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.
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.
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).
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.
The mongo database command syntax is slightly different from the mongo collection methods you may be familiar with. Read more
Mongo by default returns only 101 records due to its default batchSize. This can be updated by setting the limit and batchSize fields to higher values in your query
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
Once you have successfully run a Query, you can use it in your application to