PutMongo

PutMongo 2.0.0

Bundle: org.apache.nifi | nifi-mongodb-nar
Description: Writes the contents of a FlowFile to MongoDB
Tags: insert, mongodb, put, update, write
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Character Set
The Character Set in which the data is encoded

Display Name

Character Set

Description

The Character Set in which the data is encoded

API Name

Character Set

Default Value

UTF-8

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Mode
Indicates whether the processor should insert or update content
Display Name

Mode

Description

Indicates whether the processor should insert or update content

API Name

Mode

Default Value

insert

Allowable Values
- insert
- update
Expression Language Scope

Not Supported

Sensitive

false

Required

true
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
Update Mode
Choose 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.
Display Name

Update Mode

Description

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

API Name

put-mongo-update-mode

Default Value

doc

Allowable Values
- With whole document
- With operators enabled
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Mode is set to any of [update]
Update Query
Specify 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.
Display Name

Update Query

Description

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

API Name

putmongo-update-query

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Mode is set to any of [update]
Update Method
MongoDB method for running collection update operations, such as updateOne or updateMany
Display Name

Update Method

Description

MongoDB method for running collection update operations, such as updateOne or updateMany

API Name

Update Method

Default Value

one

Allowable Values
- Update One
- Update Many
- Use 'mongodb.update.mode' FlowFile attribute.
Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Update Mode is set to any of [operators]
Update Query Key
One or more comma-separated document key names used to build the update query criteria, such as _id
Display Name

Update Query Key

Description

One or more comma-separated document key names used to build the update query criteria, such as _id

API Name

Update Query Key

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Mode is set to any of [update]
Upsert
When true, inserts a document if no document matches the update query criteria; this property is valid only when using update mode, otherwise it is ignored
Display Name

Upsert

Description

When true, inserts a document if no document matches the update query criteria; this property is valid only when using update mode, otherwise it is ignored

API Name

Upsert

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Mode is set to any of [update]

System Resource Considerations

Resource	Description
MEMORY	An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.

Relationships

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

Writes Attributes

Name	Description
mongo.put.update.match.count	The match count from result if update/upsert is performed, otherwise not set.
mongo.put.update.modify.count	The modify count from result if update/upsert is performed, otherwise not set.
mongo.put.upsert.id	The '_id' hex value if upsert is performed, otherwise not set.