In this article
Overview
This Snap provides functionality to look up records in the target Postgres table and returns 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.
JSON paths can be used in the Snap properties and will have values from an incoming document substituted into the properties. However, documents missing values for a given JSON path will be written to Snap's error view. After a query is executed, the query's results are merged into the incoming document.
The Snap ignores any duplicated lookup condition in the input document stream since 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.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| This Snap allows exactly one document input view. Each document should have values for one AND clause in the WHERE statement. |
Output | Document |
|
| 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 while 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
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 fieldset.
Remove icon ( ): Indicates that you can remove fields from the fieldset.
Upload icon ( ): Indicates that you can upload files.
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default value: AlloyDB Lookup | String | Specify a unique name for the Snap. | |
Schema name Default value: N/A | String/Expression/Suggestion | The database schema name. Selecting a schema filters the Table name list to show only those tables within the selected schema. The values can be passed using the pipeline parameters but not the upstream parameter. | |
Table name* Default Value: N/A | String/Expression/Suggestion | Enter or select the name of the table to execute the lookup query on. The values can be passed using the pipeline parameters but not the upstream parameter. | |
Output fields Default value: N/A | String/Expression/Suggestion | Enter or select output field names for 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 lookup records in the lookup table. | ||
Value* Default Value: N/A | 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 | String/Expression | Enter or select lookup column name. | |
Pass-through on no lookup match Default Value: False | 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 | 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 | 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 Value: Validate & Execute | Dropdown list | Select one of the following three modes in which the Snap executes:
|
Download and import the Pipeline into SnapLogic.
Configure Snap accounts, as applicable.
Provide Pipeline parameters, as applicable.
Snap Pack History
Release | Snap Pack Version | Date | Type | Updates |
---|---|---|---|---|
May 2024 | 4postgresupgrade26570 |
| - | The JDBC driver for the Google AlloyDB Snap Pack has been upgraded from v42.4.2 to v42.7.2 (Java 8). This upgrade will be part of the GA release on August 14, 2024 (Stable release). As part of this upgrade, the 42.7.2 JDBC driver is bundled with the AlloyDB Snap Pack as the default JDBC driver. Learn more about the behavior changes caused by the driver upgrade. |
May 2024 | main26341 |
| Stable | Updated the Delete Condition (Truncates a Table if empty) field in the AlloyDB Delete Snap to Delete condition (deletes all records from a table if left blank) to indicate that all entries will be deleted from the table when this field is blank, but no truncate operation is performed. |
February 2024 | main25112 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
November 2023 | main23721 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
August 2023 | main22460 |
| Stable | The AlloyDB Execute Snap now includes a new Query type field. When Auto is selected, the Snap tries to determine the query type automatically. |
May 2023 | main21015 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
February 2023 | main19844 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
November 2022 | main18944 |
| Stable | The AlloyDB Insert Snap now creates the target table only from the table metadata of the second input view when the following conditions are met:
|
September 2022 | 430patches18149 |
| Latest | The AlloyDB Select and AlloyDB Execute Snaps now read NaN values in Numeric columns. |
4.30Patches | 430patches17841 |
| Latest | Introduced the Google AlloyDB Snap Pack— a fully managed PostgresSQL-compatible database service that you can use for all your database workloads. This Snap Pack offers the following Snaps: |