Compress

Owned by Amritesh Singh
Last updated: Jun 11, 2024 by Lakshmi Manda
2 min read

In this article

Overview

You can use this Snap to compress the contents of a binary stream. For example, you can connect this Snap upstream of a File Writer Snap to compress the data before upload. If you need to archive and compress multiple files into a single ZIP file, use the ZipFile Write Snap.

Snap Type

The Compress Snap is a TRANSFORM-type Snap that transforms the binary documents.

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 

Binary

 

 

  • Min:1

  • Max:1

  • File Reader

  • Compress

The Binary file to be compressed.

Output

Binary

 

 

  • Min:1

  • Max:1

  • File Writer

  • Decompress

The Binary file in the specified compression format:

  • BZIP2

  • DEFLATE

  • GZIP

Error

 

 

 

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

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: Compress
Example: Compress

String

Specify a unique name for the Snap.

Compression Scheme*

 

Default value: GZIP
Example: DEFLATE

Dropdown list

Choose one of the following compression schemes to compress the data:

  • BZIP2

  • DEFLATE

  • GZIP

Snap Execution

 

Default Value: Validate & Execute
Example: Execute only

Dropdown list

Select one of the following three modes in which the Snap executes:

  • 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.

 

Snap Pack History

Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.