Overview

You can use this Snap to decompress the content of binary data. For example, if a File Reader Snap is configured to read a compressed file, you can use this Snap to decompress the content before passing the data to a Parser Snap. The decompression scheme can be explicitly chosen or automatically detected based on the content of the binary data. 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
ZIP
7ZIP

Prerequisites

None.

Support for Ultra Pipelines

Works in 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
ZIP
7ZIP

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 Value: Decompress
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
Example: BZIP2

Dropdown list

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

Auto - Automatically detects the decompression scheme to be applied (based on the compression scheme) on the incoming documents. This scheme supports ZIP and 7z.
Bzip2 - Decompresses files compressed in the BZIP2 compression scheme.
Gzip - Decompresses files compressed in the GZIP compression scheme.
Deflate - Decompresses files compressed in the DEFLATE compression scheme.
ZIP - Decompresses files compressed in the ZIP compression scheme.
7z - Decompresses files compressed in 7z compression scheme.

Supported schemes for AUTO Scheme

AUTO scheme detection is supported for DEFLATE, GZIP, BZIP2, ZIP, and 7z compression schemes.

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.

Example

PDF BZIP2-Compression decompression

The following example pipeline demonstrates how to read a PDF file, compress it using BZIP2 compression, and then decompress it back to its original format. It demonstrates a simple data compression and decompression workflow.

Configure the File Reader Snap to read the specified PDF file 529-Article Text-2712-1-10-20130506.pdf from the file system. On validation, the Snap The Snap reads the PDF file as binary data.
Configure the Compress Snap to compress the file data using the BZIP2 compression scheme. On validation, the Snap compresses this binary data using BZIP2 compression scheme.
Configure the Decompress Snap to decompress the compressed data using automatic scheme detection . On validation, the Snap decompresses the data back to its original format.