Oracle - Select

On this Page

Snap type:

Read

Description:

This Snap allows you to fetch data from an Oracle database by providing a table name and configuring the connection. The Snap produces the records from the database on its output view which can then be processed by a downstream Snap. 

JSON paths can be used in a query and will have values from an incoming document substituted into the query. 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 overwriting any existing keys' values. The original document is output if there are no results from the query.

Queries produced by the Snap have an equivalent format:

SELECT * FROM [table] WHERE [where clause] ORDER BY [ordering] LIMIT [limit] OFFSET [offset]

If more powerful functionality is desired, then the Execute Snap should be used.

  • Expected upstream Snaps: A dynamic where a clause can be defined by providing values upstream, such as the Mapper Snap can provide constants, pipeline parameters mapped into variables, which then can be used in the where clause or even in the table/schema properties.
  • Expected downstream Snaps: The Snap will output one document for every record retrieved, hence any document processing Snap can be used downstream.
  • Expected input: Document that provides values for one or more properties of the Snap or simply for pass through purpose.
  • Expected output: Document for each record retrieved. Special types such as TIMESTAMP, TIMESTAMPTZ and TIMESTAMPLTZ are converted into SnapLogic internal date type representations which then can be consumed by downstream Snaps just like any other data type.
The where clause can only use variables, not constants or pipeline parameters. 

A good example of a where clause is: SALARY =$SALARY (here we use the SALARY variable of the input document).

Prerequisites:

None

Support and limitations:Works in Ultra Task 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:
Input

This Snap allows up to one input view. If the input view is defined, then the where clause can substitute incoming values for a given expression, such as a table name or as a variable as part of the where clause.

Output

A second view can be added to show the metadata for the table as a Document. The metadata document can then be fed into the second input view of Oracle - Insert or Bulk Load Snap so that the table is created in Oracle with a similar schema as the source table.

Error

This Snap has at most one error view and produces zero or more documents in the view.

Settings

Label*


Specify 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

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

Default value: None
Example: SYS

Table name*

Enter or select the name of the table to execute the select on.

Default value: None
Examplepeople

Where clause 

WHERE clause of SELECT statement. The value to be used in the WHERE clause will be used here. Document value substitutions (such as $person.firstname with the value found in the incoming document at the path) can also be used as needed. The "=" will not need to be checked when using document value substitutions unless using expression language.

Default value: None
Examples

Without using expressions

  • email = 'you@example.com' or email = $email 
  • emp=$emp

Using expressions

  • "EMPNO=$EMPNO and ENAME=$EMPNAME"
  • "emp='" + $emp + "'"
  • "EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"

Caution

Using expressions that join strings together to create SQL queries or conditions has a potential SQL injection risk and hence unsafe. Ensure that you understand all implications and risks involved before using concatenation of strings with '=' Expression enabled. 

The Where clause property does not support passing Pipeline parameters or passing upstream parameters.

Order by: Column names 

Enter in the columns in the order in which you want to order by. The default database sort order will be used.

Default value: None
Example: name, email

Limit offset

Specify the first row for the query.

Default value: None
Example0

Limit rows 

Specify the number of rows to return from the query.

Default value: None
Example10

Output fields*

Enter or select output field names for SQL SELECT statement. To select all fields, leave it at default.

Default value: None
Example: email, address, first, last

Fetch Output Fields In Schema

Select this check box to include only the selected fields or columns in the Output Schema (second output view). If you do not provide any Output fields, all the columns are visible in the output.
If you provide output fields, we recommend you to select Fetch Output Fields In Schema check box.

Default value: Not selected

Pass through 


Select this checkbox to pass the input document to the output view under the key 'original'. 

Default value: Selected

Ignore empty resultSelect this checkbox to ignore empty results, that is no document will be written to the output view when a SELECT operation does not produce any result.
If you do not select this checkbox and select the Pass through checkbox, the input document will be passed through to the output view.

Default value: Not selected
Auto commit

Select one of the options for this property to override the state of the Auto commit property on the account. The Auto commit at the Snap-level has three values: TrueFalse, and Use account setting. The expected functionality for these modes are:

  •  True - The Snap will execute with auto-commit enabled regardless of the value set for Auto commit in the Account used by the Snap.
  •  False - The Snap will execute with auto-commit disabled regardless of the value set for Auto commit in the Account used by the Snap.
  • Use account setting - The Snap will execute with Auto commit property value inherited by the Account used by the Snap.

