Oracle - Lookup

On this Page

Snap type:

Read


Description:

This Snap provides functionality to lookup records in the target Oracle 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 the Snap's error view. After a query is executed, the query's results are merged into the incoming document.


Queries produced by the 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]
 


The Snap ignores any duplicated lookup condition in the input document stream since it maintains a cache for lookup conditions internally.
 

  • Expected upstream Snaps:  Any Snap which produces documents in the output view, such as CSV Parser, JSON Parser, Structure, Data.
  • Expected downstream Snaps:  Any Snap which receives documents in the input view, such as JSON Formatter, Structure, Data. CSV Formatter will cause an error since the output data is not a flattened Map data.
  • Expected input:  Each document in the input view should contain a Map data of key-value entries. Input data may contain values needed to evaluate expressions in the Object type, Output fields, and Conditions properties. Please make sure input data types match column data types in the database table. Otherwise, you may encounter an error message "Cannot find an input data which is related to the output record .....". If the error view is open, all input data in the batch are routed to the error view with the same error information.
  • Expected output Each document in the output view contains a Map data of key-value entries, where keys are the Output fields property values. The input data that has produced the corresponding output data is also included in the output data under the "original" key.


Prerequisites:

None


Support and limitations:Works in Ultra Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint.  See Oracle Account for information on setting up this type of account.


Views:
InputThis Snap has exactly one document input view. Each document should have values for one AND clause in the WHERE statement.
OutputThis Snap has exactly one document output view. The output document includes the corresponding input data under the "original" key. For each input document, if there are no results from the query, there won't be output routing to output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view. For each input document, if there are no results from the query and the Pass-though on no lookup match property is unchecked, there will be an error document that contains the input document itself.

Settings

Label


Required. 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 name



The database schema name. Selecting a schema filters the Table name list to show only those tables within the selected schema. This property is suggestible and will retrieve available database schemas during suggest values.

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

Table name

Required. 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.

Example: people
Default value: [None]
 

Output fields

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 ..."
Exampleemail, address, first, last
Default: [None]
 

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


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

Example:  $email, $first, $last
Default value: [None]


Lookup column name


Required. Enter or select lookup column name.

Example:  email, first, last
Default value: [None]


Pass-through on no lookup match


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.

Default value:  False


Snap Execution

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.

 
 

The Oracle database handles the case-sensitivity of column names differently from other databases. If the columns are created in all uppercase, you may refer to them in any case. Oracle database changes them to all uppercase automatically. However, if the columns are created in mixed case or lowercase, they are case-sensitive AND they must be enclosed in double quotes in the SQL statements, and you must follow the same rule when you enter the Output fields and Lookup column name properties as in the examples above.

Date type column cannot be used in the Lookup conditions. You will have to use the Oracle Execute Snap for this purpose. An example of the execute statement is:

SELECT *
FROM LOOKUPTABLE
WHERE DATECOL >= TO_DATE('2014-11-03', 'yyyy-mm-dd')
Please note ">=" is used instead of "=" in the WHERE clause. If you use "=", you will not get any result


Examples


 1. Finding a students score from the table

In this example, we have a table named STUDENT that stores students' scores. It has 3 columns: ID, NAME and SCORE. We will find all the student records that have same scores with Adam's with this pipeline:


The Oracle-Select Snap finds the row whose NAME is 'Adam', and pass the row's data to Oracle-Lookup Snap:

Then the Oracle-Lookup Snap will lookup all the rows that has the same score as Adam's. We use $SCORE to retrieve data of SCORE Column passed from Oracle-Select Snap.


This is the output of the pipeline, Bob has the same score as Adam's:

 2. Error handling on the Snap

This example will show the error handling of the Snap.

We use the same pipeline as the one in example 1 and route error messages to error view:


We add one row of Lookup condition with value as $AGE and Lookup column name as SCORE,  this setting should cause type mismatch error since column SCORE is of type NUMBER while column NAME is of type VARCHAR2:

Here is the error message that is routed to the error view:

Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File Example_Oracle_Lookup.slp

