DeleteMongo

DeleteMongo 2.0.0

Bundle: org.apache.nifi | nifi-mongodb-nar
Description: Executes 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.
Tags: delete, mongo, mongodb
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Delete Mode
Choose between deleting one document by query or many documents by query.
Display Name

Delete Mode

Description

Choose between deleting one document by query or many documents by query.

API Name

delete-mongo-delete-mode

Default Value

one

Allowable Values
- Delete One
- Delete Many
- Use 'mongodb.delete.mode' attribute
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Fail When Nothing Is Deleted
Determines whether to send the flowfile to the success or failure relationship if nothing is successfully deleted.
Display Name

Fail When Nothing Is Deleted

Description

Determines whether to send the flowfile to the success or failure relationship if nothing is successfully deleted.

API Name

delete-mongo-fail-on-no-delete

Default Value

true

Allowable Values
- True
- False
Expression Language Scope

Not Supported

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

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.delete.mode	Configurable 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.'