Actions YAML Reference
Properties | List of all members
UpdateDatabaseRecordsAction Class Reference

Updates one or more database records. More...

Inherits ExecuteSQLAction.

Properties

DataTarget ConnectionSetup [get, set]
 Specifies the database connection setup that is generated by the Database Setup wizard as DataTarget. More...
 
DataTarget Command [get, set]
 Specifies the SQL command source to run. This property is ignored if the command tries to modify a database that does not support modification by using SQL. More...
 
CommonActionProperties

Describes the common action properties for Actions and ActionGroups.

string Name [get, set]
 Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
 
string Description [get, set]
 Specifies the description. The default value is "". More...
 
ActionRunType RunType [get, set]
 Runs the action by using one of the following types: More...
 
bool IgnoreErrors [get, set]
 Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
 
int FailureRetries [get, set]
 Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
 
int RetryInterval [get, set]
 Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...
 

Detailed Description

Updates one or more database records.

For common action properties, see IntegrationAction.
Example:

Actions:
- UpdateDatabaseRecordsAction:
File: C:\MyFolder\MyMSSQL.xml
UPDATE [Record]
SET [Value] = N'New Value'
WHERE ([ID] > 100)
# And more common action properties
...
DataTarget Command
Specifies the SQL command source to run. This property is ignored if the command tries to modify a da...
Definition: ExecuteSQLAction.Properties.cs:156
DataTarget ConnectionSetup
Specifies the database connection setup that is generated by the Database Setup wizard as DataTarget.
Definition: ExecuteSQLAction.Properties.cs:126

Property Documentation

◆ ConnectionSetup

DataTarget ConnectionSetup
getsetinherited

Specifies the database connection setup that is generated by the Database Setup wizard as DataTarget.

Example in which the database connection setup from the XML generated by the Database Setup wizard is used.

<?xml version="1.0" encoding="utf-8"?>
<DatabaseSetup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
</DatabaseSetup>

Example in which the database connection setup from a file in the temporary storage:

File: MyMSSQL.xml

Example in which the database connection setup from a local file or a Librarian file is used:

File: lib://MyMSSQL.xml

Example in which the database connection setup from a could file is used:

File: dropbox://mydropbox/Folder/MyMSSQL.xml

◆ Command

DataTarget Command
getsetinherited

Specifies the SQL command source to run. This property is ignored if the command tries to modify a database that does not support modification by using SQL.

Example:

select * from MyTable
where ID > 1000

Example in which an SQL command from a file in the temporary storage:

File: mysqlcommand.txt

Example in which an SQL command from a local file or a Librarian file is run:

File: lib://mysqlcommand.txt

Example in which an SQL command from a cloud file is run:

File: dropbox://Dropbox/Data.xml

◆ Name

string Name
getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

◆ Description

string Description
getsetinherited

Specifies the description. The default value is "".

◆ RunType

ActionRunType RunType
getsetinherited

Runs the action by using one of the following types:

  • Always (default)
  • Never

◆ IgnoreErrors

bool IgnoreErrors
getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

◆ FailureRetries

int FailureRetries
getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

◆ RetryInterval

int RetryInterval
getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.


The documentation for this class was generated from the following file: