C++ SDK Documentation  9.0
Public Member Functions | Static Public Attributes | List of all members
Vertica::UnsizedUDSource Class Referenceabstract

Base class for UDSource. Use, with IterativeSourceFactory, if computing the size of a source up front would be prohibitively expensive, or if the number of distinct sources would be prohibitively large to use the standard API. Typically you should use UDSource instead. More...

Inheritance diagram for Vertica::UnsizedUDSource:
Inheritance graph
Collaboration diagram for Vertica::UnsizedUDSource:
Collaboration graph

Public Member Functions

virtual void destroy (ServerInterface &srvInterface)
 
virtual void destroy (ServerInterface &srvInterface, SessionParamWriterMap &udSessionParams)
 
virtual Portion getPortion ()=0
 
virtual std::string getUri ()
 
virtual StreamState process (ServerInterface &srvInterface, DataBuffer &output)=0
 
virtual size_t requestMinBufferSize (ServerInterface &srvInterface)
 
virtual void setup (ServerInterface &srvInterface)
 

Static Public Attributes

static const size_t DEFAULT_MIN_BUFFER_SIZE = 1024 * 1024
 

Detailed Description

Base class for UDSource. Use, with IterativeSourceFactory, if computing the size of a source up front would be prohibitively expensive, or if the number of distinct sources would be prohibitively large to use the standard API. Typically you should use UDSource instead.

Not intended or optimized for typical applications.

Member Function Documentation

virtual Portion Vertica::UnsizedUDSource::getPortion ( )
pure virtual

Return the portion this source object is responsible for (if any).

This can be used by other elements of the load stack to determine how much data to process. It also will uniquely identify a source in the load_sources view. As such, this will be called BEFORE setup() (for load_sources) and again after setup() (for data processing).

Implemented in Vertica::UDSource.

virtual std::string Vertica::UnsizedUDSource::getUri ( )
inlinevirtual

UnsizedUDSource::getUri()

Return the URI of the current source of data.

This function will be invoked during execution to fill in monitoring information.

virtual size_t Vertica::UnsizedUDSource::requestMinBufferSize ( ServerInterface &  srvInterface)
inlinevirtual

Request a minimum buffer size into which this source will read data. This will be called after setup(), before the first call to process().