Redis Scan

In this article

Overview

You can use this Snap to scan and retrieve keys from a Redis database based on specified patterns. The Redis Scan Snap retrieves keys based on a specified pattern. This helps in finding keys that match certain naming conventions or structures.

 

Snap Type

This is a Read-type Snap that retrieves the keys from the Redis database.

Prerequisites

  • Valid client ID.

  • A valid account with the required permissions.

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: 0

  • Max: 1

  • Scheduler Snap

A document in a structured JSON-like object that can be easily parsed and passed between Snaps in a pipeline.

 

Output

Document

  • Min: 1

  • Max: 1

  • Filter Snap

  • Mapper Snap

  • File Writer Snap

JSON-like documents with key-value pairs. If values are included, each document contains a key and value; otherwise, only key is present.

 

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 when 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 if 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

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

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

  • Upload icon (): Indicates that you can upload files. Learn more about managing Files.

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default ValueRedis
ExampleRedis Snap

String

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.

 

Query*

 

Default Value: None
Example:

String/Expression

Enter the pattern to search for keys in the Redis database. Use wildcard characters (*, ?, etc.) to match specific key patterns. For example, entering user:* will retrieve all keys that start with user:, while session:? will find keys where the character after session: is any single character.

Count*

Default Value: 1000
Example: 2000

String/Expression

Enter the maximum number of keys to retrieve per scan operation. This value controls the batch size of the scan, allowing you to manage the performance of the scan process.

Original Data

 

Default state: Unselected
Example: Selected

Checkbox

Select this checkbox to include the original input data along with the Redis results in the output. When enabled, the Snap will append the original data (if any) to the output document, allowing you to compare or combine the Redis results with the initial data.

Snap Execution

Default Value
Example: Validate & Execute

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