AlloyDB Lookup

In this article

Overview

You can use this Snap to look up records in the target AlloyDB table and return a selected set of fields for every matched record.

The Snap executes one request per multiple input documents to avoid making a request for every input record. It ignores any duplicated lookup condition in the input document stream because it maintains a cache for lookup conditions internally.

 


Snap Type

The AlloyDB Lookup Snap is a Read Snap.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Task Pipelines with pass-through.

Limitations and Known Issues

None.

Behavior Change

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

  • JSON Formatter

  • Mapper

Each document should have values for one AND clause in the WHERE statement.

Output

Document

 

  • Min: 1

  • Max: 1

  • Mapper

  • Copy

  • File Writer

This Snap has exactly one document output view. The output document includes the corresponding input data under the "original" key. If there are no results from the query, each output field will have a null value. Queries produced by Snap have the format:

SELECT [Output fields] FROM [Table name] WHERE [C1 = V11 AND C2 = V21 AND...[Cn = Vn1] OR [C1 = V12 AND C2 = V22 AND...[Cn = Vn2] OR ......................................  OR [Cn = V1n AND Cm = V2m AND...[Cn = Vnm]

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

  • Asterisk ( * ): Indicates a mandatory field.

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

  • Expression icon ( ): Indicates 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.

  • Upload icon ( ): Indicates that you can upload files.

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

Default valueAlloyDB Lookup
Example: Check Records

String

Specify a unique name for the Snap.

 

Schema name

Default value: N/A
Example: SYS

 

String/Expression/Suggestion

Specify the database schema name. Selecting a schema filters the Table name list to show only those tables in the selected schema.

The values can be passed using the Pipeline parameters but not the upstream parameter.

Table name*

 

Default Value: N/A
Example: People

String/Expression/Suggestion

Specify or select the name of the table to execute the lookup query on.

Output fields

Default value: N/A
Exampleemail, address, first, last

String/Expression/Suggestion

Specify or select output field names for an SQL SELECT statement. If this property is empty, the Snap selects all fields by executing the statement "SELECT * FROM ...".

Lookup conditions*

The lookup conditions are created by using the lookup column name and the lookup column value. Each row will build a condition, such as lookupColumn1 = $inputField. Each additional row will be concatenated using a logical AND. All rows together build the lookup condition being used to look up records in the lookup table.

Value*

Default Value: N/A
Example $email, $first, $last

String/Expression

Enter or select the JSON path of the lookup column value. The value will be provided by the input data field.

Lookup column name*

Default Value: N/A
Exampleemail, first, last

String/Expression

Enter or select the lookup column name.

Pass-through on no lookup match

Default Value: False
Example: True

 

Checkbox

When there is no lookup matching an input document, the input document will pass through to the output view if this property is checked. Otherwise, it will be written to the error view as an error condition.

Number of Retries

Default Value: 0
Example: 3

Integer/Expression

Specifies the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response.

Retry Interval

Default Value: 1
Example: 10

Integer/Expression

Specifies the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. 

Snap Execution

Default ValueValidate & 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

 

Google AlloyDB Snap Pack

Related Links