Java SDK Documentation
12.0.0
|
Classes | |
enum | strictness |
enum | volatility |
Public Member Functions | |
abstract ScalarFunction | createScalarFunction (ServerInterface srvInterface) |
void | getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes) |
void | getPerInstanceResources (ServerInterface srvInterface, VResources res) |
void | getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) |
abstract void | getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) |
void | getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException |
UDXType | getUDXFactoryType () |
Public Attributes | |
strictness | strict |
volatility | vol |
Protected Attributes | |
long | libOid |
String | sqlName |
Interface for declaring parameters and return types for, and instantiating, an associated ScalarFunction.
|
pure virtual |
Note: More than one object may be instantiated per query.
srvInterface | a ServerInterface object used to communicate with Vertica |
|
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.
srvInterface | a ServerInterface object used to communicate with Vertica |
parameterTypes | SizedColumnTypes describing the parameters |
|
inherited |
Set the resource required for each instance of the UDX Object subclass
srvInterface | a ServerInterface object used to communicate with Vertica |
res | a VResources object used to tell Vertica what resources are needed by the UDX |
Referenced by com.vertica.sdk.UDXFactory.getPerInstanceResources().
|
inherited |
Set the resource required for each instance of the UDX Object subclass
srvInterface | a ServerInterface object used to communicate with Vertica |
res | a VResources object used to tell Vertica what resources are needed by the UDX |
argTypes | Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx. |
|
pure virtualinherited |
Provides the argument and return types of the UDX
srvInterface | a ServerInterface object used to communicate with Vertica |
argTypes | the types of the arguments |
returnType | the type(s) of the return |
Implemented in com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.
Referenced by com.vertica.sdk.ScalarFunctionFactory.getReturnType().
|
virtual |
For scalar functions, this function needs to be overridden only if the return type needs length/precision specification.
srvInterface | a ServerInterface object used to communicate with Vertica |
argTypes | The data type of the return value defined by processBlock() |
returnType | The size of the data returned by processBlock() |
Implements com.vertica.sdk.UDXFactory.
|
virtual |
Implements com.vertica.sdk.UDXFactory.
volatility com.vertica.sdk.ScalarFunctionFactory.vol |
Strictness and Volatility settings that the UDSF programmer can set Defaults are VOLATILE and CALLED_ON_NULL_INPUT