Home > Class Reference > ENSLIB namespace > EnsLib.SQL.Snapshot

EnsLib.SQL.Snapshot

persistent class EnsLib.SQL.Snapshot extends %Library.Persistent, %Library.IResultSet, %XML.Adaptor

SQL Table Name: EnsLib_SQL.Snapshot

This class is a specialized result set used with the EnsLib.SQL.OutboundAdapter Instances are returned as output from EnsLib.SQL.OutboundAdapter.ExecuteQuery(). The list of rows is a static snapshot as of the time when the query was executed

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property %CurrentRow as %Integer [ InitialExpression = 0 , Transient ];
This is the index of the 'current' row in the Snapshot. Used by the Next(), Get(), GetData(), and Rewind() methods.
Property methods: %CurrentRowDisplayToLogical(), %CurrentRowGet(), %CurrentRowIsValid(), %CurrentRowLogicalToDisplay(), %CurrentRowNormalize(), %CurrentRowSet(), %CurrentRowXSDToLogical()
property %GblRef as %String (MAXLEN = 80) [ InitialExpression = $Name($$$EnsJobLocal($this)) ];
Location of the storage for the fields of this Snapshot.
Property methods: %GblRefDisplayToLogical(), %GblRefGet(), %GblRefGetStored(), %GblRefIsValid(), %GblRefLogicalToDisplay(), %GblRefLogicalToOdbc(), %GblRefNormalize(), %GblRefSet()
property %Message as %Library.String [ Transient ];
Property methods: %MessageDisplayToLogical(), %MessageGet(), %MessageIsValid(), %MessageLogicalToDisplay(), %MessageLogicalToOdbc(), %MessageNormalize(), %MessageSet()
property %NextColumn as %CacheString [ Private , Transient ];
Property methods: %NextColumnGet(), %NextColumnIsValid(), %NextColumnSet()
property %PrivateTables as array of %XSQL.DS.TempTable [ Transient ];
Inherited description: %PrivateTables is an array of private temporary table orefs used by this result set subscripted by temp table name.
Property methods: %PrivateTablesBuildValueArray(), %PrivateTablesCollectionToDisplay(), %PrivateTablesCollectionToOdbc(), %PrivateTablesDisplayToCollection(), %PrivateTablesGet(), %PrivateTablesGetObject(), %PrivateTablesGetObjectId(), %PrivateTablesGetSwizzled(), %PrivateTablesIsValid(), %PrivateTablesOdbcToCollection(), %PrivateTablesSet(), %PrivateTablesSetObject(), %PrivateTablesSetObjectId()
property %ROWCOUNT as %Library.Integer [ Transient , ReadOnly ];
Property methods: %ROWCOUNTDisplayToLogical(), %ROWCOUNTGet(), %ROWCOUNTIsValid(), %ROWCOUNTLogicalToDisplay(), %ROWCOUNTNormalize(), %ROWCOUNTSet(), %ROWCOUNTXSDToLogical()
property %ROWID as %String) [ Transient ];
Property methods: %ROWIDDisplayToLogical(), %ROWIDGet(), %ROWIDIsValid(), %ROWIDLogicalToDisplay(), %ROWIDLogicalToOdbc(), %ROWIDNormalize(), %ROWIDSet()
property %ResultColumnCount as %Library.Integer [ Transient , ReadOnly ];
Inherited description: %ResultColumnCount is the number of columns in the result set. This value is always zero unless the current result is a RESULTSET object (instance of %SQL.IResultSet) or a procedure context object (instance of %Library.IProcedureContext). For a CALL statement result, this value represents the column count of the result set currently bound. For more information on result set sequences and dynamic result set binding refer to <>.
Property methods: %ResultColumnCountDisplayToLogical(), %ResultColumnCountGet(), %ResultColumnCountIsValid(), %ResultColumnCountLogicalToDisplay(), %ResultColumnCountNormalize(), %ResultColumnCountXSDToLogical()
property %RuntimeMode as %Library.String [ Private , Transient ];
Inherited description: This property is set on instantiation to the current value of $zu(115,5). It cannot be set directly by the user. It is to be used by the result set object to format column and parameter values. SQL based result sets using SELECTMODE=RUNTIME will use this value. The user can indirectly set this value by setting $zu(115,5) prior to calling %Prepare() to instantiate the result set. Possible values are:
  • 0 for LOGICAL mode.
  • 1 for ODBC mode.
  • 2 for DISPLAY mode.
Property methods: %RuntimeModeDisplayToLogical(), %RuntimeModeGet(), %RuntimeModeIsValid(), %RuntimeModeLogicalToDisplay(), %RuntimeModeLogicalToOdbc(), %RuntimeModeNormalize(), %RuntimeModeSet()
property %SQLCODE as %Library.Integer [ Transient ];
Property methods: %SQLCODEDisplayToLogical(), %SQLCODEGet(), %SQLCODEIsValid(), %SQLCODELogicalToDisplay(), %SQLCODENormalize(), %SQLCODESet(), %SQLCODEXSDToLogical()
property AtEnd as %Boolean [ Calculated , Transient , ReadOnly ];
Are we at the last row?
Property methods: AtEndDisplayToLogical(), AtEndGet(), AtEndIsValid(), AtEndLogicalToDisplay(), AtEndLogicalToXSD(), AtEndNormalize(), AtEndXSDToLogical()
property ColCount as %Integer [ Calculated , Transient , ReadOnly ];
This holds the column count for this snapshot
Property methods: ColCountDisplayToLogical(), ColCountGet(), ColCountIsValid(), ColCountLogicalToDisplay(), ColCountNormalize(), ColCountXSDToLogical()
property FirstRow as %Integer [ InitialExpression = 1 ];
The index of the first row in this Snapshot. May be set on input when calling OutboundAdapter.ExecuteQuery() or ResultSet.GetSnapshot() to cause the first n-1 rows to be discarded before populating the Snapshot.
Property methods: FirstRowDisplayToLogical(), FirstRowGet(), FirstRowGetStored(), FirstRowIsValid(), FirstRowLogicalToDisplay(), FirstRowNormalize(), FirstRowSet(), FirstRowXSDToLogical()
property MaxRowsToGet as %Integer [ InitialExpression = 250 ];
The maximum number of rows to populate this Snapshot with. May be set on input to OutboundAdapter.ExecuteQuery() or ResultSet.GetSnapshot(). Set to -1 to get all rows no matter how many.
Property methods: MaxRowsToGetDisplayToLogical(), MaxRowsToGetGet(), MaxRowsToGetGetStored(), MaxRowsToGetIsValid(), MaxRowsToGetLogicalToDisplay(), MaxRowsToGetNormalize(), MaxRowsToGetSet(), MaxRowsToGetXSDToLogical()
property RowCount as %Integer [ Calculated , Transient , ReadOnly ];
This holds the row count