mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-22 14:07:26 +00:00
2aa2850651
* remove azureblobstorage.md * fix typo * fix broken link to query manager * update zendesk header to fix anchor tag * fix broken anchor tag * fix broken achor * fix broken anchor * fix broken anchor on set variables from runjs * replace global data source with just data source * fix achor for tooljet database env variables * fix available fk actions * fix filter operations link * remove obsolute anchor link for kanban * fix broken achor to query manager add * remove console.log to fix undefined log on build
109 lines
5.3 KiB
Markdown
109 lines
5.3 KiB
Markdown
---
|
|
id: mongodb
|
|
title: MongoDB
|
|
---
|
|
|
|
# MongoDB
|
|
|
|
ToolJet can connect to MongoDB to read and write data.
|
|
|
|
## Connection
|
|
|
|
Please make sure the host/ip of the database is accessible from your VPC if you have self-hosted ToolJet. If you are using ToolJet cloud, please whitelist our IP.
|
|
|
|
To add a new MongoDB, click on the `+` button on data sources panel at the left-bottom corner of the app editor. Select MongoDB from the modal that pops up.
|
|
|
|
ToolJet requires the following to connect to your MongoDB.
|
|
|
|
- **Host**
|
|
- **Port**
|
|
- **Username**
|
|
- **Password**
|
|
|
|
It is recommended to create a new MongoDB user so that you can control the access levels of ToolJet.
|
|
|
|
<img className="screenshot-full" src="/img/datasource-reference/mo-connect.png" alt="ToolJet - Mongo connection" height="250"/>
|
|
|
|
Click on 'Test connection' button to verify if the credentials are correct and that the database is accessible to ToolJet server. Click on 'Save' button to save the data source.
|
|
|
|
## Querying MongoDB
|
|
|
|
Click on `+` button of the query manager at the bottom panel of the editor and select the database added in the previous step as the data source. Select the operation that you want to perform and click 'Save' to save the query.
|
|
|
|
<img className="screenshot-full" src="/img/datasource-reference/mo-query.png" alt="ToolJet - Mongo query" height="250"/>
|
|
|
|
|
|
|
|
Click on the 'run' button to run the query. NOTE: Query should be saved before running.
|
|
|
|
:::tip
|
|
Query results can be transformed using transformations. Read our transformations documentation to see how: [link](/docs/tutorial/transformations)
|
|
:::
|
|
|
|
### Supported operations
|
|
- [List Collections](#list-collections)
|
|
- [Find One](#find-one)
|
|
- [Find Many](#find-many)
|
|
- [Total Count](#total-count)
|
|
- [Count](#count)
|
|
- [Distinct](#distinct)
|
|
- [Insert One](#insert-one)
|
|
- [Insert Many](#insert-many)
|
|
- [Update One](#update-one)
|
|
- [Update Many](#update-many)
|
|
- [Replace One](#replace-one)
|
|
- [Find One and Update](#find-one-and-update)
|
|
- [Find One and Replace](#find-one-and-replace)
|
|
- [Find One and Delete](#find-one-and-delete)
|
|
- [Aggregate](#aggregate)
|
|
- [Delete One](#delete-one)
|
|
- [Delete Many](#delete-many)
|
|
- [Bulk Operations](#bulk-operations)
|
|
#### List Collections
|
|
Returns list of collections
|
|
#### Find One
|
|
Return a document which satisfy the given filter and options. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/findOne)
|
|
#### Find Many
|
|
Return list of documents which satisfy the given filter and options. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/find/)
|
|
#### Total Count
|
|
Returns an estimation of the number of documents in the collection based on collection metadata. [Reference](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#estimateddocumentcount)
|
|
#### Count
|
|
Returns the number of documents based on the filter. [Reference](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#countdocuments)
|
|
#### Distinct
|
|
Retrieve a list of distinct values for a field based on the filter. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/distinct/)
|
|
#### Insert One
|
|
Insert a document. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/insertOne/)
|
|
#### Insert Many
|
|
Insert list of documents. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/insertMany/)
|
|
#### Update One
|
|
Update a document based on the filter. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/updateOne/)
|
|
#### Update Many
|
|
Update many documents based on the filter. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/updateMany/)
|
|
#### Replace One
|
|
Replace a document based on filter. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/replaceOne/)
|
|
#### Find One and Update
|
|
If your application requires the document after updating, use this instead of `Update One`. [Reference](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#findoneandupdate)
|
|
#### Find One and Replace
|
|
If your application requires the document after updating, use this instead of `Replace One`. [Reference](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#findoneandreplace)
|
|
#### Find One and Delete
|
|
If your application requires the document after deleting, use this instead of `Delete One`. [Reference](https://mongodb.github.io/node-mongodb-native/4.0/classes/collection.html#findoneanddelete)
|
|
#### Aggregate
|
|
Aggregation operations are expressions you can use to produce reduced and summarized results. [Reference](https://docs.mongodb.com/drivers/node/v4.0/fundamentals/aggregation/)
|
|
#### Delete One
|
|
Delete a record based on the filter. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/deleteOne/)
|
|
#### Delete Many
|
|
Delete many records based on the filter. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/deleteMany/)
|
|
#### Bulk Operations
|
|
Perform bulk operations. [Reference](https://docs.mongodb.com/drivers/node/v4.0/usage-examples/bulkWrite/)
|
|
|
|
### Dynamic Quries
|
|
```javascript
|
|
{ amount: { $lt: '{{ components.textinput1.value }}' }}
|
|
|
|
// Dates
|
|
// supported: Extended JSON syntax
|
|
{ createdAt: { $date: '{{ new Date('01/10/2020') }}'} }
|
|
// not supported: MongoDB classic syntax
|
|
{ createdAt: new Date('01/10/2020') }
|
|
```
|
|
Reference on [mongodb extended JSON](https://docs.mongodb.com/manual/reference/mongodb-extended-json/) supported data types
|