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 | Â |
---|---|---|---|---|---|
Input | Document |
|
| A document in a structured JSON-like object that can be easily parsed and passed between Snaps in a pipeline. | Â |
Output | Document |
|
| JSON-like documents with key-value pairs. If values are included, each document contains a | Â |
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:
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 |
---|---|---|
Label* Â Default Value:Â Redis | 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 | String/Expression | Enter the pattern to search for keys in the Redis database. Use wildcard characters ( |
Count* Default Value:Â 1000 | 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 | 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:Â | Dropdown list | Select one of the following three modes in which the Snap executes:
|
Â
Â
Snap Pack History
Â
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.