C++ SDK Documentation  9.0
Vertica::UDXObject Class Reference

Base class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications. More...

Inheritance diagram for Vertica::UDXObject:
Inheritance graph
Collaboration diagram for Vertica::UDXObject:
Collaboration graph

Public Member Functions

virtual ~UDXObject ()
 
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
 
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams)
 
virtual void setup (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
 

Detailed Description

Base class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications.

Constructor & Destructor Documentation

virtual Vertica::UDXObject::~UDXObject ( )
inlinevirtual

Destructors MAY NOT throw errors / exceptions. Exceptions thrown during the destructor will be ignored.

Member Function Documentation

virtual void Vertica::UDXObject::destroy ( ServerInterface srvInterface,
const SizedColumnTypes argTypes 
)
inlinevirtual

Perform per instance destruction. This function may throw errors

virtual void Vertica::UDXObject::destroy ( ServerInterface srvInterface,
const SizedColumnTypes argTypes,
SessionParamWriterMap udSessionParams 
)
inlinevirtual

Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

virtual void Vertica::UDXObject::setup ( ServerInterface srvInterface,
const SizedColumnTypes argTypes 
)
inlinevirtual

Perform per instance initialization. This function may throw errors.