Feb 23, 2022 by Subhajit Sengupta


Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
August 2022main17386 StableEnhanced the Oracle - Merge and Oracle - Update Snaps with the Session parameters fieldset that provides National Language Support (NLS).
4.29 Patch429patches16603 Latest
  • Fixed an issue with Oracle Bulk Load Snap where the Snap encountered an error when trying to load data into Timestampwithtimezone datatype field.

  • Fixed an issue with Oracle Execute Snap where the Snap did not display a valid error message when the delete condition was invalid.

  • Fixed an issue with Oracle - Merge Snap where the Snap displayed an error when the RetryInterval and Number of Retries fields were expression enabled and the values were passed using the Pipeline parameters.

  • Fixed an issue with the Oracle Stored Procedure Snap where the Snap errored out due to an upgrade made to HikariCP that caused a conditional failure and prevented the downstream Snaps to supply the parameters to the stored procedure. 

  • Enhanced the Oracle - Merge and Oracle - Update Snaps with the Session Parameters fieldset that provides National Language Support (NLS).

4.29

main15993

 

Stable

Upgraded with the latest SnapLogic Platform release.

4.28main14627 Stable
  • Enhanced the Oracle - Update Snap to accept values in the Number of Retries and Retry Interval (seconds) fields from Pipeline parameters only. 

  • Enhanced the Oracle Bulk Load Snap with the Column Length Overrides field set to support CLOB (Character Large Object) and NCLOB (National Character Large Object) data types that may require a large buffer size, allowing users to load large amounts of data into a single column store of data type CLOB or NCLOB.

  • Updated the label for Delete Condition to Delete Condition (Truncates Table if empty) in the Snap Oracle Delete Snap
4.27main12833 Stable
  • Enhanced the Oracle - Execute Snap to invoke stored procedures.
  • Enhanced the Oracle Bulk Load Snap with Additional SQL Loader Parameters field set to define additional SQL Loader parameters if required.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25425patches11008 Latest
  • Improved the support for the CLOB data type in the Oracle - Insert Snap. 
  • Improved the error messages for all the Snaps in the Oracle Snap Pack where the Snaps fail with Null Pointer Exception when the account reference provided is invalid. 
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
Stable
  • Enhances the Oracle - Select Snap to return only the selected output fields or columns in the output schema (second output view) using the Fetch Output Fields In Schema check box. If the Output Fields field is empty all the columns are visible. 
  • Enhances the Oracle - Stored Procedure Snap to ignore the parameters evaluated as null by using the Ignore Null Parameters check box. This applies to parameters with defined default values.
4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21 Patch421patches6272 Latest

Fixes the issue where Snowflake SCD2 Snap generates two output documents despite no changes to Cause-historization fields with DATE, TIME and TIMESTAMP Snowflake data types, and with Ignore unchanged rows field selected.

4.21 Patch421patches6144 Latest

Fixes the following issues with DB Snaps:

  • The connection thread waits indefinitely causing the subsequent connection requests to become unresponsive.
  • Connection leaks occur during Pipeline execution.
4.21 PatchMULTIPLE8841 LatestFixes the connection issue in Database Snaps by detecting and closing open connections after the Snap execution ends.
4.21snapsmrc542

 

Stable

Updated the Oracle Thin Account and Oracle Thin Dynamic Account, enabling them to connect via Oracle Active Data Guard (ADG).

4.20 Patch 

db/oracle8812Latest

Enhances the Oracle Snap Pack to support connections to the Oracle ADG (Active Data Guard) URL.

4.20 Patch 

db/oracle8803  Latest

Support for Oracle Database 19c.

4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patch db/oracle8408 Latest

Fixes an issue with the Oracle - Update Snap wherein the Snap is unable to perform operations when:

  • An expression is used in the Update condition property.
  • Input data contain the character '?'.
4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18 Patchoracle7786 Latest

Fixes an issue using the NVARCHAR2 datatype in Oracle databases when the character set is not AL32UTF8. However, a known issue is that special characters display as (question).

4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17 Patch db/oracle7459 Latest

Fixed an issue with the Oracle Stored Procedure Snap wherein the Pipeline execution fails with an error when the input data type is CLOB.

4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Latest
  • Fixed an issue with the Oracle Execute Snap wherein the Snap would send the input document to the output view even if the Pass through field is not selected in the Snap configuration. With this fix, the Snap sends the input document to the output view, under the key original, only if you select the Pass through field.
  • Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16 Patch 

db/oracle6919 Latest

Added a new property, Session parameters, in the Oracle Insert Snap to enable the use of National Language Support (NLS) parameters.

4.16 Patch 

db/oracle6824 Latest

Fixed an issue with the Lookup Snap passing data simultaneously to output and error views when some values contained spaces at the end.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15 Patch db/oracle6534 Latest

Improved performance in Pipelines that contain child Pipelines.

