C++ SDK Documentation  v9.1.0
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
oNBasicsBasic utilities mainly for data types
|oCBigInt
||\Clong_double_parts
|oCFiveToScale
|\CUuid
oNEE
|oCDataArea
|\CStringValue
\NVertica
 oCAggregateFunctionInterface for User-Defined Aggregate Function (UDAF). A UDAF operates on one column of data and returns one column of data
 oCAggregateFunctionFactoryInterface for declaring parameters and return types for, and instantiating, an associated AggregateFunction
 oCAnalyticFunctionInterface for User-Defined Analytic Function (UDAnF). A UDAnF operates on rows of data and returns rows of data, not necessarily 1:1
 oCAnalyticFunctionFactoryInterface for declaring parameters and return types for, and instantiating, an associated AnalyticFunction
 oCAnalyticPartitionReaderProvides an iterator-based read interface over all the partition_by keys, order_by keys, and function arguments in a partition
 oCAnalyticPartitionWriterPartition writer for all input data in a single partition. It automatically makes space as needed
 oCBasePartitionWriterColumnBase class for vectorized writing to columns. Efficiently writes each element in a single column
 oCBlockFormatter
 oCBlockFormatterCout
 oCBlockReaderIterator interface for reading rows in a Vertica block
 oCBlockWriterIterator interface for writing rows to a Vertica block
 oCColumnTypesRepresents (unsized) types of the columns used as input/output of a User Defined Function/Transform Function
 oCConcurrencyModel
 oCCounterControllerClass to interact with counters
 oCDataBuffer
 oCDefaultSourceIterator
 oCExecutorParamWriterAn ExecutorParamWriter is a ParamWriter whose scope is limited to a single executor node - it will never be serialized for transfer to a different node. As a result, any object which is allocated from a Vertica memory pool (i.e. a ServerInterface's allocator object) can have its address saved in the ExecutorParamWriter (see setPointer()), and be safely retrieved later on (see getPointer()) from a different API call in the same query
 oCExecutorPlanContextAn ExecutorPlanContext is a PlanContext object whose scope is limited to a single executor node: it and its parameters will never be serialized. In addition to providing information about nodes involved in a query, it indicates how many threads are available and allocated for a load
 oCFilterFactoryProduces and initializes UDFilters to transform input data before parsing
 oCFIunion
 oCIntermediateAggsA wrapper around a single intermediate aggregate value
 oCIterativeSourceFactorySource factory that works with a SourceIterator to produce UDSources
 oCLibraryRegistrar
 oCModel
 oCMultiPhaseTransformFunctionFactoryInterface for declaring parameters and return types for, and instantiating, an associated multi-phase transform function. This class is similar to, but not a subclass of, TransformFunctionFactory
 oCMultipleIntermediateAggsA wrapper around multiple intermediate aggregates
 oCNodeSpecifyingPlanContextInterface that allows storage of query-plan state, when different parts of query planning take place on different computers
 oCParallelismInfo
 oCParamReaderProvides read access to a set of named parameters. This class provides type-specific methods to retrieve values
 oCParamWriterProvides write access to a set of named parameters. This class extends ParamReader to add type-specific methods to write values
 oCParserFactoryProduces and initializes UDParsers to parse input into tuples
 oCPartitionOrderColumnInfoRepresents the partition by and order by column information for each phase in a multi-phase transform function
 oCPartitionReaderIterator-based read interface over all input data in a single partition. Automatically fetches data a block-at-a-time, as needed
 oCPartitionWriterProvides an iterator-based write interface over output data for a single partition. Automatically makes space a block-at-a-time, as needed
 oCPartitionWriterColumn
 oCPartitionWriterColumnsPartitionWriterColumns allow column-by-column access to PartitionWriter data
 oCPartitionWriterNumericColumn
 oCPartitionWriterStringColumn
 oCPartitionWriterUuidColumn
 oCPerColumnParamReaderA wrapper around a map from column to ParamReader
 oCPlanContextShared query-plan state, used when different parts of query planning take place on different nodes. For example, if some work is done on the query initiator node and some is done on each node executing the query, this class stores shared state
 oCPortion
 oCRejectedRecord
 oCScalarFunctionInterface for User-Defined Scalar Function (UDSF). A UDSF produces a single value from a row of data
 oCScalarFunctionFactoryInterface for declaring parameters and return types for, and instantiating, an associated ScalarFunction
 oCScopedTimerCounterClass to start an execution timer on construction and to automatically stop the timer on deconstruction or when manually called with stop()
 oCServerInterfaceProvides UDxs with access to the Vertica server
 |oCFunctionDescription
 |oCRelationDescription
 |\CTypeDescription
 oCSessionParamReaderMapThis class provides an interface for reading the Used defined session parameters
 oCSessionParamWriterMapThis class provides an interface for writing the Used defined session parameters
 oCSizedColumnTypesRepresents types and information to determine the size of the columns as input/output of a User Defined Function/Transform
 |\CPropertiesSets column properties. Properties have specific meaning in a given contexts (e.g., in UDx parameter declaration) and may not apply in every context
 oCSourceFactoryProduces and initializes UDSources to process input data sources
 oCSourceIteratorConstructs a set of Sources to be used by an IterativeSourceFactory
 oCStreamWriterProvides an iterator-based write interface over output data for a stream of blocks. Automatically makes space a block-at-a-time, as needed
 oCTransformFunctionInterface for User-Defined Transform Function (UDTF). A UDTF operates on a table segment and returns zero or more rows of data
 oCTransformFunctionFactoryInterface for declaring parameters and return types for, and instantiating, an associated TransformFunction
 oCTransformFunctionPhaseInterface to provide compile-time information for a single phase of a multi-phase user-defined transform function
 oCUDChunkerSeparates parser input into chunks at record boundaries, allowing parsing to proceed in parallel
 oCUDFileOperator
 oCUDFileSystem
 oCUDFileSystemFactory
 oCUDFileSystemStats
 oCUDFilterReads input data from a UDSource or another UDFilter and transforms it
 oCUDLFactory
 oCUDParserParses an input stream into Vertica tuples (rows to be inserted into a table)
 oCUDSourceAcquires data from an external source (such as a file or URL) and produces that data in a streaming manner
 oCUDxCounterRequest
 oCUDXFactoryParent class for UDx factories; not intended for direct use by applications
 oCUDXFunction
 oCUDXObjectBase class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications
 oCUDxRegistrar
 oCUnsizedUDSourceBase class for UDSource. Use, with IterativeSourceFactory, if computing the size of a source up front would be prohibitively expensive, or if the number of distinct sources would be prohibitively large to use the standard API. Typically you should use UDSource instead
 oCValueRangeReaderThis class represents the value ranges of the arguments of a UDSF, one range per argument
 oCValueRangeWriterThis class represents the output value range of a UDSF
 oCVerticaBlock: Represents an in-memory block of tuples
 oCVerticaBuildInfo
 oCVerticaTypeRepresents types of data that are passed into and returned back from user's code
 oCVerticaValueRangeThis class represents value ranges used in analyzing the output of UDSFs. A range is expressed as a minimum/maximum value (inclusive) pair
 |\CValueRange
 oCVIntervalRepresentation of an Interval in Vertica
 oCVIntervalYMRepresentation of an IntervalYM in Vertica. An Interval can be broken up into years and months
 oCVNumericRepresentation of NUMERIC, fixed point data types in Vertica
 oCVResources
 oCVStringRepresentation of a String in Vertica. All character data is internally encoded as UTF-8 characters and is not NULL terminated
 oCVTAllocatorA pool-based allocator that is provided to simplify memory management for UDF implementors
 \CVUuidRepresentation of Universally Unique Identifier (UUID) data type in Vertica