GetMongo 2.3.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

PROPERTIES

Property

Description

Batch Size

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

Limit

The maximum number of elements to return

Mongo Collection Name

The name of the collection to use

Mongo Database Name

The name of the database to use

Projection

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

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.

Sort

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

get-mongo-send-empty

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

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.

mongo-charset

Specifies the character set of the document data.

mongo-client-service

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

mongo-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.

mongo-query-attribute

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

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.

use-pretty-printing

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

RELATIONSHIPS

NAME

DESCRIPTION

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.

success

All FlowFiles that have the results 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.

Language: English