com.vertica.sdk.UDXFactory Class Reference
Inheritance diagram for com.vertica.sdk.UDXFactory:
Collaboration diagram for com.vertica.sdk.UDXFactory:
| Classes | |
|---|---|
| enum | UDXType |
| 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 | getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) |
| abstract void | getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException |
| abstract UDXType | getUDXFactoryType () |
| Protected Attributes | |
|---|---|
| long | libOid |
| String | sqlName |
Detailed Description
Parent class for UDx factories; not intended for direct use by applications.
Member Function Documentation
◆getParameterType()
void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)
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
◆getPerInstanceResources() [1/2]
void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res)
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().
◆getPerInstanceResources() [2/2]
void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
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.
◆getPrototype()
abstract void com.vertica.sdk.UDXFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
abstract
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
Referenced by com.vertica.sdk.ScalarFunctionFactory.getReturnType().
◆getReturnType()
abstract void com.vertica.sdk.UDXFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException
abstract
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.
◆getUDXFactoryType()
abstract UDXType com.vertica.sdk.UDXFactory.getUDXFactoryType()
abstract
User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.
Returns the type of UDX Object instance this factory returns.