This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %ResultSet.MetaData


class %ResultSet.MetaData extends %Library.RegisteredObject

This class has been superseded. It will remain for compatibility with existing code and samples. We recommend using %SQL.Statement.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property columnCount as %Integer;
The number of columns defined as SQLRESULTCOL that are returned by executing this statement. This is the same as columns.Count().
Property methods: columnCountDisplayToLogical(), columnCountGet(), columnCountIsValid(), columnCountLogicalToDisplay(), columnCountNormalize(), columnCountSet()
property columnIndex as %String) [ MultiDimensional ];
Property methods: columnIndexDisplayToLogical(), columnIndexGet(), columnIndexIsValid(), columnIndexLogicalToDisplay(), columnIndexLogicalToOdbc(), columnIndexNormalize(), columnIndexSet()
property columns as list of %ResultSet.MD.Column;
Property methods: columnsBuildValueArray(), columnsCollectionToDisplay(), columnsCollectionToOdbc(), columnsDisplayToCollection(), columnsGet(), columnsGetObject(), columnsGetObjectId(), columnsGetSwizzled(), columnsIsValid(), columnsOdbcToCollection(), columnsSet(), columnsSetObject(), columnsSetObjectId()
property objects as list of %ResultSet.MD.ObjectId;
Property methods: objectsBuildValueArray(), objectsCollectionToDisplay(), objectsCollectionToOdbc(), objectsDisplayToCollection(), objectsGet(), objectsGetObject(), objectsGetObjectId(), objectsGetSwizzled(), objectsIsValid(), objectsOdbcToCollection(), objectsSet(), objectsSetObject(), objectsSetObjectId()
property parameters as list of %ResultSet.MD.Parameter;
Property methods: parametersBuildValueArray(), parametersCollectionToDisplay(), parametersCollectionToOdbc(), parametersDisplayToCollection(), parametersGet(), parametersGetObject(), parametersGetObjectId(), parametersGetSwizzled(), parametersIsValid(), parametersOdbcToCollection(), parametersSet(), parametersSetObject(), parametersSetObjectId()

Methods (Including Private)

method %Display() as %Status
Display metadata on the current device.
private method %OnNew(initvalue As %CacheString = "", pParameters As %CacheString = "", pObjects As %CacheString = "") as %Status
This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status %ResultSet.MetaData is a metadata class for result set metadata. The initial value is the metadata from a result set object or it is the result set object itself.

method print() as %Status
method printMetaData(pMetadata As %CacheString) as %Status

Inherited Members

Inherited Methods (Including Private)