MoveHDFS

Description:

Rename existing files or a directory of files (non-recursive) on Hadoop Distributed File System (HDFS).

Tags:

hadoop, HDFS, put, move, filesystem, moveHDFS

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.

NameDefault ValueAllowable ValuesDescription
Hadoop Configuration ResourcesA file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration. To use swebhdfs, see 'Additional Details' section of PutHDFS's documentation.
Supports Expression Language: true (will be evaluated using variable registry only)
Kerberos Credentials ServiceController Service API:
KerberosCredentialsService
Implementation: KeytabCredentialsService
Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos
Kerberos PrincipalKerberos principal to authenticate as. Requires nifi.kerberos.krb5.file to be set in your nifi.properties
Supports Expression Language: true (will be evaluated using variable registry only)
Kerberos KeytabKerberos keytab associated with the principal. Requires nifi.kerberos.krb5.file to be set in your nifi.properties
Supports Expression Language: true (will be evaluated using variable registry only)
Kerberos Relogin Period4 hoursPeriod of time which should pass before attempting a kerberos relogin. This property has been deprecated, and has no effect on processing. Relogins now occur automatically.
Supports Expression Language: true (will be evaluated using variable registry only)
Additional Classpath ResourcesA comma-separated list of paths to files and/or directories that will be added to the classpath. When specifying a directory, all files with in the directory will be added to the classpath, but further sub-directories will not be included.
Conflict Resolution Strategyfail
  • replace Replaces the existing file if any.
  • ignore Failed rename operation stops processing and routes to success.
  • fail Failing to rename a file routes to failure.
Indicates what should happen when a file with the same name already exists in the output directory
Input Directory or File${path}The HDFS directory from which files should be read, or a single file to read.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Output DirectoryThe HDFS directory where the files will be moved to
Supports Expression Language: true (will be evaluated using variable registry only)
HDFS Operationmove
  • move
  • copy
The operation that will be performed on the source file
File Filter RegexA Java Regular Expression for filtering Filenames; if a filter is supplied then only files whose names match that Regular Expression will be fetched, otherwise all files will be fetched
Ignore Dotted Filestrue
  • true
  • false
If true, files whose names begin with a dot (".") will be ignored
Remote OwnerChanges the owner of the HDFS file to this value after it is written. This only works if NiFi is running as a user that has HDFS super user privilege to change owner
Remote GroupChanges the group of the HDFS file to this value after it is written. This only works if NiFi is running as a user that has HDFS super user privilege to change group

Relationships:

NameDescription
successFiles that have been successfully renamed on HDFS are transferred to this relationship
failureFiles that could not be renamed on HDFS are transferred to this relationship

Reads Attributes:

NameDescription
filenameThe name of the file written to HDFS comes from the value of this attribute.

Writes Attributes:

NameDescription
filenameThe name of the file written to HDFS is stored in this attribute.
absolute.hdfs.pathThe absolute path to the file on HDFS is stored in this attribute.

State management:

This component does not store state.

Restricted:

Required PermissionExplanation
read filesystemProvides operator the ability to retrieve any file that NiFi has access to in HDFS or the local filesystem.
write filesystemProvides operator the ability to delete any file that NiFi has access to in HDFS or the local filesystem.

Input requirement:

This component allows an incoming relationship.

System Resource Considerations:

None specified.

See Also:

PutHDFS, GetHDFS