ForeignTableQuery Class Reference

Inheritance diagram for ForeignTableQuery:

Collaboration diagram for ForeignTableQuery:

Static Public Member Functions
_.Library.Status	Close (_, _.Library.Binary qHandle)
	Close the connection assoicated with the foreign data wrapper object qHandle
_.Library.Status	Execute (_, _.Library.Binary qHandle, _.Library.String query, _.Library.List parameters)
_.Library.Status	Fetch (_, _.Library.Binary qHandle, _.Library.List Row, _.Library.Integer AtEnd)
	Fetch the next row of data from the external source. More...
_.SQL.StatementResult	Func ()
	Func is a method that is used to invoke the query as a function, returning an instance of SQL.StatementResult.
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 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

Execute()

_.Library.Status Execute (   _, _.Library.Binary  qHandle, _.Library.String  query, _.Library.List  parameters  )

static

Execute takes optional whereClause and parameters parameters

for predicate pushdown. This method creates an object of the relevant foreign data wrapper class (SQL.FDW.*) and returns it by reference in qHandle.

Fetch()

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

static

Fetch the next row of data from the external source.

qHandle is a foreign data wrapper object.

The Fetch method sets Row to be a $List of values corresponding to the columns of the query by passing the row by reference to the Fetch method of the foreign data wrapper. 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 is set to 1, indicating that an additional call to Fetch may be avoided.