Vertica.h File Reference

Contains the classes needed to write User-Defined things in Vertica.

Include dependency graph for Vertica.h:

image

Classes
struct Vertica::LibraryRegistrar
struct Vertica::UDxRegistrar
Namespaces
Vertica
Macros
#define InlineAggregate()
#define RegisterFactory(clazz)
#define RegisterLibrary(author, library_build_tag, library_version, library_sdk_version, source_url, description, licenses_required, signature) Vertica::LibraryRegistrar registrar(author, library_build_tag, library_version, library_sdk_version, source_url, description, licenses_required, signature)

Detailed Description

Contains the classes needed to write User-Defined things in Vertica.

Macro Definition Documentation

◆InlineAggregate

#define InlineAggregate()

Value:

virtual void aggregateArrs(ServerInterface &srvInterface, void **dstTuples,\ int doff, const void *arr, int stride, const void *rcounts,\ int rcstride, int count, IntermediateAggs &intAggs,\ std::vector &intOffsets, BlockReader &arg_reader) override {\ char *arg = const_cast(static_cast(arr));\ const uint8 *rowCountPtr = static_cast(rcounts);\ for (int i=0; i(rowCountPtr);\ char *aggPtr = static_cast(dstTuples[i]) + doff;\ updateCols(arg_reader, arg, rowCount, intAggs, aggPtr, intOffsets);\ aggregate(srvInterface, arg_reader, intAggs);\ arg += rowCount * stride;\ rowCountPtr += rcstride;\ }\ }\Vertica::vposunsigned long long vpos64-bit vertica position Definition: BasicsUDxShared.h:112
Vertica::uint8unsigned char uint8unsigned 8-bit integer Definition: BasicsUDxShared.h:82

InlineAggregate() is used to implement the virtual function "aggregateArrs()" for AggregateFunctions. This allows aggregate functions to work on blocks at a time. This macro should be called from inside an AggregateFunction - for a reference, check the examples in the example folder.

◆RegisterFactory

#define RegisterFactory(clazz)

Value:

clazz clazz##_instance; \ extern "C" Vertica::UDXFactory *get##clazz() { return &clazz##_instance; } \ Vertica::UDxRegistrar clazz##_registrar(#clazz)Vertica::UDXFactoryParent class for UDx factories; not intended for direct use by applications. Definition: VerticaUDx.h:3177

Parameters

  • class: The name of the class to register as a UDx factory. Helper macro for registering UDx's with Vertica

To use: Extend a subclass of UDXFactory (e.g. ScalarFunctionFactory) and then call RegisterFactory with that class name.

For example:

... class MyFactory : public ScalarFunctionFactory ...

RegisterFactory(MyFactory);