Decompress

In this article

Overview

You can use this Snap to decompress the contents of a binary stream. For example, if a File Reader Snap 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.

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.

This Snap supports decompression of the following compression schemes:

  • GZIP

  • BZIP2 (or BZ2)

  • DEFLATE

Prerequisites

None.

Support for Ultra Pipelines

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document



  • Min:1

  • Max:1

  • Mapper

  • Copy

The document to be decompressed.

Output

Document

  • Min:1

  • Max:1

  • Mapper

  • Any Parser Snap

The decompressed file in the specified decompression format:

  • AUTO

  • BZIP2

  • GZIP

  • DEFLATE

Snap Settings

  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon (): Indicates that you can add fields in the field set.

  • Remove icon (): Indicates that you can remove fields from the field set.

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default ValueDecompress
Example: Decompress

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.

Scheme*

 

Default Value: AUTO
ExampleBZIP2



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.

AUTO Scheme - Supported schemes

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

Snap Execution*

 

Default Value: Validate & Execute
Example: Execute only

Dropdown list

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.