AlloyDB Delete

In this article

Overview

You can use this Snap to execute an SQL delete query.

alloydb-delete-overview.png

 

Snap Type

The AlloyDB Delete Snap is a Write-type Snap.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations and Known Issues

None.

Behavior Change

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

 

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

WHERE clause for the delete condition.

Output

Document

 

  • Min: 0

  • Max: 1

Optional

The status of the deleted object.

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.

Snap Settings

  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( ): Indicates that you can add fields in the fieldset.

  • Remove icon ( ): Indicates that you can remove fields from the fieldset.

  • Upload icon ( ): Indicates that you can upload files.

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default Value: AlloyDB Delete
Example: AlloyDB Delete

String

Specify a unique name for the Snap.

 

Schema Name

 

Default Value: N/A
Example: 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: test_table

String/Expression

Table name to execute the delete on.

The values can be passed using the pipeline parameters but not the upstream parameter.

 

Delete condition (deletes all records from table if left blank)

 

Default Value: N/A
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+ "'"

String/Expression

Specify a valid WHERE clause for the delete condition. The delete condition may also be passed through an upstream Snap or through the Pipeline parameters.
The document field values can be substituted into the WHERE clause by providing the path. For example, $person.firstname would insert the field 'firstname' from the 'person' object into the query (firstname == $person.firstname would become firstname == 'Joe' if $person.firstname evaluates to 'Joe'). 

If you leave this field blank, the Snap deletes all the records from the table.

Here is an example of a delete statement. 

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. 

 

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.

Snap Pack History

 

Related Links

Â