Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

You can use this Snap to decompress the contents of a binary stream. For example, if a File Reader Snap was is configured to read a compressed file, you can use this Snap to decompress the contents before passing the data to a parser Snap. It currently supports decompressing files in the GZIP, BZIP2, and DEFLATE compression schemes. The decompression scheme can be explicitly chosen or automatically detected based on the contents of the binary stream. If the compression scheme is set to AUTO and the incoming data is not compressed, the raw input data is passed through without any changes.

Note

This Snap only uncompresses the compressed files on the first level. It does not decompress the archived folders which are located at the second level and deeper.

Prerequisites

None.

Support for Ultra Pipelines

  • Works in Ultra Pipelines
  • This Snap supports decompression of the following compression schemes:
    • GZIP
    • BZIP2 (or BZ2)
    • DEFLATE

Limitations and Known Issues

None.

Snap Input and Output


Input/Output
Type of View
Number of Views
Examples of Upstream and Downstream Snaps
Description
Input 

Document


  • Min:1
  • Max:1
  • Mapper
  • Copy
The binary file to be decompressed.
Output

Document

  • Min:1
  • Max:1
  • Mapper
  • Any Parser Snap

The decompressed file.


Snap Settings

Field Name

Field TypeDescription

Label*


String

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

Default ValueDecompress
Example: Decompress

Scheme*



Dropdown list

Specify the decompression scheme to use. The available options include:

  • AUTO - To automatically detect the decompression scheme to be applied (based on the compression scheme) on the incoming documents. 
  • BZIP2 - To decompress files compressed in the BZIP2 compression scheme.
  • GZIP - To decompress files compressed in the GZIP compression scheme.
  • DEFLATE - To decompress files compressed in the DEFLATE compression scheme.

Default Value: AUTO
ExampleBZIP2

Note
titleAUTO Scheme - Supported schemes

Automatic scheme detection and decompression is possible only for the three supported compression schemes - GZIP, BZIP2, and DEFLATE. 


Snap Execution*


Dropdown list


Excerpt

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default Value: Validate & Execute
Example: Execute only



Excerpt Include
Binary Snap Pack
Binary Snap Pack
nopaneltrue