Home > Class Reference > ENSLIB namespace > %SQL.StatementResult

%SQL.StatementResult

class %SQL.StatementResult extends %Library.RegisteredObject

%SQL.StatementResult Base Dynamic Statement Result Descriptor.

Dynamic SQL Statement Result

%SQL.StatementResult is the result descriptor class. Executing a dynamic statement (by calling statement.%Execute or ##class(%SQL.Statement).%ExecDirect where statement is an instance of %SQL.Statement) returns an instance of %SQL.StatementResult.

The content of a statement result object varies depending on the statement type and whether or not the statement was successfully executed. The interface to the result object is the same for all statement types but the content of the result object varies.

When retrieving results, first check for successful execution by examining %SQLCODE. For many statement types, success/failure is all that is needed. The %SQLCODE property contains the SQL error code value. Successful completion values are 0 (successful completion) and 100 (the operation has either found no data or reached the end of the data). Error condition values are negative numbers. Many statements affect some number of rows. The number of rows affected by the statement execution is contained in the %ROWCOUNT property. For a SELECT statement, if the cursor is positioned after the last row, the value of %ROWCOUNT indicates the number of rows contained in the result set. At any other time, %ROWCOUNT contains the number of rows retrieved thus far. %ROWID is set to the RowID of the last record modified by the most recent INSERT, UPDATE, INSERT OR UPDATE, DELETE, or TRUNCATE TABLE operation. After an INSERT statement, the %ROWID property contains the system-assigned value of the RowID (Object ID) assigned to the new record.

A successfully executed SELECT statement returns a single result set. The number of columns in the result set is contained in %ResultColumnCount. A cursor (iterator) is available to retrieve rows from the result set. To advance t