PutMongoRecord

Description:

This processor is a record-aware processor for inserting/upserting data into MongoDB. It uses a configured record reader and schema to read an incoming record set from the body of a flowfile and then inserts/upserts batches of those records into a configured MongoDB collection. This processor does not support deletes. The number of documents to insert/upsert at a time is controlled by the "Batch Size" configuration property. This value should be set to a reasonable size to ensure that MongoDB is not overloaded with too many operations at once.

Tags:

mongodb, insert, update, upsert, record, put

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.

Display Name	API Name	Default Value	Allowable Values	Description
Client Service	mongo-client-service		Controller Service API: MongoDBClientService Implementation: MongoDBControllerService	If configured, this property will use the assigned client service for connection pooling.
Mongo Database Name	Mongo Database Name			The name of the database to use Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
Mongo Collection Name	Mongo Collection Name			The name of the collection to use Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
Record Reader	record-reader		Controller Service API: RecordReaderFactory Implementations: CSVReader JsonPathReader AvroReader CEFReader Syslog5424Reader JsonTreeReader WindowsEventLogReader XMLReader SyslogReader JASN1Reader ReaderLookup ParquetReader GrokReader ScriptedReader YamlTreeReader ExcelReader	Specifies the Controller Service to use for parsing incoming data and determining the data's schema
Batch Size	insert_count	100		The number of records to group together for one single insert/upsert operation against MongoDB.
Ordered	ordered	False	True False	Perform ordered or unordered operations
Bypass Validation	bypass-validation	False	True False	Enable or disable bypassing document schema validation during insert or update operations. Bypassing document validation is a Privilege Action in MongoDB. Enabling this property can result in authorization errors for users with limited privileges.
Update Key Fields	update-key-fields			Comma separated list of fields based on which to identify documents that need to be updated. If this property is set NiFi will attempt an upsert operation on all documents. If this property is not set all documents will be inserted.
Update Mode	update-mode	Update One	Update One Update Many Use 'mongodb.update.mode' flowfile attribute.	Choose between updating a single document or multiple documents per incoming record. This Property is only considered if the [Update Key Fields] Property has a value specified.

Relationships:

Name	Description
success	All FlowFiles that are written to MongoDB are routed to this relationship
failure	All FlowFiles that cannot be written to MongoDB are routed to this relationship

Reads Attributes:

Name	Description
mongodb.update.mode	Configurable parameter for controlling update mode on a per-flowfile basis. Acceptable values are 'one' and 'many' and controls whether a single incoming record should update a single or multiple Mongo documents.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.