GetMongo

GetMongo 2.0.0

Bundle: org.apache.nifi | nifi-mongodb-nar
Description: Creates FlowFiles from documents in MongoDB loaded by a user-specified query.
Tags: get, mongodb, read
Input Requirement: ALLOWED
Supports Sensitive Dynamic Properties: false

Additional Details for GetMongo 2.0.0
GetMongo

Description:

This processor runs queries against a MongoDB instance or cluster and writes the results to a flowfile. It allows input, but can run standalone as well.

Specifying the Query

The query can be specified in one of three ways:
- Query configuration property.
- Query Attribute configuration property.
- FlowFile content.
If a value is specified in either of the configuration properties, it will not look in the FlowFile content for a query.

Limiting/Shaping Results

The following options for limiting/shaping results are available:
- Limit - limit the number of results. This should not be confused with the “batch size” option which is a setting for the underlying MongoDB driver to tell it how many items to retrieve in each poll of the server.
- Sort - sort the result set. Requires a JSON document like { “someDate”: -1 }
- Projection - control which fields to return. Exampe, which would remove _id: { “_id”: 0 }
Misc Options

Results Per FlowFile, if set, creates a JSON array out of a batch of results and writes the result to the output. Pretty Print, if enabled, will format the JSON data to be easy read by a human (ex. proper indentation of fields).

Properties

Batch Size
The number of elements to be returned from the server in one batch

Display Name

Batch Size

Description

The number of elements to be returned from the server in one batch

API Name

Batch Size

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Send Empty Result
If a query executes successfully, but returns no results, send an empty JSON document signifying no result.
Display Name

Send Empty Result

Description

If a query executes successfully, but returns no results, send an empty JSON document signifying no result.

API Name

get-mongo-send-empty

Default Value

false

Allowable Values
- true
- false
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
Limit
The maximum number of elements to return

Display Name

Limit

Description

The maximum number of elements to return

API Name

Limit

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
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
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
Projection
The fields to be returned from the documents in the result set; must be a valid BSON document

Display Name

Projection

Description

The fields to be returned from the documents in the result set; must be a valid BSON document

API Name

Projection

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Query
The selection criteria to do the lookup. If the field is left blank, it will look for input from an incoming connection from another processor to provide the query as a valid JSON document inside of the FlowFile's body. If this field is left blank and a timer is enabled instead of an incoming connection, that will result in a full collection fetch using a "{}" query.

Display Name

Query

Description

The selection criteria to do the lookup. If the field is left blank, it will look for input from an incoming connection from another processor to provide the query as a valid JSON document inside of the FlowFile's body. If this field is left blank and a timer is enabled instead of an incoming connection, that will result in a full collection fetch using a "{}" query.

API Name

Query

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

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Sort
The fields by which to sort; must be a valid BSON document

Display Name

Sort

Description

The fields by which to sort; must be a valid BSON document

API Name

Sort

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Pretty Print Results JSON
Choose whether or not to pretty print the JSON from the results of the query. Choosing 'True' can greatly increase the space requirements on disk depending on the complexity of the JSON document
Display Name

Pretty Print Results JSON

Description

Choose whether or not to pretty print the JSON from the results of the query. Choosing 'True' can greatly increase the space requirements on disk depending on the complexity of the JSON document

API Name

use-pretty-printing

Default Value

true

Allowable Values
- True
- False
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Relationships

Name	Description
success	All FlowFiles that have the results of a successful query execution go here.
failure	All input FlowFiles that are part of a failed query execution go here.
original	All input FlowFiles that are part of a successful query execution go here.

Writes Attributes

Name	Description
mongo.database.name	The database where the results came from.
mongo.collection.name	The collection where the results came from.

GetMongo 2.0.0

GetMongo

Description:

Specifying the Query

Limiting/Shaping Results

Misc Options