Sparksee  5.2.0
STSQueryStream Class Reference

Query stream interface. More...

Inheritance diagram for STSQueryStream:
Inheritance graph
Collaboration diagram for STSQueryStream:
Collaboration graph

Instance Methods

(BOOL) - prepare:
 Prepares the stream before it is started.
 
(BOOL) - start:
 Starts the stream.
 
(BOOL) - fetch:
 Gets the next row and moves the iterator forward.
 

Detailed Description

Query stream interface.

A QueryStream is the interface between the application and the STREAM operator. When the operator starts inside a Query, the method is prepared with query-defined arguments. Then, if there are input operations, the STREAM operator builds the ResultSets and starts the iteration. Finally, the operator fetches rows until no more are available.

Application exceptions must be cached by the subclass that implements the interface.

Author
Sparsity Technologies http://www.sparsity-technologies.com

Method Documentation

- (BOOL) fetch: (STSValueList *)  list

Gets the next row and moves the iterator forward.

The end of sequence is denoted by returning TRUE with an empty row. A valid row must contain as many values (even NULL) as expected by the query.

Parameters
list[out] Storage for the new rows
Returns
TRUE if there is a row or end of sequence, FALSE on error
- (BOOL) prepare: (STSValueList *)  list

Prepares the stream before it is started.

Parameters
list[in] Optional list of arguments
Returns
FALSE on error
- (BOOL) start: (STSResultSetList *)  list

Starts the stream.

Parameters
list[in] Optional list of input ResultSets
Returns
FALSE on error

The documentation for this class was generated from the following file: