com.vertica.sdk.MultiPhaseTransformFunctionFactory Class Reference
Inheritance diagram for com.vertica.sdk.MultiPhaseTransformFunctionFactory:
Collaboration diagram for com.vertica.sdk.MultiPhaseTransformFunctionFactory:
| Public Member Functions | |
|---|---|
| void | getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes) |
| void | getPerInstanceResources (ServerInterface srvInterface, VResources res) |
| void | getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) |
| abstract void | getPhases (ServerInterface srvInterface, Vector phases) |
| void | getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) |
| void | getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException |
| UDXType | getUDXFactoryType () |
| Protected Attributes | |
|---|---|
| long | libOid |
| String | sqlName |
Detailed Description
Interface for declaring parameters and return types for, and instantiating, an associated multi-phase transform function. This class is similar to, but not a subclass of, TransformFunctionFactory.
A multi-phase transform function is made up of TransformFunctionPhase instances. For each phase of your transform, extend this class (not TransformFunction). In getPhases(), return a vector of instances of those classes. Semantically, getPhases() replaces TransformFunctionFactory.createTransformFunction().
Member Function Documentation
void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)
inherited Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.
Parameters
srvInterface: a ServerInterface object used to communicate with VerticaparameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res)
inherited Set the resource required for each instance of the UDX Object subclass
Parameters
srvInterface: a ServerInterface object used to communicate with Verticares: a VResources object used to tell Vertica what resources are needed by the UDX
Referenced by com.vertica.sdk.UDXFactory.getPerInstanceResources().
void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
inherited Set the resource required for each instance of the UDX Object subclass
Parameters
srvInterface: a ServerInterface object used to communicate with Verticares: a VResources object used to tell Vertica what resources are needed by the UDXargTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
abstract void com.vertica.sdk.MultiPhaseTransformFunctionFactory.getPhases(ServerInterface srvInterface, Vector phases)
pure virtual Called when Vertica needs a new TransformFunctionPhase pipeline to process a multi-phase UDTF function call. Vertica invokes the phases in order; collectively they behave like a TransformFunction.
Note More than one object may be instantiated per query.
Parameters
srvInterface: a ServerInterface object used to communicate with Verticaphases: output TransformFunctionPhase objects
Referenced by com.vertica.sdk.MultiPhaseTransformFunctionFactory.getReturnType().
void com.vertica.sdk.MultiPhaseTransformFunctionFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
virtual
Provides the argument and return types of the UDX
Parameters
srvInterface: a ServerInterface object used to communicate with VerticaargTypes: the types of the argumentsreturnType: the type(s) of the return
Implements com.vertica.sdk.UDXFactory.
void com.vertica.sdk.MultiPhaseTransformFunctionFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException
virtual
Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.
For CHAR/VARCHAR types, specify the max length,
For NUMERIC types, specify the precision and scale.
For Time types (with or without time zone), specify the precision, -1 means unspecified/don't care
For IntervalYM/IntervalDS types, specify the precision and range
For all other types, no length/precision specification needed
Parameters
srvInterface: a ServerInterface object used to communicate with VerticaargTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.returnType: User code must fill in the names and data types returned by the UDT.
Implements com.vertica.sdk.UDXFactory.
UDXType com.vertica.sdk.MultiPhaseTransformFunctionFactory.getUDXFactoryType()
virtual
Returns the object type internally used by Vertica
Implements com.vertica.sdk.UDXFactory.