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. Anyother properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language (or simply EL), 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.

NameDescriptionDefault ValueValid ValuesELSensitive
Input DirectoryThe input directory from which to pull filesYesNo
File FilterOnly files whose names match the given regular expression will be picked up[^\.].*NoNo
Path FilterWhen Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scannedNoNo
Batch SizeThe maximum number of files to pull in each iteration10NoNo
Keep Source FileIf 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.false
  • true
  • false
NoNo
Recurse SubdirectoriesIndicates whether or not to pull files from subdirectoriestrue
  • true
  • false
NoNo
Polling IntervalIndicates how long to wait before performing a directory listing0 secNoNo
Ignore Hidden FilesIndicates whether or not hidden files should be ignoredtrue
  • true
  • false
NoNo
Minimum File AgeThe 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 ignored0 secNoNo
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 ignoredNoNo
Minimum File SizeThe minimum size that a file must be in order to be pulled0 BNoNo
Maximum File SizeThe maximum size that a file can be in order to be pulledNoNo

Relationships:

NameDescription
successAll files are routed to success