Vertica documentation is moving! Use our new documentation site at https://docs.rocketsoftware.com/bundle/vertica_24.1/page/index.html

com.vertica.sdk.UDLFactory Class Reference

Inheritance diagram for com.vertica.sdk.UDLFactory:

Collaboration diagram for com.vertica.sdk.UDLFactory:

Public Member Functions
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)
abstract UDXType getUDXFactoryType ()
Protected Attributes
long libOid
String sqlName

Member Function Documentation

◆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

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters

◆getPerInstanceResources()

void com.vertica.sdk.UDLFactory.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 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.

◆getPrototype()

void com.vertica.sdk.UDLFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

Provides the argument and return types of the UDL. UDL's take no input tuples; as such, their prototype is empty.

◆getReturnType()

void com.vertica.sdk.UDLFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)

Not used in this form

◆getUDXFactoryType()

abstract UDXType com.vertica.sdk.UDXFactory.getUDXFactoryType()

abstractinherited

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.