![]() |
Java SDK Documentation
24.2.0
|
Public Member Functions | |
final void | cancelUDX (ServerInterface srvInterface) |
void | destroy (ServerInterface srvInterface, SizedColumnTypes argTypes) |
void | destroy (ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams) |
boolean | isCanceled () |
abstract void | processPartition (ServerInterface srvInterface, AnalyticPartitionReader input_reader, AnalyticPartitionWriter output_writer) throws UdfException, DestroyInvocation |
void | setup (ServerInterface srvInterface, SizedColumnTypes argTypes) |
Protected Member Functions | |
void | cancel (ServerInterface srvInterface) |
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.
|
protectedinherited |
Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.
srvInterface | a ServerInterface object used to communicate with Vertica |
Referenced by com.vertica.sdk.UDXObject.cancelUDX().
|
inherited |
Cancel callback invoked when the query running the UDX has been canceled.
See cancel().
srvInterface | a ServerInterface object used to communicate with Vertica |
|
inherited |
Perform per instance destruction. This function may throw errors
srvInterface | a ServerInterface object used to communicate with Vertica |
argTypes | the types of the arguments (as SizedColumnTypes) |
Referenced by com.vertica.sdk.UDXFunction.destroy().
|
inherited |
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
srvInterface | a ServerInterface object used to communicate with Vertica |
argTypes | the types of the arguments (as SizedColumnTypes) |
udSessionParams | a SessionParamWriterMap |
|
inherited |
Referenced by com.vertica.sdk.UDXObject.cancelUDX().
|
abstract |
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 |
UdfException | UDF problem |
DestroyInvocation | vertica canceling – do not catch or handle |
|
inherited |
Perform per instance initialization. This function may throw errors.
srvInterface | a ServerInterface object used to communicate with Vertica |
argTypes | the types of the arguments (as SizedColumnTypes) |