C++ SDK Documentation  9.0
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 NBasicsBasic utilities mainly for data types
 CBigInt
 Clong_double_parts
 CFiveToScale
 CUuid
 NEE
 CDataArea
 CStringValue
 NVertica
 CAggregateFunctionInterface for User-Defined Aggregate Function (UDAF). A UDAF operates on one column of data and returns one column of data
 CAggregateFunctionFactoryInterface for declaring parameters and return types for, and instantiating, an associated AggregateFunction
 CAnalyticFunctionInterface for User-Defined Analytic Function (UDAnF). A UDAnF operates on rows of data and returns rows of data, not necessarily 1:1
 CAnalyticFunctionFactoryInterface for declaring parameters and return types for, and instantiating, an associated AnalyticFunction
 CAnalyticPartitionReaderProvides an iterator-based read interface over all the partition_by keys, order_by keys, and function arguments in a partition
 CAnalyticPartitionWriterPartition writer for all input data in a single partition. It automatically makes space as needed
 CBasePartitionWriterColumnBase class for vectorized writing to columns. Efficiently writes each element in a single column
 CBlockFormatter
 CBlockFormatterCout
 CBlockReaderIterator interface for reading rows in a Vertica block
 CBlockWriterIterator interface for writing rows to a Vertica block
 CColumnTypesRepresents (unsized) types of the columns used as input/output of a User Defined Function/Transform Function
 CConcurrencyModel
 CCounterControllerClass to interact with counters
 CDataBuffer
 CDefaultSourceIterator
 CExecutorParamWriterAn 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
 CExecutorPlanContextAn 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
 CFilterFactoryProduces and initializes UDFilters to transform input data before parsing
 CFIunion
 CIntermediateAggsA wrapper around a single intermediate aggregate value
 CIterativeSourceFactorySource factory that works with a SourceIterator to produce UDSources
 CLibraryRegistrar
 CModel
 CMultiPhaseTransformFunctionFactoryInterface 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
 CMultipleIntermediateAggsA wrapper around multiple intermediate aggregates
 CNodeSpecifyingPlanContextInterface that allows storage of query-plan state, when different parts of query planning take place on different computers
 CParallelismInfo
 CParamReaderProvides read access to a set of named parameters. This class provides type-specific methods to retrieve values
 CParamWriterProvides write access to a set of named parameters. This class extends ParamReader to add type-specific methods to write values
 CParserFactoryProduces and initializes UDParsers to parse input into tuples
 CPartitionOrderColumnInfoRepresents the partition by and order by column information for each phase in a multi-phase transform function
 CPartitionReaderIterator-based read interface over all input data in a single partition. Automatically fetches data a block-at-a-time, as needed
 CPartitionWriterProvides an iterator-based write interface over output data for a single partition. Automatically makes space a block-at-a-time, as needed
 CPartitionWriterColumn
 CPartitionWriterColumnsPartitionWriterColumns allow column-by-column access to PartitionWriter data
 CPartitionWriterNumericColumn
 CPartitionWriterStringColumn
 CPartitionWriterUuidColumn
 CPerColumnParamReaderA wrapper around a map from column to ParamReader
 CPlanContextShared 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
 CPortion
 CRejectedRecord
 CScalarFunctionInterface for User-Defined Scalar Function (UDSF). A UDSF produces a single value from a row of data
 CScalarFunctionFactoryInterface for declaring parameters and return types for, and instantiating, an associated ScalarFunction
 CServerInterfaceProvides UDxs with access to the Vertica server
 CFunctionDescription
 CRelationDescription
 CTypeDescription
 CSessionParamReaderMapThis class provides an interface for reading the Used defined session parameters
 CSessionParamWriterMapThis class provides an interface for writing the Used defined session parameters
 CSizedColumnTypesRepresents 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
 CSourceFactoryProduces and initializes UDSources to process input data sources
 CSourceIteratorConstructs a set of Sources to be used by an IterativeSourceFactory
 CStreamWriterProvides an iterator-based write interface over output data for a stream of blocks. Automatically makes space a block-at-a-time, as needed
 CTransformFunctionInterface for User-Defined Transform Function (UDTF). A UDTF operates on a table segment and returns zero or more rows of data
 CTransformFunctionFactoryInterface for declaring parameters and return types for, and instantiating, an associated TransformFunction
 CTransformFunctionPhaseInterface to provide compile-time information for a single phase of a multi-phase user-defined transform function
 CUDChunkerSeparates parser input into chunks at record boundaries, allowing parsing to proceed in parallel
 CUDFileOperator
 CUDFileSystem
 CUDFileSystemFactory
 CUDFileSystemStats
 CUDFilterReads input data from a UDSource or another UDFilter and transforms it
 CUDLFactory
 CUDParserParses an input stream into Vertica tuples (rows to be inserted into a table)
 CUDSourceAcquires data from an external source (such as a file or URL) and produces that data in a streaming manner
 CUDxCounterRequest
 CUDXFactoryParent class for UDx factories; not intended for direct use by applications
 CUDXObjectBase class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications
 CUDXObjectCancelable
 CUDxRegistrar
 CUnsizedUDSourceBase 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
 CValueRangeReaderThis class represents the value ranges of the arguments of a UDSF, one range per argument
 CValueRangeWriterThis class represents the output value range of a UDSF
 CVerticaBlock: Represents an in-memory block of tuples
 CVerticaBuildInfo
 CVerticaTypeRepresents types of data that are passed into and returned back from user's code
 CVerticaValueRangeThis class represents value ranges used in analyzing the output of UDSFs. A range is expressed as a minimum/maximum value (inclusive) pair
 CValueRange
 CVIntervalRepresentation of an Interval in Vertica
 CVIntervalYMRepresentation of an IntervalYM in Vertica. An Interval can be broken up into years and months
 CVNumericRepresentation of NUMERIC, fixed point data types in Vertica
 CVResources
 CVStringRepresentation of a String in Vertica. All character data is internally encoded as UTF-8 characters and is not NULL terminated
 CVTAllocatorA pool-based allocator that is provided to simplify memory management for UDF implementors
 CVUuidRepresentation of Universally Unique Identifier (UUID) data type in Vertica