4.15 Patch db/oracle6417 Latest

Fixed an issue with data types conversion. All fields with byte, short, int, or long data types will be converted to BigInteger after fetching.

4.15 Patch db/oracle6284 Latest

Replaced the existing Max idle time and Idle connection test period properties with Max life time and Idle Timeout properties respectively, in the Account configuration. The new properties fix the connection release issues that were occurring due to default/restricted DB Account settings.

4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.

4.13 Patch 

db/oracle5192 Latest
  • Fixed the Oracle Bulk Load Snap that stores special characters incorrectly in the target table.
  • Fixed the Oracle Bulk Load Snap that throws a NullPointerException error when the input letter case does not match with that of the Oracle table.
4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12 Patchoracle4862 Latest

Fixed an issue in the Oracle Bulk Load Snap that fails to execute the SQLLDR (SQL Loader) command, while also enhancing the support for the TCPS protocol.

4.12 Patch db/oracle4721 Latest

Added a property, "SSL/TCPS" for Oracle Account.

4.12 PatchMULTIPLE4744 Latest

Enabled expression for Delete Condition in Oracle Delete Snap. 

4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.

4.11 Patch 

db/oracle4369 Latest

Enhanced the Oracle Bulk Load Snap to accept date-type values in the format "yyyy-mm-dd".

4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10 Patchoracle3633 Latest

Fixed BULK LOAD so it adds the thread name to the name of the temporary directory. This allows multiple BULK LOAD Snaps within a single pipeline.

4.10

snapsmrc414

 
Stable

Added Auto commit property to the Select and Execute Snaps at the Snap level to support overriding of the Auto commit property at the Account level.

4.9.0 Patch

oracle3188 Latest

Fixed the issue that "NaN" check was done to unexpected data types like varchar.

4.9.0 Patch

oracle3096 Latest

Fixed a class casting issue for custom data types(BLOB, CLOB, NCLOB, etc) when custom Oracle JDBC driver is used.

4.9.0 Patch

oracle3071 Latest

Fixed an issue regarding connection not closed after login failure; Expose autocommit for "Select into" statement in PostgreSQL Execute Snap and Redshift Execute Snap.

4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.

4.8.0 Patch

oracle2905

 


Latest

Fix for SQL*Loader interpreting white-space only data as null values.

4.8.0 Patch

oracle2756

 Latest

Potential fix for JDBC deadlock issue.

4.8.0 Patch

oracle2711 Latest

Fixed Oracle Snap Pack rendering dates that are one hour off from the date returned by database query for non-UTC Snaplexes.

4.8

snapsmrc398

 
Stable

Database accounts now invalidate connection pools if account properties are modified and login attempts fail.

4.7.0 Patch

oracle2190 Latest

Fixed an issue for database Select Snaps regarding Limit rows not supporting an empty string from a pipeline parameter.

4.7

snapsmrc382

 
Stable
  • pdated the Oracle - Stored Procedure Snap with the Pass through field. 
  • Resolved an issue in Oracle - Stored Procedure Snap that caused invalid column type failures.
  • Oracle - Bulk Load updated to handle dates the same way as Oracle - Insert. Acceptable format for timestamp strings:
    • Prior to 4.7, the only acceptable timestamp format was  "yyyy-mm-dd hh:mm:ss.SSS", such as 2016-11-07 10:55:12

    • It now also supports:

      • ISO8601 formats (plus fractional seconds) without timezone.

             "yyyy-mm-ddThh:mm:ss.SSS", (ex: 2016-11-07T10:55:12)
             "yyyymmddThhmmss.SSS", (ex: 20161107T105512)

      • ISO8601 formats with time zone. ONLY 'zulu' and 'UTC' at this time. Note that there is no space before the 'Z' but is a space before the 'UTC'.

             "yyyy-mm-ddThh:mm:ss.SSSZ"
             "yyyymmddThhmmss.SSSZ"

             "yyyy-mm-ddThh:mm:ss.SSS UTC"
             "yyyymmddThhmmss.SSS UTC"

             ex: 2016-11-07T10:55:12Z
             ex: 20161107T105512Z

             ex: 2016-11-07T10:55:12 UTC
             ex: 20161107T105512 UTC

        The ISO8601 format is used by many web services, Oracle Bulk Loader, and others.

4.6snapsmrc362
 
