Skip to content

TSTool / Command / DeleteTableRows


Overview

The DeleteTableRows command deletes specified rows from a table using one of the following approaches:

  • Condition
    • delete rows where a column value matches a condition
  • Row Number
    • delete specific row numbers
    • delete all rows

Because the deletion is a destructive action, one of the above conditions is required to be specified.

Command Editor

The following dialog is used to edit the command and illustrates the syntax of the command.

DeleteTableRows_Condition

DeleteTableRows Command Editor for Condition Parameter (see also the full-size image)

DeleteTableRows_RowNum

DeleteTableRows Command Editor for Row Number Parameter (see also the full-size image)

Command Syntax

The command syntax is as follows:

DeleteTableRows(Parameter="Value",...)

Command Parameters

Parameter                           Description Default          
TableID
required
The table identifier for the table to process. Can specify with ${Property}. None - must be specified.
Condition A condition to match rows to be deleted. Can use ${Property} to specify row number. See additional information in the Tables appendix. Condition or row number must be specified.
DeleteRowNumbers The row number(s) to delete:
  • Comma-separated list of row numbers (1+)
  • last to delete the last row
  • * to delete all rows.

Can use ${Property}.
Condition or row number must be specified.

Examples

See the automated tests.

A simple comma-separated-value data as follows can be read with ReadTableFromDelimitedFile:

# Simple table for testing
"string1","double1","integer1"
"String1",1.0,1
"String2",2.0,2
"String3",3.0,3

The command file to read the above file and remove the first and last rows is as follows:

ReadTableFromDelimitedFile(TableID="Table1",InputFile="testtable.csv")
DeleteTableRows(TableID="Table1",DeleteRowNumbers="1")
DeleteTableRows(TableID="Table1",DeleteRowNumbers="last")

Troubleshooting

See Also