org.apache.nifinifi-mongodb-nar2.2.0org.apache.nifinifi-mongodb-client-service-api-nar2.2.02.0.0rel/nifi-2.2.0main1org.apache.nifi.processors.mongodb.DeleteMongoPROCESSORExecutes a delete query against a MongoDB collection. The query is provided in the body of the flowfile and the user can select whether it will delete one or many documents that match it.deletemongomongodbmongo-client-serviceClient ServiceIf configured, this property will use the assigned client service for connection pooling.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0falsefalsefalseNONEfalsefalseMongo Database NameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseMongo Collection NameMongo Collection NameThe name of the collection to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsedelete-mongo-delete-modeDelete ModeChoose between deleting one document by query or many documents by query.oneDelete OneoneDelete only the first document that matches the query.Delete ManymanyDelete every document that matches the query.Use 'mongodb.delete.mode' attributeattrRead the 'mongodb.delete.mode attribute and use that mode. Acceptable values are 'many' and 'one.'falsefalsefalseNONEfalsefalsedelete-mongo-fail-on-no-deleteFail When Nothing Is DeletedDetermines whether to send the flowfile to the success or failure relationship if nothing is successfully deleted.trueTruetrueFail when no documents are deleted.FalsefalseDo not fail when nothing is deleted.falsefalsefalseNONEfalsefalsesuccessAll FlowFiles that are written to MongoDB are routed to this relationshipfalsefailureAll FlowFiles that cannot be written to MongoDB are routed to this relationshipfalsemongodb.delete.modeConfigurable parameter for controlling delete mode on a per-flowfile basis. The process must be configured to use this option. Acceptable values are 'one' and 'many.'INPUT_REQUIREDorg.apache.nifi.processors.mongodb.GetMongoPROCESSORCreates FlowFiles from documents in MongoDB loaded by a user-specified query.mongodbreadgetmongo-client-serviceClient ServiceIf configured, this property will use the assigned client service for connection pooling.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0falsefalsefalseNONEfalsefalseMongo Database NameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseMongo Collection NameMongo Collection NameThe name of the collection to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsejson-typeJSON TypeBy 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.ExtendedExtended JSONExtendedUse MongoDB's "extended JSON". This is the JSON generated with toJson() on a MongoDB Document from the Java driverStandard JSONStandardGenerate a JSON document that conforms to typical JSON conventions instead of Mongo-specific conventions.truefalsefalseNONEfalsefalseuse-pretty-printingPretty Print Results JSONChoose 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 documenttrueTruetrueFalsefalsetruefalsefalseNONEfalsefalsemongo-charsetCharacter SetSpecifies the character set of the document data.UTF-8truefalsetrueFLOWFILE_ATTRIBUTESfalsefalseQueryQueryThe 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.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsemongo-query-attributeQuery Output AttributeIf set, the query will be written to a specified attribute on the output flowfiles.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseProjectionProjectionThe fields to be returned from the documents in the result set; must be a valid BSON documentfalsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseSortSortThe fields by which to sort; must be a valid BSON documentfalsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseLimitLimitThe maximum number of elements to returnfalsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseBatch SizeBatch SizeThe number of elements to be returned from the server in one batchfalsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseresults-per-flowfileResults Per FlowFileHow many results to put into a FlowFile at once. The whole body will be treated as a JSON array of results.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsemongo-date-formatDate FormatThe 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.yyyy-MM-dd'T'HH:mm:ss'Z'falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseget-mongo-send-emptySend Empty ResultIf a query executes successfully, but returns no results, send an empty JSON document signifying no result.falsetruetruefalsefalsefalsefalsefalseNONEfalsefalsefailureAll input FlowFiles that are part of a failed query execution go here.falsesuccessAll FlowFiles that have the results of a successful query execution go here.falseoriginalAll input FlowFiles that are part of a successful query execution go here.falsemongo.database.nameThe database where the results came from.mongo.collection.nameThe collection where the results came from.INPUT_ALLOWEDorg.apache.nifi.processors.mongodb.GetMongoRecordPROCESSORA record-based version of GetMongo that uses the Record writers to write the MongoDB result set.mongomongodbgetfetchrecordjsonmongo-client-serviceClient ServiceIf configured, this property will use the assigned client service for connection pooling.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0falsefalsefalseNONEfalsefalseget-mongo-record-writer-factoryRecord WriterThe record writer to use to write the result sets.org.apache.nifi.serialization.RecordSetWriterFactoryorg.apache.nifinifi-standard-services-api-nar2.2.0truefalsefalseNONEfalsefalseMongo Database NameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseMongo Collection NameMongo Collection NameThe name of the collection to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsemongodb-schema-nameSchema NameThe name of the schema in the configured schema registry to use for the query results.${schema.name}truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsemongo-query-attributeQuery Output AttributeIf set, the query will be written to a specified attribute on the output flowfiles.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseQueryQueryThe 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.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseProjectionProjectionThe fields to be returned from the documents in the result set; must be a valid BSON documentfalsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseSortSortThe fields by which to sort; must be a valid BSON documentfalsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseLimitLimitThe maximum number of elements to returnfalsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseBatch SizeBatch SizeThe number of elements to be returned from the server in one batchfalsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsefailureAll input FlowFiles that are part of a failed query execution go here.falsesuccessAll FlowFiles that have the results of a successful query execution go here.falseoriginalAll input FlowFiles that are part of a successful query execution go here.falsemongo.database.nameThe database where the results came from.mongo.collection.nameThe collection where the results came from.INPUT_ALLOWEDorg.apache.nifi.processors.mongodb.PutMongoPROCESSORWrites the contents of a FlowFile to MongoDBmongodbinsertupdatewriteputmongo-client-serviceClient ServiceIf configured, this property will use the assigned client service for connection pooling.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0falsefalsefalseNONEfalsefalseMongo Database NameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseMongo Collection NameMongo Collection NameThe name of the collection to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseModeModeIndicates whether the processor should insert or update contentinsertinsertinsertupdateupdatetruefalsefalseNONEfalsefalseUpsertUpsertWhen true, inserts a document if no document matches the update query criteria; this property is valid only when using update mode, otherwise it is ignoredfalsetruetruefalsefalsetruefalsefalseNONEfalsefalseModeModeupdateUpdate Query KeyUpdate Query KeyOne or more comma-separated document key names used to build the update query criteria, such as _idfalsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseModeModeupdateputmongo-update-queryUpdate QuerySpecify a full MongoDB query to be used for the lookup query to do an update/upsert. NOTE: this field is ignored if the 'Update Query Key' value is not empty.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseModeModeupdateput-mongo-update-modeUpdate ModeChoose an update mode. You can either supply a JSON document to use as a direct replacement or specify a document that contains update operators like $set, $unset, and $inc. When Operators mode is enabled, the flowfile content is expected to be the operator part for example: {$set:{"key": "value"},$inc:{"count":1234}} and the update query will come from the configured Update Query property.docWith whole documentdocWith operators enabledoperatorstruefalsefalseNONEfalsefalseModeModeupdateUpdate MethodUpdate MethodMongoDB method for running collection update operations, such as updateOne or updateManyoneUpdate OneoneUpdates only the first document that matches the query.Update ManymanyUpdates every document that matches the query.Use 'mongodb.update.mode' FlowFile attribute.flowfile-attributeUse the value of the 'mongodb.update.mode' attribute of the incoming FlowFile. Acceptable values are 'one' and 'many'.falsefalsefalseNONEfalsefalseput-mongo-update-modeUpdate ModeoperatorsCharacter SetCharacter SetThe Character Set in which the data is encodedUTF-8truefalsefalseNONEfalsefalsesuccessAll FlowFiles that are written to MongoDB are routed to this relationshipfalsefailureAll FlowFiles that cannot be written to MongoDB are routed to this relationshipfalsemongo.put.update.match.countThe match count from result if update/upsert is performed, otherwise not set.mongo.put.update.modify.countThe modify count from result if update/upsert is performed, otherwise not set.mongo.put.upsert.idThe '_id' hex value if upsert is performed, otherwise not set.INPUT_REQUIREDMEMORYAn instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.org.apache.nifi.processors.mongodb.PutMongoBulkOperationsPROCESSORWrites the contents of a FlowFile to MongoDB as bulk-updatemongodbinsertupdatewriteputbulkmongo-client-serviceClient ServiceIf configured, this property will use the assigned client service for connection pooling.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0falsefalsefalseNONEfalsefalseMongo Database NameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseMongo Collection NameMongo Collection NameThe name of the collection to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseOrderedOrderedOrdered execution of bulk-writes and break on error - otherwise arbitrary order and continue on errortruetruetruefalsefalsetruefalsefalseNONEfalsefalseCharacter SetCharacter SetThe Character Set in which the data is encodedUTF-8truefalsefalseNONEfalsefalsesuccessAll FlowFiles that are written to MongoDB are routed to this relationshipfalsefailureAll FlowFiles that cannot be written to MongoDB are routed to this relationshipfalseINPUT_REQUIREDMEMORYAn instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.org.apache.nifi.processors.mongodb.PutMongoRecordPROCESSORThis 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.mongodbinsertupdateupsertrecordputmongo-client-serviceClient ServiceIf configured, this property will use the assigned client service for connection pooling.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0falsefalsefalseNONEfalsefalseMongo Database NameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseMongo Collection NameMongo Collection NameThe name of the collection to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalserecord-readerRecord ReaderSpecifies the Controller Service to use for parsing incoming data and determining the data's schemaorg.apache.nifi.serialization.RecordReaderFactoryorg.apache.nifinifi-standard-services-api-nar2.2.0truefalsefalseNONEfalsefalseinsert_countBatch SizeThe number of records to group together for one single insert/upsert operation against MongoDB.100truefalsefalseNONEfalsefalseorderedOrderedPerform ordered or unordered operationsFalseTrueTrueFalseFalsetruefalsefalseNONEfalsefalsebypass-validationBypass Validation 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. FalseTrueTrueFalseFalsetruefalsefalseNONEfalsefalseupdate-key-fieldsUpdate Key FieldsComma 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.falsefalsefalseNONEfalsefalseupdate-modeUpdate ModeChoose between updating a single document or multiple documents per incoming record.oneUpdate OneoneUpdates only the first document that matches the query.Update ManymanyUpdates every document that matches the query.Use 'mongodb.update.mode' FlowFile attribute.flowfile-attributeUse the value of the 'mongodb.update.mode' attribute of the incoming FlowFile. Acceptable values are 'one' and 'many'.falsefalsefalseNONEfalsefalseupdate-key-fieldsUpdate Key FieldssuccessAll FlowFiles that are written to MongoDB are routed to this relationshipfalsefailureAll FlowFiles that cannot be written to MongoDB are routed to this relationshipfalsemongodb.update.modeConfigurable 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.INPUT_REQUIREDorg.apache.nifi.processors.mongodb.RunMongoAggregationPROCESSORA processor that runs an aggregation query whenever a flowfile is received.mongoaggregationaggregatemongo-client-serviceClient ServiceIf configured, this property will use the assigned client service for connection pooling.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0falsefalsefalseNONEfalsefalseMongo Database NameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseMongo Collection NameMongo Collection NameThe name of the collection to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsemongo-charsetCharacter SetSpecifies the character set of the document data.UTF-8truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsemongo-agg-queryQueryThe aggregation query to be executed.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalseallow-disk-useAllow Disk UseSet this to true to enable writing data to temporary files to prevent exceeding the maximum memory use limit during aggregation pipeline staged when handling large datasets.falsetruetruefalsefalsetruefalsefalseNONEfalsefalsejson-typeJSON TypeBy 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.ExtendedExtended JSONExtendedUse MongoDB's "extended JSON". This is the JSON generated with toJson() on a MongoDB Document from the Java driverStandard JSONStandardGenerate a JSON document that conforms to typical JSON conventions instead of Mongo-specific conventions.truefalsefalseNONEfalsefalsemongo-query-attributeQuery Output AttributeIf set, the query will be written to a specified attribute on the output flowfiles.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseBatch SizeBatch SizeThe number of elements returned from the server in one batch.100falsefalsefalseNONEfalsefalseresults-per-flowfileResults Per FlowFileHow many results to put into a flowfile at once. The whole body will be treated as a JSON array of results.1falsefalsefalseNONEfalsefalsemongo-date-formatDate FormatThe 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.yyyy-MM-dd'T'HH:mm:ss'Z'falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsefailureThe input flowfile gets sent to this relationship when the query fails.falseoriginalThe input flowfile gets sent to this relationship when the query succeeds.falseresultsThe result set of the aggregation will be sent to this relationship.falseINPUT_ALLOWEDorg.apache.nifi.processors.mongodb.gridfs.DeleteGridFSPROCESSORDeletes a file from GridFS using a file name or a query.gridfsdeletemongodbgridfs-client-serviceClient ServiceThe MongoDB client service to use for database connections.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0truefalsefalseNONEfalsefalsegridfs-database-nameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsegridfs-bucket-nameBucket NameThe GridFS bucket where the files will be stored. If left blank, it will use the default value 'fs' that the MongoDB client driver uses.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsegridfs-file-nameFile NameThe name of the file in the bucket that is the target of this processor. GridFS file names do not include path information because GridFS does not sort files into folders within a bucket.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsedelete-gridfs-queryQueryA valid MongoDB query to use to find and delete one or more files from GridFS.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsemongo-query-attributeQuery Output AttributeIf set, the query will be written to a specified attribute on the output flowfiles.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsesuccessWhen the operation succeeds, the flowfile is sent to this relationship.falsefailureWhen there is a failure processing the flowfile, it goes to this relationship.falseINPUT_REQUIREDorg.apache.nifi.processors.mongodb.gridfs.FetchGridFSPROCESSORRetrieves one or more files from a GridFS bucket by file name or by a user-defined query.fetchgridfsmongogridfs-client-serviceClient ServiceThe MongoDB client service to use for database connections.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0truefalsefalseNONEfalsefalsegridfs-database-nameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsegridfs-bucket-nameBucket NameThe GridFS bucket where the files will be stored. If left blank, it will use the default value 'fs' that the MongoDB client driver uses.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsegridfs-file-nameFile NameThe name of the file in the bucket that is the target of this processor.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsegridfs-queryQueryA valid MongoDB query to use to fetch one or more files from GridFS.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsemongo-query-attributeQuery Output AttributeIf set, the query will be written to a specified attribute on the output flowfiles.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsemongo-operation-modeOperation ModeThis option controls when results are made available to downstream processors. If Stream Query Results is enabled, provenance will not be tracked relative to the input flowfile if an input flowfile is received and starts the query. In Stream Query Results mode errors will be handled by sending a new flowfile with the original content and attributes of the input flowfile to the failure relationship. Streaming should only be used if there is reliable connectivity between MongoDB and NiFi.all-at-onceFull Query Fetchall-at-onceFetch the entire query result and then make it available to downstream processors.Stream Query ResultsstreamingAs soon as the query start sending results to the downstream processors at regular intervals.truefalsefalseNONEfalsefalsefailureWhen there is a failure processing the flowfile, it goes to this relationship.falsesuccessWhen the operation succeeds, the flowfile is sent to this relationship.falseoriginalThe original input flowfile goes to this relationship if the query does not cause an errorfalsegridfs.file.metadataThe custom metadata stored with a file is attached to this property if it exists.INPUT_REQUIREDorg.apache.nifi.processors.mongodb.gridfs.PutGridFSPROCESSORWrites a file to a GridFS bucket.mongogridfsputfilestoregridfs-client-serviceClient ServiceThe MongoDB client service to use for database connections.org.apache.nifi.mongodb.MongoDBClientServiceorg.apache.nifinifi-mongodb-client-service-api-nar2.2.0truefalsefalseNONEfalsefalsegridfs-database-nameMongo Database NameThe name of the database to usetruefalsetrueFLOWFILE_ATTRIBUTESfalsefalsegridfs-bucket-nameBucket NameThe GridFS bucket where the files will be stored. If left blank, it will use the default value 'fs' that the MongoDB client driver uses.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsegridfs-file-nameFile NameThe name of the file in the bucket that is the target of this processor. GridFS file names do not include path information because GridFS does not sort files into folders within a bucket.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalseputgridfs-properties-prefixFile Properties PrefixAttributes that have this prefix will be added to the file stored in GridFS as metadata.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseputgridfs-enforce-uniquenessEnforce UniquenessWhen enabled, this option will ensure that uniqueness is enforced on the bucket. It will do so by creating a MongoDB index that matches your selection. It should ideally be configured once when the bucket is created for the first time because it could take a long time to build on an existing bucket wit a lot of data.noneNonenoneNo uniqueness will be enforced.BothbothBoth the filename and hash must be unique.NamenameOnly the filename must be unique.HashhashOnly the file hash must be unique.truefalsefalseNONEfalsefalseputgridfs-hash-attributeHash AttributeIf uniquness enforcement is enabled and the file hash is part of the constraint, this must be set to an attribute that exists on all incoming flowfiles.hash.valuefalsefalsetrueENVIRONMENTfalsefalseputgridfs-chunk-sizeChunk SizeControls the maximum size of each chunk of a file uploaded into GridFS.256 KBtruefalsetrueFLOWFILE_ATTRIBUTESfalsefalseduplicateFlowfiles that fail the duplicate check are sent to this relationship.falsesuccessWhen the operation succeeds, the flowfile is sent to this relationship.falsefailureWhen there is a failure processing the flowfile, it goes to this relationship.falseINPUT_REQUIRED