Vertica::UDKeyManagerFactory Class Reference

Inheritance diagram for Vertica::UDKeyManagerFactory:

Collaboration diagram for Vertica::UDKeyManagerFactory:

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 UDKeyManager *	createUDKeyManager (ServerInterface &srvInterface)=0
virtual void	getParameterType (ServerInterface &srvInterface, SizedColumnTypes &parameterTypes)
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)
virtual void	getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)

Protected Member Functions
virtual UDXType	getUDXFactoryType () __override__

Protected Attributes
Oid	libOid
std::string	sqlName

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited

The type of UDX instance this factory produces

Member Function Documentation

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.

Reimplemented in Vertica::ParserFactory.

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

Reimplemented in Vertica::UDLFactory.

Referenced by Vertica::UDXFactory::getPerInstanceResources().

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

Reimplemented in Vertica::UDLFactory.

virtual void Vertica::UDKeyManagerFactory::getPrototype ( ServerInterface &  srvInterface, ColumnTypes &  argTypes, ColumnTypes &  returnType  )

inlinevirtual

UDKeyManagers take no input tuples; as such, their prototype must be empty.

virtual void Vertica::UDKeyManagerFactory::getReturnType ( ServerInterface &  srvInterface, const SizedColumnTypes &  argTypes, SizedColumnTypes &  returnType  )

inlinevirtual

UDKeyManagers return no output; as such, their prototype must be empty.

virtual UDXType Vertica::UDKeyManagerFactory::getUDXFactoryType ( )

inlineprotectedvirtual

Returns

the object type internally used by Vertica

Implements Vertica::UDXFactory.