RowSQLQuery Class Reference

This class is used to implement the 'complete row' SQL query that can be used to return the entire persistent state of an object. More...

Inheritance diagram for RowSQLQuery:

Collaboration diagram for RowSQLQuery:

Static Public Member Functions
_.Library.Status	Close (_, _.Library.Binary qHandle)
	Close the query associated with the handle.
_.Library.Status	Fetch (_, _.Library.Binary qHandle, _.Library.List Row, _.Library.Integer AtEnd)
	Fetch the next row of data from the query. More...
Static Public Member Functions inherited from SQLQuery
_.Library.Status	Execute (_, _.Library.Binary qHandle)
	Execute is passed parameters for Query. More...
_.Library.Status	FetchRows (_, _.Library.Binary qHandle, _.Library.Integer FetchCount, _.Library.List RowSet, _.Library.Integer ReturnCount, _.Library.Integer AtEnd)
	FetchRows returns the next FetchCount rows in the query. More...
_.SQL.StatementResult	Func ()
	Func is a method that is used to invoke the query as a function, returning an instance of SQL.StatementResult.
_.Library.Status	GetInfo (_.Library.List colinfo, _.Library.List parminfo, _.Library.List idinfo, _, _.Library.Binary qHandle, _.Library.Integer extoption, _.Library.List extinfo)
	Returns information about the query. More...
	SendODBC (_, _.Library.Binary qHandle, _.Library.String array, _.Library.Integer qacn, _, _.Library.Integer qrc, _.Library.Boolean piece, _.Library.Integer ColumnCount)
	Fetch and send a series of rows for the ODBC/JDBC server. More...
Static Public Member Functions inherited from Query
_.Library.Status	Close (_.Library.Binary qHandle)
	Close the query. More...
_.Library.Status	Execute (_.Library.Binary qHandle)
	Executes the query; This method is called with the query input parameters. More...
_.Library.Status	Fetch (_.Library.Binary qHandle, _.Library.List Row, _.Library.Integer AtEnd)
	Fetch the next row of data from the query. More...
_.Library.Status	FetchRows (_.Library.Binary qHandle, _.Library.Integer FetchCount, _.Library.List RowSet, _.Library.Integer ReturnCount, _.Library.Integer AtEnd)
	FetchRows returns the next FetchCount rows in the query and updates handle for subsequent operations. More...
_.Library.Status	GetInfo (_.Library.List colinfo, _.Library.List parminfo, _.Library.List idinfo, _.Library.Binary qHandle, _.Library.Integer extoption, _.Library.List extinfo)
	Returns information about the query. More...
_.Library.Status	Prepare (_.Library.Binary qHandle, _.Library.String statement, _.Library.Integer containid, _.Library.String optional)
	Prepare the query for execution. More...
	SendODBC (_.Library.Binary qHandle, _.Library.String array, _.Library.Integer qacn, _, _.Library.Integer qrc, _.Library.Boolean piece, _.Library.Integer ColumnCount)
	Fetch and send a series of rows for the ODBC/JDBC server. More...

Additional Inherited Members
Static Public Attributes inherited from SQLQuery
	COMPILEMODE = None
	COMPILEMODE parameter deprecated. More...
Static Public Attributes inherited from Query
	CONTAINID = None
	SELECTMODE = None
	The SELECTMODE parameter allows the query author to declare the format of the values returned by the query. More...

Detailed Description

This class is used to implement the 'complete row' SQL query that can be used to return the entire persistent state of an object.

This class is not for application use.

Member Function Documentation

Fetch()

_.Library.Status Fetch (   _, _.Library.Binary  qHandle, _.Library.List  Row, _.Library.Integer  AtEnd  )

static

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(columnNumber). Library.ResultSet recognizes this form and will extract the column value as the subscripted value.

Reimplemented from SQLQuery.