Description and usage of DeleteGridFS processor:

Deletes a file from GridFS using a file name or a query.

Tags:

gridfs, delete, mongodb

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the Expression Language Guide.

Name	Default Value	Allowable Values	Description
Client Service		Controller Service API:  MongoDBClientService Implementation:  MongoDBControllerService	The MongoDB client service to use for database connections.
Mongo Database Name			The name of the database to use Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
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: true (will be evaluated using flow file attributes and variable registry)
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: true (will be evaluated using flow file attributes and variable registry)
Query			A valid MongoDB query to use to find and delete one or more files from GridFS. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Query Output Attribute			If set, the query will be written to a specified attribute on the output flowfiles. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

Name	Description
success	When the operation succeeds, the flowfile is sent to this relationship.
failure	When there is a failure processing the flowfile, it goes to this relationship.

Reads Attributes:

None specified.

Writes Attributes:

None specified.

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:

None specified.

Summary:

This processor retrieves one or more files from GridFS. The query to execute can be either provided in the query configuration parameter or generated from the value pulled from the filename configuration parameter. Upon successful execution, it will append the query that was executed as an attribute on the flowfile that was processed.