![]() |
C++ SDK Documentation
8.1
|
Interface for User-Defined Analytic Function (UDAnF). A UDAnF operates on rows of data and returns rows of data, not necessarily 1:1. More...
Public Member Functions | |
virtual void | cancel (ServerInterface &srvInterface) |
virtual void | destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes) |
virtual void | destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams) |
bool | isCanceled () |
virtual void | processPartition (ServerInterface &srvInterface, AnalyticPartitionReader &input_reader, AnalyticPartitionWriter &output_writer)=0 |
virtual void | setup (ServerInterface &srvInterface, const SizedColumnTypes &argTypes) |
Protected Attributes | |
volatile bool | canceled |
Interface for User-Defined Analytic Function (UDAnF). A UDAnF operates on rows of data and returns rows of data, not necessarily 1:1.
An AnalyticFunction must have an associated AnalyticFunctionFactory.
|
inlinevirtualinherited |
This function is invoked from a different thread when the execution is canceled This baseclass cancel should be called in any override.
|
inlinevirtualinherited |
Perform per instance destruction. This function may throw errors
Referenced by Vertica::UDXObject::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 |
Returns true if execution was canceled.
|
pure virtual |
Invoke a user defined analytic 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.