RunMongoAggregation
Description
A processor that runs an aggregation query whenever a flowfile is received.
Tags
aggregate, aggregation, mongo
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Client Service | mongo-client-service | Controller Service: MongoDBClientService Implementations: MongoDBControllerService | If configured, this property will use the assigned client service for connection pooling. | |
| Mongo Database Name * | Mongo Database Name | The name of the database to use Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Mongo Collection Name * | Mongo Collection Name | The name of the collection to use Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Character Set * | mongo-charset | UTF-8 | Specifies the character set of the document data. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Query * | mongo-agg-query | The aggregation query to be executed. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Allow Disk Use * | allow-disk-use | false |
| Set this to true to enable writing data to temporary files to prevent exceeding the maximum memory use limit during aggregation pipeline staged when handling large datasets. |
| JSON Type * | json-type | Extended JSON |
| By default, MongoDB's Java driver returns "extended JSON". Some of the features of this variant of JSON may cause problems for other JSON parsers that expect only standard JSON types and conventions. This configuration setting controls whether to use extended JSON or provide a clean view that conforms to standard JSON. |
| Query Output Attribute | mongo-query-attribute | If set, the query will be written to a specified attribute on the output flowfiles. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Batch Size | Batch Size | 100 | The number of elements returned from the server in one batch. | |
| Results Per FlowFile | results-per-flowfile | 1 | How many results to put into a flowfile at once. The whole body will be treated as a JSON array of results. | |
| Date Format | mongo-date-format | yyyy-MM-dd'T'HH:mm:ss'Z' | The date format string to use for formatting Date fields that are returned from Mongo. It is only applied when the JSON output format is set to Standard JSON. Supports Expression Language, using FlowFile attributes and Environment variables. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | The input flowfile gets sent to this relationship when the query fails. |
| original | The input flowfile gets sent to this relationship when the query succeeds. |
| results | The result set of the aggregation will be sent to this relationship. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
This processor does not write attributes.
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component allows an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.