Versions Compared

Key

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

...

Field Name

Field Type

Field Dependency

Description

Label*

Default ValueAlloyDB Select
ExampleSelect Query

String

N/A

Specify a unique name for the Snap.

Schema name

Default Value: N/A
ExampleSYS

String/Expression/Suggestion

N/A

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

Table name*

Default Value: N/A
Example: people

String/Expression/Suggestion

N/A

Specify the name of the table to execute a select query on.

Where clause

Default Value: N/A
Example:

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+ "'"

String/Expression/Suggestion

N/A

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

Note

Caution:

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

Order By

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

Limit offset

Default Value: None
Example10

Integer/Expression/Suggestion

N/A

Number of rows to return from the query.

Limit rows 

Default Value: None.
Example10

Integer/Expression/Suggestion

N/A

Number of rows to return from the query.

Output fields

Default Value: None
Example: email, address, first, last, etc.

String/Expression/Suggestion

N/A

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

Fetch output fields In schema

Default Value: Not Selected
Example: Selected

Checkbox

N/A

Select this checkbox 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 select the Fetch Output Fields In Schema check box.

Pass through

Default Value: Selected
Example: Not Selected

Checkbox

N/A

If checked, the input document will be passed through to the output view under the 'original' key.

Ignore empty result

Default Value: Not Selected
Example: Selected

Checkbox

N/A

If selected, no document will 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

N/A

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 autocommit 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 the Auto commit property value inherited by the Account used by the Snap.

Match data types

Default Value: Not Selected
Example: Selected

Checkbox

N/A

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

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

N/A

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

If the value is larger than 0, the Snap first downloads the target file into a temporary local file. If any error occurs during the download, the Snap waits for the time specified in the Retry interval and attempts to download the file again from the beginning. When the download is successful, the Snap streams the data from the temporary file to the downstream Pipeline. All temporary local files are deleted when they are no longer needed.

Ensure that the local drive has sufficient free disk space to store the temporary local file.

Retry interval (seconds)

Default Value: 1
Example: 10

Integer/Expression

N/A

Specifies 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 to store input documents between retries, from the following options:

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

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

Snap Execution

Default Value
Example: Validate & Execute

Dropdown list

N/A

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.

...