Oracle - Execute

In this article

Overview

You can use this Snap to execute an Oracle statement or query. This is a Write Snap type.

This Snap:

  • is for simple DML (SELECT, INSERT, UPDATE, DELETE) type statements. For the comprehensive scripting functionality offered by various databases, you should use stored procedure functionality offered by their chosen database using the Stored Procedure Snap.
  • might drop your database, hence be cautious.

  • If you execute a SELECT query, the query's results are merged into the incoming document and the values of any existing keys will be overwritten. On the other hand, if there are no results from the query, the original document is written.
  • Any valid JSON paths that you define in the WHERE clause for queries/statements are substituted with values from an incoming document. Documents will be written to the error view if the document is missing a value to be substituted into the query/statement. 

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

  • Due to the limitation in Oracle JDBC driver, the SQL statement cannot have semicolons at the end except that it is a BEGIN-END block.
  • This Snap cannot invoke procedures, hence we recommend you to use Oracle Stored Procedure Snap for invoking procedures.

Known Issues

When the SQL statement property is an expression, the Pipeline parameters are shown in the Suggest, but not the input schema.

Behavior Change

  • In 4.26, when the stored procedures were called using the Database Execute Snaps, the queries were treated as write queries instead of read queries. So the output displayed message and status keys after executing the stored procedure.
    In 4.27, all the Database Execute Snaps run stored procedures correctly, that is, the queries are treated as read queries. The output now displays message key, and OUT params of the procedure (if any). The status key is not displayed.
  • If the stored procedure has no OUT parameters then only the message key is displayed with value success.

If you have any existing Pipelines that are mapped with status key or previous description then those Pipelines will fail. So, you might need to revisit your Pipeline design.

Snap Input and Output

Input/OutputType of viewNumber of viewsExamples of Upstream/Downstream SnapDescription
InputDocument
  • Min:0
  • Max:1
  • JSON Generator
  • JSON Formatter
  • XML Formatter
This Snap has at most one document input view. If the input view is defined, then the where clause can substitute incoming values for a given expression.
OutputDocument
  • Min:1
  • Max:1
  • Mapper
  • Copy
  • JSON Formatter and File Writer

This Snap has at most one document output view. If an output view is available and an update/insert/merge/delete statement was executed, then the original document that was used to create the statement will be output with the status of the statement executed.

Database Write Snaps output all records of a batch (as configured in your account settings) to the error view if the write fails during batch processing.

Snap Settings

FieldField TypeDescription

Label*


String

Enter a unique 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.

Default Value: Oracle Execute
Example: Oracle Execute

SQL statement*


String

Specify the SQL statement to execute on the server.

Executing SQL statements in SnapLogic

You must understand the following scenarios to successfully execute your SQL statements:

Scenario 1: Executing SQL statements without expressions
If you do not enable the expression toggle of the SQL statement field:  

  • The SQL statement must not be within quotes. 
  • The $<variable_name> parts of the SQL statement are expressions. In the below example, $id and $book.

Examples:

Additionally, the JSON path is allowed only in the WHERE clause. If the SQL statement starts with SELECT (case-insensitive), the Snap regards it as a select-type query and executes once per input document. If not, it regards it as write-type query and executes in batch mode.

If your Oracle table has columns whose names contain a '$' (or any other special character) in it, enclose the column name within quotes, such as: select "USER$ID" from testtable1


Scenario 2: Executing SQL queries using expressions
If you enable the expression toggle of the SQL statement field:  

  • The SQL statement must be within quotes. 
  • The + $<variable_name> + parts of the SQL statement are expressions, and must not be within quotes. In the below example, $tablename.
  • The $<variable_name> parts of the SQL statement are bind parameter, and must be within quotes. In the below example, $id and $book.
Table name and column names must not be provided as bind parameters. Only values can be provided as bind parameters.

