Input

Document

• Min: 0

• Max: 1

• Mapper Snap

Document that provides values for one or more properties of the Snap or simply for pass through purposes.

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, such as a table name or as a variable as part of the WHERE clause.

Output

Document

• Min: 1

• Max: 2

• Join Snap

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.

This Snap has one document output view by default A second view can be added to dump out the metadata for the table as a document. The metadata document can then be fed into the second input view of a database Insert or Bulk Load Snap so that the table is created in the database with a similar schema as the source table.

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 when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

• Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Field Name

Field Type

Description

Label*

Default Value: Generic JDBC - Select
Example: Generic JDBC - Select

String

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

Default Value: N/A
Example: schema_demo

String/Expression

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

Table Name*

Default Value: N/A
Example: employees_table

String/Expression

Specify the table to execute the select query on.

Where Clause 

Default Value: N/A
Example: SELECT * FROM employees WHERE salary > 50000

String/Expression

Specify the WHERE clause of the SELECT statement. This supports document value substitution (such as $person.firstname will be substituted with the value found in the incoming document at the path). However, you may not use a value substitution after "IS" or "is" word.

Examples:

Without using expressions

• EmpId = 12 

• email = 'you@example.com'

Using expressions

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

• email = $email 

• emp=$emp

• "emp='" + $emp + "'"

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

Order By 

Use this fieldset to specify the columns in the order in which you want to sort the database. The default database sort order will be used.

Column Names

Default Value: N/A
Example: name

String/Expression

Specify the column names.

Limit offset

Default Value: N/A
Example: 0

Integer/Expression

Specify the offset for the limit clause. This is where the result set should start. Starting row for the query. Note that some databases do not support OFFSET, such as Teradata, and the Limit offset property is ignored.

Limit rows 

Default Value: N/A
Example: 10

Integer/Expression

Specify the number of rows to return from the query.

Output fields

Use this fieldset to specify the output fields for SQL SELECT statement.

Output Field

Default Value: N/A
Example: email, address, first, last

String/Expression

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

Fetch Output Fields In Schema

Default Value: Deselected

Checkbox

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.

Pass-through 

Default Value: Selected

Checkbox

Select to make the input document will be pass through the output view under the key 'original'. 

Ignore empty result

Default Value: Deselected

Checkbox

Select if you want no document to be written to the output view when a SELECT operation does not produce any result. If this property is not selected and the Pass-through property is selected, the input document will be passed through to the output view.

Auto Commit

Default Value: False
Example: True

Dropdown list

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: True, False, 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.

Match data types

Default Value: Deselected

Checkbox

This property applies only when the Output fields property is provided with any field value(s).

If this property is selected, the Snap tries to match 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.

Number of Retries

Default Value: 0
Example: 3

Integer/Expression

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.

Retry Interval (seconds)

Default Value: 1
Example:  10

Integer/Expression

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

Staging mode

Default Value: In memory
Example: On disk

Dropdown list

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.

Snap Execution

Default Value: Validate & Execute
Example: Execute only

Dropdown list

Select one of the following three modes in which the Snap executes:

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