Delete

Activity

 

ospdelete.png  An OpenSpirit Delete Activity creates and executes a query to delete data via an OpenSpirit Data Connection.

 

Configuration

 

OpenSpirit Insert Configuration Fields

 

Field Global Var? Optional? Description
Name No No User assigned name given to query activity
Description No Yes User assigned description (optional)
OpenSpirit Data Connection No No A shared resource that defines a project or data source. See OpenSpirit Data Connection.
SQL Query No No The SQL DELETE query that defines which rows to delete. The SQL is constructed using the OpenSpirit Delete Query builder.
Model No Read Only Displays the data model used in the SQL query.  The model is specified in the OpenSpirit Delete Query builder.

 

 

Input

 

The input for the activity is the following.

 

Input Item Datatype Description
QueryParameters Complex Contains the list of prepared parameters, the values of the attributes to be inserted, in the SQL statement. Prepared parameters allow you to substitute process data for items in the SQL statement. The types and names of the prepared parameters are based on the SQL query.

 

 

Output

 

The output for the activity is the following.

 

Output Item Datatype Description

OspOutput

Complex The root class for the output of the OpenSpirit Insert  activity. This class contains all output items for the activity.
NumRowsDeleted Integer The number of rows deleted by this query.
QueryParameters Complex Contains the list of prepared parameters, the values of the attributes to be inserted, in the SQL statement. Prepared parameters allow you to substitute process data for items in the SQL statement. The types and names of the prepared parameters are based on the SQL query.

 

 

Error Output

 

The Error Output tab lists the possible exceptions that can be thrown by this activity.

 

Exception Thrown When ...

OspException

The query could not be successfully executed.  The msg element should contain some indication of the reason.

 

 

Note that the behavior of the Delete activity will vary across data stores. Some data stores will perform a cascading delete if a parent object is deleted whereas other data stores will require you to delete all children objects before a parent may be deleted. So before using this activity you should have a good understanding of the specifics of the data store that you are deleting from.