C++ SDK Documentation
12.0.0
|
Interface for User-Defined Transform Function (UDTF). A UDTF operates on a table segment and returns zero or more rows of data. More...
Public Member Functions | |
void | cancelUDX (ServerInterface &srvInterface) |
virtual void | destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes) |
virtual void | destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams) |
bool | isCanceled () const |
virtual void | processPartition (ServerInterface &srvInterface, PartitionReader &input_reader, PartitionWriter &output_writer)=0 |
virtual void | setup (ServerInterface &srvInterface, const SizedColumnTypes &argTypes) |
Protected Member Functions | |
virtual void | cancel (ServerInterface &srvInterface) |
Interface for User-Defined Transform Function (UDTF). A UDTF operates on a table segment and returns zero or more rows of data.
UDTFs can only be used in the SELECT list of a query. UDTFs are cancelable.
A TransformFunction must have an associated TransformFunctionFactory.
|
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().
|
inlinevirtualinherited |
Perform per instance destruction. This function may throw errors
Referenced by Vertica::UDXFunction::destroy().
|
inlinevirtualinherited |
Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors
|
inlineinherited |
|
pure virtual |
Invoke a user defined transform on a set of rows. As the name suggests, a batch of rows are passed in for every invocation to amortize performance.
srvInterface | a ServerInterface object used to communicate with Vertica |
input_reader | input rows |
output_writer | output location |
|
inlinevirtualinherited |
Perform per instance initialization. This function may throw errors.