reftable.Read()

Syntax

list reftable.Read(map search-criteria)

Parameters

Parameter	Type	Description
search-criteria (required)	map	A field or fields that identify one or more rows in the reftable object, represented as a map object where the column name is the key and the field value is the value.

Returns

A list of map objects; one for each of the rows that match the search-field parameter in the reftable object.

Remarks

If you pass the method an empty map as the search-field parameter, it returns all the rows of the reference table. The method returns an empty list if there is no row that matches the search-criteria parameter in the reftable object. If the search-criteria parameter includes a column name that the reference table does not have, the method throws a No column ... in table... runtime error.

Sample

Download the declaration file for the sample reference table here.

Figure 410. The reference table used in the sample below

tableSample.rfs

trace db.cat.Read({name: "Fjord"});
trace db.cat.Read(map.New());
trace db.cat.Read({name: "Igor"});
/* This throws a 'No column ... in table...' runtime error
trace db.cat.Read({size: "medium"});
*/

[{name: "Fjord", age: 3, color: "ginger", weight: 2, sex: "female"}]
[{name: "Fjord", age: 3, color: "ginger", weight: 2, sex: "female"}]
[]

Figure 411. The trace message output of the script above

Developer Documentation

The reftable data type