Examples:


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

  • Select * from "Snap10gic$#_1".emp order by ID asc
  • select firstname from test.cyclist_name
  • INSERT statement "insert into " + $tablename + " (city, temp_lo, temp_hi, date) values ('" + $city + "','" + $temp_lo + "', '" + $temp_hi + "', '" + $date + "')"
  • "select * from " + $tablename

  • The non-expression form uses bind parameters, so it is much faster than executing N arbitrary SQL expressions.
  • 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 '$' sign and identifier characters, such as double quotes (“), single quotes ('), or back quotes (`), are reserved characters and should not be used in comments or for purposes other than their originally intended purpose.

We recommend you to use the Oracle Stored Procedure Snap for invoking procedures as the Oracle Execute Snap has the following limitation while invoking procedures:

  • Procedures have to invoked as a PL/SQL block (with older jdbc JARs).  However, with this approach the output parameters cannot be sent to the output view.  Besides, the latest oracle jdbc drivers do not support PL/SQL.

Oracle JDBC documentation recommends using CallableStatement for invoking procedures, which is what the Oracle Stored Procedure Snap does.


Single quotes in values must be escaped

Any relational database (RDBMS) treats single quotes (') as special symbols. So, single quotes in the data or values passed through a DML query may cause the Snap to fail when the query is executed. Ensure that you pass two consecutive single quotes in place of one within these values to escape the single quote through these queries.

For example:

If String To pass this valueUse
Has no single quotes
Schaum Series
'Schaum Series'
Contains single quotes
O'Reilly's Publication
'O''Reilly''s Publication'

Default Value: [None]

Pass through


Checkbox

Select this checkbox to pass the input document to the output view under the key 'original'. This field applies only to the Execute Snaps with SELECT statement.

Default Value: Selected


Ignore empty result


Checkbox

Select this checkbox to not write any document to the output view when a SELECT operation does not produce any result.
If you deselect this checkbox and select Pass through, the input document will be passed through to the output view.

Default Value: Not selected


Auto commit

Dropdown list

Choose one of the options from the list to override the state of the Auto commit on the account. The available options are:

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

Default Value: Use account setting

'Auto commit' may be enabled for certain use cases if PostgreSQL jdbc driver is used in either Redshift, PostgreSQL or generic JDBC Snap. But the JDBC driver may cause out of memory issues when Select statements are executed. In those cases, “Auto commit" in Snap property should be set to ‘False’ and the Fetch size in the “Account setting" can be increased for optimal performance.

Behavior of DML Queries in Database Execute Snap when auto-commit is false

DDL queries used in the Database Execute Snap will be committed by the Database itself, regardless of the Auto-commit setting.
When Auto commit is set to false for the DML queries, commit will be called only at the end of the pipeline lifecycle.
Instead of building multiple Snaps with inter dependent DML queries, we recommend you to use the Oracle - Stored Procedure Snap.
The Auto commit needs to be true in a scenario where the downstream Snap does depend on the data processed on an Upstream Database Execute Snap containing a DML query.
When the Auto commit is set to the Use account setting on the Snap, the account level commit needs to be enabled.
Number of retriesInteger

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

Retry interval (seconds)Integer

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

Snap Execution

Dropdown list

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.


Examples



 Get the student's records from a table

In this example, we have a table named STUDENT that stores students' scores. It has 3 columns: ID, NAME and SCORE. We will get the record of a student named "Brace" with this pipeline:

 

The JSON Generator Snap passes the student's name to Oracle-Execute Snap:


The Oracle-Execute Snap executes a select SQL statement to get the student's information from table STUDENT. Note that the student's name passed from previous Snap can be accessed with "$name".

Here is the running result of the pipeline:

 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:

 

The Oracle - Execute Snap tries to select AGE column that doesn't exist in table STUDENT. This should cause a SQL execution error and the error message will be routed to error view:

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

Feb 23, 2022 by Subhajit Sengupta

Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates

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.