Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

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:

Code Block
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 /wiki/spaces/DRWIP/pages/1439198Oracle 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.

Note

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.

Note

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


Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read


Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

 
 

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


Note

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


Expand
title1. 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:


Expand
title2. 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:

Pipeline Downloads

Attachments
uploadfalse
oldfalse
patterns*.slp, *.zip


Excerpt Include
Oracle Snap Pack
Oracle Snap Pack
nopaneltrue