GetMongoRecord

Description:

A record-based version of GetMongo that uses the Record writers to write the MongoDB result set.

Additional Details...

Tags:

mongo, mongodb, get, fetch, record, json

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

NameDefault ValueAllowable ValuesDescription
Client ServiceController Service API:
MongoDBClientService
Implementation: MongoDBControllerService
If configured, this property will use the assigned client service for connection pooling.
Record WriterController Service API:
RecordSetWriterFactory
Implementations: FreeFormTextRecordSetWriter
AvroRecordSetWriter
ParquetRecordSetWriter
ScriptedRecordSetWriter
JsonRecordSetWriter
RecordSetWriterLookup
CSVRecordSetWriter
XMLRecordSetWriter
The record writer to use to write the result sets.
Mongo Database NameThe name of the database to use
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Mongo Collection NameThe name of the collection to use
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Schema Name${schema.name}The name of the schema in the configured schema registry to use for the query results.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Query Output AttributeIf set, the query will be written to a specified attribute on the output flowfiles.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
QueryThe 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.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
ProjectionThe fields to be returned from the documents in the result set; must be a valid BSON document
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SortThe fields by which to sort; must be a valid BSON document
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
LimitThe maximum number of elements to return
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Batch SizeThe number of elements to be returned from the server in one batch
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
successAll FlowFiles that have the results of a successful query execution go here.
failureAll input FlowFiles that are part of a failed query execution go here.
originalAll input FlowFiles that are part of a successful query execution go here.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
mongo.database.nameThe database where the results came from.
mongo.collection.nameThe collection where the results came from.

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:

None specified.