PutGridFS

Description:

Writes a file to a GridFS bucket.

Tags:

mongo, gridfs, put, file, store

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 NiFi Expression Language.

Display Name	API Name	Default Value	Allowable Values	Description
Client Service	gridfs-client-service		Controller Service API: MongoDBClientService Implementation: 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: true (will be evaluated using flow file attributes and variable registry)
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: true (will be evaluated using flow file attributes and variable registry)
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: true (will be evaluated using flow file attributes and variable registry)
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: true (will be evaluated using flow file attributes and variable registry)
Enforce Uniqueness	putgridfs-enforce-uniqueness	None	None Both Name Hash	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: true (will be evaluated using variable registry only)
Chunk Size	putgridfs-chunk-size	256 KB		Controls the maximum size of each chunk of a file uploaded into GridFS. 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.
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.

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.