DeleteMongo
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
Properties
In the list below required Properties are shown with an asterisk (*). Other properties 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: MongoDBClientService Implementations: 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, using FlowFile attributes and Environment variables. | ||
| Mongo Collection Name * | Mongo Collection Name | The name of the collection to use Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Delete Mode | delete-mongo-delete-mode | Delete One |
| Choose between deleting one document by query or many documents by query. |
| Fail When Nothing Is Deleted | delete-mongo-fail-on-no-delete | True |
| Determines whether to send the flowfile to the success or failure relationship if nothing is successfully deleted. |
Dynamic Properties
This component does not support dynamic properties.
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 |
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.' |
Writes Attributes
This processor does not write attributes.
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
This component does not specify system resource considerations.