class represents a special-purpose result set for use in Ensemble. An initialized instance of this class has a live data connection to a data source. The class provides methods to examine the contents of the result set as well as a method to return a static snapshot.
Creating and Initializing a Result Set
To create and initialize an Ensemble SQL result set:
If you just use the %New()
class method, you can create a result set, but it will not be initialized and cannot contain any data. To initialize the result set, use the procedure described here.
Getting Basic Information about the Result Set
property indicates the number of columns in the result set.
property indicates the query statement used by this result set.
Navigating the Result Set
A result set consists of rows of data. You can use the following methods to navigate through the rows:
method Next(ByRef pSC As %Status) returns %Integer
Advances the cursor to the next row and caches the row data. Returns 0 if the cursor is at the end of the result set.
method SkipNext(ByRef pSC As %Status) returns %Integer
Advances the cursor to the next row. Returns 0 if the cursor is at the end of the result set.
Examining the Current Row of the Result Set
Use the following methods to examine the current row of the result set:
method Get(pName As %String) returns %String
Returns the value of the column that has the name pName
, in the current row.
method GetData(pColumn As %Integer) returns %String
Returns the value of the column whose position is specified by pColumn
in the current row.
method GetColumnName(pColumn As %Integer = 0)
Returns the name of the column whose position is specified by pColumn
If the source data contains any unnamed columns, the result set automatically provides names for these columns in the following form: xCol_n