Avro Formatter

In this article

Overview

You can use this Snap to serialize the incoming SnapLogic document objects into Avro-formatted data.

Snap Type

Avro Formatter Snap is a FORMAT-type Snap that formats data to Avro-formatted data.

Prerequisites

None.

Support for Ultra Pipelines

Does not support 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

This Snap exposes the avsc schema in its input view. You must use a Mapper Snap in front of this Snap to map the fields present in .avsc schema file.

Output

Document

 

  • Min: 1

  • Max: 1

  • Binary

Any serialized binary stream output processing Snap that contains data and its schema.

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. The available options are:

  • 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 rest of the 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

Type

Description

Field Name

Type

Description

Label*

Default ValueAvro Formatter
ExampleAvro_Formatter

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.

 

Schema File*

Default Value[None]
Examplesldb:///foo/bar/schema.avsc

String/Expression

Specify the path to the schema file in .avsc format

Ignore empty stream

Default value: Deselected
ExampleSelected

Checkbox

Select the checkbox to specify an action that the Snap must take if the input view contains empty documents. If selected, the Snap does not write anything to the output if no documents are received in the input. Else, the Snap writes an empty array in the output view if no documents are received in the input view. 

 

Snap Execution

Default value: Validate & Execute
ExampleDisabled

 

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.

Snap Pack History