IRISLIB database
DynamicGWQuery Class Reference
Inheritance diagram for DynamicGWQuery:
Collaboration diagram for DynamicGWQuery:

Static Public Member Functions

_.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 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 sqltext, _.Library.Integer containid, _.Library.String connection)
 Prepare the query for execution. More...
 
- Static Public Member Functions inherited from Query
_.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...
 
_.SQL.StatementResult Func ()
 Func is a method that is used to invoke the query as a function, returning an instance of SQL.StatementResult.
 
 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 Query
 CONTAINID = None
 
 SELECTMODE = None
 The SELECTMODE parameter allows the query author to declare the format of the values returned by the query. More...
 

Member Function Documentation

◆ Close()

_.Library.Status Close ( _.Library.Binary  qHandle)
static

Close the query.

qHandle is user-defined data.

Reimplemented from Query.

◆ Execute()

_.Library.Status Execute ( _.Library.Binary  qHandle)
static

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.

Reimplemented from Query.

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

Reimplemented from Query.

◆ GetInfo()

_.Library.Status GetInfo ( _.Library.List  colinfo,
_.Library.List  parminfo,
_.Library.List  idinfo,
_.Library.Binary  qHandle,
_.Library.Integer  extoption,
_.Library.List  extinfo 
)
static

Returns information about the query.

It is used by the various ResultSet objects.

Reimplemented from Query.

◆ Prepare()

_.Library.Status Prepare ( _.Library.Binary  qHandle,
_.Library.String  statement,
_.Library.Integer  containid,
_.Library.String  optional 
)
static

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.

Reimplemented from Query.