Table and Row Objects |
The Table Object contains all of the data in a table, organized by rows. It is obtained by calling the environment.get_table() function, which can be used in the Global Inbound Post Process Script and the Global Inbound Parse-complete Script. (See Environment Variable Functions for more details on this function.)
The following table lists the functions and operations that can be performed on this object:
| Function or Operation | Description |
|---|---|
| len(table) | Get the length (number of rows) of the table. |
| table[i] | Get row i of the table. If a subscript is negative, start counting from the end of the table: for example, table[-1] retrieves the last row, table[-2] the second-last, and so on. |
| append_row() | Add a row to the end of the table. |
| insert_row(i) | Insert a row before row i of the table. The existing rows are shifted down: the existing row i becomes row i+1, and so on. If i is a negative number, the new row is inserted before the ith last row of the table; for example, insert_row(-1) inserts a row immediately before the last row of the table. |
| del table[i] | Delete row i of the table. |
| del table[i:j] | Delete all rows of the table from row i up to, but not including, row j. Row j is not deleted. |
Each row of a Table Object is a Row Object. In a Row Object, you can retrieve data from the row or delete it, as described below:
| Function or Operation | Description |
|---|---|
| has_key(C) | Indicates whether a value for column name C is defined. For example, row.has_key("Name") indicates whether the table row stored in variable row has a value defined for the Name column. |
| row[C] | The value defined for column name C. You can use this in assignments: for example, row["Name"] = "John Doe". |
| del row[C] | Delete the value stored in column C. |
To view examples of how to use these functions, see Retrieving a Table and Adding or Deleting Rows.
 | ||
|
If you want to insert, append or delete rows or update table data, you should perform these tasks in the Global Inbound Parse-complete Script. While these tasks can be performed in the Global Inbound Post Process Script, the data in the tables will already have been written to the database. | ||
 |
 | ||
|
The Table Inbound Script defines a table variable that enables you to delete the row of the table that it is processing. For details on the table variable, see Table Variable. | ||
 |