Skip to main content


class %Library.Query

For information on this class, see Defining and Using Class Queries.

The %Query class defines the basic interface used by class queries.

Use the %Query class as a type for a class query if you wish to implement the query using custom-written ObjectScript.

Method Inventory


parameter CONTAINID = 0;
parameter EXTENT;
parameter ROWSPEC;
The SELECTMODE parameter allows the query author to declare the format of the values returned by the query. It is the responsibility of the query implementation to properly format the values according to the SELECTMODE value. If SELECTMODE is RUNTIME then the query implementation has to examine the current runtime setting and react accordingly. The current runtime SELECTMODE value can be retrieved by calling $system.SQL.GetSelectMode(). The default value of SELECTMODE is LOGICAL to preserve compatibility with older implementations. REMEMBER - it is only a declaration and the implementation of the query is responsible for properly formatting the column values in a manner consistent with the SELECTMODE setting.
parameter SQLFUNCTION = 0;


classmethod Close(qHandle As %Binary) as %Status
Close the query. qHandle is user-defined data.
classmethod Execute(ByRef qHandle As %Binary) as %Status
Executes the query; This method is called with the query input parameters. qHandle is user-defined data used to communicate amongst the various Query methods.
classmethod Fetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
Fetch the next row of data from the query.

qHandle is query-defined data and is typically updated by Fetch.

The Fetch method should set Row to be a $List of values corresponding to the columns of the query. If we are past the end of the data and no row is returned, Row should be set to null string (""). If the non-empty row being returned is the last one, AtEnd could be optionally set to 1, indicating that an additional call to Fetch may be avoided.

Row may also be subscripted. If any of the columns in the row are stream orefs then the oref type information is lost in the Row $list encoded value. To retain the oref type, place the oref into Row(0,columnNumber). %Library.ResultSet recognizes this form and will extract the column value as the subscripted value.

classmethod FetchRows(ByRef qHandle As %Binary, FetchCount As %Integer = 0, ByRef RowSet As %List, ByRef ReturnCount As %Integer, ByRef AtEnd As %Integer) as %Status
FetchRows returns the next FetchCount rows in the query and updates handle for subsequent operations. FetchCount is the number of rows to fetch. If FetchCount is zero then up to 24k of row data is returned. ReturnCount contains the number of rows returned and AtEnd is true if there are no more rows to be fetched. This method does not preserve swizzled streams.
classmethod Func() as %SQL.StatementResult
Func is a method that is used to invoke the query as a function, returning an instance of %SQL.StatementResult.
classmethod GetInfo(ByRef colinfo As %List, ByRef parminfo As %List, ByRef idinfo As %List, ByRef qHandle As %Binary, extoption As %Integer = 0, ByRef extinfo As %List) as %Status
Returns information about the query. It is used by the various ResultSet objects.

Returns information about columns in the query result, parameters in the query formal list, and whether or not the result contains enough information to form an ID value.

This information is return in three pass-by-reference parmeters:

  • colinfo - contains one list element for each column declared in ROWSPEC. The form is name:exttype:caption
  • parminfo - contains one list element for each formal paramter of the query in the form name:exttype
  • idinfo - contains a list, the first element indicating the position of the ID, zero if not included and the second element is the extent of these ID value.
  • qHandle - query handle, used for dynamic queries
classmethod GetODBCInfo(ByRef colinfo As %List, ByRef parminfo As %List, ByRef qHandle As %Binary)
classmethod Prepare(ByRef qHandle As %Binary, statement As %String, containid As %Integer = 0, optional As %String) as %Status
Prepare the query for execution. For static queries, this method probably just returns $$$OK. For dynamic queries this method will set up the information returned by GetInfo. It is used by the various ResultSet objects.
classmethod SendODBC(ByRef qHandle As %Binary, ByRef array As %String, qacn As %Integer, ByRef %qrc As %Integer, ByRef piece As %Boolean, ColumnCount As %Integer)
Fetch and send a series of rows for the ODBC/JDBC server. For internal use only.


FeedbackOpens in a new tab