C++ SDK Documentation
24.2.0
|
Constructs a set of Sources to be used by an IterativeSourceFactory. More...
Public Member Functions | |
void | cancelUDX (ServerInterface &srvInterface) |
virtual UnsizedUDSource * | createNextSource (ServerInterface &srvInterface)=0 |
Create the next UDSource to process. More... | |
virtual void | destroy (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) |
Tear down this SourceIterator. More... | |
virtual size_t | getNumberOfSources ()=0 |
indicate an upper bound for the number of sources this factory will produce. More... | |
virtual size_t | getSizeOfSource (size_t sourceNum) |
bool | isCanceled () const |
virtual void | setup (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) |
Set up this SourceIterator. More... | |
Protected Member Functions | |
virtual void | cancel (ServerInterface &srvInterface) |
Constructs a set of Sources to be used by an IterativeSourceFactory.
Wrappers to help construct and manage UDLs createNextSource() will be called repeatedly until it returns NULL. Each resulting Source will be read to completion, and the contained data passed to the Filter and Parser.
|
inlineprotectedvirtualinherited |
Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.
Referenced by Vertica::UDXObject::cancelUDX().
|
inlineinherited |
Cancel callback invoked when the query running the UDX has been canceled. See cancel().
|
pure virtual |
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.
Implemented in Vertica::DefaultSourceIterator.
|
inlinevirtual |
Tear down this SourceIterator.
Should perform clean-up that should not take place in the destructor due to the exception-handling semantics of destructors.
|
pure virtual |
indicate an upper bound for the number of sources this factory will produce.
If this method returns N, then createNextSource() will be called at most N times ("at most" because it will stop being called when it returns NULL).
Implemented in Vertica::DefaultSourceIterator.
Referenced by Vertica::SourceFactory::getDesiredThreads().
|
inlinevirtual |
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 in Vertica::DefaultSourceIterator.
|
inlineinherited |
|
inlinevirtual |
Set up this SourceIterator.
Should perform setup that should not take place in the constructor due to the exception-handling semantics of constructors