GetMongoRecord

GetMongoRecord 2.0.0

Bundle: org.apache.nifi | nifi-mongodb-nar
Description: A record-based version of GetMongo that uses the Record writers to write the MongoDB result set.
Tags: fetch, get, json, mongo, mongodb, record
Input Requirement: ALLOWED
Supports Sensitive Dynamic Properties: false

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
Record Writer
The record writer to use to write the result sets.

Display Name

Record Writer

Description

The record writer to use to write the result sets.

API Name

get-mongo-record-writer-factory

Service Interface

org.apache.nifi.serialization.RecordSetWriterFactory

Service Implementations

org.apache.nifi.avro.AvroRecordSetWriter

org.apache.nifi.csv.CSVRecordSetWriter

org.apache.nifi.text.FreeFormTextRecordSetWriter

org.apache.nifi.json.JsonRecordSetWriter

org.apache.nifi.lookup.RecordSetWriterLookup

org.apache.nifi.record.script.ScriptedRecordSetWriter

org.apache.nifi.xml.XMLRecordSetWriter

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
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
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
Schema Name
The name of the schema in the configured schema registry to use for the query results.

Display Name

Schema Name

Description

The name of the schema in the configured schema registry to use for the query results.

API Name

mongodb-schema-name

Default Value

${schema.name}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
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
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

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.