Interface for declaring parameters and return types for, and instantiating, an associated TransformFunction.
More...
|
| 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
} |
| |
|
|
Oid | libOid |
| |
|
std::string | sqlName |
| |
Interface for declaring parameters and return types for, and instantiating, an associated TransformFunction.
The type of UDX instance this factory produces
| virtual TransformFunction* Vertica::TransformFunctionFactory::createTransformFunction |
( |
ServerInterface & |
srvInterface | ) |
|
|
pure virtual |
Called when Vertica needs a new TransformFunction object to process a UDTF function call.
- Returns
- a TransformFunction object which implements the UDx API described by this metadata.
- Parameters
-
| srvInterface | a ServerInterface object used to communicate with Vertica |
- Note
- More than one object may be instantiated per query.
| virtual void Vertica::UDXFactory::getParameterType |
( |
ServerInterface & |
srvInterface, |
|
|
SizedColumnTypes & |
parameterTypes |
|
) |
| |
|
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.
| virtual void Vertica::UDXFactory::getPerInstanceResources |
( |
ServerInterface & |
srvInterface, |
|
|
VResources & |
res |
|
) |
| |
|
inlinevirtualinherited |
Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.
- Parameters
-
| srvInterface | a ServerInterface object used to communicate with Vertica |
| res | a VResources object used to tell Vertica what resources are needed by the UDX |
| virtual void Vertica::UDXFactory::getPerInstanceResources |
( |
ServerInterface & |
srvInterface, |
|
|
VResources & |
res, |
|
|
const SizedColumnTypes & |
inputTypes |
|
) |
| |
|
inlinevirtualinherited |
Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.
- Parameters
-
| 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 |
| virtual void Vertica::FunctionFactory::getPrototype |
( |
ServerInterface & |
srvInterface, |
|
|
ColumnTypes & |
argTypes, |
|
|
ColumnTypes & |
returnType |
|
) |
| |
|
pure virtualinherited |
Provides the argument and return types of the UDX
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/Timestamp 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
-
| argTypes | 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. |
Implemented in Vertica::ScalarFunctionFactory.
| virtual UDXType Vertica::TransformFunctionFactory::getUDXFactoryType |
( |
| ) |
|
|
inlineprotectedvirtual |
