Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
| Basics | Basic utilities mainly for data types |
|---|---|
| BigInt | |
| FiveToScale | |
| Uuid | |
| EE | |
| DAAllocation | |
| DataArea | |
| StringValue | |
| Vertica | |
| Array | |
| ArrayReader | Interface for reading array data. This class wraps a BlockReader which reads the elements of an array datum |
| ArrayWriter | Interface for writing elements into an array datum |
| AESKey | |
| AggregateFunction | Interface for User-Defined Aggregate Function (UDAF). A UDAF operates on one column of data and returns one column of data |
| AggregateFunctionFactory | Interface for declaring parameters and return types for, and instantiating, an associated AggregateFunction |
| AnalyticFunction | Interface for User-Defined Analytic Function (UDAnF). A UDAnF operates on rows of data and returns rows of data, not necessarily 1:1 |
| AnalyticFunctionFactory | Interface for declaring parameters and return types for, and instantiating, an associated AnalyticFunction |
| AnalyticPartitionReader | Provides an iterator-based read interface over all the partition_by keys, order_by keys, and function arguments in a partition |
| AnalyticPartitionWriter | Partition writer for all input data in a single partition. It automatically makes space as needed |
| BasePartitionWriterColumn | Base class for vectorized writing to columns. Efficiently writes each element in a single column |
| BlockFormatter | |
| BlockFormatterCout | |
| BlockReader | Iterator interface for reading rows in a Vertica block |
| BlockWriter | Iterator interface for writing rows to a Vertica block |
| ClientMessage | Holds the contents of a user-defined message to be reported by a UDx |
| ColumnTypes | Represents (unsized) types of the columns used as input/output of a User Defined Function/Transform Function |
| ConcurrencyModel | |
| CounterController | Class to interact with counters |
| DataBuffer | |
| DefaultSourceIterator | |
| defserializer | |
| defserializer | |
| defserializer | |
| defserializer | |
| ExecutorParamWriter | An 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 |
| ExecutorPlanContext | An 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 |
| Field | |
| Fields | |
| Properties | |
| FilterFactory | Produces and initializes UDFilters to transform input data before parsing |
| FIunion | |
| FunctionFactory | |
| IntermediateAggs | A wrapper around a single intermediate aggregate value |
| IterativeSourceFactory | Source factory that works with a SourceIterator to produce UDSources |
| LengthBuffer | |
| LibraryRegistrar | |
| Model | |
| MultiPhaseTransformFunctionFactory | Interface 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 |
| MultipleIntermediateAggs | A wrapper around multiple intermediate aggregates |
| NodeSpecifyingPlanContext | Interface that allows storage of query-plan state, when different parts of query planning take place on different computers |
| OpenOptions | |
| ParallelismInfo | |
| ParamReader | Provides read access to a set of named parameters. This class provides type-specific methods to retrieve values |
| ParamWriter | Provides write access to a set of named parameters. This class extends ParamReader to add type-specific methods to write values |
| ParserFactory | Produces and initializes UDParsers to parse input into tuples |
| PartitionOrderColumnInfo | Represents the partition by and order by column information for each phase in a multi-phase transform function |
| PartitionReader | Iterator-based read interface over all input data in a single partition. Automatically fetches data a block-at-a-time, as needed |
| PartitionWriter | Provides an iterator-based write interface over output data for a single partition. Automatically makes space a block-at-a-time, as needed |
| PartitionWriterColumn | |
| PartitionWriterColumns | PartitionWriterColumns allow column-by-column access to PartitionWriter data |
| PartitionWriterNumericColumn | |
| PartitionWriterStringColumn | |
| PartitionWriterUuidColumn | |
| PerColumnParamReader | A wrapper around a map from column to ParamReader |
| PlanContext | Shared 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 |
| Portion | |
| RejectedRecord | |
| ScalarFunction | Interface for User-Defined Scalar Function (UDSF). A UDSF produces a single value from a row of data |
| ScalarFunctionFactory | Interface for declaring parameters and return types for, and instantiating, an associated ScalarFunction |
| ScopedTimerCounter | Class to start an execution timer on construction and to automatically stop the timer on deconstruction or when manually called with stop() |
| ServerInterface | Provides UDxs with access to the Vertica server |
| FunctionDescription | |
| RelationDescription | |
| TypeDescription | |
| SessionParamReaderMap | This class provides an interface for reading the Used defined session parameters |
| SessionParamWriterMap | This class provides an interface for writing the Used defined session parameters |
| SimpleArchiveIn | |
| SimpleArchiveOut | |
| SizedColumnTypes | Represents types and information to determine the size of the columns as input/output of a User Defined Function/Transform |
| SourceFactory | Produces and initializes UDSources to process input data sources |
| SourceIterator | Constructs a set of Sources to be used by an IterativeSourceFactory |
| SplitArchiver | |
| SplitArchiver | |
| SplitArchiver | |
| StreamWriter | Provides an iterator-based write interface over output data for a stream of blocks. Automatically makes space a block-at-a-time, as needed |
| TransformFunction | Interface for User-Defined Transform Function (UDTF). A UDTF operates on a table segment and returns zero or more rows of data |
| TransformFunctionFactory | Interface for declaring parameters and return types for, and instantiating, an associated TransformFunction |
| TransformFunctionPhase | Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function |
| UDChunker | Separates parser input into chunks at record boundaries, allowing parsing to proceed in parallel |
| UDFileOperator | |
| UDFileSystem | |
| UDFileSystemFactory | |
| UDFileSystemStats | |
| UDFilter | Reads input data from a UDSource or another UDFilter and transforms it |
| UDKeyManager | |
| UDKeyManagerFactory | |
| UDLFactory | |
| UDParser | Parses an input stream into Vertica tuples (rows to be inserted into a table) |
| UDSource | Acquires data from an external source (such as a file or URL) and produces that data in a streaming manner |
| UDxCounterRequest | |
| UDXFactory | Parent class for UDx factories; not intended for direct use by applications |
| UDXFunction | |
| UDXObject | Base class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications |
| UDxRegistrar | |
| UnsizedUDSource | Base 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 |
| ValueRangeReader | This class represents the value ranges of the arguments of a UDSF, one range per argument |
| ValueRangeWriter | This class represents the output value range of a UDSF |
| VerticaBlock | : Represents an in-memory block of tuples |
| NestedBlockPtr | |
| VerticaBuildInfo | |
| VerticaType | Represents types of data that are passed into and returned back from user's code |
| VerticaValueRange | This class represents value ranges used in analyzing the output of UDSFs. A range is expressed as a minimum/maximum value (inclusive) pair |
| ValueRange | |
| VInterval | Representation of an Interval in Vertica |
| VIntervalYM | Representation of an IntervalYM in Vertica. An Interval can be broken up into years and months |
| VNumeric | Representation of NUMERIC, fixed point data types in Vertica |
| VNumericTemp | |
| VResources | |
| VString | Representation of a String in Vertica. All character data is internally encoded as UTF-8 characters and is not NULL terminated |
| VTAllocator | A pool-based allocator that is provided to simplify memory management for UDF implementors |
| VUuid | Representation of Universally Unique Identifier (UUID) data type in Vertica |
| inlining_array | |
| stack_array | |
| Typemod | |
| TypemodFields |