Default value: False

Match data types

ConditionalIf you select this checkbox, the Snap matches the output data types same as when the Output fields property is empty (SELECT * FROM ...). The output preview would be in the same format as the one when SELECT * FROM is implied and all the contents of the table are displayed.

This field applies only when the Output fields field is provided with any values.

Default value: Not selected

Number of retries

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

Default value: 0
Example: 3

No macro found named "retries" on page "File Reader" in space "SD".

If you're experiencing issues please see our Troubleshooting Guide.

Retry interval (seconds)

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

Default value: 1
Example: 10

Staging mode

Required when the value in the Number of retries field is greater than 0. 

Specify the location from the following options to store input documents between retries:

  • In memory: The query results are stored in the Snaplex memory. If the query is too large to fit in the memory space, it may cause the Snap to fail, choose the On disk option.
  • On disk: The query results are stored on the disk in a temporary (tmp) directory that is managed by the SnapLogic platform. This directory is deleted automatically when the Snap terminates.

Default valueIn memory

To disable staging, enter 0 in the Number of retries field.

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.

  

For the 'Suggest' in the Order by columns and the Output fields properties, the value of the Table name property should be an actual table name instead of an expression. If it is an expression, it will display an error message "Could not evaluate accessor:  ..." when the 'Suggest' button is clicked. This is because, at the time the "Suggest" button is clicked, the input document is not available for the Snap to evaluate the expression in the Table name property. The input document is available to the Snap only during the preview or execution time.

Examples


Using the Where clause with expressions enabled:

The values are passed upstream for the Oracle Select Snap to fetch the data from a table:

The Oracle Select Snap retrieves the records from the EMPTABLE. The values passed from the upstream for the Where clause in different ways is displayed below:

Without expressions enabled: The values are directly passed for the Select Snap to retrieve the specified records.

With expressions enabled:

The queries can be passed in either of the ways as below for the above upstream values (using the Mapper Snap): 

  • "EMPNO=$EMPNO and ENAME=$EMPNAME"
  • "EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"

Successful execution of the Snap displays the below output preview, with the field names as provided from the upstream:

Following are the two examples. The first one using a where clause for a conditional retrieval. The second one will showcase error handling.

 1. Using a where clause for a conditional retrieval

 

  • The first Oracle Execute Snap will drop the existing table. We use an error view to handle the case where the table does not exist yet. Both the error and the output view then are funneled into a Union Snap which triggers the actual insertion data provided by a JSON Generator Snap.
  • Then we use a Mapper Snap to map back the original input data and use a Tail to use the last record (having the color black).
  • Next, we select on the table using the where clause: "color"=$color, which will retrieve the color black from the table and write it to the output view.
    Hint: The table COLOR1 was created on the fly, and the color column is created lowercase. We quote the color column in the merge condition since it is defined as a lower case column on the table.
    Hint: Multiple columns can be used in an expression such as "color"=$color and "value"=$value
 2. Error view on the Oracle Select Snap

In the second example, we use an error view on the Oracle Select Snap.

Here we mis-typed the variable in the condition, which will trigger an error. The error will be written to the error view of the Snap, which then can be used for debugging purpose or further processing.
An example of the error view is shown below.

  • Error is the message provided by SnapLogic.
  • Reason is defined as the underlying reason of the error, here the path $colo does not exist in the input view. 
  • Original is defined as the data from the input view.
invalidValuePath: "$" error: "Unable to read path: $.colo" reason: "Field not found in JSON object: colo" invalidSubPath: "$.colo" original: color: "black" value: "#000" resolution: "Check the path syntax" stacktrace: "com.Snaplogic.jsonpath.FieldNotFoundException: Field not found in JSON object: colo\n ... invalidValue: color: "black" value: "#000"

Getting Data For Columns Using Fetch Output Fields In Schema

In this example Pipeline, we use an Oracle Select Snap to get data for only the fields that we provide in the Output fields list. 

We configure the Oracle Select Snap to get data from TECTONIC.EMPLOYEE table, and fetch EMPLOYEE_ID and EMPLOYEE_NAME columns in the output.

On validation, we see that only the selected output fields (EMPLOYEE_ID and EMPLOYEE_NAME) appear in the preview and column schema.

Download the Pipeline.

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_Select_Fetch_Output_Fields.slp

Feb 04, 2021 by Kalpana Malladi

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.