Stable
  • Resolved an issue in Oracle Select Snap that caused failures in the second output view when retrieving outputs from a table with a dot (.) character.
  • Enhanced the Oracle Select Snap to fully support SQL statements with/without expressions & SQL bind variables.
  • Extended support for Oracle Thin Dynamic accounts.
4.5.1

oracle1583

 
Stable
  • Updated the Bulk Load Snap with a new field, Use direct path load, to enhance bulk loading performance.
  • Resolved an issue with Oracle Select Snap failing if the table name included a dot (.) character.
4.4.1NA Stable
  • Oracle Select: Resolved an issue with database access error occurring while iterating over table name result set when using an uploaded driver with a different version than the bundled driver.
  • Resolved an issue with Oracle Stored Procedure Snap not accepting CLOB data.
  • Made improvements to JDBC auto-commit consistency.
4.4NA Stable
  • Table List Snap: A new option, Compute table graph, now lets you determine whether or not to generate dependents data into the output.
  • Oracle Bulk Load
    • Resolved an issue with a pipeline never completing.
    • Resolved an issue with pipeline statistics, bulk load summary statistics not matching and bulk load summary was confusing.
    • Maximum error count field added to set the maximum number of rows which can fail before the bulk load operation is stopped.
    • Mixed-case matching option removed.
    • Added error messaging to handle BLOB type data trying to be loaded to an Oracle table when not supported.
    • Resolved an issue with the record separator of the input file not being processed correctly.
    • Improved error messages for when data types do not match.
  • Oracle Stored Procedure: All accessible objects are now visible during design.
4.3.2NA Stable
  • Resolved an issue with Oracle Select not reading table names: Database access error occurred while iterating over table name result set.
  • Resolved an issue with Oracle Bulk load failure: String index out of range: -1.
NANA Stable
  • Oracle Lookup failed in preview if DATE column was used for Lookup conditions
  • Dynamic DB queries now supported in the Execute Snap.
  • The SQL statement property now can be set as an expression property. When it is an expression, it will be evaluated with each input document and one SQL statement per each input document will be executed.
  • Known issue: When the SQL statement property is an expression, the pipeline parameters are shown in the suggest, but not the input schema.
  • With the SQL statement property set as an expression, the Snap can be exposed to SQL injection. Please use this feature with caution.
  • Oracle Insert: When a string value is entered into a date col, its successfully inserting into db with null
  • Oracle Stored Procedure: parameter type list was not populating even if a procedure had custom types defined.
NANA Stable
  • Oracle Execute error - no more documents will be written to SLFS
  • Oracle Execute Snap failing with maximum number of documents reached
  • Oracle Select Snap - Early dates are corrupted when reading data
  • Oracle select- with date data type does not return Time(hh:mm:ss)
  • Oracle Stored Procedure fails with error- Reason: invalid name pattern: TECTONIC.null
  • Oracle Stored Procedure - fails with - "invalid name pattern: TECTONIC.strarray32 " when type name given in lower case
NANA Stable
  • The version number of the default Oracle JDBC driver (shared/ojdbc-6.1.jar) is now 11.2.0.4.
  • Fixed the following defects:
    • Oracle Stored Procedure: suggest method for parameter index throws -Suggestion value cannot be empty for property: customTypeParameterIndex
    • Oracle Stored Procedure: Parameter index suggest throws "invalid path" when no schema nor procedure is selected

    • Oracle Stored Procedure: If there is no type defined in Schema, suggest throwing Suggestion value cannot be empty for property: customTypeParameterType

    • Oracle Stored Procedure: When custom type created in different schema, its not populating through Snap
    • Oracle Select- Order by property as parameter fails
    • Oracle Stored Procedure: Parameter type list- Can we make it in an order
    • Oracle Snaps- When in account given a username which dont have privileges to access other schema, upon suggest all schema 's are populating
    • Oracle Stored Procedure: NPE
    • Oracle Stored Procedure: invalid name pattern: TECTONIC.STR_ARRAY_32_$
    • Oracle Stored Procedure: Procedure name mismatch error - suggest from parameter type when no package selected
    • Oracle Stored Procedure: When in a schema if there are no types defined, showing null in type and index value
    • Oracle Merge: error: "SQL operation failed"
    • Oracle merge condition when expression is enabled, input schema in not getting populated
    • Oracle Merge with expression more than 2 columns not working.getting Invalid identifier
    • Oracle Merge: When expression enable- Fails with Failure: Could not evaluate expression:
    • Oracle Stored Procedure: Failure: Failed to execute callable statement. Cause: invalid name pattern: TECTONIC.null.