C++ SDK Documentation  11.0.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
 CDAAllocation
 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
 CBlockFormatter
 CBlockFormatterCout
 CBlockReaderIterator interface for reading rows in a Vertica block
 CBlockWriterIterator interface for writing rows to a Vertica block
 CConcurrencyModel
 CCounterControllerClass to interact with counters
 CDataBuffer
 CDefaultSourceIterator
 Cdefserializer
 Cdefserializer< false, false, Archive, T >
 Cdefserializer< false, true, Archive, T >
 Cdefserializer< true, false, Archive, T >
 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
 CFields
 CProperties
 CFilterFactoryProduces and initializes UDFilters to transform input data before parsing
 CFIunion
 CFunctionFactory
 CIterativeSourceFactorySource factory that works with a SourceIterator to produce UDSources
 CLengthBuffer
 CLibraryRegistrar
 CModel
 CNodeSpecifyingPlanContextInterface that allows storage of query-plan state, when different parts of query planning take place on different computers
 COpenOptions
 CParallelismInfo
 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
 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
 CScopedTimerCounterClass to start an execution timer on construction and to automatically stop the timer on deconstruction or when manually called with stop()
 CSessionParamWriterMapThis class provides an interface for writing the Used defined session parameters
 CSimpleArchiveIn
 CSimpleArchiveOut
 CSizedColumnTypesRepresents types and information to determine the size of the columns as input/output of a User Defined Function/Transform
 CSourceFactoryProduces and initializes UDSources to process input data sources
 CSourceIteratorConstructs a set of Sources to be used by an IterativeSourceFactory
 CSplitArchiver
 CSplitArchiver< false, Archive, T >
 CSplitArchiver< true, Archive, T >
 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
 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
 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
 CUDXFunction
 CUDXObjectBase class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications
 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
 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
 CVNumericTemp
 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
 CTypemod
 CTypemodFields