C++ SDK Documentation  9.0
Vertica::DefaultSourceIterator Class Reference
Inheritance diagram for Vertica::DefaultSourceIterator:
Inheritance graph
Collaboration diagram for Vertica::DefaultSourceIterator:
Collaboration graph

Public Member Functions

 DefaultSourceIterator (std::vector< UDSource * > sources)
 
UnsizedUDSourcecreateNextSource (ServerInterface &srvInterface)
 Create the next UDSource to process. More...
 
virtual void destroy (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
 Tear down this SourceIterator. More...
 
size_t getNumberOfSources ()
 
size_t getSizeOfSource (size_t sourceNum)
 
virtual void setup (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
 Set up this SourceIterator. More...
 

Member Function Documentation

UnsizedUDSource* Vertica::DefaultSourceIterator::createNextSource ( ServerInterface srvInterface)
inlinevirtual

Create the next UDSource to process.

Should return NULL if no further sources are available for processing.

Note that the previous Source may still be open and in use on a different thread when this function is called.

Returns
a new Source instance corresponding to a new input stream

Implements Vertica::SourceIterator.

virtual void Vertica::SourceIterator::destroy ( ServerInterface srvInterface,
NodeSpecifyingPlanContext planCtxt 
)
inlinevirtualinherited

Tear down this SourceIterator.

Should perform clean-up that should not take place in the destructor due to the exception-handling semantics of destructors.

size_t Vertica::DefaultSourceIterator::getNumberOfSources ( )
inlinevirtual
Returns
the total number of Sources that this factory will produce

Implements Vertica::SourceIterator.

size_t Vertica::DefaultSourceIterator::getSizeOfSource ( size_t  sourceNum)
inlinevirtual
Returns
the raw-data size of the sourceNum'th source that will be produced by createNextSource(). Should return vint_null if the size is unknown.

This value is used as a hint, and is used by the "load_streams" table to display load progress. If incorrect or not set, "load_streams" may contain incorrect or unhelpful information.

Reimplemented from Vertica::SourceIterator.

virtual void Vertica::SourceIterator::setup ( ServerInterface srvInterface,
NodeSpecifyingPlanContext planCtxt 
)
inlinevirtualinherited

Set up this SourceIterator.

Should perform setup that should not take place in the constructor due to the exception-handling semantics of constructors