Java SDK Documentation  24.1.0
com.vertica.sdk.ScalarFunctionFactory Class Referenceabstract
Inheritance diagram for com.vertica.sdk.ScalarFunctionFactory:
Inheritance graph
Collaboration diagram for com.vertica.sdk.ScalarFunctionFactory:
Collaboration graph

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
 

Detailed Description

Interface for declaring parameters and return types for, and instantiating, an associated ScalarFunction.

Member Function Documentation

◆ createScalarFunction()

abstract ScalarFunction com.vertica.sdk.ScalarFunctionFactory.createScalarFunction ( ServerInterface  srvInterface)
abstract

Note: More than one object may be instantiated per query.

Parameters
srvInterfacea ServerInterface object used to communicate with Vertica
Returns
a ScalarFunction object which implements the UDx API described by this metadata.

◆ getParameterType()

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
srvInterfacea ServerInterface object used to communicate with Vertica
parameterTypesSizedColumnTypes describing the parameters

◆ getPerInstanceResources() [1/2]

void com.vertica.sdk.UDXFactory.getPerInstanceResources ( ServerInterface  srvInterface,
VResources  res 
)
inherited

Set the resource required for each instance of the UDX Object subclass

Parameters
srvInterfacea ServerInterface object used to communicate with Vertica
resa 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 
)
inherited

Set the resource required for each instance of the UDX Object subclass

Parameters
srvInterfacea ServerInterface object used to communicate with Vertica
resa VResources object used to tell Vertica what resources are needed by the UDX
argTypesProvides 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 
)
abstractinherited

Provides the argument and return types of the UDX

Parameters
srvInterfacea ServerInterface object used to communicate with Vertica
argTypesthe types of the arguments
returnTypethe type(s) of the return

Referenced by com.vertica.sdk.ScalarFunctionFactory.getReturnType().

◆ getReturnType()

void com.vertica.sdk.ScalarFunctionFactory.getReturnType ( ServerInterface  srvInterface,
SizedColumnTypes  argTypes,
SizedColumnTypes  returnType 
) throws UdfException

For scalar functions, this function needs to be overridden only if the return type needs length/precision specification.

Parameters
srvInterfacea ServerInterface object used to communicate with Vertica
argTypesThe data type of the return value defined by processBlock()
returnTypeThe size of the data returned by processBlock()

◆ getUDXFactoryType()

UDXType com.vertica.sdk.ScalarFunctionFactory.getUDXFactoryType ( )
Returns
the object type internally used by Vertica

Member Data Documentation

◆ vol

volatility com.vertica.sdk.ScalarFunctionFactory.vol

Strictness and Volatility settings that the UDSF programmer can set Defaults are VOLATILE and CALLED_ON_NULL_INPUT