C++ SDK Documentation
12.0.0
|
Interface for declaring parameters and return types for, and instantiating, an associated ScalarFunction. More...
Public Types | |
enum | UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 } |
Public Member Functions | |
virtual ScalarFunction * | createScalarFunction (ServerInterface &srvInterface)=0 |
virtual void | getParameterType (ServerInterface &srvInterface, SizedColumnTypes ¶meterTypes) |
virtual void | getPerInstanceResources (ServerInterface &srvInterface, VResources &res) |
virtual void | getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) |
virtual void | getPrototype (ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0 |
virtual void | getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType) __override__ |
Public Attributes | |
strictness | strict |
volatility | vol |
Protected Member Functions | |
virtual UDXType | getUDXFactoryType () __override__ |
Protected Attributes | |
Oid | libOid |
std::string | sqlName |
Interface for declaring parameters and return types for, and instantiating, an associated ScalarFunction.
|
inherited |
The type of UDX instance this factory produces
|
pure virtual |
srvInterface | a ServerInterface object used to communicate with Vertica |
|
inlinevirtualinherited |
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.
Reimplemented in Vertica::ParserFactory.
|
inlinevirtualinherited |
Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.
srvInterface | a ServerInterface object used to communicate with Vertica |
res | a VResources object used to tell Vertica what resources are needed by the UDX |
Reimplemented in Vertica::UDLFactory.
Referenced by Vertica::UDXFactory::getPerInstanceResources().
|
inlinevirtualinherited |
Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.
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 UDT was called with |
Reimplemented in Vertica::UDLFactory.
|
pure virtualinherited |
Provides the argument and return types of the UDX
Implemented in Vertica::MultiPhaseTransformFunctionFactory.
Referenced by getReturnType().
|
inlinevirtual |
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 Vertica::FunctionFactory.
|
inlineprotectedvirtual |
Implements Vertica::UDXFactory.
volatility Vertica::ScalarFunctionFactory::vol |
Strictness and Volatility settings that the UDSF programmer can set Defaults are VOLATILE and CALLED_ON_NULL_INPUT