Input 

Document

• Min: 0

• Max: 1

• Mapper

• Copy

If the input view is defined, then the WHERE clause can substitute incoming values for a given expression.

Valid JSON paths that are defined in the WHERE clause for queries or statements are substituted with values from an incoming document. If the document is missing a value to be substituted into the query or statement documents, it is written to the error view.

Output

Document

• Min: 0

• Max: 1

• AlloyDB Select

• Mapper

The executed query result. If a SELECT query is executed, the query's results are merged into the incoming document and any existing keys will have their values overwritten. On the other hand, the original document is written if there are no results from the query.

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

Label*

Default Value: AlloyDB Execute
Example: AlloyDB Execute

String

Specify a unique name for the Snap.

SQL Statement

Default Value: 
Example:

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

• emp=$emp

String/Expression

Specify the SQL statement to execute on the server. We recommend you to add a single query in the SQL Statement field.

Query type

Default Value: Auto
Example: Read

Dropdown list/Expression

Select the type of query for your SQL statement (Read or Write).

When Auto is selected, the Snap tries to determine the query type automatically.
If the execution result of the query is not as expected, you can change the query type to Read or Write.

Pass through

Default Value: Selected

Checkbox

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

Ignore empty result

Default Value: Deselected

Checkbox

Select this checkbox to not write any document to the output view when a SELECT operation does not produce any result.
If this checkbox is not selected and the Pass-through checkbox is selected, the input document is passed through to the output view.

Number of Retries

Default Value: 0
Example: 3

Integer/Expression

Specify the maximum number of retry attempts the Snap must make in case there is a network failure and is unable to read the target file. The request is terminated if the attempts do not result in a response.

• If the Number of retries value is set to 0 (the default value), the retry option is disabled, and the Snap does not initiate a retry. The pipeline will not attempt to retry the operation in case of a failure—any failure encountered during the database operation will immediately result in the pipeline failing without any retry attempts to recover from the errors.

• If the Number of retries value is greater than 0, the Snap initiates a download of 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 then attempts to download the file again from the beginning. After 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.

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 results in an exception. 

Auto Commit

Default Value: Use account setting
Example: True

Dropdown list

Choose one of the following options to override the state of the Auto commit on the account. 

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

Snap Execution

Default Value: Execute only
Example: Validate & Execute

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.