DeleteGridFS
Description
Deletes a file from GridFS using a file name or a query.
Tags
delete, gridfs, 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 * | gridfs-client-service | Controller Service: MongoDBClientService Implementations: MongoDBControllerService | The MongoDB client service to use for database connections. | |
| Mongo Database Name * | gridfs-database-name | The name of the database to use Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Bucket Name | gridfs-bucket-name | The GridFS bucket where the files will be stored. If left blank, it will use the default value 'fs' that the MongoDB client driver uses. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| File Name | gridfs-file-name | The 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. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Query | delete-gridfs-query | A valid MongoDB query to use to find and delete one or more files from GridFS. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Query Output Attribute | mongo-query-attribute | If set, the query will be written to a specified attribute on the output flowfiles. Supports Expression Language, using FlowFile attributes and Environment variables. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | When there is a failure processing the flowfile, it goes to this relationship. |
| success | When the operation succeeds, the flowfile is sent to this relationship. |
Reads Attributes
This processor does not read attributes.
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.