PutGridFS

PutGridFS 2.0.0

Bundle: org.apache.nifi | nifi-mongodb-nar
Description: Writes a file to a GridFS bucket.
Tags: file, gridfs, mongo, put, store
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

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.

Display Name

Bucket Name

Description

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.

API Name

gridfs-bucket-name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Client Service
The MongoDB client service to use for database connections.

Display Name

Client Service

Description

The MongoDB client service to use for database connections.

API Name

gridfs-client-service

Service Interface

org.apache.nifi.mongodb.MongoDBClientService

Service Implementations

org.apache.nifi.mongodb.MongoDBControllerService

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Mongo Database Name
The name of the database to use

Display Name

Mongo Database Name

Description

The name of the database to use

API Name

gridfs-database-name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
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.

Display Name

File Name

Description

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.

API Name

gridfs-file-name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Chunk Size
Controls the maximum size of each chunk of a file uploaded into GridFS.

Display Name

Chunk Size

Description

Controls the maximum size of each chunk of a file uploaded into GridFS.

API Name

putgridfs-chunk-size

Default Value

256 KB

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Enforce Uniqueness
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.
Display Name

Enforce Uniqueness

Description

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.

API Name

putgridfs-enforce-uniqueness

Default Value

none

Allowable Values
- None
- Both
- Name
- Hash
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Hash Attribute
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.

Display Name

Hash Attribute

Description

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.

API Name

putgridfs-hash-attribute

Default Value

hash.value

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
File Properties Prefix
Attributes that have this prefix will be added to the file stored in GridFS as metadata.

Display Name

File Properties Prefix

Description

Attributes that have this prefix will be added to the file stored in GridFS as metadata.

API Name

putgridfs-properties-prefix

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

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.