Get Documents
Description
MongoDB: Get Documents plugin step gets the list of documents for the specified criteria.
Reference https://www.mongodb.com/docs/manual/tutorial/query-documents/
Configurations
| No. | Field Name | Description |
|---|---|---|
| Connection | ||
| 2 | Deployment Type | Deployment Type differentiates between on cloud or on premise instances. Select the type of deployment you require. Available values: On-Cloud or On-Premise. The data type is String. This field is mandatory. |
| 3 | Host Name | Specify the host name based on the type of deployment you selected. Therefore, if deployment type is On-Cloud specify the cluster name and for On-Premise specify the IP address of the machine. The data type is String. This field is mandatory. |
| 4 | Port | Specify the port number of the MongoDB instance. The default value is 27017. Note: Port number is mandatory for Deployment Type: On-Premise. |
| 5 | Username | Specify a username to access the database. The data type is String. This field is mandatory. |
| Password: | ||
| 6 | Accept Values from fields | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| 7 | Password | Specify the password for the username. If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. The data type is String. This field is mandatory. |
| 8 | Button: Test Connection | Verifies whether the connection is available or not. For the purpose of verification fields coming from previous steps are not allowed. Static values and environment variables are allowed. |
| Input Fields: | ||
| 1 | Database Name | Select a database name to retrieve records. The data type is String. This field is mandatory. |
| 2 | Get | On click of this button, if connection is successfully established, it populates a list of database names on MongoDB Server. |
| 3 | Collection Name | Specify the collection name from which you want to retrieve the documents. The data type is String. This field is mandatory. |
| 4 | Get | On click of this button, if connection is successfully established, it populate a list of collections for the specified database. |
| 5 | Criteria Query | Specify a combination of static values or variables and the previous step. The Criteria Query expression uses MongoDB’s JSON-like query language with query operators to perform query operations. Note: Query must be same as MongoDB Compass. Sample Query: 1. { status: "D" } 2. { status: { $in: [ "A", "D" ] } } 3. { status: "A", qty: { $lt: 30 } } |
| 6 | Batch Size | Specify the batch size to fetch the records. The default batch size is10. The data type is String. This field is mandatory. |
| Output Tab: | ||
| 1 | Output | Specify an output field to hold the result of the successful plugin execution. Default value: Result |