RunMongoAggregation 2.0.0

Bundle: org.apache.nifi | nifi-mongodb-nar
Description: A processor that runs an aggregation query whenever a flowfile is received.
Tags: aggregate, aggregation, mongo
Input Requirement: ALLOWED
Supports Sensitive Dynamic Properties: false

Additional Details for RunMongoAggregation 2.0.0

RunMongoAggregation

Description:

This processor runs a MongoDB aggregation query based on user-defined settings. The following is an example of such a query (and what the expected input looks like):

[
  {
    "$project": {
      "domain": 1
    },
    "$group": {
      "_id": {
        "domain": "$domain"
      },
      "total": {
        "$sum": 1
      }
    }
  }
]

Properties

Allow Disk Use
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.
Display Name

Allow Disk Use

Description

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.

API Name

allow-disk-use

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Batch Size
The number of elements returned from the server in one batch.

Display Name

Batch Size

Description

The number of elements returned from the server in one batch.

API Name

Batch Size

Default Value

100

Expression Language Scope

Not Supported

Sensitive

false

Required

false
JSON Type
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.
Display Name

JSON Type

Description

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.

API Name

json-type

Default Value

Extended

Allowable Values
- Extended JSON
- Standard JSON
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Mongo Collection Name
The name of the collection to use

Display Name

Mongo Collection Name

Description

The name of the collection to use

API Name

Mongo Collection Name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Mongo Database Name
The name of the database to use

Display Name

Mongo Database Name

Description

The name of the database to use

API Name

Mongo Database Name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Query
The aggregation query to be executed.

Display Name

Query

Description

The aggregation query to be executed.

API Name

mongo-agg-query

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Character Set
Specifies the character set of the document data.

Display Name

Character Set

Description

Specifies the character set of the document data.

API Name

mongo-charset

Default Value

UTF-8

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Client Service
If configured, this property will use the assigned client service for connection pooling.

Display Name

Client Service

Description

If configured, this property will use the assigned client service for connection pooling.

API Name

mongo-client-service

Service Interface

org.apache.nifi.mongodb.MongoDBClientService

Service Implementations

org.apache.nifi.mongodb.MongoDBControllerService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Date Format
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.

Display Name

Date Format

Description

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.

API Name

mongo-date-format

Default Value

yyyy-MM-dd'T'HH:mm:ss'Z'

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Query Output Attribute
If set, the query will be written to a specified attribute on the output flowfiles.

Display Name

Query Output Attribute

Description

If set, the query will be written to a specified attribute on the output flowfiles.

API Name

mongo-query-attribute

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Results Per FlowFile
How many results to put into a flowfile at once. The whole body will be treated as a JSON array of results.

Display Name

Results Per FlowFile

Description

How many results to put into a flowfile at once. The whole body will be treated as a JSON array of results.

API Name

results-per-flowfile

Default Value

1

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Relationships

Name	Description
results	The result set of the aggregation will be sent to this relationship.
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.