DSIExtMetadataHelper Class Reference

A helper class that allows access to the list of tables and stored procedures in a data source. More...

List of all members.

Public Member Functions

virtual bool GetNextProcedure (Simba::SQLEngine::Identifier &out_procedure)=0
 Get the next procedure in the data source.
virtual bool GetNextTable (Simba::SQLEngine::Identifier &out_table)=0
 Get the next table in the data source.
virtual ~DSIExtMetadataHelper ()
 Destructor.

Detailed Description

A helper class that allows access to the list of tables and stored procedures in a data source.

These lists are then used to open the tables and stored procedures, from which the catalog metadata is generated.

Note that this class is optional and that if a DSII provides an implementation of any metadata source, it will be used instead of the default one.


Constructor & Destructor Documentation

virtual ~DSIExtMetadataHelper (  )  [inline, virtual]

Destructor.


Member Function Documentation

virtual bool GetNextProcedure ( Simba::SQLEngine::Identifier out_procedure  )  [pure virtual]

Get the next procedure in the data source.

When this function is first called it should return the first procedure in the data source, and on each successive call it should return the next procedure. When there are no more procedures, it should return false.

Parameters:
out_procedure The struct to fill with information about the next procedure.
Returns:
True if there was another procedure; false otherwise.
virtual bool GetNextTable ( Simba::SQLEngine::Identifier out_table  )  [pure virtual]

Get the next table in the data source.

When this function is first called it should return the first table in the data source, and on each successive call it should return the next table. When there are no more tables, it should return false.

Parameters:
out_table The struct to fill with information about the next table.
Returns:
True if there was another table; false otherwise.

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

Generated on Wed May 17 14:21:17 2017 for SimbaEngine 10.1.3.1011 by simba