PutGridFS
Description
Writes a file to a GridFS bucket.
Tags
file, gridfs, mongo, put, store
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. | ||
| File Properties Prefix | putgridfs-properties-prefix | Attributes that have this prefix will be added to the file stored in GridFS as metadata. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Enforce Uniqueness * | putgridfs-enforce-uniqueness | None |
| When enabled, this option will ensure that uniqueness is enforced on the bucket. It will do so by creating a MongoDB index that matches your selection. It should ideally be configured once when the bucket is created for the first time because it could take a long time to build on an existing bucket wit a lot of data. |
| Hash Attribute | putgridfs-hash-attribute | hash.value | If uniquness enforcement is enabled and the file hash is part of the constraint, this must be set to an attribute that exists on all incoming flowfiles. Supports Expression Language, using Environment variables. | |
| Chunk Size * | putgridfs-chunk-size | 256 KB | Controls the maximum size of each chunk of a file uploaded into GridFS. Supports Expression Language, using FlowFile attributes and Environment variables. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| duplicate | Flowfiles that fail the duplicate check are sent to this relationship. |
| 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.