FetchGridFS

FetchGridFS 2.0.0

Bundle: org.apache.nifi | nifi-mongodb-nar
Description: Retrieves one or more files from a GridFS bucket by file name or by a user-defined query.
Tags: fetch, gridfs, mongo
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.

Display Name

File Name

Description

The name of the file in the bucket that is the target of this processor.

API Name

gridfs-file-name

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Query
A valid MongoDB query to use to fetch one or more files from GridFS.

Display Name

Query

Description

A valid MongoDB query to use to fetch one or more files from GridFS.

API Name

gridfs-query

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Operation Mode
This option controls when results are made available to downstream processors. If Stream Query Results is enabled, provenance will not be tracked relative to the input flowfile if an input flowfile is received and starts the query. In Stream Query Results mode errors will be handled by sending a new flowfile with the original content and attributes of the input flowfile to the failure relationship. Streaming should only be used if there is reliable connectivity between MongoDB and NiFi.
Display Name

Operation Mode

Description

This option controls when results are made available to downstream processors. If Stream Query Results is enabled, provenance will not be tracked relative to the input flowfile if an input flowfile is received and starts the query. In Stream Query Results mode errors will be handled by sending a new flowfile with the original content and attributes of the input flowfile to the failure relationship. Streaming should only be used if there is reliable connectivity between MongoDB and NiFi.

API Name

mongo-operation-mode

Default Value

all-at-once

Allowable Values
- Full Query Fetch
- Stream Query Results
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Query Output Attribute
If set, the query will be written to a specified attribute on the output flowfiles.

Display Name

Query Output Attribute

Description

If set, the query will be written to a specified attribute on the output flowfiles.

API Name

mongo-query-attribute

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.
failure	When there is a failure processing the flowfile, it goes to this relationship.
original	The original input flowfile goes to this relationship if the query does not cause an error

Writes Attributes

Name	Description
gridfs.file.metadata	The custom metadata stored with a file is attached to this property if it exists.