Description:

Creates FlowFiles from files in a directory. NiFi will ignore files it doesn't have at least read permissions for.

Additional Details...

Tags:

local, files, filesystem, ingest, ingress, get, source, input

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, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueValid ValuesDescription
Input DirectoryThe input directory from which to pull files
Supports Expression Language: true
File Filter[^\.].*Only files whose names match the given regular expression will be picked up
Path FilterWhen Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned
Batch Size10The maximum number of files to pull in each iteration
Keep Source Filefalse
  • true
  • false
If true, the file is not deleted after it has been copied to the Content Repository; this causes the file to be picked up continually and is useful for testing purposes. If not keeping original NiFi will need write permissions on the directory it is pulling from otherwise it will ignore the file.
Recurse Subdirectoriestrue
  • true
  • false
Indicates whether or not to pull files from subdirectories
Polling Interval0 secIndicates how long to wait before performing a directory listing
Ignore Hidden Filestrue
  • true
  • false
Indicates whether or not hidden files should be ignored
Minimum File Age0 secThe minimum age that a file must be in order to be pulled; any file younger than this amount of time (according to last modification date) will be ignored
Maximum File AgeThe maximum age that a file must be in order to be pulled; any file older than this amount of time (according to last modification date) will be ignored
Minimum File Size0 BThe minimum size that a file must be in order to be pulled
Maximum File SizeThe maximum size that a file can be in order to be pulled

Relationships:

NameDescription
successAll files are routed to success