Description:

Compresses or decompresses the contents of FlowFiles using a user-specified compression algorithm and updates the mime.type attribute as appropriate

Additional Details...

Tags: content, compress, decompress, gzip, bzip2, lzma, xz-lzma2

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
ModeIndicates whether the processor should compress content or decompress content. Must be either 'compress' or 'decompress'compress
  • compress
  • decompress
NoNo
Compression FormatThe compression format to use. Valid values are: GZIP, BZIP2, XZ-LZMA2, and LZMAuse mime.type attribute
  • use mime.type attribute
  • gzip
  • bzip2
  • xz-lzma2
  • lzma
NoNo
Compression LevelThe compression level to use; this is valid only when using GZIP compression. A lower value results in faster processing but less compression; a value of 0 indicates no compression but simply archiving1
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
NoNo
Update FilenameIf true, will remove the filename extension when decompressing data (only if the extension indicates the appropriate compression format) and add the appropriate extension when compressing datafalse
  • true
  • false
NoNo

Relationships:

NameDescription
failureFlowFiles will be transferred to the failure relationship if they fail to compress/decompress
successFlowFiles will be transferred to the success relationship after successfully being compressed or decompressed