This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

API reference

The Vertica SDK has application programming interfaces (APIs) in the following languages:

Vertica has the following client API:

1 - C++ SDK Documentation

Welcome to the Vertica C++ SDK Documentation. This documentation covers all of the classes that make up the C++ SDK. Using this SDK, you can create User Defined Extensions (UDxs) that integrate your own features into the Vertica Analytics Platform.

See Developing User-Defined Extensions.

1.1 - Class Index

A | B | C | D | E | F | I | L | M | N | O | P | R | S | T | U | V

A

defserializer (Vertica)   

N

ScalarFunctionFactory (Vertica)   

UDFilter (Vertica)   

defserializer (Vertica)   

ScopedTimerCounter (Vertica)   

UDKeyManager (Vertica)   

AESKey (Vertica)   

defserializer (Vertica)   

VerticaBlock::NestedBlockPtr (Vertica)   

ServerInterface (Vertica)   

UDKeyManagerFactory (Vertica)   

AggregateFunction (Vertica)   

defserializer (Vertica)   

NodeSpecifyingPlanContext (Vertica)   

SessionParamReaderMap (Vertica)   

UDLFactory (Vertica)   

AggregateFunctionFactory (Vertica)   

E
O

SessionParamWriterMap (Vertica)   

UDParser (Vertica)   

AnalyticFunction (Vertica)   

SimpleArchiveIn (Vertica)   

UDSource (Vertica)   

AnalyticFunctionFactory (Vertica)   

ExecutorParamWriter (Vertica)   

OpenOptions (Vertica)   

SimpleArchiveOut (Vertica)   

UDxCounterRequest (Vertica)   

AnalyticPartitionReader (Vertica)   

ExecutorPlanContext (Vertica)   

P

SizedColumnTypes (Vertica)   

UDXFactory (Vertica)   

AnalyticPartitionWriter (Vertica)   

F

SourceFactory (Vertica)   

UDXFunction (Vertica)   

ArrayReader (Vertica::Array)   

ParallelismInfo (Vertica)   

SourceIterator (Vertica)   

UDXObject (Vertica)   

ArrayWriter (Vertica::Array)   

Field (Vertica)   

ParamReader (Vertica)   

SplitArchiver (Vertica)   

UDxRegistrar (Vertica)   

B

Fields (Vertica)   

ParamWriter (Vertica)   

SplitArchiver (Vertica)   

UnsizedUDSource (Vertica)   

FilterFactory (Vertica)   

ParserFactory (Vertica)   

SplitArchiver (Vertica)   

Uuid (Basics)   

BasePartitionWriterColumn (Vertica)   

FIunion (Vertica)   

PartitionOrderColumnInfo (Vertica)   

stack_array   

V

BigInt (Basics)   

FiveToScale (Basics)   

PartitionReader (Vertica)   

StreamWriter (Vertica)   

BlockFormatter (Vertica)   

ServerInterface::FunctionDescription (Vertica)   

PartitionWriter (Vertica)   

StringValue (EE)   

VerticaValueRange::ValueRange (Vertica)   

BlockFormatterCout (Vertica)   

FunctionFactory (Vertica)   

PartitionWriterColumn (Vertica)   

T

ValueRangeReader (Vertica)   

BlockReader (Vertica)   

I

PartitionWriterColumns (Vertica)   

ValueRangeWriter (Vertica)   

BlockWriter (Vertica)   

PartitionWriterNumericColumn (Vertica)   

TransformFunction (Vertica)   

VerticaBlock (Vertica)   

C

inlining_array   

PartitionWriterStringColumn (Vertica)   

TransformFunctionFactory (Vertica)   

VerticaBuildInfo (Vertica)   

IntermediateAggs (Vertica)   

PartitionWriterUuidColumn (Vertica)   

TransformFunctionPhase (Vertica)   

VerticaType (Vertica)   

ClientMessage (Vertica)   

IterativeSourceFactory (Vertica)   

PerColumnParamReader (Vertica)   

ServerInterface::TypeDescription (Vertica)   

VerticaValueRange (Vertica)   

ColumnTypes (Vertica)   

L

PlanContext (Vertica)   

Typemod   

VInterval (Vertica)   

ConcurrencyModel (Vertica)   

Portion (Vertica)   

TypemodFields   

VIntervalYM (Vertica)   

CounterController (Vertica)   

LengthBuffer (Vertica)   

Fields::Properties (Vertica)   

U

VNumeric (Vertica)   

D

LibraryRegistrar (Vertica)   

R

VNumericTemp (Vertica)   

M

UDChunker (Vertica)   

VResources (Vertica)   

DAAllocation (EE)   

RejectedRecord (Vertica)   

UDFileOperator (Vertica)   

VString (Vertica)   

DataArea (EE)   

Model (Vertica)   

ServerInterface::RelationDescription (Vertica)   

UDFileSystem (Vertica)   

VTAllocator (Vertica)   

DataBuffer (Vertica)   

MultiPhaseTransformFunctionFactory (Vertica)   

S

UDFileSystemFactory (Vertica)   

VUuid (Vertica)   

DefaultSourceIterator (Vertica)   

MultipleIntermediateAggs (Vertica)   

UDFileSystemStats (Vertica)   

ScalarFunction (Vertica)   

A | B | C | D | E | F | I | L | M | N | O | P | R | S | T | U | V

1.1.1 - Basics::BigInt Member List

This is the complete list of members for Basics::BigInt, including all inherited members.

accumulateNN(void *outBuf, const void *buf1, int nWords) Basics::BigInt static
addNN(void *outBuf, const void *buf1, const void *buf2, int nWords) Basics::BigInt static
castNumeric(uint64 *wordso, int nwdso, Typemod typmodo, uint64 *wordsi, int nwdsi, Typemod typmodi) (defined in Basics::BigInt) Basics::BigInt static
castNumeric(uint64 *wordso, int nwdso, int32 numericattro, uint64 *wordsi, int nwdsi, int32 numericattri) (defined in Basics::BigInt) Basics::BigInt static
checkOverflowNN(const void *po, int nwdso, Typemod typmodo) (defined in Basics::BigInt) Basics::BigInt static
checkOverflowNN(const void *po, int nwo, int nwdso, Typemod typmodo) (defined in Basics::BigInt) Basics::BigInt static
checkOverflowNN(const void *po, int nwdso, int32 numericattro) (defined in Basics::BigInt) Basics::BigInt static
checkOverflowNN(const void *po, int nwo, int nwdso, int32 numericattro) (defined in Basics::BigInt) Basics::BigInt static
compareNN(const void *buf1, const void *buf2, int nWords) Basics::BigInt static
convertPosToFloatNN(const void *bbuf, int bwords) Basics::BigInt static
copy(void *buf, const void *src, int nWords) Basics::BigInt inlinestatic
divUnsignedN1(void *qbuf, int qw, int round, const void *ubuf, int uw, uint64 v) (defined in Basics::BigInt) Basics::BigInt static
divUnsignedNN(void *qbuf, int qw, int round, uint64 *rbuf, int rw, const void *ubuf, int uw, const void *vbuf, int vw) (defined in Basics::BigInt) Basics::BigInt static
fromIntNN(void *buf, int nWords, int64 val) Basics::BigInt static
incrementNN(void *buf, int nWords) Basics::BigInt static
invertSign(void *buf, int nWords) Basics::BigInt static
isEqualNN(const void *buf1, const void *buf2, int nWords) Basics::BigInt static
isNeg(const void *buf, int nWords) Basics::BigInt inlinestatic
isNull(const void *buf, int nWords) Basics::BigInt static
isZero(const void *buf, int nWords) Basics::BigInt static
mulUnsignedN1(void *obuf, const void *ubuf, int uw, uint64 v) Basics::BigInt static
mulUnsignedNN(void *obuf, const void *buf1, int nw1, const void *buf2, int nw2) Basics::BigInt static
numericDivide(const uint64 *pa, int nwdsa, Typemod typmoda, const uint64 *pb, int nwdsb, Typemod typmodb, uint64 *outNum, int nwdso, Typemod typmodo) Basics::BigInt static
numericDivide(const uint64 *pa, int nwdsa, int32 numericattra, const uint64 *pb, int nwdsb, int32 numericattrb, uint64 *outNum, int nwdso, int32 numericattro) (defined in Basics::BigInt) Basics::BigInt static
numericMultiply(const uint64 *pa, int nwdsa, const uint64 *pb, int nwdsb, uint64 *outNum, int nwdso) Basics::BigInt static
NumericRescaleDown(uint64 *wordso, int nwdso, Typemod typmodo, uint64 *wordsi, int nwdsi, Typemod typmodi) (defined in Basics::BigInt) Basics::BigInt static
NumericRescaleDown(uint64 *wordso, int nwdso, int32 numericattro, uint64 *wordsi, int nwdsi, int32 numericattri) (defined in Basics::BigInt) Basics::BigInt static
NumericRescaleSameScaleSmallerPrec(uint64 *wordso, int nwdso, Typemod typmodo, uint64 *wordsi, int nwdsi, Typemod typmodi) (defined in Basics::BigInt) Basics::BigInt static
NumericRescaleSameScaleSmallerPrec(uint64 *wordso, int nwdso, int32 numericattro, uint64 *wordsi, int nwdsi, int32 numericattri) (defined in Basics::BigInt) Basics::BigInt static
NumericRescaleUp(uint64 *wordso, int nwdso, Typemod typmodo, uint64 *wordsi, int nwdsi, Typemod typmodi) (defined in Basics::BigInt) Basics::BigInt static
NumericRescaleUp(uint64 *wordso, int nwdso, int32 numericattro, uint64 *wordsi, int nwdsi, int32 numericattri) (defined in Basics::BigInt) Basics::BigInt static
numericToFloat(const void *buf, int nwds, ifloat tenthtoscale) Basics::BigInt static
rescaleNumeric(void *out, int ow, int pout, int sout, void *in, int iw, int pin, int sin) Basics::BigInt static
setFromFloat(void *bbuf, int bwords, Typemod typmod, long double value, bool round) Basics::BigInt static
setFromFloat(void *bbuf, int bwords, int32 numericattr, long double value, bool round) (defined in Basics::BigInt) Basics::BigInt static
setNull(void *buf, int nWords) Basics::BigInt static
setNumericBoundsFromType(uint64 *numUpperBound, uint64 *numLowerBound, int nwdso, Typemod typmod) (defined in Basics::BigInt) Basics::BigInt static
setNumericBoundsFromType(uint64 *numUpperBound, uint64 *numLowerBound, int nwdso, int32 numericattr) (defined in Basics::BigInt) Basics::BigInt static
setZero(void *buf, int nWords) Basics::BigInt static
shiftLeftNN(void *buf, unsigned nw, unsigned bitsToShift) Basics::BigInt static
shiftRightNN(void *buf, unsigned nw, unsigned bitsToShift) Basics::BigInt static
subNN(void *outBuf, const void *buf1, const void *buf2, int nWords) Basics::BigInt static
toIntNN(int64 &out, const void *buf, int nWords) Basics::BigInt static
ucompareNN(const void *buf1, const void *buf2, int nWords) Basics::BigInt inlinestatic
usedWordsUnsigned(const void *buf, int nWords) Basics::BigInt static

1.1.2 - Basics::BigInt Struct Reference

Collaboration diagram for Basics::BigInt:

Static Public Member Functions
static uint64 accumulateNN (void *outBuf, const void *buf1, int nWords)
Add number on to a temporary No null handling Returns carry.
static uint64 addNN (void *outBuf, const void *buf1, const void *buf2, int nWords)
Add together 2 numbers w/ same number of digits No null handling Returns carry.
static void castNumeric (uint64 *wordso, int nwdso, Typemod typmodo, uint64 *wordsi, int nwdsi, Typemod typmodi)
static void castNumeric (uint64 *wordso, int nwdso, int32 numericattro, uint64 *wordsi, int nwdsi, int32 numericattri)
static bool checkOverflowNN (const void *po, int nwdso, Typemod typmodo)
static bool checkOverflowNN (const void *po, int nwo, int nwdso, Typemod typmodo)
static bool checkOverflowNN (const void *po, int nwdso, int32 numericattro)
static bool checkOverflowNN (const void *po, int nwo, int nwdso, int32 numericattro)
static int compareNN (const void *buf1, const void *buf2, int nWords)
Compare integers, return -1, 0, 1.
static long double convertPosToFloatNN (const void *bbuf, int bwords)
Convert Numeric to a float helper function Input should not be negative / null.
static void copy (void *buf, const void *src, int nWords)
cpoy nWords from src to buf
static uint64 divUnsignedN1 (void *qbuf, int qw, int round, const void *ubuf, int uw, uint64 v)
static void divUnsignedNN (void *qbuf, int qw, int round, uint64 *rbuf, int rw, const void *ubuf, int uw, const void *vbuf, int vw)
static void fromIntNN (void *buf, int nWords, int64 val)
Load from 64-bit signed int (does not handle NULL inside)
static void incrementNN (void *buf, int nWords)
Increment by 1.
static void invertSign (void *buf, int nWords)
Invert the sign of a number, performed in place, using the invert and +1 method, turns out NULLs are OK in this sense.
static bool isEqualNN (const void *buf1, const void *buf2, int nWords)
Check integers for equality.
static bool isNeg (const void *buf, int nWords)
Check if integer is less than zero.
static bool isNull (const void *buf, int nWords)
Check an integer for NULL.
static bool isZero (const void *buf, int nWords)
Check an integer for 0.
static void mulUnsignedN1 (void *obuf, const void *ubuf, int uw, uint64 v)
Multiply, unsigned only. uw words by 1 word -> uw+1 words Output array must be uw+1 words long; may not overlap inputs.
static void mulUnsignedNN (void *obuf, const void *buf1, int nw1, const void *buf2, int nw2)
Multiply, unsigned only. Output array must be nw1+nw2 long; may not overlap inputs PERF NOTE: Operates like a school boy, could do Karatsuba (or better)
static void numericDivide (const uint64 *pa, int nwdsa, Typemod typmoda, const uint64 *pb, int nwdsb, Typemod typmodb, uint64 *outNum, int nwdso, Typemod typmodo)
Divide Numerics Handles negative / null input.
static void numericDivide (const uint64 *pa, int nwdsa, int32 numericattra, const uint64 *pb, int nwdsb, int32 numericattrb, uint64 *outNum, int nwdso, int32 numericattro)
static void numericMultiply (const uint64 *pa, int nwdsa, const uint64 *pb, int nwdsb, uint64 *outNum, int nwdso)
Multiply Numerics , result in outNum Handles negative / null input.
static void NumericRescaleDown (uint64 *wordso, int nwdso, Typemod typmodo, uint64 *wordsi, int nwdsi, Typemod typmodi)
static void NumericRescaleDown (uint64 *wordso, int nwdso, int32 numericattro, uint64 *wordsi, int nwdsi, int32 numericattri)
static void NumericRescaleSameScaleSmallerPrec (uint64 *wordso, int nwdso, Typemod typmodo, uint64 *wordsi, int nwdsi, Typemod typmodi)
static void NumericRescaleSameScaleSmallerPrec (uint64 *wordso, int nwdso, int32 numericattro, uint64 *wordsi, int nwdsi, int32 numericattri)
static void NumericRescaleUp (uint64 *wordso, int nwdso, Typemod typmodo, uint64 *wordsi, int nwdsi, Typemod typmodi)
static void NumericRescaleUp (uint64 *wordso, int nwdso, int32 numericattro, uint64 *wordsi, int nwdsi, int32 numericattri)
static ifloat numericToFloat (const void *buf, int nwds, ifloat tenthtoscale)
Convert Numeric to a float Handles negative / null input.
static bool rescaleNumeric (void *out, int ow, int pout, int sout, void *in, int iw, int pin, int sin)
Rescale a given numeric to a specific prec/scale/nwds The input should have minimal precision to avoid unnecessary overflow; for example, "0" should have precision 0 (as generated by charToNumeric). Accepts signed numerics. Will set its "in" argument to abs(in).
static bool setFromFloat (void *bbuf, int bwords, Typemod typmod, long double value, bool round)
Convert floating point multiplied by 10^scale to an integer This truncates if round is false; otherwise the numeric result is rounded.
static bool setFromFloat (void *bbuf, int bwords, int32 numericattr, long double value, bool round)
static void setNull (void *buf, int nWords)
Set an integer to NULL.
static void setNumericBoundsFromType (uint64 *numUpperBound, uint64 *numLowerBound, int nwdso, Typemod typmod)
static void setNumericBoundsFromType (uint64 *numUpperBound, uint64 *numLowerBound, int nwdso, int32 numericattr)
static void setZero (void *buf, int nWords)
Set an integer to 0.
static void shiftLeftNN (void *buf, unsigned nw, unsigned bitsToShift)
Shift a BigInt to the left (>) by the given number of bits. The given BigInt must be positive and non-null.
static void subNN (void *outBuf, const void *buf1, const void *buf2, int nWords)
Subtract 2 numbers w/ same number of digits No null handling.
static bool toIntNN (int64 &out, const void *buf, int nWords)
Convert to int (return false if there was an overflow)
static int ucompareNN (const void *buf1, const void *buf2, int nWords)
static int usedWordsUnsigned (const void *buf, int nWords)
Calculate number of words that are actually used to represent the value (amount left after stripping leading 0's)

Detailed Description

Holds integer utilities A few are inlined for performance reasons. Most are in vertica.cpp.

Member Function Documentation

static bool Basics::BigInt::isEqualNN(const void * buf1, const void * buf2, int nWords)

static

Check integers for equality.

Note Optimized for small nWords; scan from end and break out of loop

Referenced by Vertica::VNumeric::equal().

static bool Basics::BigInt::isZero(const void * buf, int nWords)

static

Check an integer for 0.

Note Optimized for small nWords; scan from end and break out of loop

Referenced by Vertica::VNumeric::isZero().

static ifloat Basics::BigInt::numericToFloat(const void * buf, int nwds, ifloat tenthtoscale)

static

Convert Numeric to a float Handles negative / null input.

Parameters

  • tenthtoscale: 10^-scale of the Numeric

Referenced by Vertica::VNumeric::toFloat().

bool Basics::BigInt::setFromFloat(void * bbuf, int bwords, Typemod typmod, long double value, bool round)

static

Convert floating point multiplied by 10^scale to an integer This truncates if round is false; otherwise the numeric result is rounded.

Returns false if high bits were lost, true if reasonable fidelity was achieved

Referenced by Vertica::VNumeric::copy().

static int Basics::BigInt::ucompareNN(const void * buf1, const void * buf2, int nWords)

inlinestatic

Compare integers, return -1, 0, 1

Referenced by Vertica::VNumeric::compareUnsigned().

1.1.3 - Basics::FiveToScale Member List

This is the complete list of members for Basics::FiveToScale, including all inherited members.

scale (defined in Basics::FiveToScale) Basics::FiveToScale
value (defined in Basics::FiveToScale) Basics::FiveToScale
wordCount (defined in Basics::FiveToScale) Basics::FiveToScale

1.1.4 - Basics::FiveToScale Struct Reference

Collaboration diagram for Basics::FiveToScale:

Public Attributes
unsigned scale
const uint64 * value
unsigned wordCount

1.1.5 - Basics::Uuid Member List

This is the complete list of members for Basics::Uuid, including all inherited members.

StringToUuid(const char *source, vuuid_t uuid) (defined in Basics::Uuid) Basics::Uuid static
UuidToString(const vuuid_t uuid, char *outbuf) (defined in Basics::Uuid) Basics::Uuid static

1.1.6 - Basics::Uuid Struct Reference

Collaboration diagram for Basics::Uuid:

Static Public Member Functions
static bool StringToUuid (const char *source, vuuid_t uuid)
static void UuidToString (const vuuid_t uuid, char *outbuf)

1.1.7 - Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

[detail level 1234]

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

1.1.8 - 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

1.1.9 - EE::DAAllocation Member List

This is the complete list of members for EE::DAAllocation, including all inherited members.

alen (defined in EE::DAAllocation) EE::DAAllocation
data (defined in EE::DAAllocation) EE::DAAllocation

1.1.10 - EE::DAAllocation Struct Reference

Collaboration diagram for EE::DAAllocation:

Public Attributes
vsize alen
uint8 data []

Detailed Description

Some data areas are never updated and therefore use a packed allocation scheme (only data in the DA, no other accounting(StringValue has it)) However, if the contents may be updated/expanded, the following struct is generally employed. The StringValue is still interpreted as usual, but its target is prefixed with the size of the allocation:

alen

StringValue[sloc+slen]+DA -> -------— data... (alen bytes reserved)

Thus as long as alen >= the size needed for a new value, no reallocation is needed.

1.1.11 - EE::DataArea Class Reference

Collaboration diagram for EE::DataArea:

Public Member Functions
const char * centry (size_t e) const
void clearDA ()
char * entry (size_t e)
void initializeDA (size_t sz)
Public Attributes
size_t freeDA
size_t sizeDA

Detailed Description

This class holds the strings used by a TupleBlock, VLHash, etc. It is fixed length, applications either use a conservative max or go until it is full.

1.1.12 - EE::DataArea Member List

This is the complete list of members for EE::DataArea, including all inherited members.

centry(size_t e) const (defined in EE::DataArea) EE::DataArea inline
clearDA() (defined in EE::DataArea) EE::DataArea inline
entry(size_t e) (defined in EE::DataArea) EE::DataArea inline
freeDA (defined in EE::DataArea) EE::DataArea
initializeDA(size_t sz) (defined in EE::DataArea) EE::DataArea inline
sizeDA (defined in EE::DataArea) EE::DataArea

1.1.13 - EE::StringValue Member List

This is the complete list of members for EE::StringValue, including all inherited members.

base (defined in EE::StringValue) EE::StringValue
inlinePtr() const (defined in EE::StringValue) EE::StringValue inline
inlinePtr() (defined in EE::StringValue) EE::StringValue inline
slen (defined in EE::StringValue) EE::StringValue
sloc (defined in EE::StringValue) EE::StringValue

1.1.14 - EE::StringValue Struct Reference

Collaboration diagram for EE::StringValue:

Public Member Functions
const char * inlinePtr () const
char * inlinePtr ()
Public Attributes
char base [0]
vsize slen
uint32 sloc

1.1.15 - functions

Here is a list of all documented class members with links to the class documentation for each member:

- a -

1.1.16 - functions 0x62

Here is a list of all documented class members with links to the class documentation for each member:

- b -

1.1.17 - functions 0x63

Here is a list of all documented class members with links to the class documentation for each member:

- c -

1.1.18 - functions 0x64

Here is a list of all documented class members with links to the class documentation for each member:

- d -

1.1.19 - functions 0x65

Here is a list of all documented class members with links to the class documentation for each member:

- e -

1.1.20 - functions 0x66

Here is a list of all documented class members with links to the class documentation for each member:

- f -

1.1.21 - functions 0x67

Here is a list of all documented class members with links to the class documentation for each member:

- g -

1.1.22 - functions 0x68

Here is a list of all documented class members with links to the class documentation for each member:

- h -

1.1.23 - functions 0x69

Here is a list of all documented class members with links to the class documentation for each member:

- i -

1.1.24 - functions 0x6b

Here is a list of all documented class members with links to the class documentation for each member:

- k -

1.1.25 - functions 0x6c

Here is a list of all documented class members with links to the class documentation for each member:

- l -

1.1.26 - functions 0x6d

Here is a list of all documented class members with links to the class documentation for each member:

- m -

1.1.27 - functions 0x6e

Here is a list of all documented class members with links to the class documentation for each member:

- n -

1.1.28 - functions 0x6f

Here is a list of all documented class members with links to the class documentation for each member:

- o -

1.1.29 - functions 0x70

Here is a list of all documented class members with links to the class documentation for each member:

- p -

1.1.30 - functions 0x72

Here is a list of all documented class members with links to the class documentation for each member:

- r -

1.1.31 - functions 0x73

Here is a list of all documented class members with links to the class documentation for each member:

- s -

1.1.32 - functions 0x74

Here is a list of all documented class members with links to the class documentation for each member:

- t -

1.1.33 - functions 0x75

Here is a list of all documented class members with links to the class documentation for each member:

- u -

1.1.34 - functions 0x76

Here is a list of all documented class members with links to the class documentation for each member:

- v -

1.1.35 - functions 0x77

Here is a list of all documented class members with links to the class documentation for each member:

- w -

1.1.36 - functions 0x7e

Here is a list of all documented class members with links to the class documentation for each member:

- ~ -

1.1.37 - functions enum

1.1.38 - functions func

- a -

1.1.39 - functions func 0x62

- b -

1.1.40 - functions func 0x63

- c -

1.1.41 - functions func 0x64

- d -

1.1.42 - functions func 0x65

- e -

1.1.43 - functions func 0x66

- f -

1.1.44 - functions func 0x67

- g -

1.1.45 - functions func 0x68

- h -

1.1.46 - functions func 0x69

- i -

1.1.47 - functions func 0x6c

- l -

1.1.48 - functions func 0x6d

- m -

1.1.49 - functions func 0x6e

- n -

1.1.50 - functions func 0x6f

- o -

1.1.51 - functions func 0x70

- p -

1.1.52 - functions func 0x72

- r -

1.1.53 - functions func 0x73

- s -

1.1.54 - functions func 0x74

- t -

1.1.55 - functions func 0x75

- u -

1.1.56 - functions func 0x76

- v -

1.1.57 - functions func 0x7e

- ~ -

1.1.58 - functions vars

- a -

- b -

- c -

- d -

- f -

- i -

- k -

- l -

- m -

- n -

- o -

- p -

- r -

- s -

- t -

- u -

- v -

- w -

1.1.59 - inlining_array< T, MAX_STACK_ELEMS > Member List

This is the complete list of members for inlining_array, including all inherited members.

at(size_t idx) (defined in inlining_array) inlining_array inline
begin() (defined in inlining_array) inlining_array inline
end() (defined in inlining_array) inlining_array inline
getNumElements() const (defined in inlining_array) inlining_array inline
getPtr() (defined in inlining_array) inlining_array inline
getSize() const (defined in inlining_array) inlining_array inline
inlining_array(size_t n_elements, Args &&...args) (defined in inlining_array) inlining_array inline
inlining_array(const inlining_array &)=delete (defined in inlining_array) inlining_array
inlining_array(inlining_array &&)=delete (defined in inlining_array) inlining_array
operator T *() (defined in inlining_array) inlining_array inline
operator&() const =delete (defined in inlining_array) inlining_array
operator()() (defined in inlining_array) inlining_array inline
operator+(size_t i) (defined in inlining_array) inlining_array inline
operator->() (defined in inlining_array) inlining_array inline
operator=(const inlining_array &)=delete (defined in inlining_array) inlining_array
operator=(inlining_array &&)=delete (defined in inlining_array) inlining_array
operator[](size_t idx) (defined in inlining_array) inlining_array inline
~inlining_array() (defined in inlining_array) inlining_array inline

1.1.60 - inlining_array< T, MAX_STACK_ELEMS > Struct Template Reference

Collaboration diagram for inlining_array< T, MAX_STACK_ELEMS >:

Public Member Functions
template
inlining_array (size_t n_elements, Args &&...args)
inlining_array (const inlining_array &)=delete
inlining_array (inlining_array &&)=delete
T & at (size_t idx)
T * begin ()
T * end ()
size_t getNumElements () const
T * getPtr ()
size_t getSize () const
operator T * ()
T * operator& () const =delete
T * operator() ()
T * operator+ (size_t i)
T * operator-> ()
inlining_array & operator= (const inlining_array &)=delete
inlining_array & operator= (inlining_array &&)=delete
T & operator[] (size_t idx)

Detailed Description

template

struct inlining_array

Heap-allocated array that optimizes for small sizes by storing locally, such as on the stack. Replacement for variable-length stack arrays, but with bounded stack usage, and larger items allocated on the heap. If element count is less than template parameter, use internal buffer, otherwise use malloc/free

1.1.61 - stack_array< T, MAX_STACK_ELEMS > Member List

This is the complete list of members for stack_array, including all inherited members.

at(size_t idx) (defined in stack_array) stack_array inline
begin() (defined in stack_array) stack_array inline
end() (defined in stack_array) stack_array inline
getNumElements() (defined in stack_array) stack_array inline
getPtr() (defined in stack_array) stack_array inline
getSize() (defined in stack_array) stack_array inline
operator T *() (defined in stack_array) stack_array inline
operator&() const =delete (defined in stack_array) stack_array
operator()() (defined in stack_array) stack_array inline
operator+(size_t i) (defined in stack_array) stack_array inline
operator->() (defined in stack_array) stack_array inline
operator=(const stack_array &)=delete (defined in stack_array) stack_array
operator=(stack_array &&)=delete (defined in stack_array) stack_array
operator[](size_t idx) (defined in stack_array) stack_array inline
stack_array(size_t n_elements) (defined in stack_array) stack_array inline
stack_array(const stack_array &)=delete (defined in stack_array) stack_array
stack_array(stack_array &&)=delete (defined in stack_array) stack_array
~stack_array() (defined in stack_array) stack_array inline

1.1.62 - stack_array< T, MAX_STACK_ELEMS > Struct Template Reference

Collaboration diagram for stack_array< T, MAX_STACK_ELEMS >:

Public Member Functions
stack_array (size_t n_elements)
stack_array (const stack_array &)=delete
stack_array (stack_array &&)=delete
T & at (size_t idx)
T * begin ()
T * end ()
size_t getNumElements ()
T * getPtr ()
size_t getSize ()
operator T * ()
T * operator& () const =delete
T * operator() ()
T * operator+ (size_t i)
T * operator-> ()
stack_array & operator= (const stack_array &)=delete
stack_array & operator= (stack_array &&)=delete
T & operator[] (size_t idx)

Detailed Description

template

struct stack_array

Replacement for variable-length stack arrays, but with bounded stack usage. If there is more usage than expected, it will error.

1.1.63 - Typemod Member List

This is the complete list of members for Typemod, including all inherited members.

bits (defined in Typemod) Typemod
fields (defined in Typemod) Typemod

1.1.64 - Typemod Union Reference

Collaboration diagram for Typemod:

Public Attributes
signed long long int bits
TypemodFields fields

1.1.65 - TypemodFields Member List

This is the complete list of members for TypemodFields, including all inherited members.

arrayBound (defined in TypemodFields) TypemodFields
attribute (defined in TypemodFields) TypemodFields

1.1.66 - TypemodFields Struct Reference

Collaboration diagram for TypemodFields:

Public Attributes
TypemodArrayBound arrayBound
TypemodAttribute attribute

1.1.67 - Vertica::AESKey Member List

This is the complete list of members for Vertica::AESKey, including all inherited members.

iv Vertica::AESKey
IV_LENGTH (defined in Vertica::AESKey) Vertica::AESKey static
key Vertica::AESKey
KEY_LENGTH Vertica::AESKey static
length Vertica::AESKey

1.1.68 - Vertica::AESKey Struct Reference

Collaboration diagram for Vertica::AESKey:

Public Attributes
unsigned char iv [IV_LENGTH] = {0}
initialization vector to use for AES encryption
unsigned char key [KEY_LENGTH] = {0}
key to use for AES encryption
size_t length
number of bytes of key filled
Static Public Attributes
static constexpr size_t IV_LENGTH = 12
static constexpr size_t KEY_LENGTH = 32
256 bits (max) for key, 96 (always) for IV

1.1.69 - Vertica::AggregateFunction Class Reference

Interface for User-Defined Aggregate Function (UDAF). A UDAF operates on one column of data and returns one column of data.

Inheritance diagram for Vertica::AggregateFunction:

Collaboration diagram for Vertica::AggregateFunction:

Public Member Functions
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)=0
void cancelUDX (ServerInterface &srvInterface)
virtual void combine (ServerInterface &srvInterface, IntermediateAggs &aggs_output, MultipleIntermediateAggs &aggs_other)=0
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams)
virtual void initAggregate (ServerInterface &srvInterface, IntermediateAggs &aggs)=0
bool isCanceled () const
virtual void setup (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
virtual void terminate (ServerInterface &srvInterface, BlockWriter &res_writer, IntermediateAggs &aggs)
virtual void terminate (ServerInterface &srvInterface, BlockWriter &res_writer, IntermediateAggs &aggs, SessionParamWriterMap &udSessionParams)
Static Public Member Functions
static void updateCols (BlockReader &arg_reader, char *arg, int count, IntermediateAggs &intAggs, char *aggPtr, std::vector &intOffsets)
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Detailed Description

Interface for User-Defined Aggregate Function (UDAF). A UDAF operates on one column of data and returns one column of data.

An AggregateFunction must have an associated AggregateFunctionFactory.

Member Function Documentation

virtual void Vertica::AggregateFunction::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)

pure virtual Called by the server to perform aggregation on multiple blocks of data

Note User should not explicity implement this function. It is implemented by calling the InlineAggregate() macro. User should follow the convention of implementing void aggregate(ServerInterface &srvInterface, BlockReader &arg_reader, IntermediateAggs &aggs) along with initAggregate, combine, and terminate. For references on what a fully implemented Aggregate Function looks like, check the examples in the example folder.

which the inlined aggregateArrs implemention will invoke

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual void Vertica::AggregateFunction::combine(ServerInterface & srvInterface, IntermediateAggs & aggs_output, MultipleIntermediateAggs & aggs_other)

pure virtual Called when intermediate aggregates need to be combined with each other

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtualinherited

Perform per instance destruction. This function may throw errors

Referenced by Vertica::UDXFunction::destroy().

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SessionParamWriterMap & udSessionParams)

inlinevirtualinherited

Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

virtual void Vertica::AggregateFunction::initAggregate(ServerInterface & srvInterface, IntermediateAggs & aggs)

pure virtual Called by the server to set the starting values of the Intermediate aggregates.

Note This can be called multiple times on multiple machines, so starting values should be idempotent.

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual void Vertica::UDXFunction::setup(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtualinherited

Perform per instance initialization. This function may throw errors.

virtual void Vertica::AggregateFunction::terminate(ServerInterface & srvInterface, BlockWriter & res_writer, IntermediateAggs & aggs)

inlinevirtual

Called by the server to get the output to the aggregate function

Referenced by terminate().

virtual void Vertica::AggregateFunction::terminate(ServerInterface & srvInterface, BlockWriter & res_writer, IntermediateAggs & aggs, SessionParamWriterMap & udSessionParams)

inlinevirtual

Called by the server to get the output to the aggregate function

void Vertica::AggregateFunction::updateCols(BlockReader & arg_reader, char * arg, int count, IntermediateAggs & intAggs, char * aggPtr, std::vector & intOffsets)

static

Helper function for aggregateArrs.

Note User should not call this function.

1.1.70 - Vertica::AggregateFunction Member List

This is the complete list of members for Vertica::AggregateFunction, including all inherited members.

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)=0 Vertica::AggregateFunction pure virtual
cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
combine(ServerInterface &srvInterface, IntermediateAggs &aggs_output, MultipleIntermediateAggs &aggs_other)=0 Vertica::AggregateFunction pure virtual
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams) Vertica::UDXFunction inlinevirtual
initAggregate(ServerInterface &srvInterface, IntermediateAggs &aggs)=0 Vertica::AggregateFunction pure virtual
isCanceled() const Vertica::UDXObject inline
setup(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
terminate(ServerInterface &srvInterface, BlockWriter &res_writer, IntermediateAggs &aggs) Vertica::AggregateFunction inlinevirtual
terminate(ServerInterface &srvInterface, BlockWriter &res_writer, IntermediateAggs &aggs, SessionParamWriterMap &udSessionParams) Vertica::AggregateFunction inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
updateCols(BlockReader &arg_reader, char *arg, int count, IntermediateAggs &intAggs, char *aggPtr, std::vector &intOffsets) Vertica::AggregateFunction static
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.71 - Vertica::AggregateFunctionFactory Class Reference

Interface for declaring parameters and return types for, and instantiating, an associated AggregateFunction.

Inheritance diagram for Vertica::AggregateFunctionFactory:

Collaboration diagram for Vertica::AggregateFunctionFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual AggregateFunction * createAggregateFunction (ServerInterface &srvInterface)
virtual AggregateFunction * createAggregateFunction (ServerInterface &srvInterface, const SizedColumnTypes &inputType)
virtual void getIntermediateTypes (ServerInterface &srvInterface, const SizedColumnTypes &inputTypes, SizedColumnTypes &intermediateTypeMetaData)=0
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes)
virtual void getPrototype (ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0
virtual void getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)=0
Protected Member Functions
virtual UDXType getUDXFactoryType () override
Protected Attributes
Oid libOid
std::string sqlName

Detailed Description

Interface for declaring parameters and return types for, and instantiating, an associated AggregateFunction.

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual AggregateFunction* Vertica::AggregateFunctionFactory::createAggregateFunction(ServerInterface & srvInterface)

inlinevirtual

Called when Vertica needs a new AggregateFunction object to process a function call. Users should override only one of the following methods.

Returns an AggregateFunction object which implements the UDx API described by this metadata.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Note More than one object may be instantiated per query.

Referenced by createAggregateFunction().

virtual AggregateFunction* Vertica::AggregateFunctionFactory::createAggregateFunction(ServerInterface & srvInterface, const SizedColumnTypes & inputType)

inlinevirtual

Called when Vertica needs a new AggregateFunction object to process a function call. Users should override only one of the following methods.

Returns an AggregateFunction object which implements the UDx API described by this metadata.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • inputType: data type of the input argument

Note More than one object may be instantiated per query.

virtual void Vertica::AggregateFunctionFactory::getIntermediateTypes(ServerInterface & srvInterface, const SizedColumnTypes & inputTypes, SizedColumnTypes & intermediateTypeMetaData)

pure virtual Returns the intermediate types used for this aggregate. Called by the server to set the types of the Intermediate aggregates.

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented in Vertica::UDLFactory.

Referenced by Vertica::UDXFactory::getPerInstanceResources().

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented in Vertica::UDLFactory.

virtual void Vertica::FunctionFactory::getPrototype(ServerInterface & srvInterface, ColumnTypes & argTypes, ColumnTypes & returnType)

pure virtual inherited Provides the argument and return types of the UDX

Implemented in Vertica::MultiPhaseTransformFunctionFactory.

Referenced by Vertica::ScalarFunctionFactory::getReturnType().

virtual void Vertica::FunctionFactory::getReturnType(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SizedColumnTypes & returnType)

pure virtual inherited Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time/Timestamp types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Implemented in Vertica::MultiPhaseTransformFunctionFactory, and Vertica::ScalarFunctionFactory.

virtual UDXType Vertica::AggregateFunctionFactory::getUDXFactoryType()

inlineprotectedvirtual

Returns the object type internally used by Vertica

Implements Vertica::UDXFactory.

1.1.72 - Vertica::AggregateFunctionFactory Member List

This is the complete list of members for Vertica::AggregateFunctionFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
createAggregateFunction(ServerInterface &srvInterface) Vertica::AggregateFunctionFactory inlinevirtual
createAggregateFunction(ServerInterface &srvInterface, const SizedColumnTypes &inputType) Vertica::AggregateFunctionFactory inlinevirtual
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getIntermediateTypes(ServerInterface &srvInterface, const SizedColumnTypes &inputTypes, SizedColumnTypes &intermediateTypeMetaData)=0 Vertica::AggregateFunctionFactory pure virtual
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) Vertica::UDXFactory inlinevirtual
getPrototype(ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0 Vertica::FunctionFactory pure virtual
getReturnType(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)=0 Vertica::FunctionFactory pure virtual
getUDXFactoryType() override Vertica::AggregateFunctionFactory inlineprotectedvirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~AggregateFunctionFactory() (defined in Vertica::AggregateFunctionFactory) Vertica::AggregateFunctionFactory inlinevirtual
~FunctionFactory() (defined in Vertica::FunctionFactory) Vertica::FunctionFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.73 - Vertica::AnalyticFunction Class Reference

Interface for User-Defined Analytic Function (UDAnF). A UDAnF operates on rows of data and returns rows of data, not necessarily 1:1.

Inheritance diagram for Vertica::AnalyticFunction:

Collaboration diagram for Vertica::AnalyticFunction:

Public Member Functions
void cancelUDX (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams)
bool isCanceled () const
virtual void processPartition (ServerInterface &srvInterface, AnalyticPartitionReader &input_reader, AnalyticPartitionWriter &output_writer)=0
virtual void setup (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Detailed Description

Interface for User-Defined Analytic Function (UDAnF). A UDAnF operates on rows of data and returns rows of data, not necessarily 1:1.

An AnalyticFunction must have an associated AnalyticFunctionFactory.

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtualinherited

Perform per instance destruction. This function may throw errors

Referenced by Vertica::UDXFunction::destroy().

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SessionParamWriterMap & udSessionParams)

inlinevirtualinherited

Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual void Vertica::AnalyticFunction::processPartition(ServerInterface & srvInterface, AnalyticPartitionReader & input_reader, AnalyticPartitionWriter & output_writer)

pure virtual Invoke a user defined analytic on a set of rows. As the name suggests, a batch of rows are passed in for every invocation to amortize performance.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • input_reader: input rows
  • output_writer: output location
virtual void Vertica::UDXFunction::setup(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtualinherited

Perform per instance initialization. This function may throw errors.

1.1.74 - Vertica::AnalyticFunction Member List

This is the complete list of members for Vertica::AnalyticFunction, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams) Vertica::UDXFunction inlinevirtual
isCanceled() const Vertica::UDXObject inline
processPartition(ServerInterface &srvInterface, AnalyticPartitionReader &input_reader, AnalyticPartitionWriter &output_writer)=0 Vertica::AnalyticFunction pure virtual
setup(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.75 - Vertica::AnalyticFunctionFactory Class Reference

Interface for declaring parameters and return types for, and instantiating, an associated AnalyticFunction.

Inheritance diagram for Vertica::AnalyticFunctionFactory:

Collaboration diagram for Vertica::AnalyticFunctionFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual AnalyticFunction * createAnalyticFunction (ServerInterface &srvInterface)=0
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes)
virtual void getPrototype (ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0
virtual void getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)=0
Protected Member Functions
virtual UDXType getUDXFactoryType () override
Protected Attributes
Oid libOid
std::string sqlName

Detailed Description

Interface for declaring parameters and return types for, and instantiating, an associated AnalyticFunction.

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual AnalyticFunction* Vertica::AnalyticFunctionFactory::createAnalyticFunction(ServerInterface & srvInterface)

pure virtual Called when Vertica needs a new AnalyticFunction object to process a function call.

Returns an AnalyticFunction object which implements the UDx API described by this metadata.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Note More than one object may be instantiated per query.

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented in Vertica::UDLFactory.

Referenced by Vertica::UDXFactory::getPerInstanceResources().

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented in Vertica::UDLFactory.

virtual void Vertica::FunctionFactory::getPrototype(ServerInterface & srvInterface, ColumnTypes & argTypes, ColumnTypes & returnType)

pure virtual inherited Provides the argument and return types of the UDX

Implemented in Vertica::MultiPhaseTransformFunctionFactory.

Referenced by Vertica::ScalarFunctionFactory::getReturnType().

virtual void Vertica::FunctionFactory::getReturnType(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SizedColumnTypes & returnType)

pure virtual inherited Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time/Timestamp types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Implemented in Vertica::MultiPhaseTransformFunctionFactory, and Vertica::ScalarFunctionFactory.

virtual UDXType Vertica::AnalyticFunctionFactory::getUDXFactoryType()

inlineprotectedvirtual

Returns the object type internally used by Vertica

Implements Vertica::UDXFactory.

1.1.76 - Vertica::AnalyticFunctionFactory Member List

This is the complete list of members for Vertica::AnalyticFunctionFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
createAnalyticFunction(ServerInterface &srvInterface)=0 Vertica::AnalyticFunctionFactory pure virtual
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) Vertica::UDXFactory inlinevirtual
getPrototype(ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0 Vertica::FunctionFactory pure virtual
getReturnType(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)=0 Vertica::FunctionFactory pure virtual
getUDXFactoryType() override Vertica::AnalyticFunctionFactory inlineprotectedvirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~AnalyticFunctionFactory() (defined in Vertica::AnalyticFunctionFactory) Vertica::AnalyticFunctionFactory inlinevirtual
~FunctionFactory() (defined in Vertica::FunctionFactory) Vertica::FunctionFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.77 - Vertica::AnalyticPartitionReader Class Reference

Provides an iterator-based read interface over all the partition_by keys, order_by keys, and function arguments in a partition.

Inheritance diagram for Vertica::AnalyticPartitionReader:

Collaboration diagram for Vertica::AnalyticPartitionReader:

Public Member Functions
AnalyticPartitionReader (size_t narg, EE::UserDefinedProcess *udx_object)
void copy (const VerticaBlock &other)
Array::ArrayReader getArrayRef (size_t idx) const
Get a reference to an Array value from the input row.
const vbool * getBoolPtr (size_t idx) const
Get a pointer to a BOOLEAN value from the input row.
const vbool & getBoolRef (size_t idx) const
Get a reference to a BOOLEAN value from the input row.
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
const DateADT * getDatePtr (size_t idx) const
Get a pointer to a DATE value from the input row.
const DateADT & getDateRef (size_t idx) const
Get a reference to a DATE value from the input row.
const vfloat * getFloatPtr (size_t idx) const
Get a pointer to a FLOAT value from the input row.
const vfloat & getFloatRef (size_t idx) const
Get a reference to a FLOAT value from the input row.
const Interval * getIntervalPtr (size_t idx) const
Get a pointer to an INTERVAL value from the input row.
const Interval & getIntervalRef (size_t idx) const
Get a reference to an INTERVAL value from the input row.
const IntervalYM * getIntervalYMPtr (size_t idx) const
Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.
const IntervalYM & getIntervalYMRef (size_t idx) const
Get a reference to an INTERVAL YEAR TO MONTH value from the input row.
const vint * getIntPtr (size_t idx) const
Get a pointer to an INTEGER value from the input row.
const vint & getIntRef (size_t idx) const
Get a reference to an INTEGER value from the input row.
size_t getNumCols () const
const VNumeric * getNumericPtr (size_t idx) const
Get a pointer to a VNumeric value from the input row.
const VNumeric & getNumericRef (size_t idx) const
Get a reference to a VNumeric value from the input row.
int getNumRows () const
int getPosition () const
const BlockReader * getRowPtr (size_t idx) const
Get a reference to a Row value from the input row.
const BlockReader & getRowRef (size_t idx) const
Get a reference to a Row value from the input row.
const VString * getStringPtr (size_t idx) const
Get a pointer to a VString value from the input row.
const VString & getStringRef (size_t idx) const
Get a reference to an VString value from the input row.
const TimeADT * getTimePtr (size_t idx) const
Get a pointer to a TIME value from the input row.
const TimeADT & getTimeRef (size_t idx) const
Get a reference to a TIME value from the input row.
const Timestamp * getTimestampPtr (size_t idx) const
Get a pointer to a TIMESTAMP value from the input row.
const Timestamp & getTimestampRef (size_t idx) const
Get a reference to a TIMESTAMP value from the input row.
const TimestampTz * getTimestampTzPtr (size_t idx) const
Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimestampTz & getTimestampTzRef (size_t idx) const
Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimeTzADT * getTimeTzPtr (size_t idx) const
Get a pointer to a TIME WITH TIMEZONE value from the input row.
const TimeTzADT & getTimeTzRef (size_t idx) const
Get a reference to a TIME WITH TIMEZONE value from the input row.
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
const VUuid * getUuidPtr (size_t idx) const
Get a pointer to a VUuid value from the input row.
const VUuid & getUuidRef (size_t idx) const
Get a reference to a VUuid value from the input row.
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool hasData () const
bool hasMoreData ()
bool isNewOrderByKey ()
bool isNull (int col) const
Check if the idx'th argument is null.
bool next ()
virtual bool readNextBlock () override
bool remaining () const
void setDataArea (size_t idx, void *dataarea)
bool willFetchBlockOnNext ()
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool advanceToNextRow (bool recurIntoArrays)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void resetIndex ()
void setRowCount (int rowCount)
virtual void setupColsAndStrides () override
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
union {
EE::UserDefinedAnalytic * udan
EE::UserDefinedTransform * udt
EE::UserDefinedProcess * udx_object
};
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
EE::DataHolder * dh
int index
const int * indices
size_t ncols
std::vector newOrderMarkers
int nrows
std::vector processBlockUserInfoVector
vpos pstart
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers
Friends
class ::AnalyticPartitionReaderHelper
class EE::UserDefinedAnalytic
class EE::UserDefinedProcess

Detailed Description

Provides an iterator-based read interface over all the partition_by keys, order_by keys, and function arguments in a partition.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

Array::ArrayReader Vertica::BlockReader::getArrayRef(size_t idx) const

inherited Get a reference to an Array value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument: another BlockReader which reads elements of the array.

const vbool* Vertica::BlockReader::getBoolPtr(size_t idx) const

inline inherited Get a pointer to a BOOLEAN value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a BOOLEAN.

Referenced by Vertica::BlockReader::getBoolRef().

const vbool& Vertica::BlockReader::getBoolRef(size_t idx) const

inline inherited Get a reference to a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an BOOLEAN.

Referenced by Vertica::BlockReader::isNull().

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

const DateADT* Vertica::BlockReader::getDatePtr(size_t idx) const

inline inherited Get a pointer to a DATE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a DATE.

Referenced by Vertica::BlockReader::getDateRef().

const DateADT& Vertica::BlockReader::getDateRef(size_t idx) const

inline inherited Get a reference to a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an DATE.

Referenced by Vertica::BlockReader::isNull().

const vfloat* Vertica::BlockReader::getFloatPtr(size_t idx) const

inline inherited Get a pointer to a FLOAT value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a FLOAT.

Referenced by Vertica::BlockReader::getFloatRef().

const vfloat& Vertica::BlockReader::getFloatRef(size_t idx) const

inline inherited Get a reference to a FLOAT value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the idx'th argument, cast as an FLOAT.

Referenced by Vertica::BlockReader::isNull().

const Interval* Vertica::BlockReader::getIntervalPtr(size_t idx) const

inline inherited Get a pointer to an INTERVAL value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as an INTERVAL.

Referenced by Vertica::BlockReader::getIntervalRef().

const Interval& Vertica::BlockReader::getIntervalRef(size_t idx) const

inline inherited Get a reference to an INTERVAL value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTERVAL.

Referenced by Vertica::BlockReader::isNull().

const IntervalYM* Vertica::BlockReader::getIntervalYMPtr(size_t idx) const

inline inherited Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A point to the retrieved value cast as a INTERVAL YEAR TO MONTH.

Referenced by Vertica::BlockReader::getIntervalYMRef().

const IntervalYM& Vertica::BlockReader::getIntervalYMRef(size_t idx) const

inline inherited Get a reference to an INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTERVAL YEAR TO MONTH.

Referenced by Vertica::BlockReader::isNull().

const vint* Vertica::BlockReader::getIntPtr(size_t idx) const

inline inherited Get a pointer to an INTEGER value from the input row.

Returns a pointer to the idx'th argument, cast appropriately.

Parameters

  • idx: The column number to retrieve from the input row.

Example:

const vint *a = arg_reader->getIntPtr(0);

Referenced by Vertica::BlockReader::getIntRef().

const vint& Vertica::BlockReader::getIntRef(size_t idx) const

inline inherited Get a reference to an INTEGER value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTEGER.

Example:

const vint a = arg_reader->getIntRef(0);

Referenced by Vertica::BlockReader::isNull().

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

const VNumeric* Vertica::BlockReader::getNumericPtr(size_t idx) const

inline inherited Get a pointer to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a Numeric.

Referenced by Vertica::BlockReader::getNumericRef().

const VNumeric& Vertica::BlockReader::getNumericRef(size_t idx) const

inline inherited Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VNumeric.

Referenced by Vertica::BlockReader::isNull().

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

int Vertica::BlockReader::getPosition() const

inline inherited Returns the current row position or array index

const BlockReader* Vertica::BlockReader::getRowPtr(size_t idx) const

inline inherited Get a reference to a Row value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a pointer to a reader for the Row fields

Referenced by Vertica::BlockReader::getRowRef().

const BlockReader& Vertica::BlockReader::getRowRef(size_t idx) const

inline inherited Get a reference to a Row value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, as a Row value.

const VString* Vertica::BlockReader::getStringPtr(size_t idx) const

inline inherited Get a pointer to a VString value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a VString.

Referenced by Vertica::BlockReader::getStringRef().

const VString& Vertica::BlockReader::getStringRef(size_t idx) const

inline inherited Get a reference to an VString value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by Vertica::BlockReader::isNull().

const TimeADT* Vertica::BlockReader::getTimePtr(size_t idx) const

inline inherited Get a pointer to a TIME value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIME.

Referenced by Vertica::BlockReader::getTimeRef().

const TimeADT& Vertica::BlockReader::getTimeRef(size_t idx) const

inline inherited Get a reference to a TIME value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIME.

Referenced by Vertica::BlockReader::isNull().

const Timestamp* Vertica::BlockReader::getTimestampPtr(size_t idx) const

inline inherited Get a pointer to a TIMESTAMP value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP.

Referenced by Vertica::BlockReader::getTimestampRef().

const Timestamp& Vertica::BlockReader::getTimestampRef(size_t idx) const

inline inherited Get a reference to a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIMESTAMP.

Referenced by Vertica::BlockReader::isNull().

const TimestampTz* Vertica::BlockReader::getTimestampTzPtr(size_t idx) const

inline inherited Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP WITH TIMEZONE .

Referenced by Vertica::BlockReader::getTimestampTzRef().

const TimestampTz& Vertica::BlockReader::getTimestampTzRef(size_t idx) const

inline inherited Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIMESTAMP WITH TIMEZONE.

Referenced by Vertica::BlockReader::isNull().

const TimeTzADT* Vertica::BlockReader::getTimeTzPtr(size_t idx) const

inline inherited Get a pointer to a TIME WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIME WITH TIMEZONE.

Referenced by Vertica::BlockReader::getTimeTzRef().

const TimeTzADT& Vertica::BlockReader::getTimeTzRef(size_t idx) const

inline inherited Get a reference to a TIME WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIME WITH TIMEZONE.

Referenced by Vertica::BlockReader::isNull().

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

const VUuid* Vertica::BlockReader::getUuidPtr(size_t idx) const

inline inherited Get a pointer to a VUuid value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a VUuid.

Referenced by Vertica::BlockReader::getUuidRef().

const VUuid& Vertica::BlockReader::getUuidRef(size_t idx) const

inline inherited Get a reference to a VUuid value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VUuid.

Referenced by Vertica::BlockReader::isNull().

bool Vertica::BlockReader::hasData() const

inline inherited Returns true if there is data available

Referenced by Vertica::copyBlockColumn().

bool Vertica::BlockReader::isNull(int col) const

inline inherited Check if the idx'th argument is null.

Parameters

  • col: The column number in the row to check for null

Returns true is the col value is null false otherwise

virtual bool Vertica::AnalyticPartitionReader::readNextBlock()

virtual

Reads in the next block of data and positions cursor at the beginning.

Returns false if there's no more input data

Reimplemented from Vertica::PartitionReader.

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

1.1.78 - Vertica::AnalyticPartitionReader Member List

This is the complete list of members for Vertica::AnalyticPartitionReader, including all inherited members.

::AnalyticPartitionReaderHelper (defined in Vertica::AnalyticPartitionReader) Vertica::AnalyticPartitionReader friend
addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
advanceToNextRow(bool recurIntoArrays) (defined in Vertica::BlockReader) Vertica::BlockReader inlineprotected
AnalyticPartitionReader(size_t narg, EE::UserDefinedProcess *udx_object) (defined in Vertica::AnalyticPartitionReader) Vertica::AnalyticPartitionReader inline
BlockReader(size_t narg, int rowcount, const int *indices) (defined in Vertica::BlockReader) Vertica::BlockReader inline
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
dh (defined in Vertica::PartitionReader) Vertica::PartitionReader protected
EE::UserDefinedAnalytic (defined in Vertica::AnalyticPartitionReader) Vertica::AnalyticPartitionReader friend
EE::UserDefinedProcess (defined in Vertica::AnalyticPartitionReader) Vertica::AnalyticPartitionReader friend
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getArrayRef(size_t idx) const Vertica::BlockReader
getBoolPtr(size_t idx) const Vertica::BlockReader inline
getBoolRef(size_t idx) const Vertica::BlockReader inline
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDatePtr(size_t idx) const Vertica::BlockReader inline
getDateRef(size_t idx) const Vertica::BlockReader inline
getFloatPtr(size_t idx) const Vertica::BlockReader inline
getFloatRef(size_t idx) const Vertica::BlockReader inline
getIntervalPtr(size_t idx) const Vertica::BlockReader inline
getIntervalRef(size_t idx) const Vertica::BlockReader inline
getIntervalYMPtr(size_t idx) const Vertica::BlockReader inline
getIntervalYMRef(size_t idx) const Vertica::BlockReader inline
getIntPtr(size_t idx) const Vertica::BlockReader inline
getIntRef(size_t idx) const Vertica::BlockReader inline
getNumCols() const Vertica::VerticaBlock inline
getNumericPtr(size_t idx) const Vertica::BlockReader inline
getNumericRef(size_t idx) const Vertica::BlockReader inline
getNumRows() const Vertica::VerticaBlock inline
getPosition() const Vertica::BlockReader inline
getRowPtr(size_t idx) const Vertica::BlockReader inline
getRowRef(size_t idx) const Vertica::BlockReader inline
getStringPtr(size_t idx) const Vertica::BlockReader inline
getStringRef(size_t idx) const Vertica::BlockReader inline
getTimePtr(size_t idx) const Vertica::BlockReader inline
getTimeRef(size_t idx) const Vertica::BlockReader inline
getTimestampPtr(size_t idx) const Vertica::BlockReader inline
getTimestampRef(size_t idx) const Vertica::BlockReader inline
getTimestampTzPtr(size_t idx) const Vertica::BlockReader inline
getTimestampTzRef(size_t idx) const Vertica::BlockReader inline
getTimeTzPtr(size_t idx) const Vertica::BlockReader inline
getTimeTzRef(size_t idx) const Vertica::BlockReader inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidPtr(size_t idx) const Vertica::BlockReader inline
getUuidRef(size_t idx) const Vertica::BlockReader inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
hasData() const Vertica::BlockReader inline
hasMoreData() (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
isNewOrderByKey() (defined in Vertica::AnalyticPartitionReader) Vertica::AnalyticPartitionReader inline
isNull(int col) const Vertica::BlockReader inline
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
newOrderMarkers (defined in Vertica::AnalyticPartitionReader) Vertica::AnalyticPartitionReader protected
next() (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
PartitionReader(size_t narg) (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
PartitionReader(size_t narg, EE::UserDefinedProcess *udx_object) (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
pstart (defined in Vertica::PartitionReader) Vertica::PartitionReader protected
readNextBlock() override Vertica::AnalyticPartitionReader virtual
remaining() const Vertica::VerticaBlock inline
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setupColsAndStrides() override (defined in Vertica::AnalyticPartitionReader) Vertica::AnalyticPartitionReader protectedvirtual
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
udan (defined in Vertica::PartitionReader) Vertica::PartitionReader
udt (defined in Vertica::PartitionReader) Vertica::PartitionReader
udx_object (defined in Vertica::PartitionReader) Vertica::PartitionReader
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
willFetchBlockOnNext() (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
~PartitionReader() (defined in Vertica::PartitionReader) Vertica::PartitionReader inlinevirtual
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.79 - Vertica::AnalyticPartitionWriter Class Reference

Partition writer for all input data in a single partition. It automatically makes space as needed.

Inheritance diagram for Vertica::AnalyticPartitionWriter:

Collaboration diagram for Vertica::AnalyticPartitionWriter:

Public Member Functions
AnalyticPartitionWriter (size_t narg, EE::UserDefinedProcess *udx_object)
void copy (const VerticaBlock &other)
void copyFromInput (size_t dstIdx, const BlockReader &input_reader, size_t srcIdx)
void copyFromInput (const BlockReader &input_reader)
Array::ArrayWriter getArrayRef (size_t idx)
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
PartitionWriterColumns getColumns ()
const EE::DataArea * getDataArea (size_t idx) const
size_t getNumCols () const
VNumeric & getNumericRef (size_t idx)
int getNumRows () const
BlockWriter * getRowPtr (size_t idx)
BlockWriter & getRowRef (size_t idx)
Get a reference for writing an output Row value.
VString & getStringRef (size_t idx)
VString & getStringRefNoClear (size_t idx)
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
VUuid & getUuidRef (size_t idx)
const void * getVoidPtr (size_t idx=0) const
void * getVoidPtr (size_t idx)
virtual bool getWriteableBlock () override
bool next ()
bool remaining () const
void setBool (size_t idx, vbool r)
void setDataArea (size_t idx, void *dataarea)
void setDate (size_t idx, DateADT r)
void setFloat (size_t idx, vfloat r)
void setInt (size_t idx, vint r)
void setInterval (size_t idx, Interval r)
void setIntervalYM (size_t idx, IntervalYM r)
void setNull (size_t idx)
Set the idx'th argument to null. If a column has the canBeNull attribute set to false, then this throws an exception.
void setNull (size_t idx, bool enforceNotNullProperty)
Set the idx'th argument to null.
void setTime (size_t idx, TimeADT r)
void setTimestamp (size_t idx, Timestamp r)
void setTimestampTz (size_t idx, TimestampTz r)
void setTimeTz (size_t idx, TimeTzADT r)
void throwIncorrectUsageError (size_t idx)
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
bool commitPrefilledRows (int nRows)
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
union {
EE::UserDefinedAnalytic * udan
EE::UserDefinedTransform * udt
EE::UserDefinedProcess * udx_object
};
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
int pstart
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers

Detailed Description

Partition writer for all input data in a single partition. It automatically makes space as needed.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

void Vertica::PartitionWriter::copyFromInput(size_t dstIdx, const BlockReader & input_reader, size_t srcIdx)

inherited Copies a column from the input reader to the output writer. Raises an error if the input and output data types are not compatible.

Parameters

  • dstIdx: The destination column index (in the output writer)
  • input_reader: The input reader from which to copy a column
  • srcIdx: The source column index (in the input reader)
EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

BlockWriter& Vertica::PartitionWriter::getRowRef(size_t idx)

inline inherited Get a reference for writing an output Row value.

Parameters

  • idx: the output column

Returns a reference to a BlockWriter which holds output data for the Row value's fields

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

virtual bool Vertica::AnalyticPartitionWriter::getWriteableBlock()

virtual

Gets a writeable block of data and positions cursor at the beginning.

Reimplemented from Vertica::PartitionWriter.

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

void Vertica::PartitionWriter::setInt(size_t idx, vint r)

inline inherited Setter methods

void Vertica::PartitionWriter::setNull(size_t idx)

inline inherited Set the idx'th argument to null. If a column has the canBeNull attribute set to false, then this throws an exception.

Parameters

  • idx: The column number in the row to set to null
void Vertica::PartitionWriter::setNull(size_t idx, bool enforceNotNullProperty)

inline inherited Set the idx'th argument to null.

Parameters

  • idx: The column number in the row to set to null
  • enforceNotNullProperty: If false, do not throw an exception if canBeNull is false.

1.1.80 - Vertica::AnalyticPartitionWriter Member List

This is the complete list of members for Vertica::AnalyticPartitionWriter, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
AnalyticPartitionWriter(size_t narg, EE::UserDefinedProcess *udx_object) (defined in Vertica::AnalyticPartitionWriter) Vertica::AnalyticPartitionWriter inline
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
commitPrefilledRows(int nRows) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inlineprotected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
copyFromInput(size_t dstIdx, const BlockReader &input_reader, size_t srcIdx) Vertica::PartitionWriter
copyFromInput(const BlockReader &input_reader) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getArrayRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColumns() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getNumCols() const Vertica::VerticaBlock inline
getNumericRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getNumRows() const Vertica::VerticaBlock inline
getRowPtr(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getRowRef(size_t idx) Vertica::PartitionWriter inline
getStringRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getStringRefNoClear(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getVoidPtr(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getWriteableBlock() override Vertica::AnalyticPartitionWriter virtual
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
next() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
PartitionWriter(size_t narg) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
PartitionWriter(size_t narg, EE::UserDefinedProcess *udx_object) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
PartitionWriter(size_t narg, size_t nrows, EE::UserDefinedProcess *udx_object) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
pstart (defined in Vertica::PartitionWriter) Vertica::PartitionWriter protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inlineprotected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setBool(size_t idx, vbool r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setDate(size_t idx, DateADT r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setFloat(size_t idx, vfloat r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setInt(size_t idx, vint r) Vertica::PartitionWriter inline
setInterval(size_t idx, Interval r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setIntervalYM(size_t idx, IntervalYM r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setNull(size_t idx) Vertica::PartitionWriter inline
setNull(size_t idx, bool enforceNotNullProperty) Vertica::PartitionWriter inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setTime(size_t idx, TimeADT r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setTimestamp(size_t idx, Timestamp r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setTimestampTz(size_t idx, TimestampTz r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setTimeTz(size_t idx, TimeTzADT r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
throwIncorrectUsageError(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
udan (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
udt (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
udx_object (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~AnalyticPartitionWriter() (defined in Vertica::AnalyticPartitionWriter) Vertica::AnalyticPartitionWriter inlinevirtual
~PartitionWriter() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inlinevirtual
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.81 - Vertica::Array::ArrayReader Class Reference

Interface for reading array data. This class wraps a BlockReader which reads the elements of an array datum.

Collaboration diagram for Vertica::Array::ArrayReader:

Public Member Functions
BlockReader * getElementBlock ()
const BlockReader * getElementBlock () const
BlockReader & operator* ()
const BlockReader & operator* () const
BlockReader * operator-> ()
const BlockReader * operator-> () const

Detailed Description

Interface for reading array data. This class wraps a BlockReader which reads the elements of an array datum.

Member Function Documentation

BlockReader& Vertica::Array::ArrayReader::operator*()

inline Returns a reference to the wrapped BlockReader

const BlockReader& Vertica::Array::ArrayReader::operator*() const

inline Returns a reference to the wrapped BlockReader

BlockReader* Vertica::Array::ArrayReader::operator->()

inline Returns a pointer to the wrapped BlockReader

const BlockReader* Vertica::Array::ArrayReader::operator->() const

inline Returns a pointer to the wrapped BlockReader

1.1.82 - Vertica::Array::ArrayReader Member List

This is the complete list of members for Vertica::Array::ArrayReader, including all inherited members.

getElementBlock() (defined in Vertica::Array::ArrayReader) Vertica::Array::ArrayReader inline
getElementBlock() const (defined in Vertica::Array::ArrayReader) Vertica::Array::ArrayReader inline
operator*() Vertica::Array::ArrayReader inline
operator*() const Vertica::Array::ArrayReader inline
operator->() Vertica::Array::ArrayReader inline
operator->() const Vertica::Array::ArrayReader inline

1.1.83 - Vertica::Array::ArrayWriter Class Reference

Interface for writing elements into an array datum.

Collaboration diagram for Vertica::Array::ArrayWriter:

Public Member Functions
void commit ()
BlockWriter * getElementBlock ()
const BlockWriter * getElementBlock () const
BlockWriter & operator* ()
const BlockWriter & operator* () const
BlockWriter * operator-> ()
BlockWriter * operator-> () const

Detailed Description

Interface for writing elements into an array datum.

This class wraps a BlockWriter which is a cursor onto elements of an array datum. Use the wrapped BlockWriter to write element data, and then finalize the array contents by calling ArrayWriter::commit. This does any necessary post-processing to convert the element data into a canonical array datum.

Member Function Documentation

void Vertica::Array::ArrayWriter::commit()

inline Finalize the array value. This sets the number of array elements and copies data from the temp scratch space into the target column.

Referenced by Vertica::copyBlockColumn().

BlockWriter& Vertica::Array::ArrayWriter::operator*()

inline Returns a reference to the wrapped BlockWriter

const BlockWriter& Vertica::Array::ArrayWriter::operator*() const

inline Returns a reference to the wrapped BlockWriter

BlockWriter* Vertica::Array::ArrayWriter::operator->()

inline Returns a pointer to the wrapped BlockWriter

BlockWriter* Vertica::Array::ArrayWriter::operator->() const

inline Returns a pointer to the wrapped BlockWriter

1.1.84 - Vertica::Array::ArrayWriter Member List

This is the complete list of members for Vertica::Array::ArrayWriter, including all inherited members.

commit() Vertica::Array::ArrayWriter inline
getElementBlock() (defined in Vertica::Array::ArrayWriter) Vertica::Array::ArrayWriter inline
getElementBlock() const (defined in Vertica::Array::ArrayWriter) Vertica::Array::ArrayWriter inline
operator*() Vertica::Array::ArrayWriter inline
operator*() const Vertica::Array::ArrayWriter inline
operator->() Vertica::Array::ArrayWriter inline
operator->() const Vertica::Array::ArrayWriter inline

1.1.85 - Vertica::BasePartitionWriterColumn Class Reference

Base class for vectorized writing to columns. Efficiently writes each element in a single column.

Inheritance diagram for Vertica::BasePartitionWriterColumn:

Collaboration diagram for Vertica::BasePartitionWriterColumn:

Public Member Functions
char * getAndAdvance ()
const char * getPtr (size_t offset_from_start)
int getStrideLength ()
size_t getWrittenElementCount ()
Protected Member Functions
BasePartitionWriterColumn (int _stridelength, char *_start, char *_end)
void rejectRows (std::set &rejectedRows)
Protected Attributes
char * curr
const char * end
const char * start
const int stridelength
Friends
class PartitionWriterColumns

Detailed Description

Base class for vectorized writing to columns. Efficiently writes each element in a single column.

Member Function Documentation

int Vertica::BasePartitionWriterColumn::getStrideLength()

inline Returns the size of each element in the column

1.1.86 - Vertica::BasePartitionWriterColumn Member List

This is the complete list of members for Vertica::BasePartitionWriterColumn, including all inherited members.

BasePartitionWriterColumn(int _stridelength, char *_start, char *_end) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotected
curr (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
end (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
getAndAdvance() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getPtr(size_t offset_from_start) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getStrideLength() Vertica::BasePartitionWriterColumn inline
getWrittenElementCount() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
PartitionWriterColumns (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn friend
rejectRows(std::set &rejectedRows) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
start (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
stridelength (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
~BasePartitionWriterColumn() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotectedvirtual

1.1.87 - Vertica::BlockFormatter Member List

This is the complete list of members for Vertica::BlockFormatter, including all inherited members.

BlockFormatter(const BlockReader &reader) (defined in Vertica::BlockFormatter) Vertica::BlockFormatter inline
format() (defined in Vertica::BlockFormatter) Vertica::BlockFormatter inline
writeRow(int rowNum, const std::string &row)=0 (defined in Vertica::BlockFormatter) Vertica::BlockFormatter pure virtual
~BlockFormatter() (defined in Vertica::BlockFormatter) Vertica::BlockFormatter inlinevirtual

1.1.88 - Vertica::BlockFormatter Struct Reference

Inheritance diagram for Vertica::BlockFormatter:

Collaboration diagram for Vertica::BlockFormatter:

Public Member Functions
BlockFormatter (const BlockReader &reader)
void format ()
virtual void writeRow (int rowNum, const std::string &row)=0

Detailed Description

Class to formatting the data from a UDF arg reader.

See BlockFormatterCout for example

1.1.89 - Vertica::BlockFormatterCout Member List

This is the complete list of members for Vertica::BlockFormatterCout, including all inherited members.

BlockFormatter(const BlockReader &reader) (defined in Vertica::BlockFormatter) Vertica::BlockFormatter inline
BlockFormatterCout(const BlockReader &reader) (defined in Vertica::BlockFormatterCout) Vertica::BlockFormatterCout inline
format() (defined in Vertica::BlockFormatter) Vertica::BlockFormatter inline
writeRow(int rowNum, const std::string &row) (defined in Vertica::BlockFormatterCout) Vertica::BlockFormatterCout inlinevirtual
~BlockFormatter() (defined in Vertica::BlockFormatter) Vertica::BlockFormatter inlinevirtual
~BlockFormatterCout() (defined in Vertica::BlockFormatterCout) Vertica::BlockFormatterCout inlinevirtual

1.1.90 - Vertica::BlockFormatterCout Struct Reference

Inheritance diagram for Vertica::BlockFormatterCout:

Collaboration diagram for Vertica::BlockFormatterCout:

Public Member Functions
BlockFormatterCout (const BlockReader &reader)
void format ()
void writeRow (int rowNum, const std::string &row)

Detailed Description

Formatting rows in a BlockReader to stdout

Example Usage with BlockReader *arg_reader

BlockFormatterCout(*arg_reader).format();

1.1.91 - Vertica::BlockReader Class Reference

Iterator interface for reading rows in a Vertica block.

Inheritance diagram for Vertica::BlockReader:

Collaboration diagram for Vertica::BlockReader:

Public Member Functions
BlockReader (size_t narg, int rowcount, const int *indices)
void copy (const VerticaBlock &other)
Array::ArrayReader getArrayRef (size_t idx) const
Get a reference to an Array value from the input row.
const vbool * getBoolPtr (size_t idx) const
Get a pointer to a BOOLEAN value from the input row.
const vbool & getBoolRef (size_t idx) const
Get a reference to a BOOLEAN value from the input row.
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
const DateADT * getDatePtr (size_t idx) const
Get a pointer to a DATE value from the input row.
const DateADT & getDateRef (size_t idx) const
Get a reference to a DATE value from the input row.
const vfloat * getFloatPtr (size_t idx) const
Get a pointer to a FLOAT value from the input row.
const vfloat & getFloatRef (size_t idx) const
Get a reference to a FLOAT value from the input row.
const Interval * getIntervalPtr (size_t idx) const
Get a pointer to an INTERVAL value from the input row.
const Interval & getIntervalRef (size_t idx) const
Get a reference to an INTERVAL value from the input row.
const IntervalYM * getIntervalYMPtr (size_t idx) const
Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.
const IntervalYM & getIntervalYMRef (size_t idx) const
Get a reference to an INTERVAL YEAR TO MONTH value from the input row.
const vint * getIntPtr (size_t idx) const
Get a pointer to an INTEGER value from the input row.
const vint & getIntRef (size_t idx) const
Get a reference to an INTEGER value from the input row.
size_t getNumCols () const
const VNumeric * getNumericPtr (size_t idx) const
Get a pointer to a VNumeric value from the input row.
const VNumeric & getNumericRef (size_t idx) const
Get a reference to a VNumeric value from the input row.
int getNumRows () const
int getPosition () const
const BlockReader * getRowPtr (size_t idx) const
Get a reference to a Row value from the input row.
const BlockReader & getRowRef (size_t idx) const
Get a reference to a Row value from the input row.
const VString * getStringPtr (size_t idx) const
Get a pointer to a VString value from the input row.
const VString & getStringRef (size_t idx) const
Get a reference to an VString value from the input row.
const TimeADT * getTimePtr (size_t idx) const
Get a pointer to a TIME value from the input row.
const TimeADT & getTimeRef (size_t idx) const
Get a reference to a TIME value from the input row.
const Timestamp * getTimestampPtr (size_t idx) const
Get a pointer to a TIMESTAMP value from the input row.
const Timestamp & getTimestampRef (size_t idx) const
Get a reference to a TIMESTAMP value from the input row.
const TimestampTz * getTimestampTzPtr (size_t idx) const
Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimestampTz & getTimestampTzRef (size_t idx) const
Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimeTzADT * getTimeTzPtr (size_t idx) const
Get a pointer to a TIME WITH TIMEZONE value from the input row.
const TimeTzADT & getTimeTzRef (size_t idx) const
Get a reference to a TIME WITH TIMEZONE value from the input row.
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
const VUuid * getUuidPtr (size_t idx) const
Get a pointer to a VUuid value from the input row.
const VUuid & getUuidRef (size_t idx) const
Get a reference to a VUuid value from the input row.
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool hasData () const
bool isNull (int col) const
Check if the idx'th argument is null.
bool next ()
bool remaining () const
void setDataArea (size_t idx, void *dataarea)
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool advanceToNextRow (bool recurIntoArrays)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers
Friends
class Array::ArrayReader
class EE::VEval
class VerticaBlockSerializer
class VerticaRInterface

Detailed Description

Iterator interface for reading rows in a Vertica block.

This class provides the input to the ScalarFunction.processBlock() function. You extract values from the input row using data type specific functions to extract each column value. You can also determine the number of columns and their data types, if your processBlock function does not have hard-coded input expectations.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

Array::ArrayReader Vertica::BlockReader::getArrayRef(size_t idx) const

Get a reference to an Array value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument: another BlockReader which reads elements of the array.

const vbool* Vertica::BlockReader::getBoolPtr(size_t idx) const

inline Get a pointer to a BOOLEAN value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a BOOLEAN.

Referenced by getBoolRef().

const vbool& Vertica::BlockReader::getBoolRef(size_t idx) const

inline Get a reference to a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an BOOLEAN.

Referenced by isNull().

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

const DateADT* Vertica::BlockReader::getDatePtr(size_t idx) const

inline Get a pointer to a DATE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a DATE.

Referenced by getDateRef().

const DateADT& Vertica::BlockReader::getDateRef(size_t idx) const

inline Get a reference to a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an DATE.

Referenced by isNull().

const vfloat* Vertica::BlockReader::getFloatPtr(size_t idx) const

inline Get a pointer to a FLOAT value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a FLOAT.

Referenced by getFloatRef().

const vfloat& Vertica::BlockReader::getFloatRef(size_t idx) const

inline Get a reference to a FLOAT value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the idx'th argument, cast as an FLOAT.

Referenced by isNull().

const Interval* Vertica::BlockReader::getIntervalPtr(size_t idx) const

inline Get a pointer to an INTERVAL value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as an INTERVAL.

Referenced by getIntervalRef().

const Interval& Vertica::BlockReader::getIntervalRef(size_t idx) const

inline Get a reference to an INTERVAL value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTERVAL.

Referenced by isNull().

const IntervalYM* Vertica::BlockReader::getIntervalYMPtr(size_t idx) const

inline Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A point to the retrieved value cast as a INTERVAL YEAR TO MONTH.

Referenced by getIntervalYMRef().

const IntervalYM& Vertica::BlockReader::getIntervalYMRef(size_t idx) const

inline Get a reference to an INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTERVAL YEAR TO MONTH.

Referenced by isNull().

const vint* Vertica::BlockReader::getIntPtr(size_t idx) const

inline Get a pointer to an INTEGER value from the input row.

Returns a pointer to the idx'th argument, cast appropriately.

Parameters

  • idx: The column number to retrieve from the input row.

Example:

const vint *a = arg_reader->getIntPtr(0);

Referenced by getIntRef().

const vint& Vertica::BlockReader::getIntRef(size_t idx) const

inline Get a reference to an INTEGER value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTEGER.

Example:

const vint a = arg_reader->getIntRef(0);

Referenced by isNull().

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

const VNumeric* Vertica::BlockReader::getNumericPtr(size_t idx) const

inline Get a pointer to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a Numeric.

Referenced by getNumericRef().

const VNumeric& Vertica::BlockReader::getNumericRef(size_t idx) const

inline Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VNumeric.

Referenced by isNull().

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

int Vertica::BlockReader::getPosition() const

inline Returns the current row position or array index

const BlockReader* Vertica::BlockReader::getRowPtr(size_t idx) const

inline Get a reference to a Row value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a pointer to a reader for the Row fields

Referenced by getRowRef().

const BlockReader& Vertica::BlockReader::getRowRef(size_t idx) const

inline Get a reference to a Row value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, as a Row value.

const VString* Vertica::BlockReader::getStringPtr(size_t idx) const

inline Get a pointer to a VString value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a VString.

Referenced by getStringRef().

const VString& Vertica::BlockReader::getStringRef(size_t idx) const

inline Get a reference to an VString value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by isNull().

const TimeADT* Vertica::BlockReader::getTimePtr(size_t idx) const

inline Get a pointer to a TIME value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIME.

Referenced by getTimeRef().

const TimeADT& Vertica::BlockReader::getTimeRef(size_t idx) const

inline Get a reference to a TIME value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIME.

Referenced by isNull().

const Timestamp* Vertica::BlockReader::getTimestampPtr(size_t idx) const

inline Get a pointer to a TIMESTAMP value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP.

Referenced by getTimestampRef().

const Timestamp& Vertica::BlockReader::getTimestampRef(size_t idx) const

inline Get a reference to a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIMESTAMP.

Referenced by isNull().

const TimestampTz* Vertica::BlockReader::getTimestampTzPtr(size_t idx) const

inline Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP WITH TIMEZONE .

Referenced by getTimestampTzRef().

const TimestampTz& Vertica::BlockReader::getTimestampTzRef(size_t idx) const

inline Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIMESTAMP WITH TIMEZONE.

Referenced by isNull().

const TimeTzADT* Vertica::BlockReader::getTimeTzPtr(size_t idx) const

inline Get a pointer to a TIME WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIME WITH TIMEZONE.

Referenced by getTimeTzRef().

const TimeTzADT& Vertica::BlockReader::getTimeTzRef(size_t idx) const

inline Get a reference to a TIME WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIME WITH TIMEZONE.

Referenced by isNull().

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

const VUuid* Vertica::BlockReader::getUuidPtr(size_t idx) const

inline Get a pointer to a VUuid value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a VUuid.

Referenced by getUuidRef().

const VUuid& Vertica::BlockReader::getUuidRef(size_t idx) const

inline Get a reference to a VUuid value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VUuid.

Referenced by isNull().

bool Vertica::BlockReader::hasData() const

inline Returns true if there is data available

Referenced by Vertica::copyBlockColumn().

bool Vertica::BlockReader::isNull(int col) const

inline Check if the idx'th argument is null.

Parameters

  • col: The column number in the row to check for null

Returns true is the col value is null false otherwise

bool Vertica::BlockReader::next()

inline Advance to the next record.

Returns true if there are more rows to read, false otherwise.

Referenced by Vertica::copyBlockColumn().

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

1.1.92 - Vertica::BlockReader Member List

This is the complete list of members for Vertica::BlockReader, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
advanceToNextRow(bool recurIntoArrays) (defined in Vertica::BlockReader) Vertica::BlockReader inlineprotected
Array::ArrayReader (defined in Vertica::BlockReader) Vertica::BlockReader friend
BlockReader(size_t narg, int rowcount, const int *indices) (defined in Vertica::BlockReader) Vertica::BlockReader inline
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
EE::VEval (defined in Vertica::BlockReader) Vertica::BlockReader friend
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getArrayRef(size_t idx) const Vertica::BlockReader
getBoolPtr(size_t idx) const Vertica::BlockReader inline
getBoolRef(size_t idx) const Vertica::BlockReader inline
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDatePtr(size_t idx) const Vertica::BlockReader inline
getDateRef(size_t idx) const Vertica::BlockReader inline
getFloatPtr(size_t idx) const Vertica::BlockReader inline
getFloatRef(size_t idx) const Vertica::BlockReader inline
getIntervalPtr(size_t idx) const Vertica::BlockReader inline
getIntervalRef(size_t idx) const Vertica::BlockReader inline
getIntervalYMPtr(size_t idx) const Vertica::BlockReader inline
getIntervalYMRef(size_t idx) const Vertica::BlockReader inline
getIntPtr(size_t idx) const Vertica::BlockReader inline
getIntRef(size_t idx) const Vertica::BlockReader inline
getNumCols() const Vertica::VerticaBlock inline
getNumericPtr(size_t idx) const Vertica::BlockReader inline
getNumericRef(size_t idx) const Vertica::BlockReader inline
getNumRows() const Vertica::VerticaBlock inline
getPosition() const Vertica::BlockReader inline
getRowPtr(size_t idx) const Vertica::BlockReader inline
getRowRef(size_t idx) const Vertica::BlockReader inline
getStringPtr(size_t idx) const Vertica::BlockReader inline
getStringRef(size_t idx) const Vertica::BlockReader inline
getTimePtr(size_t idx) const Vertica::BlockReader inline
getTimeRef(size_t idx) const Vertica::BlockReader inline
getTimestampPtr(size_t idx) const Vertica::BlockReader inline
getTimestampRef(size_t idx) const Vertica::BlockReader inline
getTimestampTzPtr(size_t idx) const Vertica::BlockReader inline
getTimestampTzRef(size_t idx) const Vertica::BlockReader inline
getTimeTzPtr(size_t idx) const Vertica::BlockReader inline
getTimeTzRef(size_t idx) const Vertica::BlockReader inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidPtr(size_t idx) const Vertica::BlockReader inline
getUuidRef(size_t idx) const Vertica::BlockReader inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
hasData() const Vertica::BlockReader inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
isNull(int col) const Vertica::BlockReader inline
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
next() Vertica::BlockReader inline
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
VerticaBlockSerializer (defined in Vertica::BlockReader) Vertica::BlockReader friend
VerticaRInterface (defined in Vertica::BlockReader) Vertica::BlockReader friend
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.93 - Vertica::BlockWriter Class Reference

Iterator interface for writing rows to a Vertica block.

Inheritance diagram for Vertica::BlockWriter:

Collaboration diagram for Vertica::BlockWriter:

Public Member Functions
BlockWriter (int rowcount)
BlockWriter (char *outArr, int stride, int rowcount, const int *indices, const VerticaType &dt)
int capacity () const
void copy (const VerticaBlock &other)
void copyFromInput (size_t dstIdx, const BlockReader &vblock, size_t srcIdx)
void copyFromInput (const BlockReader &vblock)
Array::ArrayWriter getArrayRef (size_t idx=0)
Get a handle for writing an output array value.
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
size_t getNumCols () const
VNumeric & getNumericRef (size_t idx=0)
Allocates a new VNumeric object to use as output.
int getNumRows () const
BlockWriter * getRowPtr (size_t idx=0)
Get a pointer for writing an output Row value.
BlockWriter & getRowRef (size_t idx=0)
Get a reference for writing an output Row value.
int getRowsWritten () const
VString * getStringPtr (size_t idx=0)
Get a pointer for writing output.
VString & getStringRef (size_t idx=0)
Allocates a new VString object to use as output.
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
VUuid & getUuidRef (size_t idx=0)
Allocates a new VUuid object to use as output.
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool hasMoreSpace () const
bool next ()
Complete writing this row of output and move to the next row.
bool remaining () const
void setBool (vbool r)
Adds a BOOLEAN value to the output row.
void setBool (size_t idx, vbool r)
Adds a BOOLEAN value to the indicated column of the output row.
void setDataArea (size_t idx, void *dataarea)
void setDate (DateADT r)
Adds a DATE value to the output row.
void setDate (size_t idx, DateADT r)
Adds a DATE value to the indicated column of the output row.
void setFloat (vfloat r)
Adds a FLOAT value to the output row.
void setFloat (size_t idx, vfloat r)
Adds a FLOAT value to the indicated column of the output row.
void setInt (vint r)
Adds an INTEGER value to the output row.
void setInt (size_t idx, vint r)
Adds an INTEGER value to the indicated column of the output row.
void setInterval (Interval r)
Adds an INTERVAL value to the output row.
void setInterval (size_t idx, Interval r)
Adds an INTERVAL value to the indicated column of the output row.
void setIntervalYM (IntervalYM r)
Adds an INTERVAL YEAR TO MONTH value to the output row.
void setIntervalYM (size_t idx, IntervalYM r)
Adds an INTERVAL YEAR TO MONTH value to the indicated column of the output row.
void setNull (size_t idx=0, bool enforceNotNullProperty=true)
Set the column to null.
void setTime (TimeADT r)
Adds a TIME value to the output row.
void setTime (size_t idx, TimeADT r)
Adds an TIME value to the indicated column of the output row.
void setTimestamp (Timestamp r)
Adds a TIMESTAMP value to the output row.
void setTimestamp (size_t idx, Timestamp r)
Adds an TIMESTAMP value to the indicated column of the output row.
void setTimestampTz (TimestampTz r)
Adds a TIMESTAMP WITH TIMEZONE value to the output row.
void setTimestampTz (size_t idx, TimestampTz r)
Adds an TIMESTAMP WITH TIMEZONE value to the indicated column of the output row.
void setTimeTz (TimeTzADT r)
Adds a TIME WITH TIMEZONE value to the output row.
void setTimeTz (size_t idx, TimeTzADT r)
Adds an TIME WITH TIMEZONE value to the indicated column of the output row.
void throwIncorrectUsageError ()
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers
Friends
class Array::ArrayWriter
class EE::VEval
class PartitionWriter

Detailed Description

Iterator interface for writing rows to a Vertica block.

This class provides the output rows that ScalarFunction.processBlock() writes to.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

void Vertica::BlockWriter::copyFromInput(size_t dstIdx, const BlockReader & vblock, size_t srcIdx)

Copies a column from the input reader to the output writer. Raises an error if the input and output data types are not compatible.

Parameters

  • dstIdx: The destination column index in the output writer (this)
  • vblock: The source data block
  • srcIdx: The source column index in the input reader

Referenced by

void Vertica::BlockWriter::copyFromInput(const BlockReader & vblock)

inline Copy all columns from the source block to this block

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

Array::ArrayWriter Vertica::BlockWriter::getArrayRef(size_t idx = 0)

Get a handle for writing an output array value.

Parameters

  • idx: the output column

Returns a handle for writing array elements

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

VNumeric& Vertica::BlockWriter::getNumericRef(size_t idx = 0)

inline Allocates a new VNumeric object to use as output.

Parameters

  • idx: the column to reference (default 0)

Returns A new VNumeric object to hold output. This object automatically added to the output row in the indicated column

Referenced by setNull().

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

BlockWriter* Vertica::BlockWriter::getRowPtr(size_t idx = 0)

inline Get a pointer for writing an output Row value.

Parameters

  • idx: the output column

Returns a pointer to a BlockWriter which holds output data for the Row value's fields

BlockWriter& Vertica::BlockWriter::getRowRef(size_t idx = 0)

inline Get a reference for writing an output Row value.

Parameters

  • idx: the output column

Returns a reference to a BlockWriter which holds output data for the Row value's fields

Referenced by

VString* Vertica::BlockWriter::getStringPtr(size_t idx = 0)

inline Get a pointer for writing output.

Parameters

  • idx: the output column

Returns A new VString object to hold output. This object automatically added to the output row in the indicated column

VString& Vertica::BlockWriter::getStringRef(size_t idx = 0)

inline Allocates a new VString object to use as output.

Parameters

  • idx: the column to reference (default 0)

Returns A new VString object to hold output. This object is automatically added to the output row in the indicated column

Referenced by

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

VUuid& Vertica::BlockWriter::getUuidRef(size_t idx = 0)

inline Allocates a new VUuid object to use as output.

Parameters

  • idx: the column to reference (default 0)

Returns A new VUuid object to hold output. This object automatically added to the output row in the indicated column

Referenced by setNull().

bool Vertica::BlockWriter::next()

inline Complete writing this row of output and move to the next row.

Referenced by Vertica::copyBlockColumn().

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

void Vertica::BlockWriter::setBool(vbool r)

inline Adds a BOOLEAN value to the output row.

Parameters

  • r: The BOOLEAN value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setBool(size_t idx, vbool r)

inline Adds a BOOLEAN value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the BOOLEAN value to insert
void Vertica::BlockWriter::setDate(DateADT r)

inline Adds a DATE value to the output row.

Parameters

  • r: The DATE value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setDate(size_t idx, DateADT r)

inline Adds a DATE value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the DATE value to insert
void Vertica::BlockWriter::setFloat(vfloat r)

inline Adds a FLOAT value to the output row.

Parameters

  • r: The FLOAT value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setFloat(size_t idx, vfloat r)

inline Adds a FLOAT value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the FLOAT value to insert
void Vertica::BlockWriter::setInt(vint r)

inline Adds an INTEGER value to the output row.

Setter methods

Parameters

  • r: The INTEGER value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setInt(size_t idx, vint r)

inline Adds an INTEGER value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the INTEGER value to insert
void Vertica::BlockWriter::setInterval(Interval r)

inline Adds an INTERVAL value to the output row.

Parameters

  • r: The INTERVAL value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setInterval(size_t idx, Interval r)

inline Adds an INTERVAL value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the INTERVAL value to insert
void Vertica::BlockWriter::setIntervalYM(IntervalYM r)

inline Adds an INTERVAL YEAR TO MONTH value to the output row.

Parameters

  • r: The INTERVAL YEAR TO MONTH value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setIntervalYM(size_t idx, IntervalYM r)

inline Adds an INTERVAL YEAR TO MONTH value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the INTERVAL YEAR TO MONTH value to insert
void Vertica::BlockWriter::setNull(size_t idx = 0, bool enforceNotNullProperty = true)

inline Set the column to null.

Parameters

  • idx: The column number in the row to set to null
  • enforceNotNullProperty: if true, raise an error if the target field has the canBeNull property set to false.

Referenced by Vertica::PartitionWriter::setNull().

void Vertica::BlockWriter::setTime(TimeADT r)

inline Adds a TIME value to the output row.

Parameters

  • r: The TIME value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setTime(size_t idx, TimeADT r)

inline Adds an TIME value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the TIME value to insert
void Vertica::BlockWriter::setTimestamp(Timestamp r)

inline Adds a TIMESTAMP value to the output row.

Parameters

  • r: The TIMESTAMP value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setTimestamp(size_t idx, Timestamp r)

inline Adds an TIMESTAMP value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the TIMESTAMP value to insert
void Vertica::BlockWriter::setTimestampTz(TimestampTz r)

inline Adds a TIMESTAMP WITH TIMEZONE value to the output row.

Parameters

  • r: The TIMESTAMP WITH TIMEZONE value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setTimestampTz(size_t idx, TimestampTz r)

inline Adds an TIMESTAMP WITH TIMEZONE value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the TIMESTAMP WITH TIMEZONE value to insert
void Vertica::BlockWriter::setTimeTz(TimeTzADT r)

inline Adds a TIME WITH TIMEZONE value to the output row.

Parameters

  • r: The TIME WITH TIMEZONE value to insert into the output row.

Referenced by setNull().

void Vertica::BlockWriter::setTimeTz(size_t idx, TimeTzADT r)

inline Adds an TIME WITH TIMEZONE value to the indicated column of the output row.

Parameters

  • idx: the column index
  • r: the TIME WITH TIMEZONE value to insert

1.1.94 - Vertica::BlockWriter Member List

This is the complete list of members for Vertica::BlockWriter, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
Array::ArrayWriter (defined in Vertica::BlockWriter) Vertica::BlockWriter friend
BlockWriter(int rowcount) (defined in Vertica::BlockWriter) Vertica::BlockWriter inline
BlockWriter(char *outArr, int stride, int rowcount, const int *indices, const VerticaType &dt) (defined in Vertica::BlockWriter) Vertica::BlockWriter inline
capacity() const (defined in Vertica::BlockWriter) Vertica::BlockWriter inline
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
copyFromInput(size_t dstIdx, const BlockReader &vblock, size_t srcIdx) Vertica::BlockWriter
copyFromInput(const BlockReader &vblock) Vertica::BlockWriter inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
EE::VEval (defined in Vertica::BlockWriter) Vertica::BlockWriter friend
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getArrayRef(size_t idx=0) Vertica::BlockWriter
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getNumCols() const Vertica::VerticaBlock inline
getNumericRef(size_t idx=0) Vertica::BlockWriter inline
getNumRows() const Vertica::VerticaBlock inline
getRowPtr(size_t idx=0) Vertica::BlockWriter inline
getRowRef(size_t idx=0) Vertica::BlockWriter inline
getRowsWritten() const (defined in Vertica::BlockWriter) Vertica::BlockWriter inline
getStringPtr(size_t idx=0) Vertica::BlockWriter inline
getStringRef(size_t idx=0) Vertica::BlockWriter inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidRef(size_t idx=0) Vertica::BlockWriter inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
hasMoreSpace() const (defined in Vertica::BlockWriter) Vertica::BlockWriter inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
next() Vertica::BlockWriter inline
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
PartitionWriter (defined in Vertica::BlockWriter) Vertica::BlockWriter friend
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setBool(vbool r) Vertica::BlockWriter inline
setBool(size_t idx, vbool r) Vertica::BlockWriter inline
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setDate(DateADT r) Vertica::BlockWriter inline
setDate(size_t idx, DateADT r) Vertica::BlockWriter inline
setFloat(vfloat r) Vertica::BlockWriter inline
setFloat(size_t idx, vfloat r) Vertica::BlockWriter inline
setInt(vint r) Vertica::BlockWriter inline
setInt(size_t idx, vint r) Vertica::BlockWriter inline
setInterval(Interval r) Vertica::BlockWriter inline
setInterval(size_t idx, Interval r) Vertica::BlockWriter inline
setIntervalYM(IntervalYM r) Vertica::BlockWriter inline
setIntervalYM(size_t idx, IntervalYM r) Vertica::BlockWriter inline
setNull(size_t idx=0, bool enforceNotNullProperty=true) Vertica::BlockWriter inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setTime(TimeADT r) Vertica::BlockWriter inline
setTime(size_t idx, TimeADT r) Vertica::BlockWriter inline
setTimestamp(Timestamp r) Vertica::BlockWriter inline
setTimestamp(size_t idx, Timestamp r) Vertica::BlockWriter inline
setTimestampTz(TimestampTz r) Vertica::BlockWriter inline
setTimestampTz(size_t idx, TimestampTz r) Vertica::BlockWriter inline
setTimeTz(TimeTzADT r) Vertica::BlockWriter inline
setTimeTz(size_t idx, TimeTzADT r) Vertica::BlockWriter inline
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
throwIncorrectUsageError() (defined in Vertica::BlockWriter) Vertica::BlockWriter inline
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.95 - Vertica::ClientMessage Class Reference

Holds the contents of a user-defined message to be reported by a UDx.

Collaboration diagram for Vertica::ClientMessage:

Public Member Functions
ClientMessage (int errorcode, std::string main, std::string hint="", std::string detail="")
ClientMessage ()
bool hasDetail () const
bool hasHint () const
template
ClientMessage & setDetail (const char *fmt, Argtypes &&...args)
template
ClientMessage & setHint (const char *fmt, Argtypes &&...args)
void truncateLengths (size_t maxLen)
Static Public Member Functions
template
static ClientMessage makeMessage (int errorcode, const char *fmt, Argtypes &&...args)
Public Attributes
std::string msg_detail
int msg_errorcode
std::string msg_hint
std::string msg_main

Detailed Description

Holds the contents of a user-defined message to be reported by a UDx.

Made using ClientMessage::makeMessage(...). Must have an error code and main message, but the hint and detail strings are optional. Reported to the client using one of the ServerInterface methods (reportInfo, reportNotice, reportWarning, or reportError).

Constructor & Destructor Documentation

Vertica::ClientMessage::ClientMessage(int errorcode, std::string main, std::string hint = "", std::string detail = "")

inline Constructor

Vertica::ClientMessage::ClientMessage()

inline Nullary constructor

Referenced by makeMessage().

Member Function Documentation

bool Vertica::ClientMessage::hasDetail() const

inline Does this message have a non-empty detail?

Returns true if this message has a detail field set

bool Vertica::ClientMessage::hasHint() const

inline Does this message have a non-empty hint?

Returns true if this message has a hint field set

template<typename... Argtypes>

static ClientMessage Vertica::ClientMessage::makeMessage(int errorcode, const char * fmt, Argtypes &&... args)

inlinestatic

Builds a message using printf-style arguments to format the main text.

Parameters

  • errorcode: This message's id number
  • fmt: A printf-style format string for the main body
  • args: Any arguments to be substituted into fmt

Returns a ClientMessage with the provided error code & formatted main body

template<typename... Argtypes>

ClientMessage& Vertica::ClientMessage::setDetail(const char * fmt, Argtypes &&... args)

inline Sets this message's detail field.

Parameters

  • fmt: A printf-style format string for the detail
  • args: Any argumetns to be substituted into fmt

Returns a reference to this message, to allow for chaining

template<typename... Argtypes>

ClientMessage& Vertica::ClientMessage::setHint(const char * fmt, Argtypes &&... args)

inline Sets this message's hint field.

Parameters

  • fmt: A printf-style format string for the hint
  • args: Any argumetns to be substituted into fmt

Returns a reference to this message, to allow for chaining

void Vertica::ClientMessage::truncateLengths(size_t maxLen)

inline Truncate the lengths of the string fields, keeping them at most maxLen

Parameters

  • maxLen: The largest length allowed for this message's fields

Member Data Documentation

std::string Vertica::ClientMessage::msg_detail

Message detail (optional)

Referenced by

int Vertica::ClientMessage::msg_errorcode

ID code for this message

std::string Vertica::ClientMessage::msg_hint

Message hint (optional)

Referenced by

std::string Vertica::ClientMessage::msg_main

Main message body (required)

Referenced by truncateLengths().

1.1.96 - Vertica::ClientMessage Member List

This is the complete list of members for Vertica::ClientMessage, including all inherited members.

ClientMessage(int errorcode, std::string main, std::string hint="", std::string detail="") Vertica::ClientMessage inline
ClientMessage() Vertica::ClientMessage inline
hasDetail() const Vertica::ClientMessage inline
hasHint() const Vertica::ClientMessage inline
makeMessage(int errorcode, const char *fmt, Argtypes &&...args) Vertica::ClientMessage inlinestatic
msg_detail Vertica::ClientMessage
msg_errorcode Vertica::ClientMessage
msg_hint Vertica::ClientMessage
msg_main Vertica::ClientMessage
setDetail(const char *fmt, Argtypes &&...args) Vertica::ClientMessage inline
setHint(const char *fmt, Argtypes &&...args) Vertica::ClientMessage inline
truncateLengths(size_t maxLen) Vertica::ClientMessage inline

1.1.97 - Vertica::ColumnTypes Class Reference

Represents (unsized) types of the columns used as input/output of a User Defined Function/Transform Function.

Collaboration diagram for Vertica::ColumnTypes:

Public Member Functions
void addAny ()
Indicates that function can take any number and type of arguments.
ColumnTypes & addArrayType (Oid elementOid)
Adds a column of 1D array type.
ColumnTypes & addArrayType (const ColumnTypes &elementprototype)
Adds a column of complex array type.
ColumnTypes & addBinary ()
Adds a column of type BINARY.
ColumnTypes & addBool ()
Adds a column of type BOOLEAN.
ColumnTypes & addChar ()
Adds a column of type CHAR.
ColumnTypes & addDate ()
Adds a column of type DATE.
ColumnTypes & addFloat ()
Adds a column of type FLOAT.
ColumnTypes & addInt ()
Adds a column of type INTEGER.
ColumnTypes & addInterval ()
Adds a column of type INTERVAL/INTERVAL DAY TO SECOND.
ColumnTypes & addIntervalYM ()
Adds a column of type INTERVAL YEAR TO MONTH.
ColumnTypes & addLongVarbinary ()
Adds a column of type VARBINARY.
ColumnTypes & addLongVarchar ()
Adds a column of type VARBINARY.
ColumnTypes & addNumeric ()
Adds a column of type NUMERIC.
ColumnTypes & addRowType (const ColumnTypes &rowprototype)
Adds a column of complex row type.
ColumnTypes & addTime ()
Adds a column of type TIME.
ColumnTypes & addTimestamp ()
Adds a column of type TIMESTAMP.
ColumnTypes & addTimestampTz ()
Adds a column of type TIMESTAMP WITH TIMEZONE.
ColumnTypes & addTimeTz ()
Adds a column of type TIME WITH TIMEZONE.
ColumnTypes & addType (Oid typeOid, const ColumnTypes &complexFields=ColumnTypes())
ColumnTypes & addUserDefinedType (const char *typeName)
Adds a column of user-defined type.
ColumnTypes & addUuid ()
Adds a column of type UUID.
ColumnTypes & addVarbinary ()
Adds a column of type VARBINARY.
ColumnTypes & addVarchar ()
Adds a column of type VARCHAR.
template
strtype toString () const

Detailed Description

Represents (unsized) types of the columns used as input/output of a User Defined Function/Transform Function.

This class is used only for generating the function or transform function prototype, where the sizes and/or precisions of the data types are not known.

Member Function Documentation

ColumnTypes& Vertica::ColumnTypes::addArrayType(Oid elementOid)

inline Adds a column of 1D array type.

Parameters

  • elementOid: the type of the array element

Returns this

Referenced by addArrayType().

ColumnTypes& Vertica::ColumnTypes::addArrayType(const ColumnTypes & elementprototype)

inline Adds a column of complex array type.

Parameters

  • rowprototype: the fields of the complex array element

Returns this

ColumnTypes& Vertica::ColumnTypes::addBinary()

inline Adds a column of type BINARY.

Returns this

ColumnTypes& Vertica::ColumnTypes::addBool()

inline Adds a column of type BOOLEAN.

Returns this

ColumnTypes& Vertica::ColumnTypes::addChar()

inline Adds a column of type CHAR.

Returns this

ColumnTypes& Vertica::ColumnTypes::addDate()

inline Adds a column of type DATE.

Returns this

ColumnTypes& Vertica::ColumnTypes::addFloat()

inline Adds a column of type FLOAT.

Returns this

ColumnTypes& Vertica::ColumnTypes::addInt()

inline Adds a column of type INTEGER.

Returns this

ColumnTypes& Vertica::ColumnTypes::addInterval()

inline Adds a column of type INTERVAL/INTERVAL DAY TO SECOND.

Returns this

ColumnTypes& Vertica::ColumnTypes::addIntervalYM()

inline Adds a column of type INTERVAL YEAR TO MONTH.

Returns this

ColumnTypes& Vertica::ColumnTypes::addLongVarbinary()

inline Adds a column of type VARBINARY.

Returns this

ColumnTypes& Vertica::ColumnTypes::addLongVarchar()

inline Adds a column of type VARBINARY.

Returns this

ColumnTypes& Vertica::ColumnTypes::addNumeric()

inline Adds a column of type NUMERIC.

Returns this

ColumnTypes& Vertica::ColumnTypes::addRowType(const ColumnTypes & rowprototype)

inline Adds a column of complex row type.

Parameters

  • rowprototype: the fields of the complex row type

Returns this

ColumnTypes& Vertica::ColumnTypes::addTime()

inline Adds a column of type TIME.

Returns this

ColumnTypes& Vertica::ColumnTypes::addTimestamp()

inline Adds a column of type TIMESTAMP.

Returns this

ColumnTypes& Vertica::ColumnTypes::addTimestampTz()

inline Adds a column of type TIMESTAMP WITH TIMEZONE.

Returns this

ColumnTypes& Vertica::ColumnTypes::addTimeTz()

inline Adds a column of type TIME WITH TIMEZONE.

Returns this

ColumnTypes& Vertica::ColumnTypes::addType(Oid typeOid, const ColumnTypes & complexFields = ColumnTypes())

inline Add a generic column to the prototype. Complex type fields are allowed only for complex types.

Returns this

ColumnTypes& Vertica::ColumnTypes::addUserDefinedType(const char * typeName)

inline Adds a column of user-defined type.

Returns this

ColumnTypes& Vertica::ColumnTypes::addUuid()

inline Adds a column of type UUID.

Returns this

ColumnTypes& Vertica::ColumnTypes::addVarbinary()

inline Adds a column of type VARBINARY.

Returns this

ColumnTypes& Vertica::ColumnTypes::addVarchar()

inline Adds a column of type VARCHAR.

Returns this

1.1.98 - Vertica::ColumnTypes Member List

This is the complete list of members for Vertica::ColumnTypes, including all inherited members.

addAny() Vertica::ColumnTypes inline
addArrayType(Oid elementOid) Vertica::ColumnTypes inline
addArrayType(const ColumnTypes &elementprototype) Vertica::ColumnTypes inline
addBinary() Vertica::ColumnTypes inline
addBool() Vertica::ColumnTypes inline
addChar() Vertica::ColumnTypes inline
addDate() Vertica::ColumnTypes inline
addFloat() Vertica::ColumnTypes inline
addInt() Vertica::ColumnTypes inline
addInterval() Vertica::ColumnTypes inline
addIntervalYM() Vertica::ColumnTypes inline
addLongVarbinary() Vertica::ColumnTypes inline
addLongVarchar() Vertica::ColumnTypes inline
addNumeric() Vertica::ColumnTypes inline
addRowType(const ColumnTypes &rowprototype) Vertica::ColumnTypes inline
addTime() Vertica::ColumnTypes inline
addTimestamp() Vertica::ColumnTypes inline
addTimestampTz() Vertica::ColumnTypes inline
addTimeTz() Vertica::ColumnTypes inline
addType(Oid typeOid, const ColumnTypes &complexFields=ColumnTypes()) Vertica::ColumnTypes inline
addUserDefinedType(const char *typeName) Vertica::ColumnTypes inline
addUuid() Vertica::ColumnTypes inline
addVarbinary() Vertica::ColumnTypes inline
addVarchar() Vertica::ColumnTypes inline
toString() const (defined in Vertica::ColumnTypes) Vertica::ColumnTypes inline

1.1.99 - Vertica::ConcurrencyModel Member List

This is the complete list of members for Vertica::ConcurrencyModel, including all inherited members.

ConcurrencyModel() (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel inline
GC_ALL_NODES enum value (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
GC_CONTEXTUAL enum value (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
GC_MULTI_NODES enum value (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
GC_SINGLE_NODE enum value (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
globalConc (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
GlobalConcurrencyType enum name (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
LC_CONTEXTUAL enum value (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
LC_REQUIRED_THREADS enum value (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
LC_SUGGESTED_THREADS enum value (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
localConc (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
LocalConcurrencyType enum name (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
nNodes (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
nThreads (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
requestedNodes (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel
sharedStateSize (defined in Vertica::ConcurrencyModel) Vertica::ConcurrencyModel

1.1.100 - Vertica::ConcurrencyModel Struct Reference

Collaboration diagram for Vertica::ConcurrencyModel:

Public Types
enum GlobalConcurrencyType { GC_CONTEXTUAL, GC_SINGLE_NODE, GC_MULTI_NODES, GC_ALL_NODES }
enum LocalConcurrencyType { LC_CONTEXTUAL, LC_SUGGESTED_THREADS, LC_REQUIRED_THREADS }
Public Attributes
enum Vertica::ConcurrencyModel::GlobalConcurrencyType globalConc
enum Vertica::ConcurrencyModel::LocalConcurrencyType localConc
int nNodes
int nThreads
RequestedNodes requestedNodes
int sharedStateSize

Detailed Description

ConcurrencyModel structure Request how many nodes, how many threads to be used for the UDT or specifically which nodes

1.1.101 - Vertica::CounterController Class Reference

Class to interact with counters.

Collaboration diagram for Vertica::CounterController:

Public Member Functions
virtual bool addToCounter (int counterIndex, vint value)=0
virtual bool getCounterValue (int counterIndex, vint &value)=0
virtual RequestedCounters * getCurrentCounters ()=0
virtual bool recordTimestamp (int counterIndex)=0
virtual bool resetTimer (int counterIndex)=0
virtual bool setCounterValue (int counterIndex, vint value)=0
virtual bool startTimer (int counterIndex)=0
virtual bool stopTimer (int counterIndex)=0

Detailed Description

Class to interact with counters.

Member Function Documentation

virtual bool Vertica::CounterController::addToCounter(int counterIndex, vint value)

pure virtual Add a value to counter

virtual bool Vertica::CounterController::getCounterValue(int counterIndex, vint & value)

pure virtual Get the current value of the counter

virtual bool Vertica::CounterController::recordTimestamp(int counterIndex)

pure virtual Save the current time to the counter

virtual bool Vertica::CounterController::resetTimer(int counterIndex)

pure virtual Clear a time counter

virtual bool Vertica::CounterController::setCounterValue(int counterIndex, vint value)

pure virtual Set counter to a value

virtual bool Vertica::CounterController::startTimer(int counterIndex)

pure virtual Start a time counter

virtual bool Vertica::CounterController::stopTimer(int counterIndex)

pure virtual Stop a time counter

1.1.102 - Vertica::CounterController Member List

This is the complete list of members for Vertica::CounterController, including all inherited members.

addToCounter(int counterIndex, vint value)=0 Vertica::CounterController pure virtual
getCounterValue(int counterIndex, vint &value)=0 Vertica::CounterController pure virtual
getCurrentCounters()=0 (defined in Vertica::CounterController) Vertica::CounterController pure virtual
recordTimestamp(int counterIndex)=0 Vertica::CounterController pure virtual
resetTimer(int counterIndex)=0 Vertica::CounterController pure virtual
setCounterValue(int counterIndex, vint value)=0 Vertica::CounterController pure virtual
startTimer(int counterIndex)=0 Vertica::CounterController pure virtual
stopTimer(int counterIndex)=0 Vertica::CounterController pure virtual
~CounterController() (defined in Vertica::CounterController) Vertica::CounterController inlinevirtual

1.1.103 - Vertica::DataBuffer Member List

This is the complete list of members for Vertica::DataBuffer, including all inherited members.

buf Vertica::DataBuffer
offset Vertica::DataBuffer
size Vertica::DataBuffer

1.1.104 - Vertica::DataBuffer Struct Reference

Collaboration diagram for Vertica::DataBuffer:

Public Attributes
char * buf
Pointer to the start of the buffer.
size_t offset
Number of bytes that have been processed by the UDL.
size_t size
Size of the buffer in bytes.

Detailed Description

A contiguous in-memory buffer of char *

1.1.105 - Vertica::DefaultSourceIterator Class Reference

Inheritance diagram for Vertica::DefaultSourceIterator:

Collaboration diagram for Vertica::DefaultSourceIterator:

Public Member Functions
DefaultSourceIterator (std::vector sources)
void cancelUDX (ServerInterface &srvInterface)
UnsizedUDSource * createNextSource (ServerInterface &srvInterface) override
Create the next UDSource to process.
virtual void destroy (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
Tear down this SourceIterator.
size_t getNumberOfSources () override
indicate an upper bound for the number of sources this factory will produce.
size_t getSizeOfSource (size_t sourceNum) override
bool isCanceled () const
virtual void setup (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
Set up this SourceIterator.
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

UnsizedUDSource* Vertica::DefaultSourceIterator::createNextSource(ServerInterface & srvInterface)

inlinevirtual

Create the next UDSource to process.

Should return NULL if no further sources are available for processing.

Note that the previous Source may still be open and in use on a different thread when this function is called.

Returns a new Source instance corresponding to a new input stream

Implements Vertica::SourceIterator.

virtual void Vertica::SourceIterator::destroy(ServerInterface & srvInterface, NodeSpecifyingPlanContext & planCtxt)

inlinevirtualinherited

Tear down this SourceIterator.

Should perform clean-up that should not take place in the destructor due to the exception-handling semantics of destructors.

size_t Vertica::DefaultSourceIterator::getNumberOfSources()

inlinevirtual

indicate an upper bound for the number of sources this factory will produce.

If this method returns N, then createNextSource() will be called at most N times ("at most" because it will stop being called when it returns NULL).

Returns the maximum number of Sources that this factory will produce

Implements Vertica::SourceIterator.

size_t Vertica::DefaultSourceIterator::getSizeOfSource(size_t sourceNum)

inlinevirtual

Returns the raw-data size of the sourceNum'th source that will be produced by createNextSource(). Should return vint_null if the size is unknown.

This value is used as a hint, and is used by the "load_streams" table to display load progress. If incorrect or not set, "load_streams" may contain incorrect or unhelpful information.

Reimplemented from Vertica::SourceIterator.

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual void Vertica::SourceIterator::setup(ServerInterface & srvInterface, NodeSpecifyingPlanContext & planCtxt)

inlinevirtualinherited

Set up this SourceIterator.

Should perform setup that should not take place in the constructor due to the exception-handling semantics of constructors

1.1.106 - Vertica::DefaultSourceIterator Member List

This is the complete list of members for Vertica::DefaultSourceIterator, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
createNextSource(ServerInterface &srvInterface) override Vertica::DefaultSourceIterator inlinevirtual
DefaultSourceIterator(std::vector sources) (defined in Vertica::DefaultSourceIterator) Vertica::DefaultSourceIterator inline
destroy(ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) Vertica::SourceIterator inlinevirtual
getNumberOfSources() override Vertica::DefaultSourceIterator inlinevirtual
getSizeOfSource(size_t sourceNum) override Vertica::DefaultSourceIterator inlinevirtual
isCanceled() const Vertica::UDXObject inline
setup(ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) Vertica::SourceIterator inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
~SourceIterator() (defined in Vertica::SourceIterator) Vertica::SourceIterator inlinevirtual
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.107 - Vertica::defserializer< false, false, Archive, T > Member List

This is the complete list of members for Vertica::defserializer, including all inherited members.

serialize(Archive &ar, T &val, const uint serializer_version) (defined in Vertica::defserializer) Vertica::defserializer inlinestatic

1.1.108 - Vertica::defserializer< false, false, Archive, T > Struct Template Reference

Collaboration diagram for Vertica::defserializer< false, false, Archive, T >:

Static Public Member Functions
static void serialize (Archive &ar, T &val, const uint serializer_version)

1.1.109 - Vertica::defserializer< false, true, Archive, T > Member List

This is the complete list of members for Vertica::defserializer, including all inherited members.

serialize(Archive &ar, T &val, const uint serializer_version) (defined in Vertica::defserializer) Vertica::defserializer inlinestatic

1.1.110 - Vertica::defserializer< false, true, Archive, T > Struct Template Reference

Collaboration diagram for Vertica::defserializer< false, true, Archive, T >:

Static Public Member Functions
static void serialize (Archive &ar, T &val, const uint serializer_version)

1.1.111 - Vertica::defserializer< IsEnum, IsPointer, Archive, T > Struct Template Reference

Collaboration diagram for Vertica::defserializer< IsEnum, IsPointer, Archive, T >:

1.1.112 - Vertica::defserializer< true, false, Archive, T > Member List

This is the complete list of members for Vertica::defserializer, including all inherited members.

serialize(Archive &ar, T &val, const uint serializer_version) (defined in Vertica::defserializer) Vertica::defserializer inlinestatic

1.1.113 - Vertica::defserializer< true, false, Archive, T > Struct Template Reference

Collaboration diagram for Vertica::defserializer< true, false, Archive, T >:

Static Public Member Functions
static void serialize (Archive &ar, T &val, const uint serializer_version)

1.1.114 - Vertica::ExecutorParamWriter Class Reference

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.

Inheritance diagram for Vertica::ExecutorParamWriter:

Collaboration diagram for Vertica::ExecutorParamWriter:

Public Member Functions
ExecutorParamWriter (VTAllocator *allocator=NULL)
void addParameter (std::string paramName, const char *arg, const VerticaType &dt)
void clearParameter (std::string fieldName)
bool containsParameter (std::string paramName) const
Function to see if the ParamReader has a value for the parameter.
void copy (const VerticaBlock &other)
void copy (const ParamReader &other)
Copy the other ParamReader. Discard any existing parameters TODO: create an alternate version that only copies if this ParamReader is empty, is a no-op if they are non-empty and the same, and error if they are non-empty and different.
const vbool * getBoolPtr (std::string paramName) const
Get a pointer to a BOOLEAN value from the input row.
const vbool & getBoolRef (std::string paramName) const
Get a reference to a BOOLEAN value from the input row.
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
const DateADT * getDatePtr (std::string paramName) const
Get a pointer to a DATE value from the input row.
const DateADT & getDateRef (std::string paramName) const
Get a reference to a DATE value from the input row.
const vfloat * getFloatPtr (std::string paramName) const
Get a pointer to a FLOAT value from the input row.
const vfloat & getFloatRef (std::string paramName) const
Get a reference to a FLOAT value from the input row.
size_t getIndex (std::string paramName) const
const Interval * getIntervalPtr (std::string paramName) const
Get a pointer to an INTERVAL value from the input row.
const Interval & getIntervalRef (std::string paramName) const
Get a reference to an INTERVAL value from the input row.
const IntervalYM * getIntervalYMPtr (std::string paramName) const
Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.
const IntervalYM & getIntervalYMRef (std::string paramName) const
Get a reference to an INTERVAL YEAR TO MONTH value from the input row.
const vint * getIntPtr (std::string paramName) const
Get a pointer to an INTEGER value from the input row.
const vint & getIntRef (std::string paramName) const
Get a reference to an INTEGER value from the input row.
VString & getLongStringRef (std::string fieldName)
Allocates a new VString object to use as output. Sets it to be a 32mb LONG type by default.
size_t getNumCols () const
const VNumeric * getNumericPtr (std::string paramName) const
Get a pointer to a VNumeric value from the input row.
const VNumeric & getNumericRef (std::string paramName) const
Get a reference to a VNumeric value from the input row.
VNumeric & getNumericRef (std::string fieldName)
Allocate a new VNumeric object to use as output.
int getNumRows () const
std::vector getParamNames () const
Return the names of all parameters stored in this ParamReader.
template
T * getPointer (std::string fieldName) const
const VString * getStringPtr (std::string paramName) const
Get a pointer to a VString value from the input row.
const VString & getStringRef (std::string paramName) const
Get a reference to an VString value from the input row.
VString & getStringRef (std::string fieldName)
Allocates a new VString object to use as output.
const TimeADT * getTimePtr (std::string paramName) const
Get a pointer to a TIME value from the input row.
const TimeADT & getTimeRef (std::string paramName) const
Get a reference to a TIME value from the input row.
const Timestamp * getTimestampPtr (std::string paramName) const
Get a pointer to a TIMESTAMP value from the input row.
const Timestamp & getTimestampRef (std::string paramName) const
Get a reference to a TIMESTAMP value from the input row.
const TimestampTz * getTimestampTzPtr (std::string paramName) const
Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimestampTz & getTimestampTzRef (std::string paramName) const
Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimeTzADT * getTimeTzPtr (std::string paramName) const
Get a pointer to a TIME WITH TIMEZONE value from the input row.
const TimeTzADT & getTimeTzRef (std::string paramName) const
Get a reference to a TIME WITH TIMEZONE value from the input row.
VerticaType getType (std::string paramName) const
Return the type of the given parameter.
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
VUuid * getUuidPtr (std::string paramName) const
Get a pointer to a VUuid value from the input row.
const VUuid & getUuidRef (std::string paramName) const
VUuid & getUuidRef (std::string fieldName)
Allocate a new VUuid object to use as output.
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool isEmpty () const
Returns true if there are no parameters.
bool remaining () const
void setAllocator (VTAllocator *allocator)
Sets the allocator to be used to allocate variable size param values such as VString. Given allocator live longer than this ParamWriter.
void setBool (std::string fieldName, vbool r)
Adds a BOOLEAN value to the output row.
void setDataArea (size_t idx, void *dataarea)
void setDate (std::string fieldName, DateADT r)
Adds a BOOLEAN value to the output row.
void setFloat (std::string fieldName, vfloat r)
Adds a FLOAT value to the output row.
void setInt (std::string fieldName, vint r)
Adds an INTEGER value to the output row.
void setInterval (std::string fieldName, Interval r, int32 precision, int32 range)
Adds an INTERVAL value to the output row.
void setIntervalYM (std::string fieldName, IntervalYM r, int32 range)
Adds an INTERVAL YEAR TO MONTH value to the output row.
template
void setPointer (std::string fieldName, T *ptr)
void setTime (std::string fieldName, TimeADT r, int32 precision)
Adds a TIME value to the output row.
void setTimestamp (std::string fieldName, Timestamp r, int32 precision)
Adds a TIMESTAMP value to the output row.
void setTimestampTz (std::string fieldName, TimestampTz r, int32 precision)
Adds a TIMESTAMP WITH TIMEZONE value to the output row.
void setTimeTz (std::string fieldName, TimeTzADT r, int32 precision)
Adds a TIME WITH TIMEZONE value to the output row.
Public Attributes
std::map paramNameToIndex
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers

Detailed Description

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.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

void Vertica::ParamReader::addParameter(std::string paramName, const char * arg, const VerticaType & dt)

inline inherited Add a parameter to the block and stores it name and corresponding index in the paramNameToIndex map

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

const vbool* Vertica::ParamReader::getBoolPtr(std::string paramName) const

inline inherited Get a pointer to a BOOLEAN value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a BOOLEAN.

Referenced by Vertica::ParamReader::getBoolRef().

const vbool& Vertica::ParamReader::getBoolRef(std::string paramName) const

inline inherited Get a reference to a BOOLEAN value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an BOOLEAN.

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

const DateADT* Vertica::ParamReader::getDatePtr(std::string paramName) const

inline inherited Get a pointer to a DATE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a DATE.

Referenced by Vertica::ParamReader::getDateRef().

const DateADT& Vertica::ParamReader::getDateRef(std::string paramName) const

inline inherited Get a reference to a DATE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an DATE.

const vfloat* Vertica::ParamReader::getFloatPtr(std::string paramName) const

inline inherited Get a pointer to a FLOAT value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a FLOAT.

Referenced by Vertica::ParamReader::getFloatRef().

const vfloat& Vertica::ParamReader::getFloatRef(std::string paramName) const

inline inherited Get a reference to a FLOAT value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A reference to the parameter value, cast as an FLOAT.

const Interval* Vertica::ParamReader::getIntervalPtr(std::string paramName) const

inline inherited Get a pointer to an INTERVAL value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as an INTERVAL.

Referenced by Vertica::ParamReader::getIntervalRef().

const Interval& Vertica::ParamReader::getIntervalRef(std::string paramName) const

inline inherited Get a reference to an INTERVAL value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an INTERVAL.

const IntervalYM* Vertica::ParamReader::getIntervalYMPtr(std::string paramName) const

inline inherited Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A point to the retrieved value cast as a INTERVAL YEAR TO MONTH.

Referenced by Vertica::ParamReader::getIntervalYMRef().

const IntervalYM& Vertica::ParamReader::getIntervalYMRef(std::string paramName) const

inline inherited Get a reference to an INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an INTERVAL YEAR TO MONTH.

const vint* Vertica::ParamReader::getIntPtr(std::string paramName) const

inline inherited Get a pointer to an INTEGER value from the input row.

Returns a pointer to the idx'th argument, cast appropriately.

Parameters

  • paramName: The name of the parameter to retrieve

Example:

vint *a = arg_reader->getIntPtr("max");

Referenced by Vertica::ParamReader::getIntRef().

const vint& Vertica::ParamReader::getIntRef(std::string paramName) const

inline inherited Get a reference to an INTEGER value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an INTEGER.

Example:

vint a = arg_reader->getIntRef("max");

VString& Vertica::ParamWriter::getLongStringRef(std::string fieldName)

inline inherited Allocates a new VString object to use as output. Sets it to be a 32mb LONG type by default.

Returns A new VString object to hold output. This object automatically added to the output row.

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

const VNumeric* Vertica::ParamReader::getNumericPtr(std::string paramName) const

inline inherited Get a pointer to a VNumeric value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a Numeric.

Referenced by Vertica::ParamReader::getNumericRef().

const VNumeric& Vertica::ParamReader::getNumericRef(std::string paramName) const

inline inherited Get a reference to a VNumeric value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an VNumeric.

VNumeric& Vertica::ParamWriter::getNumericRef(std::string fieldName)

inline inherited Allocate a new VNumeric object to use as output.

Returns A new VNumeric object to hold output. This object automatically added to the output row.

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

const VString* Vertica::ParamReader::getStringPtr(std::string paramName) const

inline inherited Get a pointer to a VString value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a VString.

Referenced by Vertica::ParamReader::getStringRef().

const VString& Vertica::ParamReader::getStringRef(std::string paramName) const

inline inherited Get a reference to an VString value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an VString.

VString& Vertica::ParamWriter::getStringRef(std::string fieldName)

inline inherited Allocates a new VString object to use as output.

Returns A new VString object to hold output. This object automatically added to the output row.

const TimeADT* Vertica::ParamReader::getTimePtr(std::string paramName) const

inline inherited Get a pointer to a TIME value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIME.

Referenced by Vertica::ParamReader::getTimeRef().

const TimeADT& Vertica::ParamReader::getTimeRef(std::string paramName) const

inline inherited Get a reference to a TIME value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIME.

const Timestamp* Vertica::ParamReader::getTimestampPtr(std::string paramName) const

inline inherited Get a pointer to a TIMESTAMP value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIMESTAMP.

Referenced by Vertica::ParamReader::getTimestampRef().

const Timestamp& Vertica::ParamReader::getTimestampRef(std::string paramName) const

inline inherited Get a reference to a TIMESTAMP value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIMESTAMP.

const TimestampTz* Vertica::ParamReader::getTimestampTzPtr(std::string paramName) const

inline inherited Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIMESTAMP WITH TIMEZONE .

Referenced by Vertica::ParamReader::getTimestampTzRef().

const TimestampTz& Vertica::ParamReader::getTimestampTzRef(std::string paramName) const

inline inherited Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIMESTAMP WITH TIMEZONE.

const TimeTzADT* Vertica::ParamReader::getTimeTzPtr(std::string paramName) const

inline inherited Get a pointer to a TIME WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIME WITH TIMEZONE.

Referenced by Vertica::ParamReader::getTimeTzRef().

const TimeTzADT& Vertica::ParamReader::getTimeTzRef(std::string paramName) const

inline inherited Get a reference to a TIME WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIME WITH TIMEZONE.

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

VUuid* Vertica::ParamReader::getUuidPtr(std::string paramName) const

inline inherited Get a pointer to a VUuid value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a VUuid.

VUuid& Vertica::ParamWriter::getUuidRef(std::string fieldName)

inline inherited Allocate a new VUuid object to use as output.

Returns A new VUuid object to hold output. This object automatically added to the output row.

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

void Vertica::ParamWriter::setAllocator(VTAllocator * allocator)

inline inherited Sets the allocator to be used to allocate variable size param values such as VString. Given allocator live longer than this ParamWriter.

Parameters

  • allocator: Used to allocate param values.
void Vertica::ParamWriter::setBool(std::string fieldName, vbool r)

inline inherited Adds a BOOLEAN value to the output row.

Parameters

  • r: The BOOLEAN value to insert into the output row.
void Vertica::ParamWriter::setDate(std::string fieldName, DateADT r)

inline inherited Adds a BOOLEAN value to the output row.

Parameters

  • r: The BOOLEAN value to insert into the output row.
void Vertica::ParamWriter::setFloat(std::string fieldName, vfloat r)

inline inherited Adds a FLOAT value to the output row.

Parameters

  • r: The FLOAT value to insert into the output row.
void Vertica::ParamWriter::setInt(std::string fieldName, vint r)

inline inherited Adds an INTEGER value to the output row.

Setter methods

Parameters

  • r: The INTEGER value to insert into the output row.
void Vertica::ParamWriter::setInterval(std::string fieldName, Interval r, int32 precision, int32 range)

inline inherited Adds an INTERVAL value to the output row.

Parameters

  • r: The INTERVAL value to insert into the output row.
void Vertica::ParamWriter::setIntervalYM(std::string fieldName, IntervalYM r, int32 range)

inline inherited Adds an INTERVAL YEAR TO MONTH value to the output row.

Parameters

  • r: The INTERVAL YEAR TO MONTH value to insert into the output row.
void Vertica::ParamWriter::setTime(std::string fieldName, TimeADT r, int32 precision)

inline inherited Adds a TIME value to the output row.

Parameters

  • r: The TIME value to insert into the output row.
void Vertica::ParamWriter::setTimestamp(std::string fieldName, Timestamp r, int32 precision)

inline inherited Adds a TIMESTAMP value to the output row.

Parameters

  • r: The TIMESTAMP value to insert into the output row.
void Vertica::ParamWriter::setTimestampTz(std::string fieldName, TimestampTz r, int32 precision)

inline inherited Adds a TIMESTAMP WITH TIMEZONE value to the output row.

Parameters

  • r: The TIMESTAMP WITH TIMEZONE value to insert into the output row.
void Vertica::ParamWriter::setTimeTz(std::string fieldName, TimeTzADT r, int32 precision)

inline inherited Adds a TIME WITH TIMEZONE value to the output row.

Parameters

  • r: The TIME WITH TIMEZONE value to insert into the output row.

Member Data Documentation

std::map Vertica::ParamReader::paramNameToIndex

inherited Bookkeepinp to make a parameter and its position in the block

Referenced by

1.1.115 - Vertica::ExecutorParamWriter Member List

This is the complete list of members for Vertica::ExecutorParamWriter, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
addParameter(std::string paramName, const char *arg, const VerticaType &dt) Vertica::ParamReader inline
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
clearParameter(std::string fieldName) (defined in Vertica::ParamWriter) Vertica::ParamWriter inline
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
containsParameter(std::string paramName) const Vertica::ParamReader inline
copy(const ParamReader &other) Vertica::ParamReader inline
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
ExecutorParamWriter(VTAllocator *allocator=NULL) (defined in Vertica::ExecutorParamWriter) Vertica::ExecutorParamWriter inline
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getBoolPtr(std::string paramName) const Vertica::ParamReader inline
getBoolRef(std::string paramName) const Vertica::ParamReader inline
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDatePtr(std::string paramName) const Vertica::ParamReader inline
getDateRef(std::string paramName) const Vertica::ParamReader inline
getFloatPtr(std::string paramName) const Vertica::ParamReader inline
getFloatRef(std::string paramName) const Vertica::ParamReader inline
getIndex(std::string paramName) const (defined in Vertica::ParamReader) Vertica::ParamReader inline
getIntervalPtr(std::string paramName) const Vertica::ParamReader inline
getIntervalRef(std::string paramName) const Vertica::ParamReader inline
getIntervalYMPtr(std::string paramName) const Vertica::ParamReader inline
getIntervalYMRef(std::string paramName) const Vertica::ParamReader inline
getIntPtr(std::string paramName) const Vertica::ParamReader inline
getIntRef(std::string paramName) const Vertica::ParamReader inline
getLongStringRef(std::string fieldName) Vertica::ParamWriter inline
getNumCols() const Vertica::VerticaBlock inline
getNumericPtr(std::string paramName) const Vertica::ParamReader inline
getNumericRef(std::string fieldName) Vertica::ParamWriter inline
Vertica::ParamReader::getNumericRef(std::string paramName) const Vertica::ParamReader inline
getNumRows() const Vertica::VerticaBlock inline
getParamNames() const Vertica::ParamReader inline
getPointer(std::string fieldName) const (defined in Vertica::ExecutorParamWriter) Vertica::ExecutorParamWriter inline
getStringPtr(std::string paramName) const Vertica::ParamReader inline
getStringRef(std::string fieldName) Vertica::ParamWriter inline
Vertica::ParamReader::getStringRef(std::string paramName) const Vertica::ParamReader inline
getTimePtr(std::string paramName) const Vertica::ParamReader inline
getTimeRef(std::string paramName) const Vertica::ParamReader inline
getTimestampPtr(std::string paramName) const Vertica::ParamReader inline
getTimestampRef(std::string paramName) const Vertica::ParamReader inline
getTimestampTzPtr(std::string paramName) const Vertica::ParamReader inline
getTimestampTzRef(std::string paramName) const Vertica::ParamReader inline
getTimeTzPtr(std::string paramName) const Vertica::ParamReader inline
getTimeTzRef(std::string paramName) const Vertica::ParamReader inline
getType(std::string paramName) const Vertica::ParamReader inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidPtr(std::string paramName) const Vertica::ParamReader inline
getUuidRef(std::string fieldName) Vertica::ParamWriter inline
getUuidRef(std::string paramName) const (defined in Vertica::ParamReader) Vertica::ParamReader inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
isEmpty() const Vertica::ParamReader inline
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
paramNameToIndex Vertica::ParamReader
ParamReader(size_t nparams) (defined in Vertica::ParamReader) Vertica::ParamReader inline
ParamReader() (defined in Vertica::ParamReader) Vertica::ParamReader inline
ParamWriter(VTAllocator *allocator=NULL) (defined in Vertica::ParamWriter) Vertica::ParamWriter inline
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setAllocator(VTAllocator *allocator) Vertica::ParamWriter inline
setBool(std::string fieldName, vbool r) Vertica::ParamWriter inline
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setDate(std::string fieldName, DateADT r) Vertica::ParamWriter inline
setFloat(std::string fieldName, vfloat r) Vertica::ParamWriter inline
setInt(std::string fieldName, vint r) Vertica::ParamWriter inline
setInterval(std::string fieldName, Interval r, int32 precision, int32 range) Vertica::ParamWriter inline
setIntervalYM(std::string fieldName, IntervalYM r, int32 range) Vertica::ParamWriter inline
setPointer(std::string fieldName, T *ptr) (defined in Vertica::ExecutorParamWriter) Vertica::ExecutorParamWriter inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setTime(std::string fieldName, TimeADT r, int32 precision) Vertica::ParamWriter inline
setTimestamp(std::string fieldName, Timestamp r, int32 precision) Vertica::ParamWriter inline
setTimestampTz(std::string fieldName, TimestampTz r, int32 precision) Vertica::ParamWriter inline
setTimeTz(std::string fieldName, TimeTzADT r, int32 precision) Vertica::ParamWriter inline
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.116 - Vertica::ExecutorPlanContext Class Reference

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.

Inheritance diagram for Vertica::ExecutorPlanContext:

Collaboration diagram for Vertica::ExecutorPlanContext:

Public Member Functions
ExecutorPlanContext (ExecutorParamWriter &writer, std::vector clusterNodes, std::vector targetNodes, bool canApportionSource, size_t maxPossibleThreads, ssize_t actualThreads=-1)
bool canApportionSource () const
const std::vector & getClusterNodes ()
ssize_t getLoadConcurrency () const
size_t getMaxAllowedThreads () const
virtual ParamReader & getReader ()
SourceIterator * getSources () const
const std::vector & getTargetNodes () const
virtual ExecutorParamWriter & getWriter () override
void setSources (SourceIterator *sources)
void setTargetNodes (const std::vector &nodes)

Detailed Description

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.

Member Function Documentation

bool Vertica::NodeSpecifyingPlanContext::canApportionSource() const

inline inherited return whether the UDL source can be apportioned among multiple nodes or threads

const std::vector& Vertica::PlanContext::getClusterNodes()

inline inherited Get a list of all of the nodes in the current cluster, by node name

Referenced by Vertica::NodeSpecifyingPlanContext::setTargetNodes().

virtual ParamReader& Vertica::PlanContext::getReader()

inlinevirtualinherited

Get a read-only instance of the current context

const std::vector& Vertica::NodeSpecifyingPlanContext::getTargetNodes() const

inline inherited Return the set of nodes that this query is currently set to run on

virtual ExecutorParamWriter& Vertica::ExecutorPlanContext::getWriter()

inlinevirtual

Get the current context for writing

Reimplemented from Vertica::PlanContext.

void Vertica::NodeSpecifyingPlanContext::setTargetNodes(const std::vector & nodes)

inline inherited Change the set of nodes that the query is intended to run on. Throws UnknownNodeException if any of the specified node names is not actually the name of any node in the cluster.

1.1.117 - Vertica::ExecutorPlanContext Member List

This is the complete list of members for Vertica::ExecutorPlanContext, including all inherited members.

canApportionSource() const Vertica::NodeSpecifyingPlanContext inline
ExecutorPlanContext(ExecutorParamWriter &writer, std::vector clusterNodes, std::vector targetNodes, bool canApportionSource, size_t maxPossibleThreads, ssize_t actualThreads=-1) (defined in Vertica::ExecutorPlanContext) Vertica::ExecutorPlanContext inline
getClusterNodes() Vertica::PlanContext inline
getLoadConcurrency() const (defined in Vertica::ExecutorPlanContext) Vertica::ExecutorPlanContext inline
getMaxAllowedThreads() const (defined in Vertica::ExecutorPlanContext) Vertica::ExecutorPlanContext inline
getReader() Vertica::PlanContext inlinevirtual
getSources() const (defined in Vertica::ExecutorPlanContext) Vertica::ExecutorPlanContext inline
getTargetNodes() const Vertica::NodeSpecifyingPlanContext inline
getWriter() override Vertica::ExecutorPlanContext inlinevirtual
NodeSpecifyingPlanContext(ParamWriter &writer, std::vector clusterNodes, bool canApportion) (defined in Vertica::NodeSpecifyingPlanContext) Vertica::NodeSpecifyingPlanContext inline
NodeSpecifyingPlanContext(ParamWriter &writer, std::vector clusterNodes, std::vector targetNodes, bool canApportion) (defined in Vertica::NodeSpecifyingPlanContext) Vertica::NodeSpecifyingPlanContext inline
PlanContext(ParamWriter &writer) (defined in Vertica::PlanContext) Vertica::PlanContext inline
PlanContext(ParamWriter &writer, std::vector clusterNodes) (defined in Vertica::PlanContext) Vertica::PlanContext inline
setSources(SourceIterator *sources) (defined in Vertica::ExecutorPlanContext) Vertica::ExecutorPlanContext inline
setTargetNodes(const std::vector &nodes) Vertica::NodeSpecifyingPlanContext inline

1.1.118 - Vertica::Field Member List

This is the complete list of members for Vertica::Field, including all inherited members.

_name (defined in Vertica::Field) Vertica::Field
_type (defined in Vertica::Field) Vertica::Field
Field(const VerticaType &t, const std::string name) (defined in Vertica::Field) Vertica::Field inline
Field(const VerticaType &t, const std::string name, const Properties &props) (defined in Vertica::Field) Vertica::Field inline
getName() const (defined in Vertica::Field) Vertica::Field inline
getType() const (defined in Vertica::Field) Vertica::Field inline
operator!=(const Field &rhs) const (defined in Vertica::Field) Vertica::Field inline
operator=(const Field &other) (defined in Vertica::Field) Vertica::Field inline
operator==(const Field &rhs) const (defined in Vertica::Field) Vertica::Field inline
Properties typedef (defined in Vertica::Field) Vertica::Field
props (defined in Vertica::Field) Vertica::Field

1.1.119 - Vertica::Field Struct Reference

Collaboration diagram for Vertica::Field:

Public Types
typedef Fields::Properties Properties
Public Member Functions
Field (const VerticaType &t, const std::string name)
Field (const VerticaType &t, const std::string name, const Properties &props)
const std::string & getName () const
const VerticaType & getType () const
bool operator!= (const Field &rhs) const
Field & operator= (const Field &other)
bool operator== (const Field &rhs) const
Public Attributes
std::string _name
VerticaType _type
Properties props

Detailed Description

Represents a field, as in a column or a complex type attribute

1.1.120 - Vertica::Fields Class Reference

Inheritance diagram for Vertica::Fields:

Collaboration diagram for Vertica::Fields:

Classes
struct Properties
Public Member Functions
Fields & addArrayType (const Field &element, const std::string &fieldName="", int maxElems=-1, const Properties &props=Properties())
Fields & addBinary (int32 len, const std::string &fieldName="")
Adds a column of type BINARY.
Fields & addBinary (int32 len, const std::string &fieldName, const Properties &props)
Fields & addBool (const std::string &fieldName="")
Adds a column of type BOOLEAN.
Fields & addBool (const std::string &fieldName, const Properties &props)
Fields & addChar (int32 len, const std::string &fieldName="")
Adds a column of type CHAR.
Fields & addChar (int32 len, const std::string &fieldName, const Properties &props)
Fields & addDate (const std::string &fieldName="")
Adds a column of type DATE.
Fields & addDate (const std::string &fieldName, const Properties &props)
Fields & addFloat (const std::string &fieldName="")
Adds a column of type FLOAT.
Fields & addFloat (const std::string &fieldName, const Properties &props)
Fields & addInt (const std::string &fieldName="")
Adds a column of type INTEGER.
Fields & addInt (const std::string &fieldName, const Properties &props)
Fields & addInterval (int32 precision, int32 range, const std::string &fieldName="")
Adds a column of type INTERVAL/INTERVAL DAY TO SECOND.
Fields & addInterval (int32 precision, int32 range, const std::string &fieldName, const Properties &props)
Fields & addIntervalYM (int32 range, const std::string &fieldName="")
Adds a column of type INTERVAL YEAR TO MONTH.
Fields & addIntervalYM (int32 range, const std::string &fieldName, const Properties &props)
Fields & addLongVarbinary (int32 len, const std::string &fieldName="")
Adds a column of type LONG VARBINARY.
Fields & addLongVarbinary (int32 len, const std::string &fieldName, const Properties &props)
Fields & addLongVarchar (int32 len, const std::string &fieldName="")
Adds a column of type LONG VARCHAR.
Fields & addLongVarchar (int32 len, const std::string &fieldName, const Properties &props)
Fields & addNumeric (int32 precision, int32 scale, const std::string &fieldName="")
Adds a column of type NUMERIC.
Fields & addNumeric (int32 precision, int32 scale, const std::string &fieldName, const Properties &props)
Fields & addRowType (const Fields &rowfields, const std::string &fieldName="")
Adds a column of complex row type, with the provided fields.
Fields & addRowType (const Fields &rowfields, const std::string &fieldName, const Properties &props)
Fields & addTime (int32 precision, const std::string &fieldName="")
Adds a column of type TIME.
Fields & addTime (int32 precision, const std::string &fieldName, const Properties &props)
Fields & addTimestamp (int32 precision, const std::string &fieldName="")
Adds a column of type TIMESTAMP.
Fields & addTimestamp (int32 precision, const std::string &fieldName, const Properties &props)
Fields & addTimestampTz (int32 precision, const std::string &fieldName="")
Adds a column of type TIMESTAMP WITH TIMEZONE.
Fields & addTimestampTz (int32 precision, const std::string &fieldName, const Properties &props)
Fields & addTimeTz (int32 precision, const std::string &fieldName="")
Adds a column of type TIME WITH TIMEZONE.
Fields & addTimeTz (int32 precision, const std::string &fieldName, const Properties &props)
Fields & addUserDefinedType (const char *typeName, int32 len, const std::string &fieldName="")
Adds a column of a user-defined type.
Fields & addUserDefinedType (const char *typeName, int32 len, const std::string &fieldName, const Properties &props)
Fields & addUuid (const std::string &fieldName="")
Adds a column of type UUID.
Fields & addUuid (const std::string &fieldName, const Properties &props)
Fields & addVarbinary (int32 len, const std::string &fieldName="")
Adds a column of type VARBINARY.
Fields & addVarbinary (int32 len, const std::string &fieldName, const Properties &props)
Fields & addVarchar (int32 len, const std::string &fieldName="")
Adds a column of type VARCHAR.
Fields & addVarchar (int32 len, const std::string &fieldName, const Properties &props)
Protected Member Functions
void validateStringLengthOrThrow (int32 len, const char *typeStr, int32 maxLength)
void validateUDTypeLengthOrThrow (Oid udTypeOid, const char *typeName, int32 len)

Member Function Documentation

Fields & Vertica::Fields::addBinary(int32 len, const std::string & fieldName = "")

Adds a column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addBool(const std::string & fieldName = "")

Adds a column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addChar(int32 len, const std::string & fieldName = "")

Adds a column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addDate(const std::string & fieldName = "")

Adds a column of type DATE.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addFloat(const std::string & fieldName = "")

Adds a column of type FLOAT.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addInt(const std::string & fieldName = "")

Adds a column of type INTEGER.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addInterval(int32 precision, int32 range, const std::string & fieldName = "")

Adds a column of type INTERVAL/INTERVAL DAY TO SECOND.

Parameters

  • precision: The precision for the interval.
  • range: The range for the interval.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addIntervalYM(int32 range, const std::string & fieldName = "")

Adds a column of type INTERVAL YEAR TO MONTH.

Parameters

  • range: The range for the interval.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addLongVarbinary(int32 len, const std::string & fieldName = "")

Adds a column of type LONG VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addLongVarchar(int32 len, const std::string & fieldName = "")

Adds a column of type LONG VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addNumeric(int32 precision, int32 scale, const std::string & fieldName = "")

Adds a column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addRowType(const Fields & rowfields, const std::string & fieldName = "")

Adds a column of complex row type, with the provided fields.

Parameters

  • rowfields: the fields of the complex row type
  • fieldName: the name of the added field

Referenced by Vertica::SizedColumnTypes::addRowType().

Fields & Vertica::Fields::addTime(int32 precision, const std::string & fieldName = "")

Adds a column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addTimestamp(int32 precision, const std::string & fieldName = "")

Adds a column of type TIMESTAMP.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addTimestampTz(int32 precision, const std::string & fieldName = "")

Adds a column of type TIMESTAMP WITH TIMEZONE.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addTimeTz(int32 precision, const std::string & fieldName = "")

Adds a column of type TIME WITH TIMEZONE.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addUserDefinedType(const char * typeName, int32 len, const std::string & fieldName = "")

Adds a column of a user-defined type.

Parameters

  • typeName: the name of the type
  • len: the length of the type field, in bytes
  • fieldName: the name of the field
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addUuid(const std::string & fieldName = "")

Adds a column of type UUID.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addVarbinary(int32 len, const std::string & fieldName = "")

Adds a column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addVarchar(int32 len, const std::string & fieldName = "")

Adds a column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

1.1.121 - Vertica::Fields Member List

This is the complete list of members for Vertica::Fields, including all inherited members.

addArrayType(const Field &element, const std::string &fieldName="", int maxElems=-1, const Properties &props=Properties()) (defined in Vertica::Fields) Vertica::Fields
addBinary(int32 len, const std::string &fieldName="") Vertica::Fields
addBinary(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addBool(const std::string &fieldName="") Vertica::Fields
addBool(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addChar(int32 len, const std::string &fieldName="") Vertica::Fields
addChar(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addDate(const std::string &fieldName="") Vertica::Fields
addDate(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addFloat(const std::string &fieldName="") Vertica::Fields
addFloat(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addInt(const std::string &fieldName="") Vertica::Fields
addInt(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addInterval(int32 precision, int32 range, const std::string &fieldName="") Vertica::Fields
addInterval(int32 precision, int32 range, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addIntervalYM(int32 range, const std::string &fieldName="") Vertica::Fields
addIntervalYM(int32 range, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addLongVarbinary(int32 len, const std::string &fieldName="") Vertica::Fields
addLongVarbinary(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addLongVarchar(int32 len, const std::string &fieldName="") Vertica::Fields
addLongVarchar(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addNumeric(int32 precision, int32 scale, const std::string &fieldName="") Vertica::Fields
addNumeric(int32 precision, int32 scale, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addRowType(const Fields &rowfields, const std::string &fieldName="") Vertica::Fields
addRowType(const Fields &rowfields, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addTime(int32 precision, const std::string &fieldName="") Vertica::Fields
addTime(int32 precision, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addTimestamp(int32 precision, const std::string &fieldName="") Vertica::Fields
addTimestamp(int32 precision, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addTimestampTz(int32 precision, const std::string &fieldName="") Vertica::Fields
addTimestampTz(int32 precision, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addTimeTz(int32 precision, const std::string &fieldName="") Vertica::Fields
addTimeTz(int32 precision, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addUserDefinedType(const char *typeName, int32 len, const std::string &fieldName="") Vertica::Fields
addUserDefinedType(const char *typeName, int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addUuid(const std::string &fieldName="") Vertica::Fields
addUuid(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addVarbinary(int32 len, const std::string &fieldName="") Vertica::Fields
addVarbinary(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addVarchar(int32 len, const std::string &fieldName="") Vertica::Fields
addVarchar(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
Fields() (defined in Vertica::Fields) Vertica::Fields inline
validateStringLengthOrThrow(int32 len, const char *typeStr, int32 maxLength) (defined in Vertica::Fields) Vertica::Fields protected
validateUDTypeLengthOrThrow(Oid udTypeOid, const char *typeName, int32 len) (defined in Vertica::Fields) Vertica::Fields protected

1.1.122 - Vertica::Fields::Properties Member List

This is the complete list of members for Vertica::Fields::Properties, including all inherited members.

canBeNull (defined in Vertica::Fields::Properties) Vertica::Fields::Properties
comment (defined in Vertica::Fields::Properties) Vertica::Fields::Properties
isSortedBy (defined in Vertica::Fields::Properties) Vertica::Fields::Properties
MAX_COMMENT_LEN (defined in Vertica::Fields::Properties) Vertica::Fields::Properties static
operator!=(const Properties &right) const (defined in Vertica::Fields::Properties) Vertica::Fields::Properties inline
operator==(const Properties &right) const (defined in Vertica::Fields::Properties) Vertica::Fields::Properties inline
Properties(bool visible, bool required, bool canBeNull, const std::string comment, bool isSortedOnThis=false) (defined in Vertica::Fields::Properties) Vertica::Fields::Properties inline
Properties() (defined in Vertica::Fields::Properties) Vertica::Fields::Properties inline
required (defined in Vertica::Fields::Properties) Vertica::Fields::Properties
visible (defined in Vertica::Fields::Properties) Vertica::Fields::Properties

1.1.123 - Vertica::Fields::Properties Struct Reference

Collaboration diagram for Vertica::Fields::Properties:

Public Member Functions
Properties (bool visible, bool required, bool canBeNull, const std::string comment, bool isSortedOnThis=false)
bool operator!= (const Properties &right) const
bool operator== (const Properties &right) const
Public Attributes
bool canBeNull
std::string comment
bool isSortedBy
bool required
bool visible
Static Public Attributes
static const uint32 MAX_COMMENT_LEN = 128

1.1.124 - Vertica::FilterFactory Class Reference

Produces and initializes UDFilters to transform input data before parsing.

Inheritance diagram for Vertica::FilterFactory:

Collaboration diagram for Vertica::FilterFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res) override
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override
UDXFactory::UDXType getUDXFactoryType () override
virtual void plan (ServerInterface &srvInterface, PlanContext &planCtxt)
virtual UDFilter * prepare (ServerInterface &srvInterface, PlanContext &planCtxt)=0
Protected Attributes
Oid libOid
std::string sqlName

Detailed Description

Produces and initializes UDFilters to transform input data before parsing.

Note that FilterFactories are singletons. Subclasses should be stateless, with no fields containing data, just methods. plan() and prepare() methods must never modify any global variables or state; they may only modify the variables that they are given as arguments. (If global state must be modified, use SourceIterator.)

Factories should be registered using the RegisterFactory() macro, defined in Vertica.h.

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented from Vertica::UDXFactory.

Referenced by Vertica::UDLFactory::getPerInstanceResources().

virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented from Vertica::UDXFactory.

UDXFactory::UDXType Vertica::FilterFactory::getUDXFactoryType()

inlinevirtual

Returns the type of UDX Object instance this factory returns.

Note User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Implements Vertica::UDXFactory.

virtual void Vertica::FilterFactory::plan(ServerInterface & srvInterface, PlanContext & planCtxt)

inlinevirtual

Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on (through srvInterface).

plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().
virtual UDFilter* Vertica::FilterFactory::prepare(ServerInterface & srvInterface, PlanContext & planCtxt)

pure virtual Initialize a UDFilter. This function will be called on each node, prior to the Load operator starting to execute.

'planData' contains the same data that was placed there by the plan() static method.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().

Returns UDFilter instance to use for this query

1.1.125 - Vertica::FilterFactory Member List

This is the complete list of members for Vertica::FilterFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) override Vertica::UDLFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override Vertica::UDLFactory inlinevirtual
getUDXFactoryType() override Vertica::FilterFactory inlinevirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
plan(ServerInterface &srvInterface, PlanContext &planCtxt) Vertica::FilterFactory inlinevirtual
prepare(ServerInterface &srvInterface, PlanContext &planCtxt)=0 Vertica::FilterFactory pure virtual
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~UDLFactory() (defined in Vertica::UDLFactory) Vertica::UDLFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.126 - Vertica::FIunion Member List

This is the complete list of members for Vertica::FIunion, including all inherited members.

vf (defined in Vertica::FIunion) Vertica::FIunion
vi (defined in Vertica::FIunion) Vertica::FIunion

1.1.127 - Vertica::FIunion Union Reference

Collaboration diagram for Vertica::FIunion:

Public Attributes
vfloat vf
vint vi

1.1.128 - Vertica::FunctionFactory Class Reference

Inheritance diagram for Vertica::FunctionFactory:

Collaboration diagram for Vertica::FunctionFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes)
virtual void getPrototype (ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0
virtual void getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)=0
virtual UDXType getUDXFactoryType ()=0
Protected Attributes
Oid libOid
std::string sqlName

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented in Vertica::UDLFactory.

Referenced by Vertica::UDXFactory::getPerInstanceResources().

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented in Vertica::UDLFactory.

virtual void Vertica::FunctionFactory::getPrototype(ServerInterface & srvInterface, ColumnTypes & argTypes, ColumnTypes & returnType)

pure virtual Provides the argument and return types of the UDX

Implemented in Vertica::MultiPhaseTransformFunctionFactory.

Referenced by Vertica::ScalarFunctionFactory::getReturnType().

virtual void Vertica::FunctionFactory::getReturnType(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SizedColumnTypes & returnType)

pure virtual Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time/Timestamp types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Implemented in Vertica::MultiPhaseTransformFunctionFactory, and Vertica::ScalarFunctionFactory.

virtual UDXType Vertica::UDXFactory::getUDXFactoryType()

pure virtual inherited Returns the type of UDX Object instance this factory returns.

Note User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Implemented in Vertica::UDKeyManagerFactory, Vertica::MultiPhaseTransformFunctionFactory, Vertica::AggregateFunctionFactory, Vertica::AnalyticFunctionFactory, Vertica::TransformFunctionFactory, Vertica::ScalarFunctionFactory, Vertica::ParserFactory, Vertica::FilterFactory, Vertica::IterativeSourceFactory, and Vertica::UDFileSystemFactory.

1.1.129 - Vertica::FunctionFactory Member List

This is the complete list of members for Vertica::FunctionFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) Vertica::UDXFactory inlinevirtual
getPrototype(ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0 Vertica::FunctionFactory pure virtual
getReturnType(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)=0 Vertica::FunctionFactory pure virtual
getUDXFactoryType()=0 Vertica::UDXFactory pure virtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~FunctionFactory() (defined in Vertica::FunctionFactory) Vertica::FunctionFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.130 - Vertica::IntermediateAggs Class Reference

A wrapper around a single intermediate aggregate value.

Inheritance diagram for Vertica::IntermediateAggs:

Collaboration diagram for Vertica::IntermediateAggs:

Public Member Functions
IntermediateAggs (size_t ninter)
void copy (const VerticaBlock &other)
vbool * getBoolPtr (size_t idx)
Get a pointer to a BOOLEAN value from the intermediate results set.
vbool & getBoolRef (size_t idx)
Get a reference to a BOOLEAN value from the intermediate results set.
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
DateADT * getDatePtr (size_t idx)
Get a pointer to a DATE value from the intermediate results set.
DateADT & getDateRef (size_t idx)
Get a reference to a DATE value from the intermediate results set.
vfloat * getFloatPtr (size_t idx)
Get a pointer to a FLOAT value from the intermediate results set.
vfloat & getFloatRef (size_t idx)
Get a reference to a FLOAT value from the intermediate results set.
Interval * getIntervalPtr (size_t idx)
Get a pointer to an INTERVAL value from the intermediate results set.
Interval & getIntervalRef (size_t idx)
Get a reference to an INTERVAL value from the intermediate results set.
IntervalYM * getIntervalYMPtr (size_t idx)
Get a pointer to a INTERVAL YEAR TO MONTH value from the intermediate results set.
IntervalYM & getIntervalYMRef (size_t idx)
Get a reference to an INTERVAL YEAR TO MONTH value from the intermediate results set.
vint * getIntPtr (size_t idx)
Get a pointer to an INTEGER value from the intermediate results set.
vint & getIntRef (size_t idx)
Get a reference to an INTEGER value from the intermediate results set.
size_t getNumCols () const
VNumeric * getNumericPtr (size_t idx)
Get a pointer to a VNumeric value from the intermediate results set.
VNumeric & getNumericRef (size_t idx)
Get a reference to a VNumeric value from the intermediate results set.
int getNumRows () const
VString * getStringPtr (size_t idx)
Get a pointer to a VString value from the intermediate results set.
VString & getStringRef (size_t idx)
Get a reference to an VString value from the intermediate results set.
TimeADT * getTimePtr (size_t idx)
Get a pointer to a TIME value from the intermediate results set.
TimeADT & getTimeRef (size_t idx)
Get a reference to a TIME value from the intermediate results set.
Timestamp * getTimestampPtr (size_t idx)
Get a pointer to a TIMESTAMP value from the intermediate results set.
Timestamp & getTimestampRef (size_t idx)
Get a reference to a TIMESTAMP value from the intermediate results set.
TimestampTz * getTimestampTzPtr (size_t idx)
Get a pointer to a TIMESTAMP WITH TIMEZONE value from the intermediate results set.
TimestampTz & getTimestampTzRef (size_t idx)
Get a reference to a TIMESTAMP WITH TIMEZONE value from the intermediate results set.
TimeTzADT * getTimeTzPtr (size_t idx)
Get a pointer to a TIME WITH TIMEZONE value from the intermediate results set.
TimeTzADT & getTimeTzRef (size_t idx)
Get a reference to a TIME WITH TIMEZONE value from the intermediate results set.
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
VUuid * getUuidPtr (size_t idx)
Get a pointer to a VUuid value from the intermediate results set.
VUuid & getUuidRef (size_t idx)
Get a reference to a VUuid value from the intermediate results set.
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool remaining () const
void setDataArea (size_t idx, void *dataarea)
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers

Detailed Description

A wrapper around a single intermediate aggregate value.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

vbool* Vertica::IntermediateAggs::getBoolPtr(size_t idx)

inline Get a pointer to a BOOLEAN value from the intermediate results set.

Parameters

  • idx: The column number in the intermediate results set to retrieve.

Returns A pointer to the retrieved value cast as a BOOLEAN.

Referenced by getBoolRef().

vbool& Vertica::IntermediateAggs::getBoolRef(size_t idx)

inline Get a reference to a BOOLEAN value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as an BOOLEAN.

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

DateADT* Vertica::IntermediateAggs::getDatePtr(size_t idx)

inline Get a pointer to a DATE value from the intermediate results set.

Parameters

  • idx: The column number in the intermediate results set to retrieve.

Returns A pointer to the retrieved value cast as a DATE.

Referenced by getDateRef().

DateADT& Vertica::IntermediateAggs::getDateRef(size_t idx)

inline Get a reference to a DATE value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as an DATE.

vfloat* Vertica::IntermediateAggs::getFloatPtr(size_t idx)

inline Get a pointer to a FLOAT value from the intermediate results set.

Parameters

  • idx: The column number in the intermediate results set to retrieve.

Returns A pointer to the retrieved value cast as a FLOAT.

Referenced by getFloatRef().

vfloat& Vertica::IntermediateAggs::getFloatRef(size_t idx)

inline Get a reference to a FLOAT value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns A reference to the idx'th argument, cast as an FLOAT.

Interval* Vertica::IntermediateAggs::getIntervalPtr(size_t idx)

inline Get a pointer to an INTERVAL value from the intermediate results set.

Parameters

  • idx: The column number in the intermediate results set to retrieve.

Returns A pointer to the retrieved value cast as an INTERVAL.

Referenced by getIntervalRef().

Interval& Vertica::IntermediateAggs::getIntervalRef(size_t idx)

inline Get a reference to an INTERVAL value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as an INTERVAL.

IntervalYM* Vertica::IntermediateAggs::getIntervalYMPtr(size_t idx)

inline Get a pointer to a INTERVAL YEAR TO MONTH value from the intermediate results set.

Parameters

  • idx: The column number in the intermediate results set to retrieve.

Returns A point to the retrieved value cast as a INTERVAL YEAR TO MONTH.

Referenced by getIntervalYMRef().

IntervalYM& Vertica::IntermediateAggs::getIntervalYMRef(size_t idx)

inline Get a reference to an INTERVAL YEAR TO MONTH value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as an INTERVAL YEAR TO MONTH.

vint* Vertica::IntermediateAggs::getIntPtr(size_t idx)

inline Get a pointer to an INTEGER value from the intermediate results set.

Returns a pointer to the idx'th argument, cast appropriately.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Example:

vint *a = arg_reader->getIntPtr(0);

Referenced by getIntRef().

vint& Vertica::IntermediateAggs::getIntRef(size_t idx)

inline Get a reference to an INTEGER value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as an INTEGER.

Example:

vint a = arg_reader->getIntRef(0);

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

VNumeric* Vertica::IntermediateAggs::getNumericPtr(size_t idx)

inline Get a pointer to a VNumeric value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns A pointer to the retrieved value cast as a Numeric.

Referenced by getNumericRef().

VNumeric& Vertica::IntermediateAggs::getNumericRef(size_t idx)

inline Get a reference to a VNumeric value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as an VNumeric.

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

VString* Vertica::IntermediateAggs::getStringPtr(size_t idx)

inline Get a pointer to a VString value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns A pointer to the retrieved value cast as a VString.

Referenced by getStringRef().

VString& Vertica::IntermediateAggs::getStringRef(size_t idx)

inline Get a reference to an VString value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as an VString.

TimeADT* Vertica::IntermediateAggs::getTimePtr(size_t idx)

inline Get a pointer to a TIME value from the intermediate results set.

Parameters

  • idx: The column number in the intermediate results set to retrieve.

Returns A pointer to the retrieved value cast as a TIME.

Referenced by getTimeRef().

TimeADT& Vertica::IntermediateAggs::getTimeRef(size_t idx)

inline Get a reference to a TIME value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as a TIME.

Timestamp* Vertica::IntermediateAggs::getTimestampPtr(size_t idx)

inline Get a pointer to a TIMESTAMP value from the intermediate results set.

Parameters

  • idx: The column number in the intermediate results set to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP.

Referenced by getTimestampRef().

Timestamp& Vertica::IntermediateAggs::getTimestampRef(size_t idx)

inline Get a reference to a TIMESTAMP value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as a TIMESTAMP.

TimestampTz* Vertica::IntermediateAggs::getTimestampTzPtr(size_t idx)

inline Get a pointer to a TIMESTAMP WITH TIMEZONE value from the intermediate results set.

Parameters

  • idx: The column number in the intermediate results set to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP WITH TIMEZONE .

Referenced by getTimestampTzRef().

TimestampTz& Vertica::IntermediateAggs::getTimestampTzRef(size_t idx)

inline Get a reference to a TIMESTAMP WITH TIMEZONE value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as a TIMESTAMP WITH TIMEZONE.

TimeTzADT* Vertica::IntermediateAggs::getTimeTzPtr(size_t idx)

inline Get a pointer to a TIME WITH TIMEZONE value from the intermediate results set.

Parameters

  • idx: The column number in the intermediate results set to retrieve.

Returns A pointer to the retrieved value cast as a TIME WITH TIMEZONE.

Referenced by getTimeTzRef().

TimeTzADT& Vertica::IntermediateAggs::getTimeTzRef(size_t idx)

inline Get a reference to a TIME WITH TIMEZONE value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as a TIME WITH TIMEZONE.

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

VUuid* Vertica::IntermediateAggs::getUuidPtr(size_t idx)

inline Get a pointer to a VUuid value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns A pointer to the retrieved value cast as a VUuid.

Referenced by getUuidRef().

VUuid& Vertica::IntermediateAggs::getUuidRef(size_t idx)

inline Get a reference to a VUuid value from the intermediate results set.

Parameters

  • idx: The column number to retrieve from the intermediate results set.

Returns a reference to the idx'th argument, cast as an VUuid.

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

1.1.131 - Vertica::IntermediateAggs Member List

This is the complete list of members for Vertica::IntermediateAggs, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getBoolPtr(size_t idx) Vertica::IntermediateAggs inline
getBoolRef(size_t idx) Vertica::IntermediateAggs inline
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDatePtr(size_t idx) Vertica::IntermediateAggs inline
getDateRef(size_t idx) Vertica::IntermediateAggs inline
getFloatPtr(size_t idx) Vertica::IntermediateAggs inline
getFloatRef(size_t idx) Vertica::IntermediateAggs inline
getIntervalPtr(size_t idx) Vertica::IntermediateAggs inline
getIntervalRef(size_t idx) Vertica::IntermediateAggs inline
getIntervalYMPtr(size_t idx) Vertica::IntermediateAggs inline
getIntervalYMRef(size_t idx) Vertica::IntermediateAggs inline
getIntPtr(size_t idx) Vertica::IntermediateAggs inline
getIntRef(size_t idx) Vertica::IntermediateAggs inline
getNumCols() const Vertica::VerticaBlock inline
getNumericPtr(size_t idx) Vertica::IntermediateAggs inline
getNumericRef(size_t idx) Vertica::IntermediateAggs inline
getNumRows() const Vertica::VerticaBlock inline
getStringPtr(size_t idx) Vertica::IntermediateAggs inline
getStringRef(size_t idx) Vertica::IntermediateAggs inline
getTimePtr(size_t idx) Vertica::IntermediateAggs inline
getTimeRef(size_t idx) Vertica::IntermediateAggs inline
getTimestampPtr(size_t idx) Vertica::IntermediateAggs inline
getTimestampRef(size_t idx) Vertica::IntermediateAggs inline
getTimestampTzPtr(size_t idx) Vertica::IntermediateAggs inline
getTimestampTzRef(size_t idx) Vertica::IntermediateAggs inline
getTimeTzPtr(size_t idx) Vertica::IntermediateAggs inline
getTimeTzRef(size_t idx) Vertica::IntermediateAggs inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidPtr(size_t idx) Vertica::IntermediateAggs inline
getUuidRef(size_t idx) Vertica::IntermediateAggs inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
IntermediateAggs() (defined in Vertica::IntermediateAggs) Vertica::IntermediateAggs inline
IntermediateAggs(size_t ninter) (defined in Vertica::IntermediateAggs) Vertica::IntermediateAggs inline
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.132 - Vertica::IterativeSourceFactory Class Reference

Source factory that works with a SourceIterator to produce UDSources.

Inheritance diagram for Vertica::IterativeSourceFactory:

Collaboration diagram for Vertica::IterativeSourceFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual ssize_t getDesiredThreads (ServerInterface &srvInterface, ExecutorPlanContext &planCtxt)
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res) override
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override
UDXFactory::UDXType getUDXFactoryType () override
virtual bool isSourceApportionable ()
virtual void plan (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
virtual SourceIterator * prepare (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
virtual SourceIterator * prepareExecutor (ServerInterface &srvInterface, ExecutorPlanContext &planCtxt)
Protected Attributes
Oid libOid
std::string sqlName

Detailed Description

Source factory that works with a SourceIterator to produce UDSources.

Usually it is easier to subclass SourceFactory and have its prepareUDSources() method return a vector of UDSource objects. Behind the scenes, Vertica uses a built-in iterator to pull sources from that vector. However, if you need to be able to control source management at this level, you can instead write your own SourceIterator and use it with an IterativeSourceFactory.

This class performs initial validation and planning of a query, before it is distributed over the network. It also instantiates objects to perform further initialization on each node, once the query has been distributed.

Note that SourceFactories are singletons. Subclasses should be stateless, with no fields containing data, just methods. plan() and prepare() methods must never modify any global variables or state; they may only modify the variables that they are given as arguments. (If global state must be modified, use SourceIterator.)

Factories should be registered using the RegisterFactory() macro, defined in Vertica.h.

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual ssize_t Vertica::IterativeSourceFactory::getDesiredThreads(ServerInterface & srvInterface, ExecutorPlanContext & planCtxt)

inlinevirtual

Request the number of threads that the SourceFactory wants to use. This function is called on each node before prepare().

'planCtxt' contains the same parameters stored by plan() method. It also exposes the maximum number of allowed threads, via 'getMaxAllowedThreads()'. Further computations can be stored in its 'ExecutorParamWriter' object, for use in prepare().

Reimplemented in Vertica::SourceFactory.

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented from Vertica::UDXFactory.

Referenced by Vertica::UDLFactory::getPerInstanceResources().

virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented from Vertica::UDXFactory.

UDXFactory::UDXType Vertica::IterativeSourceFactory::getUDXFactoryType()

inlinevirtual

Returns the type of UDX Object instance this factory returns.

Note User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Implements Vertica::UDXFactory.

virtual void Vertica::IterativeSourceFactory::plan(ServerInterface & srvInterface, NodeSpecifyingPlanContext & planCtxt)

inlinevirtual

Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on.

plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().

Reimplemented in Vertica::SourceFactory.

virtual SourceIterator* Vertica::IterativeSourceFactory::prepareExecutor(ServerInterface & srvInterface, ExecutorPlanContext & planCtxt)

inlinevirtual

Prepare this SourceFactory to start creating sources. This function will be called on each node, prior to the Load operator starting to execute and prior to any other virtual functions on this class being called.

'planCtxt' contains the same data that was placed there by the plan() and getDesiredThreads() methods.

Referenced by Vertica::SourceFactory::getDesiredThreads().

1.1.133 - Vertica::IterativeSourceFactory Member List

This is the complete list of members for Vertica::IterativeSourceFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getDesiredThreads(ServerInterface &srvInterface, ExecutorPlanContext &planCtxt) Vertica::IterativeSourceFactory inlinevirtual
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) override Vertica::UDLFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override Vertica::UDLFactory inlinevirtual
getUDXFactoryType() override Vertica::IterativeSourceFactory inlinevirtual
isSourceApportionable() (defined in Vertica::IterativeSourceFactory) Vertica::IterativeSourceFactory inlinevirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
plan(ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) Vertica::IterativeSourceFactory inlinevirtual
prepare(ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) (defined in Vertica::IterativeSourceFactory) Vertica::IterativeSourceFactory inlinevirtual
prepareExecutor(ServerInterface &srvInterface, ExecutorPlanContext &planCtxt) Vertica::IterativeSourceFactory inlinevirtual
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~UDLFactory() (defined in Vertica::UDLFactory) Vertica::UDLFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.134 - Vertica::LengthBuffer Member List

This is the complete list of members for Vertica::LengthBuffer, including all inherited members.

buf Vertica::LengthBuffer
getByteOffset() Vertica::LengthBuffer inline
offset Vertica::LengthBuffer
size Vertica::LengthBuffer

1.1.135 - Vertica::LengthBuffer Struct Reference

Collaboration diagram for Vertica::LengthBuffer:

Public Member Functions
size_t getByteOffset ()
Returns a byte representation of the offset, where the offset is the index of the buffer array.
Public Attributes
uint32 * buf
Pointer to the start of the buffer.
size_t offset
Number of length values in the buffer.
size_t size
Maximum number of length values that the buffer can hold.

Detailed Description

LengthBuffer

A contiguous in-memory buffer of uint32 *. Used for tracking record lengths.

1.1.136 - Vertica::LibraryRegistrar Member List

This is the complete list of members for Vertica::LibraryRegistrar, including all inherited members.

LibraryRegistrar(const char *author, const char *library_build_tag, const char *library_version, const char *library_sdk_version, const char *source_url, const char *description, const char *licenses_required, const char *signature) (defined in Vertica::LibraryRegistrar) Vertica::LibraryRegistrar inline

1.1.137 - Vertica::LibraryRegistrar Struct Reference

Collaboration diagram for Vertica::LibraryRegistrar:

Public Member Functions
LibraryRegistrar (const char *author, const char *library_build_tag, const char *library_version, const char *library_sdk_version, const char *source_url, const char *description, const char *licenses_required, const char *signature)

1.1.138 - Vertica::Model Class Reference

Collaboration diagram for Vertica::Model:

Public Member Functions
Model (ServerInterface &srvInterface, std::string modelName)
Model (ServerInterface &srvInterface, Oid model_oid)
std::string getBaseModelName () const
std::string getModelCategory () const
std::string getModelName () const
Oid getModelOid () const
size_t getModelSize () const
std::string getModelType () const
std::string getModelVersion () const
std::string getOwner () const
std::string getSchema () const
bool isModelComplete () const
void setModelCategory (const std::string &mc)
void setModelName (const std::string &mName)
void setModelOid (Oid mOid)
void setModelProgress (bool p)
void setModelSize (size_t size)
void setModelType (const std::string &mt)
void setModelVersion (const std::string &v)
void setOwner (const std::string &o)
void setSchema (const std::string &s)

1.1.139 - Vertica::Model Member List

This is the complete list of members for Vertica::Model, including all inherited members.

getBaseModelName() const (defined in Vertica::Model) Vertica::Model inline
getModelCategory() const (defined in Vertica::Model) Vertica::Model inline
getModelName() const (defined in Vertica::Model) Vertica::Model inline
getModelOid() const (defined in Vertica::Model) Vertica::Model inline
getModelSize() const (defined in Vertica::Model) Vertica::Model inline
getModelType() const (defined in Vertica::Model) Vertica::Model inline
getModelVersion() const (defined in Vertica::Model) Vertica::Model inline
getOwner() const (defined in Vertica::Model) Vertica::Model inline
getSchema() const (defined in Vertica::Model) Vertica::Model inline
isModelComplete() const (defined in Vertica::Model) Vertica::Model inline
Model(ServerInterface &srvInterface, std::string modelName) (defined in Vertica::Model) Vertica::Model inline
Model(ServerInterface &srvInterface, Oid model_oid) (defined in Vertica::Model) Vertica::Model inline
Model() (defined in Vertica::Model) Vertica::Model inline
setModelCategory(const std::string &mc) (defined in Vertica::Model) Vertica::Model inline
setModelName(const std::string &mName) (defined in Vertica::Model) Vertica::Model inline
setModelOid(Oid mOid) (defined in Vertica::Model) Vertica::Model inline
setModelProgress(bool p) (defined in Vertica::Model) Vertica::Model inline
setModelSize(size_t size) (defined in Vertica::Model) Vertica::Model inline
setModelType(const std::string &mt) (defined in Vertica::Model) Vertica::Model inline
setModelVersion(const std::string &v) (defined in Vertica::Model) Vertica::Model inline
setOwner(const std::string &o) (defined in Vertica::Model) Vertica::Model inline
setSchema(const std::string &s) (defined in Vertica::Model) Vertica::Model inline

1.1.140 - Vertica::MultiPhaseTransformFunctionFactory Class Reference

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.

Inheritance diagram for Vertica::MultiPhaseTransformFunctionFactory:

Collaboration diagram for Vertica::MultiPhaseTransformFunctionFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes)
virtual void getPhases (ServerInterface &srvInterface, std::vector &phases)=0
virtual void getPrototype (ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType) override
virtual void getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType) override
Protected Member Functions
virtual UDXType getUDXFactoryType () override
Protected Attributes
Oid libOid
std::string sqlName

Detailed Description

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.

A multi-phase transform function is made up of TransformFunctionPhase instances. For each phase of your transform, extend this class (not TransformFunction). In getPhases(), return a vector of instances of those classes. Semantically, getPhases() replaces TransformFunctionFactory.createTransformFunction().

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented in Vertica::UDLFactory.

Referenced by Vertica::UDXFactory::getPerInstanceResources().

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented in Vertica::UDLFactory.

virtual void Vertica::MultiPhaseTransformFunctionFactory::getPhases(ServerInterface & srvInterface, std::vector & phases)

pure virtual

Called when Vertica needs a new TransformFunctionPhase pipeline
to process a multi-phase UDTF function call. Vertica invokes the
phases in order; collectively they behave like a TransformFunction.

**Parameters:** `srvInterface` - a ServerInterface object used to communicate with Ver

tica

Parameters

  • phases: output TransformFunctionPhase objects

Note More than one object may be instantiated per query.

Referenced by getReturnType().

virtual void Vertica::MultiPhaseTransformFunctionFactory::getPrototype(ServerInterface & srvInterface, ColumnTypes & argTypes, ColumnTypes & returnType)

inlinevirtual

Provides the argument and return types of the UDX

Implements Vertica::FunctionFactory.

virtual void Vertica::MultiPhaseTransformFunctionFactory::getReturnType(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SizedColumnTypes & returnType)

inlinevirtual

Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time/Timestamp types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Implements Vertica::FunctionFactory.

virtual UDXType Vertica::MultiPhaseTransformFunctionFactory::getUDXFactoryType()

inlineprotectedvirtual

Returns the object type internally used by Vertica

Implements Vertica::UDXFactory.

1.1.141 - Vertica::MultiPhaseTransformFunctionFactory Member List

This is the complete list of members for Vertica::MultiPhaseTransformFunctionFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) Vertica::UDXFactory inlinevirtual
getPhases(ServerInterface &srvInterface, std::vector &phases)=0 Vertica::MultiPhaseTransformFunctionFactory pure virtual
getPrototype(ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType) override Vertica::MultiPhaseTransformFunctionFactory inlinevirtual
getReturnType(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType) override Vertica::MultiPhaseTransformFunctionFactory inlinevirtual
getUDXFactoryType() override Vertica::MultiPhaseTransformFunctionFactory inlineprotectedvirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~FunctionFactory() (defined in Vertica::FunctionFactory) Vertica::FunctionFactory inlinevirtual
~MultiPhaseTransformFunctionFactory() (defined in Vertica::MultiPhaseTransformFunctionFactory) Vertica::MultiPhaseTransformFunctionFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.142 - Vertica::MultipleIntermediateAggs Class Reference

A wrapper around multiple intermediate aggregates.

Inheritance diagram for Vertica::MultipleIntermediateAggs:

Collaboration diagram for Vertica::MultipleIntermediateAggs:

Public Member Functions
MultipleIntermediateAggs (size_t narg)
void copy (const VerticaBlock &other)
Array::ArrayReader getArrayRef (size_t idx) const
Get a reference to an Array value from the input row.
const vbool * getBoolPtr (size_t idx) const
Get a pointer to a BOOLEAN value from the input row.
const vbool & getBoolRef (size_t idx) const
Get a reference to a BOOLEAN value from the input row.
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
const DateADT * getDatePtr (size_t idx) const
Get a pointer to a DATE value from the input row.
const DateADT & getDateRef (size_t idx) const
Get a reference to a DATE value from the input row.
const vfloat * getFloatPtr (size_t idx) const
Get a pointer to a FLOAT value from the input row.
const vfloat & getFloatRef (size_t idx) const
Get a reference to a FLOAT value from the input row.
const Interval * getIntervalPtr (size_t idx) const
Get a pointer to an INTERVAL value from the input row.
const Interval & getIntervalRef (size_t idx) const
Get a reference to an INTERVAL value from the input row.
const IntervalYM * getIntervalYMPtr (size_t idx) const
Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.
const IntervalYM & getIntervalYMRef (size_t idx) const
Get a reference to an INTERVAL YEAR TO MONTH value from the input row.
const vint * getIntPtr (size_t idx) const
Get a pointer to an INTEGER value from the input row.
const vint & getIntRef (size_t idx) const
Get a reference to an INTEGER value from the input row.
size_t getNumCols () const
const VNumeric * getNumericPtr (size_t idx) const
Get a pointer to a VNumeric value from the input row.
const VNumeric & getNumericRef (size_t idx) const
Get a reference to a VNumeric value from the input row.
int getNumRows () const
int getPosition () const
const BlockReader * getRowPtr (size_t idx) const
Get a reference to a Row value from the input row.
const BlockReader & getRowRef (size_t idx) const
Get a reference to a Row value from the input row.
const VString * getStringPtr (size_t idx) const
Get a pointer to a VString value from the input row.
const VString & getStringRef (size_t idx) const
Get a reference to an VString value from the input row.
const TimeADT * getTimePtr (size_t idx) const
Get a pointer to a TIME value from the input row.
const TimeADT & getTimeRef (size_t idx) const
Get a reference to a TIME value from the input row.
const Timestamp * getTimestampPtr (size_t idx) const
Get a pointer to a TIMESTAMP value from the input row.
const Timestamp & getTimestampRef (size_t idx) const
Get a reference to a TIMESTAMP value from the input row.
const TimestampTz * getTimestampTzPtr (size_t idx) const
Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimestampTz & getTimestampTzRef (size_t idx) const
Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimeTzADT * getTimeTzPtr (size_t idx) const
Get a pointer to a TIME WITH TIMEZONE value from the input row.
const TimeTzADT & getTimeTzRef (size_t idx) const
Get a reference to a TIME WITH TIMEZONE value from the input row.
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
const VUuid * getUuidPtr (size_t idx) const
Get a pointer to a VUuid value from the input row.
const VUuid & getUuidRef (size_t idx) const
Get a reference to a VUuid value from the input row.
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool hasData () const
bool isNull (int col) const
Check if the idx'th argument is null.
bool next ()
bool remaining () const
void setDataArea (size_t idx, void *dataarea)
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool advanceToNextRow (bool recurIntoArrays)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers

Detailed Description

A wrapper around multiple intermediate aggregates.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

Array::ArrayReader Vertica::BlockReader::getArrayRef(size_t idx) const

inherited Get a reference to an Array value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument: another BlockReader which reads elements of the array.

const vbool* Vertica::BlockReader::getBoolPtr(size_t idx) const

inline inherited Get a pointer to a BOOLEAN value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a BOOLEAN.

Referenced by Vertica::BlockReader::getBoolRef().

const vbool& Vertica::BlockReader::getBoolRef(size_t idx) const

inline inherited Get a reference to a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an BOOLEAN.

Referenced by Vertica::BlockReader::isNull().

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

const DateADT* Vertica::BlockReader::getDatePtr(size_t idx) const

inline inherited Get a pointer to a DATE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a DATE.

Referenced by Vertica::BlockReader::getDateRef().

const DateADT& Vertica::BlockReader::getDateRef(size_t idx) const

inline inherited Get a reference to a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an DATE.

Referenced by Vertica::BlockReader::isNull().

const vfloat* Vertica::BlockReader::getFloatPtr(size_t idx) const

inline inherited Get a pointer to a FLOAT value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a FLOAT.

Referenced by Vertica::BlockReader::getFloatRef().

const vfloat& Vertica::BlockReader::getFloatRef(size_t idx) const

inline inherited Get a reference to a FLOAT value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the idx'th argument, cast as an FLOAT.

Referenced by Vertica::BlockReader::isNull().

const Interval* Vertica::BlockReader::getIntervalPtr(size_t idx) const

inline inherited Get a pointer to an INTERVAL value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as an INTERVAL.

Referenced by Vertica::BlockReader::getIntervalRef().

const Interval& Vertica::BlockReader::getIntervalRef(size_t idx) const

inline inherited Get a reference to an INTERVAL value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTERVAL.

Referenced by Vertica::BlockReader::isNull().

const IntervalYM* Vertica::BlockReader::getIntervalYMPtr(size_t idx) const

inline inherited Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A point to the retrieved value cast as a INTERVAL YEAR TO MONTH.

Referenced by Vertica::BlockReader::getIntervalYMRef().

const IntervalYM& Vertica::BlockReader::getIntervalYMRef(size_t idx) const

inline inherited Get a reference to an INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTERVAL YEAR TO MONTH.

Referenced by Vertica::BlockReader::isNull().

const vint* Vertica::BlockReader::getIntPtr(size_t idx) const

inline inherited Get a pointer to an INTEGER value from the input row.

Returns a pointer to the idx'th argument, cast appropriately.

Parameters

  • idx: The column number to retrieve from the input row.

Example:

const vint *a = arg_reader->getIntPtr(0);

Referenced by Vertica::BlockReader::getIntRef().

const vint& Vertica::BlockReader::getIntRef(size_t idx) const

inline inherited Get a reference to an INTEGER value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTEGER.

Example:

const vint a = arg_reader->getIntRef(0);

Referenced by Vertica::BlockReader::isNull().

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

const VNumeric* Vertica::BlockReader::getNumericPtr(size_t idx) const

inline inherited Get a pointer to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a Numeric.

Referenced by Vertica::BlockReader::getNumericRef().

const VNumeric& Vertica::BlockReader::getNumericRef(size_t idx) const

inline inherited Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VNumeric.

Referenced by Vertica::BlockReader::isNull().

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

int Vertica::BlockReader::getPosition() const

inline inherited Returns the current row position or array index

const BlockReader* Vertica::BlockReader::getRowPtr(size_t idx) const

inline inherited Get a reference to a Row value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a pointer to a reader for the Row fields

Referenced by Vertica::BlockReader::getRowRef().

const BlockReader& Vertica::BlockReader::getRowRef(size_t idx) const

inline inherited Get a reference to a Row value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, as a Row value.

const VString* Vertica::BlockReader::getStringPtr(size_t idx) const

inline inherited Get a pointer to a VString value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a VString.

Referenced by Vertica::BlockReader::getStringRef().

const VString& Vertica::BlockReader::getStringRef(size_t idx) const

inline inherited Get a reference to an VString value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by Vertica::BlockReader::isNull().

const TimeADT* Vertica::BlockReader::getTimePtr(size_t idx) const

inline inherited Get a pointer to a TIME value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIME.

Referenced by Vertica::BlockReader::getTimeRef().

const TimeADT& Vertica::BlockReader::getTimeRef(size_t idx) const

inline inherited Get a reference to a TIME value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIME.

Referenced by Vertica::BlockReader::isNull().

const Timestamp* Vertica::BlockReader::getTimestampPtr(size_t idx) const

inline inherited Get a pointer to a TIMESTAMP value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP.

Referenced by Vertica::BlockReader::getTimestampRef().

const Timestamp& Vertica::BlockReader::getTimestampRef(size_t idx) const

inline inherited Get a reference to a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIMESTAMP.

Referenced by Vertica::BlockReader::isNull().

const TimestampTz* Vertica::BlockReader::getTimestampTzPtr(size_t idx) const

inline inherited Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP WITH TIMEZONE .

Referenced by Vertica::BlockReader::getTimestampTzRef().

const TimestampTz& Vertica::BlockReader::getTimestampTzRef(size_t idx) const

inline inherited Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIMESTAMP WITH TIMEZONE.

Referenced by Vertica::BlockReader::isNull().

const TimeTzADT* Vertica::BlockReader::getTimeTzPtr(size_t idx) const

inline inherited Get a pointer to a TIME WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIME WITH TIMEZONE.

Referenced by Vertica::BlockReader::getTimeTzRef().

const TimeTzADT& Vertica::BlockReader::getTimeTzRef(size_t idx) const

inline inherited Get a reference to a TIME WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIME WITH TIMEZONE.

Referenced by Vertica::BlockReader::isNull().

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

const VUuid* Vertica::BlockReader::getUuidPtr(size_t idx) const

inline inherited Get a pointer to a VUuid value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a VUuid.

Referenced by Vertica::BlockReader::getUuidRef().

const VUuid& Vertica::BlockReader::getUuidRef(size_t idx) const

inline inherited Get a reference to a VUuid value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VUuid.

Referenced by Vertica::BlockReader::isNull().

bool Vertica::BlockReader::hasData() const

inline inherited Returns true if there is data available

Referenced by Vertica::copyBlockColumn().

bool Vertica::BlockReader::isNull(int col) const

inline inherited Check if the idx'th argument is null.

Parameters

  • col: The column number in the row to check for null

Returns true is the col value is null false otherwise

bool Vertica::BlockReader::next()

inline inherited Advance to the next record.

Returns true if there are more rows to read, false otherwise.

Referenced by Vertica::copyBlockColumn().

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

1.1.143 - Vertica::MultipleIntermediateAggs Member List

This is the complete list of members for Vertica::MultipleIntermediateAggs, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
advanceToNextRow(bool recurIntoArrays) (defined in Vertica::BlockReader) Vertica::BlockReader inlineprotected
BlockReader(size_t narg, int rowcount, const int *indices) (defined in Vertica::BlockReader) Vertica::BlockReader inline
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getArrayRef(size_t idx) const Vertica::BlockReader
getBoolPtr(size_t idx) const Vertica::BlockReader inline
getBoolRef(size_t idx) const Vertica::BlockReader inline
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDatePtr(size_t idx) const Vertica::BlockReader inline
getDateRef(size_t idx) const Vertica::BlockReader inline
getFloatPtr(size_t idx) const Vertica::BlockReader inline
getFloatRef(size_t idx) const Vertica::BlockReader inline
getIntervalPtr(size_t idx) const Vertica::BlockReader inline
getIntervalRef(size_t idx) const Vertica::BlockReader inline
getIntervalYMPtr(size_t idx) const Vertica::BlockReader inline
getIntervalYMRef(size_t idx) const Vertica::BlockReader inline
getIntPtr(size_t idx) const Vertica::BlockReader inline
getIntRef(size_t idx) const Vertica::BlockReader inline
getNumCols() const Vertica::VerticaBlock inline
getNumericPtr(size_t idx) const Vertica::BlockReader inline
getNumericRef(size_t idx) const Vertica::BlockReader inline
getNumRows() const Vertica::VerticaBlock inline
getPosition() const Vertica::BlockReader inline
getRowPtr(size_t idx) const Vertica::BlockReader inline
getRowRef(size_t idx) const Vertica::BlockReader inline
getStringPtr(size_t idx) const Vertica::BlockReader inline
getStringRef(size_t idx) const Vertica::BlockReader inline
getTimePtr(size_t idx) const Vertica::BlockReader inline
getTimeRef(size_t idx) const Vertica::BlockReader inline
getTimestampPtr(size_t idx) const Vertica::BlockReader inline
getTimestampRef(size_t idx) const Vertica::BlockReader inline
getTimestampTzPtr(size_t idx) const Vertica::BlockReader inline
getTimestampTzRef(size_t idx) const Vertica::BlockReader inline
getTimeTzPtr(size_t idx) const Vertica::BlockReader inline
getTimeTzRef(size_t idx) const Vertica::BlockReader inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidPtr(size_t idx) const Vertica::BlockReader inline
getUuidRef(size_t idx) const Vertica::BlockReader inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
hasData() const Vertica::BlockReader inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
isNull(int col) const Vertica::BlockReader inline
MultipleIntermediateAggs() (defined in Vertica::MultipleIntermediateAggs) Vertica::MultipleIntermediateAggs inline
MultipleIntermediateAggs(size_t narg) (defined in Vertica::MultipleIntermediateAggs) Vertica::MultipleIntermediateAggs inline
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
next() Vertica::BlockReader inline
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.144 - Vertica::NodeSpecifyingPlanContext Class Reference

Interface that allows storage of query-plan state, when different parts of query planning take place on different computers.

Inheritance diagram for Vertica::NodeSpecifyingPlanContext:

Collaboration diagram for Vertica::NodeSpecifyingPlanContext:

Public Member Functions
NodeSpecifyingPlanContext (ParamWriter &writer, std::vector clusterNodes, bool canApportion)
NodeSpecifyingPlanContext (ParamWriter &writer, std::vector clusterNodes, std::vector targetNodes, bool canApportion)
bool canApportionSource () const
const std::vector & getClusterNodes ()
virtual ParamReader & getReader ()
const std::vector & getTargetNodes () const
virtual ParamWriter & getWriter ()
void setTargetNodes (const std::vector &nodes)

Detailed Description

Interface that allows storage of query-plan state, when different parts of query planning take place on different computers.

For example, if some work is done on the query initiator node and some is done on each node executing the query.

In addition to the functionality provided by PlanContext, NodeSpecifyingPlanContext allows you to specify which nodes the query should run on. This is used for UDLs.

Member Function Documentation

bool Vertica::NodeSpecifyingPlanContext::canApportionSource() const

inline return whether the UDL source can be apportioned among multiple nodes or threads

const std::vector& Vertica::PlanContext::getClusterNodes()

inline inherited Get a list of all of the nodes in the current cluster, by node name

Referenced by setTargetNodes().

virtual ParamReader& Vertica::PlanContext::getReader()

inlinevirtualinherited

Get a read-only instance of the current context

const std::vector& Vertica::NodeSpecifyingPlanContext::getTargetNodes() const

inline Return the set of nodes that this query is currently set to run on

virtual ParamWriter& Vertica::PlanContext::getWriter()

inlinevirtualinherited

Get the current context for writing

Reimplemented in Vertica::ExecutorPlanContext.

Referenced by Vertica::ExecutorPlanContext::getWriter().

void Vertica::NodeSpecifyingPlanContext::setTargetNodes(const std::vector & nodes)

inline Change the set of nodes that the query is intended to run on. Throws UnknownNodeException if any of the specified node names is not actually the name of any node in the cluster.

1.1.145 - Vertica::NodeSpecifyingPlanContext Member List

This is the complete list of members for Vertica::NodeSpecifyingPlanContext, including all inherited members.

canApportionSource() const Vertica::NodeSpecifyingPlanContext inline
getClusterNodes() Vertica::PlanContext inline
getReader() Vertica::PlanContext inlinevirtual
getTargetNodes() const Vertica::NodeSpecifyingPlanContext inline
getWriter() Vertica::PlanContext inlinevirtual
NodeSpecifyingPlanContext(ParamWriter &writer, std::vector clusterNodes, bool canApportion) (defined in Vertica::NodeSpecifyingPlanContext) Vertica::NodeSpecifyingPlanContext inline
NodeSpecifyingPlanContext(ParamWriter &writer, std::vector clusterNodes, std::vector targetNodes, bool canApportion) (defined in Vertica::NodeSpecifyingPlanContext) Vertica::NodeSpecifyingPlanContext inline
PlanContext(ParamWriter &writer) (defined in Vertica::PlanContext) Vertica::PlanContext inline
PlanContext(ParamWriter &writer, std::vector clusterNodes) (defined in Vertica::PlanContext) Vertica::PlanContext inline
setTargetNodes(const std::vector &nodes) Vertica::NodeSpecifyingPlanContext inline

1.1.146 - Vertica::OpenOptions Member List

This is the complete list of members for Vertica::OpenOptions, including all inherited members.

Consistency enum name (defined in Vertica::OpenOptions) Vertica::OpenOptions
hintConsistency (defined in Vertica::OpenOptions) Vertica::OpenOptions
hintStreaming (defined in Vertica::OpenOptions) Vertica::OpenOptions
isModeSet() const (defined in Vertica::OpenOptions) Vertica::OpenOptions inline
isSizeSet() const (defined in Vertica::OpenOptions) Vertica::OpenOptions inline
mode (defined in Vertica::OpenOptions) Vertica::OpenOptions
OpenOptions(uint64 st_mode, uint64 st_size, bool rmClose=false, StreamingReadHint streamingHint=StreamingReadHint::AUTO_STREAM_READ, Consistency consistencyHint=Consistency::UNKNOWN) (defined in Vertica::OpenOptions) Vertica::OpenOptions inline
OpenOptions(bool rmClose) (defined in Vertica::OpenOptions) Vertica::OpenOptions inlineexplicit
OpenOptions(Consistency c) (defined in Vertica::OpenOptions) Vertica::OpenOptions inlineexplicit
OpenOptions() (defined in Vertica::OpenOptions) Vertica::OpenOptions inline
removeOnClose (defined in Vertica::OpenOptions) Vertica::OpenOptions
size (defined in Vertica::OpenOptions) Vertica::OpenOptions
StreamingReadHint enum name (defined in Vertica::OpenOptions) Vertica::OpenOptions
~OpenOptions() (defined in Vertica::OpenOptions) Vertica::OpenOptions inlinevirtual

1.1.147 - Vertica::OpenOptions Struct Reference

Collaboration diagram for Vertica::OpenOptions:

Public Types
enum Consistency { UNKNOWN = 0, STRONG, EVENTUAL }
enum StreamingReadHint { AUTO_STREAM_READ, STREAM_READ, NO_STREAM_READ }
Public Member Functions
OpenOptions (uint64 st_mode, uint64 st_size, bool rmClose=false, StreamingReadHint streamingHint=StreamingReadHint::AUTO_STREAM_READ, Consistency consistencyHint=Consistency::UNKNOWN)
OpenOptions (bool rmClose)
OpenOptions (Consistency c)
bool isModeSet () const
bool isSizeSet () const
Public Attributes
Consistency hintConsistency
StreamingReadHint hintStreaming
uint64 mode
bool removeOnClose
uint64 size

1.1.148 - Vertica::ParallelismInfo Member List

This is the complete list of members for Vertica::ParallelismInfo, including all inherited members.

awaitRendezvous()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
getNumPeers()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
getPeerIndex()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
getSharedPtr()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
getSharedSize()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
isCanceled()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
isErrored()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
isLeader() (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo inline
markCanceled()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
markError()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
notifyFollowers()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
waitForLeader()=0 (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo pure virtual
~ParallelismInfo() (defined in Vertica::ParallelismInfo) Vertica::ParallelismInfo inlinevirtual

1.1.149 - Vertica::ParallelismInfo Struct Reference

Collaboration diagram for Vertica::ParallelismInfo:

Public Member Functions
virtual bool awaitRendezvous ()=0
virtual int getNumPeers ()=0
virtual int getPeerIndex ()=0
virtual void * getSharedPtr ()=0
virtual int getSharedSize ()=0
virtual bool isCanceled ()=0
virtual bool isErrored ()=0
bool isLeader ()
virtual void markCanceled ()=0
virtual void markError ()=0
virtual bool notifyFollowers ()=0
virtual bool waitForLeader ()=0

Detailed Description

Structure to tell about parallelism situation

1.1.150 - Vertica::ParamReader Class Reference

Provides read access to a set of named parameters. This class provides type-specific methods to retrieve values.

Inheritance diagram for Vertica::ParamReader:

Collaboration diagram for Vertica::ParamReader:

Public Member Functions
ParamReader (size_t nparams)
void addParameter (std::string paramName, const char *arg, const VerticaType &dt)
bool containsParameter (std::string paramName) const
Function to see if the ParamReader has a value for the parameter.
void copy (const VerticaBlock &other)
void copy (const ParamReader &other)
Copy the other ParamReader. Discard any existing parameters TODO: create an alternate version that only copies if this ParamReader is empty, is a no-op if they are non-empty and the same, and error if they are non-empty and different.
const vbool * getBoolPtr (std::string paramName) const
Get a pointer to a BOOLEAN value from the input row.
const vbool & getBoolRef (std::string paramName) const
Get a reference to a BOOLEAN value from the input row.
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
const DateADT * getDatePtr (std::string paramName) const
Get a pointer to a DATE value from the input row.
const DateADT & getDateRef (std::string paramName) const
Get a reference to a DATE value from the input row.
const vfloat * getFloatPtr (std::string paramName) const
Get a pointer to a FLOAT value from the input row.
const vfloat & getFloatRef (std::string paramName) const
Get a reference to a FLOAT value from the input row.
size_t getIndex (std::string paramName) const
const Interval * getIntervalPtr (std::string paramName) const
Get a pointer to an INTERVAL value from the input row.
const Interval & getIntervalRef (std::string paramName) const
Get a reference to an INTERVAL value from the input row.
const IntervalYM * getIntervalYMPtr (std::string paramName) const
Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.
const IntervalYM & getIntervalYMRef (std::string paramName) const
Get a reference to an INTERVAL YEAR TO MONTH value from the input row.
const vint * getIntPtr (std::string paramName) const
Get a pointer to an INTEGER value from the input row.
const vint & getIntRef (std::string paramName) const
Get a reference to an INTEGER value from the input row.
size_t getNumCols () const
const VNumeric * getNumericPtr (std::string paramName) const
Get a pointer to a VNumeric value from the input row.
const VNumeric & getNumericRef (std::string paramName) const
Get a reference to a VNumeric value from the input row.
int getNumRows () const
std::vector getParamNames () const
Return the names of all parameters stored in this ParamReader.
const VString * getStringPtr (std::string paramName) const
Get a pointer to a VString value from the input row.
const VString & getStringRef (std::string paramName) const
Get a reference to an VString value from the input row.
const TimeADT * getTimePtr (std::string paramName) const
Get a pointer to a TIME value from the input row.
const TimeADT & getTimeRef (std::string paramName) const
Get a reference to a TIME value from the input row.
const Timestamp * getTimestampPtr (std::string paramName) const
Get a pointer to a TIMESTAMP value from the input row.
const Timestamp & getTimestampRef (std::string paramName) const
Get a reference to a TIMESTAMP value from the input row.
const TimestampTz * getTimestampTzPtr (std::string paramName) const
Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimestampTz & getTimestampTzRef (std::string paramName) const
Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimeTzADT * getTimeTzPtr (std::string paramName) const
Get a pointer to a TIME WITH TIMEZONE value from the input row.
const TimeTzADT & getTimeTzRef (std::string paramName) const
Get a reference to a TIME WITH TIMEZONE value from the input row.
VerticaType getType (std::string paramName) const
Return the type of the given parameter.
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
VUuid * getUuidPtr (std::string paramName) const
Get a pointer to a VUuid value from the input row.
const VUuid & getUuidRef (std::string paramName) const
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool isEmpty () const
Returns true if there are no parameters.
bool remaining () const
void setDataArea (size_t idx, void *dataarea)
Public Attributes
std::map paramNameToIndex
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers
Friends
class VerticaBlockSerializer

Detailed Description

Provides read access to a set of named parameters. This class provides type-specific methods to retrieve values.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by addParameter().

void Vertica::ParamReader::addParameter(std::string paramName, const char * arg, const VerticaType & dt)

inline Add a parameter to the block and stores it name and corresponding index in the paramNameToIndex map

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

const vbool* Vertica::ParamReader::getBoolPtr(std::string paramName) const

inline Get a pointer to a BOOLEAN value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a BOOLEAN.

Referenced by getBoolRef().

const vbool& Vertica::ParamReader::getBoolRef(std::string paramName) const

inline Get a reference to a BOOLEAN value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an BOOLEAN.

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

const DateADT* Vertica::ParamReader::getDatePtr(std::string paramName) const

inline Get a pointer to a DATE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a DATE.

Referenced by getDateRef().

const DateADT& Vertica::ParamReader::getDateRef(std::string paramName) const

inline Get a reference to a DATE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an DATE.

const vfloat* Vertica::ParamReader::getFloatPtr(std::string paramName) const

inline Get a pointer to a FLOAT value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a FLOAT.

Referenced by getFloatRef().

const vfloat& Vertica::ParamReader::getFloatRef(std::string paramName) const

inline Get a reference to a FLOAT value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A reference to the parameter value, cast as an FLOAT.

const Interval* Vertica::ParamReader::getIntervalPtr(std::string paramName) const

inline Get a pointer to an INTERVAL value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as an INTERVAL.

Referenced by getIntervalRef().

const Interval& Vertica::ParamReader::getIntervalRef(std::string paramName) const

inline Get a reference to an INTERVAL value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an INTERVAL.

const IntervalYM* Vertica::ParamReader::getIntervalYMPtr(std::string paramName) const

inline Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A point to the retrieved value cast as a INTERVAL YEAR TO MONTH.

Referenced by getIntervalYMRef().

const IntervalYM& Vertica::ParamReader::getIntervalYMRef(std::string paramName) const

inline Get a reference to an INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an INTERVAL YEAR TO MONTH.

const vint* Vertica::ParamReader::getIntPtr(std::string paramName) const

inline Get a pointer to an INTEGER value from the input row.

Returns a pointer to the idx'th argument, cast appropriately.

Parameters

  • paramName: The name of the parameter to retrieve

Example:

vint *a = arg_reader->getIntPtr("max");

Referenced by getIntRef().

const vint& Vertica::ParamReader::getIntRef(std::string paramName) const

inline Get a reference to an INTEGER value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an INTEGER.

Example:

vint a = arg_reader->getIntRef("max");

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

const VNumeric* Vertica::ParamReader::getNumericPtr(std::string paramName) const

inline Get a pointer to a VNumeric value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a Numeric.

Referenced by getNumericRef().

const VNumeric& Vertica::ParamReader::getNumericRef(std::string paramName) const

inline Get a reference to a VNumeric value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an VNumeric.

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

const VString* Vertica::ParamReader::getStringPtr(std::string paramName) const

inline Get a pointer to a VString value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a VString.

Referenced by getStringRef().

const VString& Vertica::ParamReader::getStringRef(std::string paramName) const

inline Get a reference to an VString value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an VString.

const TimeADT* Vertica::ParamReader::getTimePtr(std::string paramName) const

inline Get a pointer to a TIME value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIME.

Referenced by getTimeRef().

const TimeADT& Vertica::ParamReader::getTimeRef(std::string paramName) const

inline Get a reference to a TIME value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIME.

const Timestamp* Vertica::ParamReader::getTimestampPtr(std::string paramName) const

inline Get a pointer to a TIMESTAMP value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIMESTAMP.

Referenced by getTimestampRef().

const Timestamp& Vertica::ParamReader::getTimestampRef(std::string paramName) const

inline Get a reference to a TIMESTAMP value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIMESTAMP.

const TimestampTz* Vertica::ParamReader::getTimestampTzPtr(std::string paramName) const

inline Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIMESTAMP WITH TIMEZONE .

Referenced by getTimestampTzRef().

const TimestampTz& Vertica::ParamReader::getTimestampTzRef(std::string paramName) const

inline Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIMESTAMP WITH TIMEZONE.

const TimeTzADT* Vertica::ParamReader::getTimeTzPtr(std::string paramName) const

inline Get a pointer to a TIME WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIME WITH TIMEZONE.

Referenced by getTimeTzRef().

const TimeTzADT& Vertica::ParamReader::getTimeTzRef(std::string paramName) const

inline Get a reference to a TIME WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIME WITH TIMEZONE.

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

VUuid* Vertica::ParamReader::getUuidPtr(std::string paramName) const

inline Get a pointer to a VUuid value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a VUuid.

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

Member Data Documentation

std::map Vertica::ParamReader::paramNameToIndex

Bookkeepinp to make a parameter and its position in the block

Referenced by

1.1.151 - Vertica::ParamReader Member List

This is the complete list of members for Vertica::ParamReader, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
addParameter(std::string paramName, const char *arg, const VerticaType &dt) Vertica::ParamReader inline
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
containsParameter(std::string paramName) const Vertica::ParamReader inline
copy(const ParamReader &other) Vertica::ParamReader inline
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getBoolPtr(std::string paramName) const Vertica::ParamReader inline
getBoolRef(std::string paramName) const Vertica::ParamReader inline
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDatePtr(std::string paramName) const Vertica::ParamReader inline
getDateRef(std::string paramName) const Vertica::ParamReader inline
getFloatPtr(std::string paramName) const Vertica::ParamReader inline
getFloatRef(std::string paramName) const Vertica::ParamReader inline
getIndex(std::string paramName) const (defined in Vertica::ParamReader) Vertica::ParamReader inline
getIntervalPtr(std::string paramName) const Vertica::ParamReader inline
getIntervalRef(std::string paramName) const Vertica::ParamReader inline
getIntervalYMPtr(std::string paramName) const Vertica::ParamReader inline
getIntervalYMRef(std::string paramName) const Vertica::ParamReader inline
getIntPtr(std::string paramName) const Vertica::ParamReader inline
getIntRef(std::string paramName) const Vertica::ParamReader inline
getNumCols() const Vertica::VerticaBlock inline
getNumericPtr(std::string paramName) const Vertica::ParamReader inline
getNumericRef(std::string paramName) const Vertica::ParamReader inline
getNumRows() const Vertica::VerticaBlock inline
getParamNames() const Vertica::ParamReader inline
getStringPtr(std::string paramName) const Vertica::ParamReader inline
getStringRef(std::string paramName) const Vertica::ParamReader inline
getTimePtr(std::string paramName) const Vertica::ParamReader inline
getTimeRef(std::string paramName) const Vertica::ParamReader inline
getTimestampPtr(std::string paramName) const Vertica::ParamReader inline
getTimestampRef(std::string paramName) const Vertica::ParamReader inline
getTimestampTzPtr(std::string paramName) const Vertica::ParamReader inline
getTimestampTzRef(std::string paramName) const Vertica::ParamReader inline
getTimeTzPtr(std::string paramName) const Vertica::ParamReader inline
getTimeTzRef(std::string paramName) const Vertica::ParamReader inline
getType(std::string paramName) const Vertica::ParamReader inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidPtr(std::string paramName) const Vertica::ParamReader inline
getUuidRef(std::string paramName) const (defined in Vertica::ParamReader) Vertica::ParamReader inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
isEmpty() const Vertica::ParamReader inline
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
paramNameToIndex Vertica::ParamReader
ParamReader(size_t nparams) (defined in Vertica::ParamReader) Vertica::ParamReader inline
ParamReader() (defined in Vertica::ParamReader) Vertica::ParamReader inline
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
VerticaBlockSerializer (defined in Vertica::ParamReader) Vertica::ParamReader friend
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.152 - Vertica::ParamWriter Class Reference

Provides write access to a set of named parameters. This class extends ParamReader to add type-specific methods to write values.

Inheritance diagram for Vertica::ParamWriter:

Collaboration diagram for Vertica::ParamWriter:

Public Member Functions
ParamWriter (VTAllocator *allocator=NULL)
void addParameter (std::string paramName, const char *arg, const VerticaType &dt)
void clearParameter (std::string fieldName)
bool containsParameter (std::string paramName) const
Function to see if the ParamReader has a value for the parameter.
void copy (const VerticaBlock &other)
void copy (const ParamReader &other)
Copy the other ParamReader. Discard any existing parameters TODO: create an alternate version that only copies if this ParamReader is empty, is a no-op if they are non-empty and the same, and error if they are non-empty and different.
const vbool * getBoolPtr (std::string paramName) const
Get a pointer to a BOOLEAN value from the input row.
const vbool & getBoolRef (std::string paramName) const
Get a reference to a BOOLEAN value from the input row.
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
const DateADT * getDatePtr (std::string paramName) const
Get a pointer to a DATE value from the input row.
const DateADT & getDateRef (std::string paramName) const
Get a reference to a DATE value from the input row.
const vfloat * getFloatPtr (std::string paramName) const
Get a pointer to a FLOAT value from the input row.
const vfloat & getFloatRef (std::string paramName) const
Get a reference to a FLOAT value from the input row.
size_t getIndex (std::string paramName) const
const Interval * getIntervalPtr (std::string paramName) const
Get a pointer to an INTERVAL value from the input row.
const Interval & getIntervalRef (std::string paramName) const
Get a reference to an INTERVAL value from the input row.
const IntervalYM * getIntervalYMPtr (std::string paramName) const
Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.
const IntervalYM & getIntervalYMRef (std::string paramName) const
Get a reference to an INTERVAL YEAR TO MONTH value from the input row.
const vint * getIntPtr (std::string paramName) const
Get a pointer to an INTEGER value from the input row.
const vint & getIntRef (std::string paramName) const
Get a reference to an INTEGER value from the input row.
VString & getLongStringRef (std::string fieldName)
Allocates a new VString object to use as output. Sets it to be a 32mb LONG type by default.
size_t getNumCols () const
const VNumeric * getNumericPtr (std::string paramName) const
Get a pointer to a VNumeric value from the input row.
const VNumeric & getNumericRef (std::string paramName) const
Get a reference to a VNumeric value from the input row.
VNumeric & getNumericRef (std::string fieldName)
Allocate a new VNumeric object to use as output.
int getNumRows () const
std::vector getParamNames () const
Return the names of all parameters stored in this ParamReader.
const VString * getStringPtr (std::string paramName) const
Get a pointer to a VString value from the input row.
const VString & getStringRef (std::string paramName) const
Get a reference to an VString value from the input row.
VString & getStringRef (std::string fieldName)
Allocates a new VString object to use as output.
const TimeADT * getTimePtr (std::string paramName) const
Get a pointer to a TIME value from the input row.
const TimeADT & getTimeRef (std::string paramName) const
Get a reference to a TIME value from the input row.
const Timestamp * getTimestampPtr (std::string paramName) const
Get a pointer to a TIMESTAMP value from the input row.
const Timestamp & getTimestampRef (std::string paramName) const
Get a reference to a TIMESTAMP value from the input row.
const TimestampTz * getTimestampTzPtr (std::string paramName) const
Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimestampTz & getTimestampTzRef (std::string paramName) const
Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimeTzADT * getTimeTzPtr (std::string paramName) const
Get a pointer to a TIME WITH TIMEZONE value from the input row.
const TimeTzADT & getTimeTzRef (std::string paramName) const
Get a reference to a TIME WITH TIMEZONE value from the input row.
VerticaType getType (std::string paramName) const
Return the type of the given parameter.
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
VUuid * getUuidPtr (std::string paramName) const
Get a pointer to a VUuid value from the input row.
const VUuid & getUuidRef (std::string paramName) const
VUuid & getUuidRef (std::string fieldName)
Allocate a new VUuid object to use as output.
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool isEmpty () const
Returns true if there are no parameters.
bool remaining () const
void setAllocator (VTAllocator *allocator)
Sets the allocator to be used to allocate variable size param values such as VString. Given allocator live longer than this ParamWriter.
void setBool (std::string fieldName, vbool r)
Adds a BOOLEAN value to the output row.
void setDataArea (size_t idx, void *dataarea)
void setDate (std::string fieldName, DateADT r)
Adds a BOOLEAN value to the output row.
void setFloat (std::string fieldName, vfloat r)
Adds a FLOAT value to the output row.
void setInt (std::string fieldName, vint r)
Adds an INTEGER value to the output row.
void setInterval (std::string fieldName, Interval r, int32 precision, int32 range)
Adds an INTERVAL value to the output row.
void setIntervalYM (std::string fieldName, IntervalYM r, int32 range)
Adds an INTERVAL YEAR TO MONTH value to the output row.
void setTime (std::string fieldName, TimeADT r, int32 precision)
Adds a TIME value to the output row.
void setTimestamp (std::string fieldName, Timestamp r, int32 precision)
Adds a TIMESTAMP value to the output row.
void setTimestampTz (std::string fieldName, TimestampTz r, int32 precision)
Adds a TIMESTAMP WITH TIMEZONE value to the output row.
void setTimeTz (std::string fieldName, TimeTzADT r, int32 precision)
Adds a TIME WITH TIMEZONE value to the output row.
Public Attributes
std::map paramNameToIndex
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers
Friends
class VerticaBlockSerializer

Detailed Description

Provides write access to a set of named parameters. This class extends ParamReader to add type-specific methods to write values.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

void Vertica::ParamReader::addParameter(std::string paramName, const char * arg, const VerticaType & dt)

inline inherited Add a parameter to the block and stores it name and corresponding index in the paramNameToIndex map

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

const vbool* Vertica::ParamReader::getBoolPtr(std::string paramName) const

inline inherited Get a pointer to a BOOLEAN value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a BOOLEAN.

Referenced by Vertica::ParamReader::getBoolRef().

const vbool& Vertica::ParamReader::getBoolRef(std::string paramName) const

inline inherited Get a reference to a BOOLEAN value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an BOOLEAN.

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

const DateADT* Vertica::ParamReader::getDatePtr(std::string paramName) const

inline inherited Get a pointer to a DATE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a DATE.

Referenced by Vertica::ParamReader::getDateRef().

const DateADT& Vertica::ParamReader::getDateRef(std::string paramName) const

inline inherited Get a reference to a DATE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an DATE.

const vfloat* Vertica::ParamReader::getFloatPtr(std::string paramName) const

inline inherited Get a pointer to a FLOAT value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a FLOAT.

Referenced by Vertica::ParamReader::getFloatRef().

const vfloat& Vertica::ParamReader::getFloatRef(std::string paramName) const

inline inherited Get a reference to a FLOAT value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A reference to the parameter value, cast as an FLOAT.

const Interval* Vertica::ParamReader::getIntervalPtr(std::string paramName) const

inline inherited Get a pointer to an INTERVAL value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as an INTERVAL.

Referenced by Vertica::ParamReader::getIntervalRef().

const Interval& Vertica::ParamReader::getIntervalRef(std::string paramName) const

inline inherited Get a reference to an INTERVAL value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an INTERVAL.

const IntervalYM* Vertica::ParamReader::getIntervalYMPtr(std::string paramName) const

inline inherited Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A point to the retrieved value cast as a INTERVAL YEAR TO MONTH.

Referenced by Vertica::ParamReader::getIntervalYMRef().

const IntervalYM& Vertica::ParamReader::getIntervalYMRef(std::string paramName) const

inline inherited Get a reference to an INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an INTERVAL YEAR TO MONTH.

const vint* Vertica::ParamReader::getIntPtr(std::string paramName) const

inline inherited Get a pointer to an INTEGER value from the input row.

Returns a pointer to the idx'th argument, cast appropriately.

Parameters

  • paramName: The name of the parameter to retrieve

Example:

vint *a = arg_reader->getIntPtr("max");

Referenced by Vertica::ParamReader::getIntRef().

const vint& Vertica::ParamReader::getIntRef(std::string paramName) const

inline inherited Get a reference to an INTEGER value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an INTEGER.

Example:

vint a = arg_reader->getIntRef("max");

VString& Vertica::ParamWriter::getLongStringRef(std::string fieldName)

inline Allocates a new VString object to use as output. Sets it to be a 32mb LONG type by default.

Returns A new VString object to hold output. This object automatically added to the output row.

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

const VNumeric* Vertica::ParamReader::getNumericPtr(std::string paramName) const

inline inherited Get a pointer to a VNumeric value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a Numeric.

Referenced by Vertica::ParamReader::getNumericRef().

const VNumeric& Vertica::ParamReader::getNumericRef(std::string paramName) const

inline inherited Get a reference to a VNumeric value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an VNumeric.

VNumeric& Vertica::ParamWriter::getNumericRef(std::string fieldName)

inline Allocate a new VNumeric object to use as output.

Returns A new VNumeric object to hold output. This object automatically added to the output row.

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

const VString* Vertica::ParamReader::getStringPtr(std::string paramName) const

inline inherited Get a pointer to a VString value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a VString.

Referenced by Vertica::ParamReader::getStringRef().

const VString& Vertica::ParamReader::getStringRef(std::string paramName) const

inline inherited Get a reference to an VString value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as an VString.

VString& Vertica::ParamWriter::getStringRef(std::string fieldName)

inline Allocates a new VString object to use as output.

Returns A new VString object to hold output. This object automatically added to the output row.

const TimeADT* Vertica::ParamReader::getTimePtr(std::string paramName) const

inline inherited Get a pointer to a TIME value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIME.

Referenced by Vertica::ParamReader::getTimeRef().

const TimeADT& Vertica::ParamReader::getTimeRef(std::string paramName) const

inline inherited Get a reference to a TIME value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIME.

const Timestamp* Vertica::ParamReader::getTimestampPtr(std::string paramName) const

inline inherited Get a pointer to a TIMESTAMP value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIMESTAMP.

Referenced by Vertica::ParamReader::getTimestampRef().

const Timestamp& Vertica::ParamReader::getTimestampRef(std::string paramName) const

inline inherited Get a reference to a TIMESTAMP value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIMESTAMP.

const TimestampTz* Vertica::ParamReader::getTimestampTzPtr(std::string paramName) const

inline inherited Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIMESTAMP WITH TIMEZONE .

Referenced by Vertica::ParamReader::getTimestampTzRef().

const TimestampTz& Vertica::ParamReader::getTimestampTzRef(std::string paramName) const

inline inherited Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIMESTAMP WITH TIMEZONE.

const TimeTzADT* Vertica::ParamReader::getTimeTzPtr(std::string paramName) const

inline inherited Get a pointer to a TIME WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a TIME WITH TIMEZONE.

Referenced by Vertica::ParamReader::getTimeTzRef().

const TimeTzADT& Vertica::ParamReader::getTimeTzRef(std::string paramName) const

inline inherited Get a reference to a TIME WITH TIMEZONE value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns a reference to the parameter value, cast as a TIME WITH TIMEZONE.

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

VUuid* Vertica::ParamReader::getUuidPtr(std::string paramName) const

inline inherited Get a pointer to a VUuid value from the input row.

Parameters

  • paramName: The name of the parameter to retrieve

Returns A pointer to the retrieved value cast as a VUuid.

VUuid& Vertica::ParamWriter::getUuidRef(std::string fieldName)

inline Allocate a new VUuid object to use as output.

Returns A new VUuid object to hold output. This object automatically added to the output row.

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

void Vertica::ParamWriter::setAllocator(VTAllocator * allocator)

inline Sets the allocator to be used to allocate variable size param values such as VString. Given allocator live longer than this ParamWriter.

Parameters

  • allocator: Used to allocate param values.
void Vertica::ParamWriter::setBool(std::string fieldName, vbool r)

inline Adds a BOOLEAN value to the output row.

Parameters

  • r: The BOOLEAN value to insert into the output row.
void Vertica::ParamWriter::setDate(std::string fieldName, DateADT r)

inline Adds a BOOLEAN value to the output row.

Parameters

  • r: The BOOLEAN value to insert into the output row.
void Vertica::ParamWriter::setFloat(std::string fieldName, vfloat r)

inline Adds a FLOAT value to the output row.

Parameters

  • r: The FLOAT value to insert into the output row.
void Vertica::ParamWriter::setInt(std::string fieldName, vint r)

inline Adds an INTEGER value to the output row.

Setter methods

Parameters

  • r: The INTEGER value to insert into the output row.
void Vertica::ParamWriter::setInterval(std::string fieldName, Interval r, int32 precision, int32 range)

inline Adds an INTERVAL value to the output row.

Parameters

  • r: The INTERVAL value to insert into the output row.
void Vertica::ParamWriter::setIntervalYM(std::string fieldName, IntervalYM r, int32 range)

inline Adds an INTERVAL YEAR TO MONTH value to the output row.

Parameters

  • r: The INTERVAL YEAR TO MONTH value to insert into the output row.
void Vertica::ParamWriter::setTime(std::string fieldName, TimeADT r, int32 precision)

inline Adds a TIME value to the output row.

Parameters

  • r: The TIME value to insert into the output row.
void Vertica::ParamWriter::setTimestamp(std::string fieldName, Timestamp r, int32 precision)

inline Adds a TIMESTAMP value to the output row.

Parameters

  • r: The TIMESTAMP value to insert into the output row.
void Vertica::ParamWriter::setTimestampTz(std::string fieldName, TimestampTz r, int32 precision)

inline Adds a TIMESTAMP WITH TIMEZONE value to the output row.

Parameters

  • r: The TIMESTAMP WITH TIMEZONE value to insert into the output row.
void Vertica::ParamWriter::setTimeTz(std::string fieldName, TimeTzADT r, int32 precision)

inline Adds a TIME WITH TIMEZONE value to the output row.

Parameters

  • r: The TIME WITH TIMEZONE value to insert into the output row.

Member Data Documentation

std::map Vertica::ParamReader::paramNameToIndex

inherited Bookkeepinp to make a parameter and its position in the block

Referenced by

1.1.153 - Vertica::ParamWriter Member List

This is the complete list of members for Vertica::ParamWriter, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
addParameter(std::string paramName, const char *arg, const VerticaType &dt) Vertica::ParamReader inline
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
clearParameter(std::string fieldName) (defined in Vertica::ParamWriter) Vertica::ParamWriter inline
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
containsParameter(std::string paramName) const Vertica::ParamReader inline
copy(const ParamReader &other) Vertica::ParamReader inline
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getBoolPtr(std::string paramName) const Vertica::ParamReader inline
getBoolRef(std::string paramName) const Vertica::ParamReader inline
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDatePtr(std::string paramName) const Vertica::ParamReader inline
getDateRef(std::string paramName) const Vertica::ParamReader inline
getFloatPtr(std::string paramName) const Vertica::ParamReader inline
getFloatRef(std::string paramName) const Vertica::ParamReader inline
getIndex(std::string paramName) const (defined in Vertica::ParamReader) Vertica::ParamReader inline
getIntervalPtr(std::string paramName) const Vertica::ParamReader inline
getIntervalRef(std::string paramName) const Vertica::ParamReader inline
getIntervalYMPtr(std::string paramName) const Vertica::ParamReader inline
getIntervalYMRef(std::string paramName) const Vertica::ParamReader inline
getIntPtr(std::string paramName) const Vertica::ParamReader inline
getIntRef(std::string paramName) const Vertica::ParamReader inline
getLongStringRef(std::string fieldName) Vertica::ParamWriter inline
getNumCols() const Vertica::VerticaBlock inline
getNumericPtr(std::string paramName) const Vertica::ParamReader inline
getNumericRef(std::string fieldName) Vertica::ParamWriter inline
Vertica::ParamReader::getNumericRef(std::string paramName) const Vertica::ParamReader inline
getNumRows() const Vertica::VerticaBlock inline
getParamNames() const Vertica::ParamReader inline
getStringPtr(std::string paramName) const Vertica::ParamReader inline
getStringRef(std::string fieldName) Vertica::ParamWriter inline
Vertica::ParamReader::getStringRef(std::string paramName) const Vertica::ParamReader inline
getTimePtr(std::string paramName) const Vertica::ParamReader inline
getTimeRef(std::string paramName) const Vertica::ParamReader inline
getTimestampPtr(std::string paramName) const Vertica::ParamReader inline
getTimestampRef(std::string paramName) const Vertica::ParamReader inline
getTimestampTzPtr(std::string paramName) const Vertica::ParamReader inline
getTimestampTzRef(std::string paramName) const Vertica::ParamReader inline
getTimeTzPtr(std::string paramName) const Vertica::ParamReader inline
getTimeTzRef(std::string paramName) const Vertica::ParamReader inline
getType(std::string paramName) const Vertica::ParamReader inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidPtr(std::string paramName) const Vertica::ParamReader inline
getUuidRef(std::string fieldName) Vertica::ParamWriter inline
getUuidRef(std::string paramName) const (defined in Vertica::ParamReader) Vertica::ParamReader inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
isEmpty() const Vertica::ParamReader inline
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
paramNameToIndex Vertica::ParamReader
ParamReader(size_t nparams) (defined in Vertica::ParamReader) Vertica::ParamReader inline
ParamReader() (defined in Vertica::ParamReader) Vertica::ParamReader inline
ParamWriter(VTAllocator *allocator=NULL) (defined in Vertica::ParamWriter) Vertica::ParamWriter inline
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setAllocator(VTAllocator *allocator) Vertica::ParamWriter inline
setBool(std::string fieldName, vbool r) Vertica::ParamWriter inline
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setDate(std::string fieldName, DateADT r) Vertica::ParamWriter inline
setFloat(std::string fieldName, vfloat r) Vertica::ParamWriter inline
setInt(std::string fieldName, vint r) Vertica::ParamWriter inline
setInterval(std::string fieldName, Interval r, int32 precision, int32 range) Vertica::ParamWriter inline
setIntervalYM(std::string fieldName, IntervalYM r, int32 range) Vertica::ParamWriter inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setTime(std::string fieldName, TimeADT r, int32 precision) Vertica::ParamWriter inline
setTimestamp(std::string fieldName, Timestamp r, int32 precision) Vertica::ParamWriter inline
setTimestampTz(std::string fieldName, TimestampTz r, int32 precision) Vertica::ParamWriter inline
setTimeTz(std::string fieldName, TimeTzADT r, int32 precision) Vertica::ParamWriter inline
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
VerticaBlockSerializer (defined in Vertica::ParamWriter) Vertica::ParamWriter friend
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.154 - Vertica::ParserFactory Class Reference

Produces and initializes UDParsers to parse input into tuples.

Inheritance diagram for Vertica::ParserFactory:

Collaboration diagram for Vertica::ParserFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes) override
virtual void getParserReturnType (ServerInterface &srvInterface, PerColumnParamReader &perColumnParamReader, PlanContext &planCtxt, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res) override
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override
UDXFactory::UDXType getUDXFactoryType () override
virtual bool isChunkerApportionable (ServerInterface &srvInterface)
virtual bool isParserApportionable ()
virtual void plan (ServerInterface &srvInterface, PerColumnParamReader &perColumnParamReader, PlanContext &planCtxt)
virtual UDParser * prepare (ServerInterface &srvInterface, PerColumnParamReader &perColumnParamReader, PlanContext &planCtxt, const SizedColumnTypes &returnType)=0
virtual UDChunker * prepareChunker (ServerInterface &srvInterface, PerColumnParamReader &perColumnParamReader, PlanContext &planCtxt, const SizedColumnTypes &returnType)
Protected Attributes
Oid libOid
std::string sqlName

Detailed Description

Produces and initializes UDParsers to parse input into tuples.

Note that ParserFactories are singletons. Subclasses should be stateless, with no fields containing data, just methods. plan() and prepare() methods must never modify any global variables or state; they may only modify the variables that they are given as arguments. (If global state must be modified, use SourceIterator.)

Factories should be registered using the RegisterFactory() macro, defined in Vertica.h.

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual void Vertica::ParserFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtual

Inherited from the parent "UDXFactory" class in VerticaUDx.h

Reimplemented from Vertica::UDXFactory.

virtual void Vertica::ParserFactory::getParserReturnType(ServerInterface & srvInterface, PerColumnParamReader & perColumnParamReader, PlanContext & planCtxt, const SizedColumnTypes & argTypes, SizedColumnTypes & returnType)

inlinevirtual

Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are. Called, possibly multiple times, on each node executing the query.

The default provided implementation configures Vertica to use the same output column types as the destination table. This requires that the UDParser validate the expected output column types and emit appropriate tuples. Note that the default provided implementation of this function should be sufficient for most Parsers, so this method should not be overridden by most Parser implementations. If a COPY statement has a return type that doesn't match the destination table, Vertica will emit an appropriate error. Users can use COPY expressions to perform typecasting and conversion if necessary.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time/Timestamp types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • perColumnParamReader: Per-column parameters passed into the query
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().
  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.
virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented from Vertica::UDXFactory.

Referenced by Vertica::UDLFactory::getPerInstanceResources().

virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented from Vertica::UDXFactory.

UDXFactory::UDXType Vertica::ParserFactory::getUDXFactoryType()

inlinevirtual

Returns the type of UDX Object instance this factory returns.

Note User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Implements Vertica::UDXFactory.

virtual bool Vertica::ParserFactory::isChunkerApportionable(ServerInterface & srvInterface)

inlinevirtual

Return true if this factory returns a UDChunker that implements alignPortion() and knows what to do with InputState END_OF_PORTION. Such a chunker can start at some offset into a source and chunk just a portion of it.

This does not have to be the same as isParserApportionable() - the two methods can return true/false independent of each other.

virtual bool Vertica::ParserFactory::isParserApportionable()

inlinevirtual

Return true if this factory returns an UDParser that knows what to do with InputState START_OF_PORTION and END_OF_PORTION. Such a parser can start at some offset into that source and parse just a portion of it

(this func only called by SDK parsers)

virtual void Vertica::ParserFactory::plan(ServerInterface & srvInterface, PerColumnParamReader & perColumnParamReader, PlanContext & planCtxt)

inlinevirtual

Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on (through srvInterface).

plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • perColumnParamReader: Per-column parameters passed into the query
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().
virtual UDParser* Vertica::ParserFactory::prepare(ServerInterface & srvInterface, PerColumnParamReader & perColumnParamReader, PlanContext & planCtxt, const SizedColumnTypes & returnType)

pure virtual Instantiate a UDParser instance. This function will be called on each node, prior to the Load operator starting to execute.

'planData' contains the same data that was placed there by the plan() static method.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • perColumnParamReader: Per-column parameters passed into the query
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().
  • returnType: The data types of the columns that this Parser must produce

Returns The UDParser instance to be used by this query

1.1.155 - Vertica::ParserFactory Member List

This is the complete list of members for Vertica::ParserFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) override Vertica::ParserFactory inlinevirtual
getParserReturnType(ServerInterface &srvInterface, PerColumnParamReader &perColumnParamReader, PlanContext &planCtxt, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType) Vertica::ParserFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) override Vertica::UDLFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override Vertica::UDLFactory inlinevirtual
getUDXFactoryType() override Vertica::ParserFactory inlinevirtual
isChunkerApportionable(ServerInterface &srvInterface) Vertica::ParserFactory inlinevirtual
isParserApportionable() Vertica::ParserFactory inlinevirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
plan(ServerInterface &srvInterface, PerColumnParamReader &perColumnParamReader, PlanContext &planCtxt) Vertica::ParserFactory inlinevirtual
prepare(ServerInterface &srvInterface, PerColumnParamReader &perColumnParamReader, PlanContext &planCtxt, const SizedColumnTypes &returnType)=0 Vertica::ParserFactory pure virtual
prepareChunker(ServerInterface &srvInterface, PerColumnParamReader &perColumnParamReader, PlanContext &planCtxt, const SizedColumnTypes &returnType) (defined in Vertica::ParserFactory) Vertica::ParserFactory inlinevirtual
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~UDLFactory() (defined in Vertica::UDLFactory) Vertica::UDLFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.156 - Vertica::PartitionOrderColumnInfo Member List

This is the complete list of members for Vertica::PartitionOrderColumnInfo, including all inherited members.

last_order_col (defined in Vertica::PartitionOrderColumnInfo) Vertica::PartitionOrderColumnInfo
last_partition_col (defined in Vertica::PartitionOrderColumnInfo) Vertica::PartitionOrderColumnInfo
PartitionOrderColumnInfo() (defined in Vertica::PartitionOrderColumnInfo) Vertica::PartitionOrderColumnInfo inline

1.1.157 - Vertica::PartitionOrderColumnInfo Struct Reference

Represents the partition by and order by column information for each phase in a multi-phase transform function.

Collaboration diagram for Vertica::PartitionOrderColumnInfo:

Public Attributes
int last_order_col
int last_partition_col

Detailed Description

Represents the partition by and order by column information for each phase in a multi-phase transform function.

1.1.158 - Vertica::PartitionReader Class Reference

provides an iterator-based read interface over all input data in a single partition. Automatically fetches data a block-at-a-time, as needed.

Inheritance diagram for Vertica::PartitionReader:

Collaboration diagram for Vertica::PartitionReader:

Public Member Functions
PartitionReader (size_t narg)
PartitionReader (size_t narg, EE::UserDefinedProcess *udx_object)
void copy (const VerticaBlock &other)
Array::ArrayReader getArrayRef (size_t idx) const
Get a reference to an Array value from the input row.
const vbool * getBoolPtr (size_t idx) const
Get a pointer to a BOOLEAN value from the input row.
const vbool & getBoolRef (size_t idx) const
Get a reference to a BOOLEAN value from the input row.
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
const DateADT * getDatePtr (size_t idx) const
Get a pointer to a DATE value from the input row.
const DateADT & getDateRef (size_t idx) const
Get a reference to a DATE value from the input row.
const vfloat * getFloatPtr (size_t idx) const
Get a pointer to a FLOAT value from the input row.
const vfloat & getFloatRef (size_t idx) const
Get a reference to a FLOAT value from the input row.
const Interval * getIntervalPtr (size_t idx) const
Get a pointer to an INTERVAL value from the input row.
const Interval & getIntervalRef (size_t idx) const
Get a reference to an INTERVAL value from the input row.
const IntervalYM * getIntervalYMPtr (size_t idx) const
Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.
const IntervalYM & getIntervalYMRef (size_t idx) const
Get a reference to an INTERVAL YEAR TO MONTH value from the input row.
const vint * getIntPtr (size_t idx) const
Get a pointer to an INTEGER value from the input row.
const vint & getIntRef (size_t idx) const
Get a reference to an INTEGER value from the input row.
size_t getNumCols () const
const VNumeric * getNumericPtr (size_t idx) const
Get a pointer to a VNumeric value from the input row.
const VNumeric & getNumericRef (size_t idx) const
Get a reference to a VNumeric value from the input row.
int getNumRows () const
int getPosition () const
const BlockReader * getRowPtr (size_t idx) const
Get a reference to a Row value from the input row.
const BlockReader & getRowRef (size_t idx) const
Get a reference to a Row value from the input row.
const VString * getStringPtr (size_t idx) const
Get a pointer to a VString value from the input row.
const VString & getStringRef (size_t idx) const
Get a reference to an VString value from the input row.
const TimeADT * getTimePtr (size_t idx) const
Get a pointer to a TIME value from the input row.
const TimeADT & getTimeRef (size_t idx) const
Get a reference to a TIME value from the input row.
const Timestamp * getTimestampPtr (size_t idx) const
Get a pointer to a TIMESTAMP value from the input row.
const Timestamp & getTimestampRef (size_t idx) const
Get a reference to a TIMESTAMP value from the input row.
const TimestampTz * getTimestampTzPtr (size_t idx) const
Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimestampTz & getTimestampTzRef (size_t idx) const
Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.
const TimeTzADT * getTimeTzPtr (size_t idx) const
Get a pointer to a TIME WITH TIMEZONE value from the input row.
const TimeTzADT & getTimeTzRef (size_t idx) const
Get a reference to a TIME WITH TIMEZONE value from the input row.
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
const VUuid * getUuidPtr (size_t idx) const
Get a pointer to a VUuid value from the input row.
const VUuid & getUuidRef (size_t idx) const
Get a reference to a VUuid value from the input row.
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool hasData () const
bool hasMoreData ()
bool isNull (int col) const
Check if the idx'th argument is null.
bool next ()
virtual bool readNextBlock ()
bool remaining () const
void setDataArea (size_t idx, void *dataarea)
bool willFetchBlockOnNext ()
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool advanceToNextRow (bool recurIntoArrays)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void resetIndex ()
void setRowCount (int rowCount)
virtual void setupColsAndStrides ()
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
union {
EE::UserDefinedAnalytic * udan
EE::UserDefinedTransform * udt
EE::UserDefinedProcess * udx_object
};
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
EE::DataHolder * dh
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
vpos pstart
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers
Friends
class EE::UserDefinedAnalytic
class EE::UserDefinedProcess
class EE::UserDefinedTransform
struct FullPartition
class VerticaBlockSerializer

Detailed Description

provides an iterator-based read interface over all input data in a single partition. Automatically fetches data a block-at-a-time, as needed.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

Array::ArrayReader Vertica::BlockReader::getArrayRef(size_t idx) const

inherited Get a reference to an Array value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument: another BlockReader which reads elements of the array.

const vbool* Vertica::BlockReader::getBoolPtr(size_t idx) const

inline inherited Get a pointer to a BOOLEAN value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a BOOLEAN.

Referenced by Vertica::BlockReader::getBoolRef().

const vbool& Vertica::BlockReader::getBoolRef(size_t idx) const

inline inherited Get a reference to a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an BOOLEAN.

Referenced by Vertica::BlockReader::isNull().

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

const DateADT* Vertica::BlockReader::getDatePtr(size_t idx) const

inline inherited Get a pointer to a DATE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a DATE.

Referenced by Vertica::BlockReader::getDateRef().

const DateADT& Vertica::BlockReader::getDateRef(size_t idx) const

inline inherited Get a reference to a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an DATE.

Referenced by Vertica::BlockReader::isNull().

const vfloat* Vertica::BlockReader::getFloatPtr(size_t idx) const

inline inherited Get a pointer to a FLOAT value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a FLOAT.

Referenced by Vertica::BlockReader::getFloatRef().

const vfloat& Vertica::BlockReader::getFloatRef(size_t idx) const

inline inherited Get a reference to a FLOAT value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the idx'th argument, cast as an FLOAT.

Referenced by Vertica::BlockReader::isNull().

const Interval* Vertica::BlockReader::getIntervalPtr(size_t idx) const

inline inherited Get a pointer to an INTERVAL value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as an INTERVAL.

Referenced by Vertica::BlockReader::getIntervalRef().

const Interval& Vertica::BlockReader::getIntervalRef(size_t idx) const

inline inherited Get a reference to an INTERVAL value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTERVAL.

Referenced by Vertica::BlockReader::isNull().

const IntervalYM* Vertica::BlockReader::getIntervalYMPtr(size_t idx) const

inline inherited Get a pointer to a INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A point to the retrieved value cast as a INTERVAL YEAR TO MONTH.

Referenced by Vertica::BlockReader::getIntervalYMRef().

const IntervalYM& Vertica::BlockReader::getIntervalYMRef(size_t idx) const

inline inherited Get a reference to an INTERVAL YEAR TO MONTH value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTERVAL YEAR TO MONTH.

Referenced by Vertica::BlockReader::isNull().

const vint* Vertica::BlockReader::getIntPtr(size_t idx) const

inline inherited Get a pointer to an INTEGER value from the input row.

Returns a pointer to the idx'th argument, cast appropriately.

Parameters

  • idx: The column number to retrieve from the input row.

Example:

const vint *a = arg_reader->getIntPtr(0);

Referenced by Vertica::BlockReader::getIntRef().

const vint& Vertica::BlockReader::getIntRef(size_t idx) const

inline inherited Get a reference to an INTEGER value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an INTEGER.

Example:

const vint a = arg_reader->getIntRef(0);

Referenced by Vertica::BlockReader::isNull().

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

const VNumeric* Vertica::BlockReader::getNumericPtr(size_t idx) const

inline inherited Get a pointer to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a Numeric.

Referenced by Vertica::BlockReader::getNumericRef().

const VNumeric& Vertica::BlockReader::getNumericRef(size_t idx) const

inline inherited Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VNumeric.

Referenced by Vertica::BlockReader::isNull().

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

int Vertica::BlockReader::getPosition() const

inline inherited Returns the current row position or array index

const BlockReader* Vertica::BlockReader::getRowPtr(size_t idx) const

inline inherited Get a reference to a Row value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a pointer to a reader for the Row fields

Referenced by Vertica::BlockReader::getRowRef().

const BlockReader& Vertica::BlockReader::getRowRef(size_t idx) const

inline inherited Get a reference to a Row value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, as a Row value.

const VString* Vertica::BlockReader::getStringPtr(size_t idx) const

inline inherited Get a pointer to a VString value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a VString.

Referenced by Vertica::BlockReader::getStringRef().

const VString& Vertica::BlockReader::getStringRef(size_t idx) const

inline inherited Get a reference to an VString value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by Vertica::BlockReader::isNull().

const TimeADT* Vertica::BlockReader::getTimePtr(size_t idx) const

inline inherited Get a pointer to a TIME value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIME.

Referenced by Vertica::BlockReader::getTimeRef().

const TimeADT& Vertica::BlockReader::getTimeRef(size_t idx) const

inline inherited Get a reference to a TIME value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIME.

Referenced by Vertica::BlockReader::isNull().

const Timestamp* Vertica::BlockReader::getTimestampPtr(size_t idx) const

inline inherited Get a pointer to a TIMESTAMP value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP.

Referenced by Vertica::BlockReader::getTimestampRef().

const Timestamp& Vertica::BlockReader::getTimestampRef(size_t idx) const

inline inherited Get a reference to a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIMESTAMP.

Referenced by Vertica::BlockReader::isNull().

const TimestampTz* Vertica::BlockReader::getTimestampTzPtr(size_t idx) const

inline inherited Get a pointer to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIMESTAMP WITH TIMEZONE .

Referenced by Vertica::BlockReader::getTimestampTzRef().

const TimestampTz& Vertica::BlockReader::getTimestampTzRef(size_t idx) const

inline inherited Get a reference to a TIMESTAMP WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIMESTAMP WITH TIMEZONE.

Referenced by Vertica::BlockReader::isNull().

const TimeTzADT* Vertica::BlockReader::getTimeTzPtr(size_t idx) const

inline inherited Get a pointer to a TIME WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number in the input row to retrieve.

Returns A pointer to the retrieved value cast as a TIME WITH TIMEZONE.

Referenced by Vertica::BlockReader::getTimeTzRef().

const TimeTzADT& Vertica::BlockReader::getTimeTzRef(size_t idx) const

inline inherited Get a reference to a TIME WITH TIMEZONE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as a TIME WITH TIMEZONE.

Referenced by Vertica::BlockReader::isNull().

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

const VUuid* Vertica::BlockReader::getUuidPtr(size_t idx) const

inline inherited Get a pointer to a VUuid value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A pointer to the retrieved value cast as a VUuid.

Referenced by Vertica::BlockReader::getUuidRef().

const VUuid& Vertica::BlockReader::getUuidRef(size_t idx) const

inline inherited Get a reference to a VUuid value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VUuid.

Referenced by Vertica::BlockReader::isNull().

bool Vertica::BlockReader::hasData() const

inline inherited Returns true if there is data available

Referenced by Vertica::copyBlockColumn().

bool Vertica::BlockReader::isNull(int col) const

inline inherited Check if the idx'th argument is null.

Parameters

  • col: The column number in the row to check for null

Returns true is the col value is null false otherwise

virtual bool Vertica::PartitionReader::readNextBlock()

virtual

Reads in the next block of data and positions cursor at the beginning.

Returns false if there's no more input data

Reimplemented in Vertica::AnalyticPartitionReader.

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

1.1.159 - Vertica::PartitionReader Member List

This is the complete list of members for Vertica::PartitionReader, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
advanceToNextRow(bool recurIntoArrays) (defined in Vertica::BlockReader) Vertica::BlockReader inlineprotected
BlockReader(size_t narg, int rowcount, const int *indices) (defined in Vertica::BlockReader) Vertica::BlockReader inline
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
dh (defined in Vertica::PartitionReader) Vertica::PartitionReader protected
EE::UserDefinedAnalytic (defined in Vertica::PartitionReader) Vertica::PartitionReader friend
EE::UserDefinedProcess (defined in Vertica::PartitionReader) Vertica::PartitionReader friend
EE::UserDefinedTransform (defined in Vertica::PartitionReader) Vertica::PartitionReader friend
FullPartition (defined in Vertica::PartitionReader) Vertica::PartitionReader friend
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getArrayRef(size_t idx) const Vertica::BlockReader
getBoolPtr(size_t idx) const Vertica::BlockReader inline
getBoolRef(size_t idx) const Vertica::BlockReader inline
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDatePtr(size_t idx) const Vertica::BlockReader inline
getDateRef(size_t idx) const Vertica::BlockReader inline
getFloatPtr(size_t idx) const Vertica::BlockReader inline
getFloatRef(size_t idx) const Vertica::BlockReader inline
getIntervalPtr(size_t idx) const Vertica::BlockReader inline
getIntervalRef(size_t idx) const Vertica::BlockReader inline
getIntervalYMPtr(size_t idx) const Vertica::BlockReader inline
getIntervalYMRef(size_t idx) const Vertica::BlockReader inline
getIntPtr(size_t idx) const Vertica::BlockReader inline
getIntRef(size_t idx) const Vertica::BlockReader inline
getNumCols() const Vertica::VerticaBlock inline
getNumericPtr(size_t idx) const Vertica::BlockReader inline
getNumericRef(size_t idx) const Vertica::BlockReader inline
getNumRows() const Vertica::VerticaBlock inline
getPosition() const Vertica::BlockReader inline
getRowPtr(size_t idx) const Vertica::BlockReader inline
getRowRef(size_t idx) const Vertica::BlockReader inline
getStringPtr(size_t idx) const Vertica::BlockReader inline
getStringRef(size_t idx) const Vertica::BlockReader inline
getTimePtr(size_t idx) const Vertica::BlockReader inline
getTimeRef(size_t idx) const Vertica::BlockReader inline
getTimestampPtr(size_t idx) const Vertica::BlockReader inline
getTimestampRef(size_t idx) const Vertica::BlockReader inline
getTimestampTzPtr(size_t idx) const Vertica::BlockReader inline
getTimestampTzRef(size_t idx) const Vertica::BlockReader inline
getTimeTzPtr(size_t idx) const Vertica::BlockReader inline
getTimeTzRef(size_t idx) const Vertica::BlockReader inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidPtr(size_t idx) const Vertica::BlockReader inline
getUuidRef(size_t idx) const Vertica::BlockReader inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
hasData() const Vertica::BlockReader inline
hasMoreData() (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
isNull(int col) const Vertica::BlockReader inline
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
next() (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
PartitionReader(size_t narg) (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
PartitionReader(size_t narg, EE::UserDefinedProcess *udx_object) (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
pstart (defined in Vertica::PartitionReader) Vertica::PartitionReader protected
readNextBlock() Vertica::PartitionReader virtual
remaining() const Vertica::VerticaBlock inline
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setupColsAndStrides() (defined in Vertica::PartitionReader) Vertica::PartitionReader protectedvirtual
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
udan (defined in Vertica::PartitionReader) Vertica::PartitionReader
udt (defined in Vertica::PartitionReader) Vertica::PartitionReader
udx_object (defined in Vertica::PartitionReader) Vertica::PartitionReader
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
VerticaBlockSerializer (defined in Vertica::PartitionReader) Vertica::PartitionReader friend
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
willFetchBlockOnNext() (defined in Vertica::PartitionReader) Vertica::PartitionReader inline
~PartitionReader() (defined in Vertica::PartitionReader) Vertica::PartitionReader inlinevirtual
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.160 - Vertica::PartitionWriter Class Reference

Provides an iterator-based write interface over output data for a single partition. Automatically makes space a block-at-a-time, as needed.

Inheritance diagram for Vertica::PartitionWriter:

Collaboration diagram for Vertica::PartitionWriter:

Public Member Functions
PartitionWriter (size_t narg)
PartitionWriter (size_t narg, EE::UserDefinedProcess *udx_object)
PartitionWriter (size_t narg, size_t nrows, EE::UserDefinedProcess *udx_object)
void copy (const VerticaBlock &other)
void copyFromInput (size_t dstIdx, const BlockReader &input_reader, size_t srcIdx)
void copyFromInput (const BlockReader &input_reader)
Array::ArrayWriter getArrayRef (size_t idx)
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
PartitionWriterColumns getColumns ()
const EE::DataArea * getDataArea (size_t idx) const
size_t getNumCols () const
VNumeric & getNumericRef (size_t idx)
int getNumRows () const
BlockWriter * getRowPtr (size_t idx)
BlockWriter & getRowRef (size_t idx)
Get a reference for writing an output Row value.
VString & getStringRef (size_t idx)
VString & getStringRefNoClear (size_t idx)
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
VUuid & getUuidRef (size_t idx)
const void * getVoidPtr (size_t idx=0) const
void * getVoidPtr (size_t idx)
virtual bool getWriteableBlock ()
bool next ()
bool remaining () const
void setBool (size_t idx, vbool r)
void setDataArea (size_t idx, void *dataarea)
void setDate (size_t idx, DateADT r)
void setFloat (size_t idx, vfloat r)
void setInt (size_t idx, vint r)
void setInterval (size_t idx, Interval r)
void setIntervalYM (size_t idx, IntervalYM r)
void setNull (size_t idx)
Set the idx'th argument to null. If a column has the canBeNull attribute set to false, then this throws an exception.
void setNull (size_t idx, bool enforceNotNullProperty)
Set the idx'th argument to null.
void setTime (size_t idx, TimeADT r)
void setTimestamp (size_t idx, Timestamp r)
void setTimestampTz (size_t idx, TimestampTz r)
void setTimeTz (size_t idx, TimeTzADT r)
void throwIncorrectUsageError (size_t idx)
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
bool commitPrefilledRows (int nRows)
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
union {
EE::UserDefinedAnalytic * udan
EE::UserDefinedTransform * udt
EE::UserDefinedProcess * udx_object
};
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
int pstart
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers
Friends
class EE::Loader::UserDefinedLoad
class EE::UserDefinedAnalytic
class EE::UserDefinedProcess
class EE::UserDefinedTransform
class PartitionWriterColumns

Detailed Description

Provides an iterator-based write interface over output data for a single partition. Automatically makes space a block-at-a-time, as needed.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

void Vertica::PartitionWriter::copyFromInput(size_t dstIdx, const BlockReader & input_reader, size_t srcIdx)

Copies a column from the input reader to the output writer. Raises an error if the input and output data types are not compatible.

Parameters

  • dstIdx: The destination column index (in the output writer)
  • input_reader: The input reader from which to copy a column
  • srcIdx: The source column index (in the input reader)
EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

BlockWriter& Vertica::PartitionWriter::getRowRef(size_t idx)

inline Get a reference for writing an output Row value.

Parameters

  • idx: the output column

Returns a reference to a BlockWriter which holds output data for the Row value's fields

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

virtual bool Vertica::PartitionWriter::getWriteableBlock()

virtual

Gets a writeable block of data and positions cursor at the beginning.

Reimplemented in Vertica::AnalyticPartitionWriter, and Vertica::StreamWriter.

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

void Vertica::PartitionWriter::setInt(size_t idx, vint r)

inline Setter methods

void Vertica::PartitionWriter::setNull(size_t idx)

inline Set the idx'th argument to null. If a column has the canBeNull attribute set to false, then this throws an exception.

Parameters

  • idx: The column number in the row to set to null
void Vertica::PartitionWriter::setNull(size_t idx, bool enforceNotNullProperty)

inline Set the idx'th argument to null.

Parameters

  • idx: The column number in the row to set to null
  • enforceNotNullProperty: If false, do not throw an exception if canBeNull is false.

1.1.161 - Vertica::PartitionWriter Member List

This is the complete list of members for Vertica::PartitionWriter, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
commitPrefilledRows(int nRows) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inlineprotected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
copyFromInput(size_t dstIdx, const BlockReader &input_reader, size_t srcIdx) Vertica::PartitionWriter
copyFromInput(const BlockReader &input_reader) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
EE::Loader::UserDefinedLoad (defined in Vertica::PartitionWriter) Vertica::PartitionWriter friend
EE::UserDefinedAnalytic (defined in Vertica::PartitionWriter) Vertica::PartitionWriter friend
EE::UserDefinedProcess (defined in Vertica::PartitionWriter) Vertica::PartitionWriter friend
EE::UserDefinedTransform (defined in Vertica::PartitionWriter) Vertica::PartitionWriter friend
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getArrayRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColumns() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getNumCols() const Vertica::VerticaBlock inline
getNumericRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getNumRows() const Vertica::VerticaBlock inline
getRowPtr(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getRowRef(size_t idx) Vertica::PartitionWriter inline
getStringRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getStringRefNoClear(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getVoidPtr(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getWriteableBlock() Vertica::PartitionWriter virtual
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
next() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
PartitionWriter(size_t narg) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
PartitionWriter(size_t narg, EE::UserDefinedProcess *udx_object) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
PartitionWriter(size_t narg, size_t nrows, EE::UserDefinedProcess *udx_object) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
PartitionWriterColumns (defined in Vertica::PartitionWriter) Vertica::PartitionWriter friend
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
pstart (defined in Vertica::PartitionWriter) Vertica::PartitionWriter protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inlineprotected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setBool(size_t idx, vbool r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setDate(size_t idx, DateADT r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setFloat(size_t idx, vfloat r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setInt(size_t idx, vint r) Vertica::PartitionWriter inline
setInterval(size_t idx, Interval r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setIntervalYM(size_t idx, IntervalYM r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setNull(size_t idx) Vertica::PartitionWriter inline
setNull(size_t idx, bool enforceNotNullProperty) Vertica::PartitionWriter inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setTime(size_t idx, TimeADT r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setTimestamp(size_t idx, Timestamp r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setTimestampTz(size_t idx, TimestampTz r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setTimeTz(size_t idx, TimeTzADT r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
throwIncorrectUsageError(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
udan (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
udt (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
udx_object (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~PartitionWriter() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inlinevirtual
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.162 - Vertica::PartitionWriterColumn< T > Class Template Reference

Inheritance diagram for Vertica::PartitionWriterColumn< T >:

Collaboration diagram for Vertica::PartitionWriterColumn< T >:

Public Member Functions
PartitionWriterColumn (int _stridelength, char *_start, char *_end, const T &_null_value)
void append (const T &value)
void appendNull ()
void directCopy (T *src, size_t elementsToCopy, size_t elementSize)
char * getAndAdvance ()
const char * getPtr (size_t offset_from_start)
int getStrideLength ()
T getVal (size_t offset_from_start)
size_t getWrittenElementCount ()
Protected Member Functions
void rejectRows (std::set &rejectedRows)
Protected Attributes
char * curr
const char * end
const T & null_value
const char * start
const int stridelength
Friends
class PartitionWriterColumns

Detailed Description

template

class Vertica::PartitionWriterColumn

PartitionWriterColumns for basic types.

Member Function Documentation

int Vertica::BasePartitionWriterColumn::getStrideLength()

inline inherited Returns the size of each element in the column

1.1.163 - Vertica::PartitionWriterColumn< T > Member List

This is the complete list of members for Vertica::PartitionWriterColumn, including all inherited members.

append(const T &value) (defined in Vertica::PartitionWriterColumn) Vertica::PartitionWriterColumn inline
appendNull() (defined in Vertica::PartitionWriterColumn) Vertica::PartitionWriterColumn inline
BasePartitionWriterColumn(int _stridelength, char *_start, char *_end) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotected
curr (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
directCopy(T *src, size_t elementsToCopy, size_t elementSize) (defined in Vertica::PartitionWriterColumn) Vertica::PartitionWriterColumn inline
end (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
getAndAdvance() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getPtr(size_t offset_from_start) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getStrideLength() Vertica::BasePartitionWriterColumn inline
getVal(size_t offset_from_start) (defined in Vertica::PartitionWriterColumn) Vertica::PartitionWriterColumn inline
getWrittenElementCount() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
null_value (defined in Vertica::PartitionWriterColumn) Vertica::PartitionWriterColumn protected
PartitionWriterColumn(int _stridelength, char *_start, char *_end, const T &_null_value) (defined in Vertica::PartitionWriterColumn) Vertica::PartitionWriterColumn inline
PartitionWriterColumns (defined in Vertica::PartitionWriterColumn) Vertica::PartitionWriterColumn friend
rejectRows(std::set &rejectedRows) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
start (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
stridelength (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
~BasePartitionWriterColumn() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotectedvirtual

1.1.164 - Vertica::PartitionWriterColumns Class Reference

PartitionWriterColumns allow column-by-column access to PartitionWriter data.

Collaboration diagram for Vertica::PartitionWriterColumns:

Public Member Functions
void commit (int64_t numRows=0)
void commit (std::set &rejectedRows, int64_t numRows=0)
PartitionWriterColumn & getBoolColumn (size_t idx)
PartitionWriterColumn & getDateColumn (size_t idx)
PartitionWriterColumn & getFloatColumn (size_t idx)
PartitionWriterColumn & getIntColumn (size_t idx)
PartitionWriterColumn & getIntervalColumn (size_t idx)
int getMaxRows ()
PartitionWriterNumericColumn & getNumericColumn (size_t idx)
int getRemaining ()
PartitionWriterStringColumn & getStringColumn (size_t idx)
PartitionWriterColumn & getTimeColumn (size_t idx)
PartitionWriterColumn & getTimestampColumn (size_t idx)
PartitionWriterColumn & getTimestampTzColumn (size_t idx)
PartitionWriterColumn & getTimeTzColumn (size_t idx)
PartitionWriterUuidColumn & getUuidColumn (size_t idx)
void rollback ()
Protected Member Functions
PartitionWriterColumns (PartitionWriter &_writer)
void clearCols ()
template
PartitionWriterColumn & getCol (size_t idx)
template
T & getCol_ (size_t idx)
void populateCols ()
void rejectRows (std::set &rejectedRows)
void resetPointers ()
Protected Attributes
std::vector cols
size_t maxRows
PartitionWriter & writer
Friends
class PartitionWriter

Detailed Description

PartitionWriterColumns allow column-by-column access to PartitionWriter data.

1.1.165 - Vertica::PartitionWriterColumns Member List

This is the complete list of members for Vertica::PartitionWriterColumns, including all inherited members.

clearCols() (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns protected
cols (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns protected
commit(int64_t numRows=0) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns
commit(std::set &rejectedRows, int64_t numRows=0) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns
getBoolColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getCol(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inlineprotected
getCol_(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inlineprotected
getDateColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getFloatColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getIntColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getIntervalColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getMaxRows() (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getNumericColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getRemaining() (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns
getStringColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getTimeColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getTimestampColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getTimestampTzColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getTimeTzColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
getUuidColumn(size_t idx) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
maxRows (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns protected
PartitionWriter (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns friend
PartitionWriterColumns(PartitionWriter &_writer) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inlineprotected
populateCols() (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns protected
rejectRows(std::set &rejectedRows) (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns protected
resetPointers() (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns protected
rollback() (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inline
writer (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns protected
~PartitionWriterColumns() (defined in Vertica::PartitionWriterColumns) Vertica::PartitionWriterColumns inlinevirtual

1.1.166 - Vertica::PartitionWriterNumericColumn Class Reference

Inheritance diagram for Vertica::PartitionWriterNumericColumn:

Collaboration diagram for Vertica::PartitionWriterNumericColumn:

Public Member Functions
PartitionWriterNumericColumn (int _stridelength, char *_start, char *_end, const VNumeric &wrapperTemplate)
VNumeric & append ()
void appendNull ()
void directCopy (uint64 *src, size_t elementsToCopy, int32 srcTypAttr, size_t elementSize)
char * getAndAdvance ()
const char * getPtr (size_t offset_from_start)
const VNumeric & getRef (size_t offset_from_start)
int getStrideLength ()
int32 getTypmod ()
size_t getWrittenElementCount ()
Protected Member Functions
void rejectRows (std::set &rejectedRows)
Protected Attributes
char * curr
const char * end
const char * start
const int stridelength
VNumeric wrapper
Friends
class PartitionWriterColumns

Member Function Documentation

VNumeric& Vertica::PartitionWriterNumericColumn::append()

inline Returns a reference to the next element to write. Setting its members will update the data in the PartitionWriter

Note that the underlying object is re-used, so the object references should not be retained between calls to append

void Vertica::PartitionWriterNumericColumn::directCopy(uint64 * src, size_t elementsToCopy, int32 srcTypAttr, size_t elementSize)

inline Elements must be in 2s compliment and in a compatible encoding; check the value of getTypmod to ensure that encodings are identical

const VNumeric& Vertica::PartitionWriterNumericColumn::getRef(size_t offset_from_start)

inline Returns a reference to a previously written element.

Note that the underlying object is re-used, so the object references should not be retained between calls to append

int Vertica::BasePartitionWriterColumn::getStrideLength()

inline inherited Returns the size of each element in the column

1.1.167 - Vertica::PartitionWriterNumericColumn Member List

This is the complete list of members for Vertica::PartitionWriterNumericColumn, including all inherited members.

append() Vertica::PartitionWriterNumericColumn inline
appendNull() (defined in Vertica::PartitionWriterNumericColumn) Vertica::PartitionWriterNumericColumn inline
BasePartitionWriterColumn(int _stridelength, char *_start, char *_end) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotected
curr (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
directCopy(uint64 *src, size_t elementsToCopy, int32 srcTypAttr, size_t elementSize) Vertica::PartitionWriterNumericColumn inline
end (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
getAndAdvance() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getPtr(size_t offset_from_start) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getRef(size_t offset_from_start) Vertica::PartitionWriterNumericColumn inline
getStrideLength() Vertica::BasePartitionWriterColumn inline
getTypmod() (defined in Vertica::PartitionWriterNumericColumn) Vertica::PartitionWriterNumericColumn inline
getWrittenElementCount() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
PartitionWriterColumns (defined in Vertica::PartitionWriterNumericColumn) Vertica::PartitionWriterNumericColumn friend
PartitionWriterNumericColumn(int _stridelength, char *_start, char *_end, const VNumeric &wrapperTemplate) (defined in Vertica::PartitionWriterNumericColumn) Vertica::PartitionWriterNumericColumn inline
rejectRows(std::set &rejectedRows) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
start (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
stridelength (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
wrapper (defined in Vertica::PartitionWriterNumericColumn) Vertica::PartitionWriterNumericColumn protected
~BasePartitionWriterColumn() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotectedvirtual

1.1.168 - Vertica::PartitionWriterStringColumn Class Reference

Inheritance diagram for Vertica::PartitionWriterStringColumn:

Collaboration diagram for Vertica::PartitionWriterStringColumn:

Public Member Functions
PartitionWriterStringColumn (int _stridelength, char *_start, char *_end, const VString &wrapperTemplate)
VString & append ()
void appendNull ()
char * getAndAdvance ()
vsize getMaxSize ()
const char * getPtr (size_t offset_from_start)
const VString & getRef (size_t offset_from_start)
int getStrideLength ()
size_t getWrittenElementCount ()
Protected Member Functions
void rejectRows (std::set &rejectedRows)
Protected Attributes
char * curr
const char * end
const char * start
const int stridelength
VString wrapper
Friends
class PartitionWriterColumns

Member Function Documentation

VString& Vertica::PartitionWriterStringColumn::append()

inline Returns a reference to the next element to write. Setting its members will update the data in the PartitionWriter

Note that the underlying object is re-used, so the object references should not be retained between calls to append

vsize Vertica::PartitionWriterStringColumn::getMaxSize()

inline Returns the maximum size that can be set in the objects returned from append()

const VString& Vertica::PartitionWriterStringColumn::getRef(size_t offset_from_start)

inline Returns a reference to a previously written element.

Note that the underlying object is re-used, so the object references should not be retained between calls to append

int Vertica::BasePartitionWriterColumn::getStrideLength()

inline inherited Returns the size of each element in the column

1.1.169 - Vertica::PartitionWriterStringColumn Member List

This is the complete list of members for Vertica::PartitionWriterStringColumn, including all inherited members.

append() Vertica::PartitionWriterStringColumn inline
appendNull() (defined in Vertica::PartitionWriterStringColumn) Vertica::PartitionWriterStringColumn inline
BasePartitionWriterColumn(int _stridelength, char *_start, char *_end) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotected
curr (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
end (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
getAndAdvance() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getMaxSize() Vertica::PartitionWriterStringColumn inline
getPtr(size_t offset_from_start) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getRef(size_t offset_from_start) Vertica::PartitionWriterStringColumn inline
getStrideLength() Vertica::BasePartitionWriterColumn inline
getWrittenElementCount() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
PartitionWriterColumns (defined in Vertica::PartitionWriterStringColumn) Vertica::PartitionWriterStringColumn friend
PartitionWriterStringColumn(int _stridelength, char *_start, char *_end, const VString &wrapperTemplate) (defined in Vertica::PartitionWriterStringColumn) Vertica::PartitionWriterStringColumn inline
rejectRows(std::set &rejectedRows) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
start (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
stridelength (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
wrapper (defined in Vertica::PartitionWriterStringColumn) Vertica::PartitionWriterStringColumn protected
~BasePartitionWriterColumn() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotectedvirtual

1.1.170 - Vertica::PartitionWriterUuidColumn Class Reference

Inheritance diagram for Vertica::PartitionWriterUuidColumn:

Collaboration diagram for Vertica::PartitionWriterUuidColumn:

Public Member Functions
PartitionWriterUuidColumn (int _stridelength, char *_start, char *_end, const VUuid &wrapperTemplate)
VUuid & append ()
void appendNull ()
char * getAndAdvance ()
const char * getPtr (size_t offset_from_start)
const VUuid & getRef (size_t offset_from_start)
int getStrideLength ()
size_t getWrittenElementCount ()
Protected Member Functions
void rejectRows (std::set &rejectedRows)
Protected Attributes
char * curr
const char * end
const char * start
const int stridelength
VUuid wrapper
Friends
class PartitionWriterColumns

Member Function Documentation

VUuid& Vertica::PartitionWriterUuidColumn::append()

inline Returns a reference to the next element to write. Setting its members will update the data in the PartitionWriter

Note that the underlying object is re-used, so the object references should not be retained between calls to append

const VUuid& Vertica::PartitionWriterUuidColumn::getRef(size_t offset_from_start)

inline Returns a reference to a previously written element.

Note that the underlying object is re-used, so the object references should not be retained between calls to append

int Vertica::BasePartitionWriterColumn::getStrideLength()

inline inherited Returns the size of each element in the column

1.1.171 - Vertica::PartitionWriterUuidColumn Member List

This is the complete list of members for Vertica::PartitionWriterUuidColumn, including all inherited members.

append() Vertica::PartitionWriterUuidColumn inline
appendNull() (defined in Vertica::PartitionWriterUuidColumn) Vertica::PartitionWriterUuidColumn inline
BasePartitionWriterColumn(int _stridelength, char *_start, char *_end) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotected
curr (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
end (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
getAndAdvance() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getPtr(size_t offset_from_start) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
getRef(size_t offset_from_start) Vertica::PartitionWriterUuidColumn inline
getStrideLength() Vertica::BasePartitionWriterColumn inline
getWrittenElementCount() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inline
PartitionWriterColumns (defined in Vertica::PartitionWriterUuidColumn) Vertica::PartitionWriterUuidColumn friend
PartitionWriterUuidColumn(int _stridelength, char *_start, char *_end, const VUuid &wrapperTemplate) (defined in Vertica::PartitionWriterUuidColumn) Vertica::PartitionWriterUuidColumn inline
rejectRows(std::set &rejectedRows) (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
start (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
stridelength (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn protected
wrapper (defined in Vertica::PartitionWriterUuidColumn) Vertica::PartitionWriterUuidColumn protected
~BasePartitionWriterColumn() (defined in Vertica::BasePartitionWriterColumn) Vertica::BasePartitionWriterColumn inlineprotectedvirtual

1.1.172 - Vertica::PerColumnParamReader Class Reference

A wrapper around a map from column to ParamReader.

Collaboration diagram for Vertica::PerColumnParamReader:

Public Member Functions
bool containsColumn (std::string columnName) const
Returns true if a ParamReader exists for the given column.
std::vector getColumnNames () const
Gets the names of all columns with column specific arguments.
ParamReader & getColumnParamReader (const std::string &column)
Gets the parameters of the given column.
const ParamReader & getColumnParamReader (const std::string &column) const

Detailed Description

A wrapper around a map from column to ParamReader.

Member Function Documentation

std::vector Vertica::PerColumnParamReader::getColumnNames() const

inline Gets the names of all columns with column specific arguments.

Returns a vector of column names

ParamReader& Vertica::PerColumnParamReader::getColumnParamReader(const std::string & column)

inline Gets the parameters of the given column.

Parameters

  • the: name of the column of interest

Returns the parameters of the given column

1.1.173 - Vertica::PerColumnParamReader Member List

This is the complete list of members for Vertica::PerColumnParamReader, including all inherited members.

containsColumn(std::string columnName) const Vertica::PerColumnParamReader inline
getColumnNames() const Vertica::PerColumnParamReader inline
getColumnParamReader(const std::string &column) Vertica::PerColumnParamReader inline
getColumnParamReader(const std::string &column) const (defined in Vertica::PerColumnParamReader) Vertica::PerColumnParamReader inline

1.1.174 - Vertica::PlanContext Class Reference

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.

Inheritance diagram for Vertica::PlanContext:

Collaboration diagram for Vertica::PlanContext:

Public Member Functions
PlanContext (ParamWriter &writer)
PlanContext (ParamWriter &writer, std::vector clusterNodes)
const std::vector & getClusterNodes ()
virtual ParamReader & getReader ()
virtual ParamWriter & getWriter ()

Detailed Description

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.

Member Function Documentation

const std::vector& Vertica::PlanContext::getClusterNodes()

inline Get a list of all of the nodes in the current cluster, by node name

Referenced by Vertica::NodeSpecifyingPlanContext::setTargetNodes().

virtual ParamReader& Vertica::PlanContext::getReader()

inlinevirtual

Get a read-only instance of the current context

virtual ParamWriter& Vertica::PlanContext::getWriter()

inlinevirtual

Get the current context for writing

Reimplemented in Vertica::ExecutorPlanContext.

Referenced by Vertica::ExecutorPlanContext::getWriter().

1.1.175 - Vertica::PlanContext Member List

This is the complete list of members for Vertica::PlanContext, including all inherited members.

getClusterNodes() Vertica::PlanContext inline
getReader() Vertica::PlanContext inlinevirtual
getWriter() Vertica::PlanContext inlinevirtual
PlanContext(ParamWriter &writer) (defined in Vertica::PlanContext) Vertica::PlanContext inline
PlanContext(ParamWriter &writer, std::vector clusterNodes) (defined in Vertica::PlanContext) Vertica::PlanContext inline

1.1.176 - Vertica::Portion Member List

This is the complete list of members for Vertica::Portion, including all inherited members.

is_first_portion (defined in Vertica::Portion) Vertica::Portion
isValid() const (defined in Vertica::Portion) Vertica::Portion inline
offset (defined in Vertica::Portion) Vertica::Portion
Portion(vint o=-1, vint s=-1, bool t=false) (defined in Vertica::Portion) Vertica::Portion inline
size (defined in Vertica::Portion) Vertica::Portion
str() const (defined in Vertica::Portion) Vertica::Portion inline

1.1.177 - Vertica::Portion Struct Reference

Collaboration diagram for Vertica::Portion:

Public Member Functions
Portion (vint o=-1, vint s=-1, bool t=false)
bool isValid () const
std::string str () const
Public Attributes
bool is_first_portion
vint offset
vint size

1.1.178 - Vertica::RejectedRecord Member List

This is the complete list of members for Vertica::RejectedRecord, including all inherited members.

data (defined in Vertica::RejectedRecord) Vertica::RejectedRecord
length (defined in Vertica::RejectedRecord) Vertica::RejectedRecord
reason (defined in Vertica::RejectedRecord) Vertica::RejectedRecord
RejectedRecord() (defined in Vertica::RejectedRecord) Vertica::RejectedRecord inline
RejectedRecord(const std::string &reason, const char *data=NULL, size_t length=0, const std::string &terminator="\n") (defined in Vertica::RejectedRecord) Vertica::RejectedRecord inline
terminator (defined in Vertica::RejectedRecord) Vertica::RejectedRecord

1.1.179 - Vertica::RejectedRecord Struct Reference

Collaboration diagram for Vertica::RejectedRecord:

Public Member Functions
RejectedRecord (const std::string &reason, const char *data=NULL, size_t length=0, const std::string &terminator="\n")
Public Attributes
const char * data
size_t length
std::string reason
std::string terminator

Detailed Description

Information about a rejected record.

1.1.180 - Vertica::ScalarFunction Class Reference

Interface for User-Defined Scalar Function (UDSF). A UDSF produces a single value from a row of data.

Inheritance diagram for Vertica::ScalarFunction:

Collaboration diagram for Vertica::ScalarFunction:

Public Member Functions
void cancelUDX (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams)
virtual void getOutputRange (ServerInterface &srvInterface, ValueRangeReader &inRange, ValueRangeWriter &outRange)
bool isCanceled () const
virtual void processBlock (ServerInterface &srvInterface, BlockReader &arg_reader, BlockWriter &res_writer)=0
virtual void setup (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)
Friends
struct ::CPPExecContext
class ::EE::VEval
class ::UdfSupport

Detailed Description

Interface for User-Defined Scalar Function (UDSF). A UDSF produces a single value from a row of data.

A UDSF can be used anywhere a native function can be used, except CREATE TABLE BY PARTITION and SEGMENTED BY expressions.

A ScalarFunction must have an associated ScalarFunctionFactory.

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtualinherited

Perform per instance destruction. This function may throw errors

Referenced by Vertica::UDXFunction::destroy().

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SessionParamWriterMap & udSessionParams)

inlinevirtualinherited

Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

virtual void Vertica::ScalarFunction::getOutputRange(ServerInterface & srvInterface, ValueRangeReader & inRange, ValueRangeWriter & outRange)

inlinevirtual

Invoke a user defined function to determine the output value range of this function. Ranges are represented by a minimum/maximum pair of values (inclusive). The developer is responsible to provide an output value range on the basis of the input argument ranges. Minimum/maximum values of ranges are of the same type as defined in the metadata class getPrototype() function.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • inRange: input value range
  • outRange: output value range

Remarks

By default, the ValueRangeWriter object can have NULL values, values in the range are unsorted, and it is unbounded, i.e., the following functions return as follows:

  • outRange.canHaveNulls() == true

  • outRange.getSortedness() == EE::SORT_UNORDERED

  • outRange.isBounded() == false

Note

  • This methods may be invoked by different threads at different times, and by a different thread than the constructor.

  • C++ exceptions may NOT be thrown out of this method. Use the vertica specific vt_throw_exception() function or vt_report_error() macro instead

  • Invoking vt_throw_exception() or vt_report_error() from this method will not stop the function execution, which may still complete successfully. Instead, the output range will be discarded, and a WARNING message will be written to the Vertica log

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual void Vertica::ScalarFunction::processBlock(ServerInterface & srvInterface, BlockReader & arg_reader, BlockWriter & res_writer)

pure virtual Invoke a user defined function on a set of rows. As the name suggests, a batch of rows are passed in for every invocation to amortize performance.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • arg_reader: input rows
  • res_writer: output location

Note

  • This methods may be invoked by different threads at different times, and by a different thread than the constructor.

  • The order in which the function sees rows is not guaranteed.

  • C++ exceptions may NOT be thrown out of this method. Use the vertica specific vt_throw_exception() function or vt_report_error() macro instead

virtual void Vertica::UDXFunction::setup(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtualinherited

Perform per instance initialization. This function may throw errors.

1.1.181 - Vertica::ScalarFunction Member List

This is the complete list of members for Vertica::ScalarFunction, including all inherited members.

::CPPExecContext (defined in Vertica::ScalarFunction) Vertica::ScalarFunction friend
::EE::VEval (defined in Vertica::ScalarFunction) Vertica::ScalarFunction friend
::UdfSupport (defined in Vertica::ScalarFunction) Vertica::ScalarFunction friend
cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams) Vertica::UDXFunction inlinevirtual
getOutputRange(ServerInterface &srvInterface, ValueRangeReader &inRange, ValueRangeWriter &outRange) Vertica::ScalarFunction inlinevirtual
isCanceled() const Vertica::UDXObject inline
processBlock(ServerInterface &srvInterface, BlockReader &arg_reader, BlockWriter &res_writer)=0 Vertica::ScalarFunction pure virtual
setup(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.182 - Vertica::ScalarFunctionFactory Class Reference

Interface for declaring parameters and return types for, and instantiating, an associated ScalarFunction.

Inheritance diagram for Vertica::ScalarFunctionFactory:

Collaboration diagram for Vertica::ScalarFunctionFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual ScalarFunction * createScalarFunction (ServerInterface &srvInterface)=0
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes)
virtual void getPrototype (ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0
virtual void getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType) override
Public Attributes
strictness strict
volatility vol
Protected Member Functions
virtual UDXType getUDXFactoryType () override
Protected Attributes
Oid libOid
std::string sqlName

Detailed Description

Interface for declaring parameters and return types for, and instantiating, an associated ScalarFunction.

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual ScalarFunction* Vertica::ScalarFunctionFactory::createScalarFunction(ServerInterface & srvInterface)

pure virtual Returns an ScalarFunction object which implements the UDx API described by this metadata.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Note More than one object may be instantiated per query.

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented in Vertica::UDLFactory.

Referenced by Vertica::UDXFactory::getPerInstanceResources().

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented in Vertica::UDLFactory.

virtual void Vertica::FunctionFactory::getPrototype(ServerInterface & srvInterface, ColumnTypes & argTypes, ColumnTypes & returnType)

pure virtual inherited Provides the argument and return types of the UDX

Implemented in Vertica::MultiPhaseTransformFunctionFactory.

Referenced by getReturnType().

virtual void Vertica::ScalarFunctionFactory::getReturnType(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SizedColumnTypes & returnType)

inlinevirtual

For scalar functions, this function needs to be overridden only if the return type needs length/precision specification.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: The data type of the return value defined by processBlock()
  • returnType: The size of the data returned by processBlock()

Implements Vertica::FunctionFactory.

virtual UDXType Vertica::ScalarFunctionFactory::getUDXFactoryType()

inlineprotectedvirtual

Returns the object type internally used by Vertica

Implements Vertica::UDXFactory.

Member Data Documentation

volatility Vertica::ScalarFunctionFactory::vol

Strictness and Volatility settings that the UDSF programmer can set Defaults are VOLATILE and CALLED_ON_NULL_INPUT

1.1.183 - Vertica::ScalarFunctionFactory Member List

This is the complete list of members for Vertica::ScalarFunctionFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
createScalarFunction(ServerInterface &srvInterface)=0 Vertica::ScalarFunctionFactory pure virtual
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) Vertica::UDXFactory inlinevirtual
getPrototype(ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0 Vertica::FunctionFactory pure virtual
getReturnType(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType) override Vertica::ScalarFunctionFactory inlinevirtual
getUDXFactoryType() override Vertica::ScalarFunctionFactory inlineprotectedvirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ScalarFunctionFactory() (defined in Vertica::ScalarFunctionFactory) Vertica::ScalarFunctionFactory inline
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
strict (defined in Vertica::ScalarFunctionFactory) Vertica::ScalarFunctionFactory
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
vol Vertica::ScalarFunctionFactory
~FunctionFactory() (defined in Vertica::FunctionFactory) Vertica::FunctionFactory inlinevirtual
~ScalarFunctionFactory() (defined in Vertica::ScalarFunctionFactory) Vertica::ScalarFunctionFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.184 - Vertica::ScopedTimerCounter Class Reference

Class to start an execution timer on construction and to automatically stop the timer on deconstruction or when manually called with stop()

Collaboration diagram for Vertica::ScopedTimerCounter:

Public Member Functions
ScopedTimerCounter (CounterController *_cc, int _counterIndex)
void stop ()

Detailed Description

Class to start an execution timer on construction and to automatically stop the timer on deconstruction or when manually called with stop()

1.1.185 - Vertica::ScopedTimerCounter Member List

This is the complete list of members for Vertica::ScopedTimerCounter, including all inherited members.

ScopedTimerCounter(CounterController *_cc, int _counterIndex) (defined in Vertica::ScopedTimerCounter) Vertica::ScopedTimerCounter inline
stop() (defined in Vertica::ScopedTimerCounter) Vertica::ScopedTimerCounter inline
~ScopedTimerCounter() (defined in Vertica::ScopedTimerCounter) Vertica::ScopedTimerCounter inline

1.1.186 - Vertica::ServerInterface Class Reference

Provides UDxs with access to the Vertica server.

Collaboration diagram for Vertica::ServerInterface:

Classes
struct BlobDescription
struct BlobIdentifier
struct FunctionDescription
struct RelationDescription
struct TypeDescription
Public Types
typedef void(* LoggingFunc )(ServerInterface *, const char *fmt, va_list ap)
Public Member Functions
ServerInterface (VTAllocator *allocator, FileManager *fileManager, LoggingFunc func, const std::string &sqlName, const ParamReader mReader, vint udxDebugLogLevel=0)
ServerInterface (VTAllocator *allocator, LoggingFunc func, const std::string &sqlName, const ParamReader mReader, vint udxDebugLogLevel=0)
ServerInterface (VTAllocator *allocator, LoggingFunc func, const std::string &sqlName, vint udxDebugLogLevel=0)
formatWithName append (" - ")
formatWithName append (format)
virtual bool describeBlob (const BlobIdentifier &blobId, BlobDescription &blobDescription, bool errorIfNotFound=true)=0
virtual bool describeFunction (FunctionDescription &func, bool errorIfNotFound=true)=0
virtual bool describeProjection (RelationDescription &proj, bool errorIfNotFound=true)=0
virtual bool describeTable (RelationDescription &baseTable, bool errorIfNotFound=true)=0
virtual bool describeType (TypeDescription &type, bool errorIfNotFound=true)=0
void std::string formatWithName (sqlName)
const std::string & getCurrentNodeName () const
const std::string & getDatabaseName () const
const std::map & getDependencies () const
virtual const UDFileSystem * getFileSystem (const char *path)=0
Oid getFunctionOid () const
const std::string & getLocale () const
ParamReader getParamReader () const
ParamReader getSessionParamReader () const
ParamReader getUDSessionParamReader (std::string nsp)
ParamReader getUDSessionParamReader () const
SessionParamReaderMap getUDSessionParamReaderMap () const
const std::string & getUserName () const
virtual std::vector listBlobs (BlobIdentifier::Namespace nsp=BlobIdentifier::NSP_LIBRARY)=0
virtual void listDerivedTables (const RelationDescription &baseTable, std::vector &tables, bool errorIfNotFound=false)=0
virtual void listProjections (const RelationDescription &lookup, std::vector &projections, bool errorIfNotFound=false)=0
virtual void listTableProjections (const RelationDescription &baseTable, std::vector &projections, bool errorIfNotFound=false)=0
virtual void listTables (const RelationDescription &lookup, std::vector &tables, bool errorIfNotFound=false)=0
void log (const char *format,...) attribute((format(printf
virtual void logEvent (const std::map &details)=0
virtual void reportError (ClientMessage msg)=0
virtual void reportInfo (ClientMessage msg)=0
virtual void reportNotice (ClientMessage msg)=0
virtual void reportWarning (ClientMessage msg)=0
void setDependencies (const std::map dependencies)
void setFunctionOid (Oid FuncOid)
void setLibraryOid (Oid libOid_)
void setParamReader (const ParamReader mReader)
void setPublicOid (Oid publicOid_)
void setSessionParamReader (const ParamReader &sessionParamReader)
void setUDSessionParameterMap (const SessionParamReaderMap &udSessionParams)
va_end (ap)
va_start (ap, format)
vlog (format, ap)
void vlog (const char *format, va_list ap)
Public Attributes
VTAllocator * allocator
va_list ap
FileManager * fileManager
format = formatWithName.c_str()
vint udxDebugLogLevel
Protected Attributes
std::string dbName
std::map dependencies
Oid funcOid
Oid libOid
std::string locale
std::string nodeName
ParamReader paramReader
Oid publicOid
ParamReader sessionParamReader
std::string sqlName
SessionParamReaderMap udSessionParamReaderMap
std::string userName
LoggingFunc vlogPtr
Friends
class ::UdfSupport
class ::UDxExecContext
class EE::UserDefinedAggregate
class EE::UserDefinedAnalytic
class EE::UserDefinedTransform

Detailed Description

Provides UDxs with access to the Vertica server.

Vertica passes a ServerInterface instance to the setup(), destroy(), and main processing functions of each UDx. Key methods for UDx use include log() (to write to the Vertica log), getParamReader(), setParamReader(), getSessionParamReader(), and setSessionParamReader().

Constructor & Destructor Documentation

Vertica::ServerInterface::ServerInterface(VTAllocator * allocator, FileManager * fileManager, LoggingFunc func, const std::string & sqlName, const ParamReader & paramReader, vint udxDebugLogLevel = 0)

inline Create a new ServerInterface.

Note that Only Vertica Server should use this method. It is not guaranteed to stay the same between releases.

Member Function Documentation

virtual bool Vertica::ServerInterface::describeBlob(const BlobIdentifier & blobId, BlobDescription & blobDescription, bool errorIfNotFound = true)

pure virtual Given a blob name and namespace (to which search path will be applied), find the rest of the details

virtual bool Vertica::ServerInterface::describeFunction(FunctionDescription & func, bool errorIfNotFound = true)

pure virtual Describe a function

virtual bool Vertica::ServerInterface::describeProjection(RelationDescription & proj, bool errorIfNotFound = true)

pure virtual Given a projection OID or name, find the rest of the details

virtual bool Vertica::ServerInterface::describeTable(RelationDescription & baseTable, bool errorIfNotFound = true)

pure virtual Given a table OID or name (to which search path will be applied), find the rest of the details

virtual bool Vertica::ServerInterface::describeType(TypeDescription & type, bool errorIfNotFound = true)

pure virtual Describe a type

const std::string& Vertica::ServerInterface::getCurrentNodeName() const

inline Returns the name of the vertica node on which this code is executed.

const std::string& Vertica::ServerInterface::getDatabaseName() const

inline Returns the name of the database in which this code is executed.

const std::map& Vertica::ServerInterface::getDependencies() const

inline Returns a list of paths to rhe dependencies

virtual const UDFileSystem* Vertica::ServerInterface::getFileSystem(const char * path)

pure virtual Get the file system corresponding to the provided path.

const std::string& Vertica::ServerInterface::getLocale() const

inline Returns the locale of the current session.

ParamReader Vertica::ServerInterface::getParamReader() const

inline Returns the ParamReader that allows accessing parameter values using their names

ParamReader Vertica::ServerInterface::getSessionParamReader() const

inline Get the sessionParamReader

ParamReader Vertica::ServerInterface::getUDSessionParamReader(std::string nsp)

inline Get the UDSessionParamReader for a namespace

ParamReader Vertica::ServerInterface::getUDSessionParamReader() const

inline Get the UDSessionParamReader for the default namespace

SessionParamReaderMap Vertica::ServerInterface::getUDSessionParamReaderMap() const

inline Get the UDSessionParamReaderMap

const std::string& Vertica::ServerInterface::getUserName() const

inline Returns the name of the vertica user of the current session.

virtual std::vector Vertica::ServerInterface::listBlobs(BlobIdentifier::Namespace nsp = BlobIdentifier::NSP_LIBRARY)

pure virtual List the blobs in the given namespace

virtual void Vertica::ServerInterface::listDerivedTables(const RelationDescription & baseTable, std::vector & tables, bool errorIfNotFound = false)

pure virtual List out derived tables, such as text indexes

virtual void Vertica::ServerInterface::listProjections(const RelationDescription & lookup, std::vector & projections, bool errorIfNotFound = false)

pure virtual List projections given projection name

virtual void Vertica::ServerInterface::listTableProjections(const RelationDescription & baseTable, std::vector & projections, bool errorIfNotFound = false)

pure virtual List projections given base table properties (schema + name, OID, etc.)

virtual void Vertica::ServerInterface::listTables(const RelationDescription & lookup, std::vector & tables, bool errorIfNotFound = false)

pure virtual List tables given properties (schema, name, etc.)

void Vertica::ServerInterface::log(const char * format, ...)

Writes a message to a log file stored in the UDxLogs directory of the database's catalog directory. The SQL name of the UDx is added to the log message, along with the string [UserMessage] to mark the entry as a message added by a call to this method.

Parameters

  • format: a printf-style format string specifying the log message format.
virtual void Vertica::ServerInterface::logEvent(const std::map & details)

pure virtual Logs an event composed of a map of key-value pairs to dc_udx_events, which can be queried using v_monitor.udx_events view.

Events logged from a fenced UDX are logged to a file and are not query-able.

virtual void Vertica::ServerInterface::reportError(ClientMessage msg)

pure virtual Report the provided ClientMessage as an error

Parameters

  • msg: The message to be reported
virtual void Vertica::ServerInterface::reportInfo(ClientMessage msg)

pure virtual Report the provided ClientMessage as info

Parameters

  • msg: The message to be reported
virtual void Vertica::ServerInterface::reportNotice(ClientMessage msg)

pure virtual Report the provided ClientMessage as a notice

Parameters

  • msg: The message to be reported
virtual void Vertica::ServerInterface::reportWarning(ClientMessage msg)

pure virtual Report the provided ClientMessage as a warning

Parameters

  • msg: The message to be reported
void Vertica::ServerInterface::setDependencies(const std::map dependencies)

inline Returns set the paths to the dependencies

void Vertica::ServerInterface::setParamReader(const ParamReader & paramReader)

inline Set the paramReader of this ServerInterface when delayed creation is required Used by the code when delayed creation of the parameters is needed Users should not call this function

void Vertica::ServerInterface::setSessionParamReader(const ParamReader & sessionParamReader)

inline Set the sessionParamReader

void Vertica::ServerInterface::setUDSessionParameterMap(const SessionParamReaderMap & udSessionParams)

inline Set the UDSessionParamReaderMap

void Vertica::ServerInterface::vlog(const char * format, va_list ap)

inline Write a message to the vertica.log system log.

Parameters

  • format: a printf style format string specifying the log message format.
  • ap: va_list for variable arguments

Member Data Documentation

VTAllocator* Vertica::ServerInterface::allocator

Memory source which is managed and freed by the server.

std::string Vertica::ServerInterface::dbName

protected

Store the name of the current database

Referenced by getDatabaseName().

std::map Vertica::ServerInterface::dependencies

protected

The list of all dependencies

Referenced by

FileManager* Vertica::ServerInterface::fileManager

File manager of the session context

Oid Vertica::ServerInterface::funcOid

protected

The Oid of the function

Oid Vertica::ServerInterface::libOid

protected

The Oid of the library

std::string Vertica::ServerInterface::locale

protected

The locale of the current session

Referenced by getLocale().

std::string Vertica::ServerInterface::nodeName

protected

Store the name of the current node

Referenced by getCurrentNodeName().

ParamReader Vertica::ServerInterface::paramReader

protected

A reader for paremeters that have been toknized using the following format: key1=val1,key2=val2,key3=val3. Has accessor methods like BlockReader to be able to access parameters of different data types

Referenced by

Oid Vertica::ServerInterface::publicOid

protected

The Oid for public user-defined session parameters and blobs

ParamReader Vertica::ServerInterface::sessionParamReader

protected

A map for session paremeters UDx might specify what session parameters it wants in its "manifest" Server will try to provide, if it agrees with that request

Referenced by

std::string Vertica::ServerInterface::sqlName

protected

Store the name for error logging

SessionParamReaderMap Vertica::ServerInterface::udSessionParamReaderMap

protected

A map for session UDParameters that were set in the session by a user or by a UDx

Referenced by

vint Vertica::ServerInterface::udxDebugLogLevel

The level of UDx debug logging which is turned on as a UDXDebugLevel set of enumeration values. Used so UDxs may forgo generating debug log messages if debug logging is off.

std::string Vertica::ServerInterface::userName

protected

The username of the current session

Referenced by getUserName().

LoggingFunc Vertica::ServerInterface::vlogPtr

protected

Callback for logging, set by the server

Referenced by vlog().

1.1.187 - Vertica::ServerInterface Member List

This is the complete list of members for Vertica::ServerInterface, including all inherited members.

::UdfSupport (defined in Vertica::ServerInterface) Vertica::ServerInterface friend
::UDxExecContext (defined in Vertica::ServerInterface) Vertica::ServerInterface friend
allocator Vertica::ServerInterface
ap (defined in Vertica::ServerInterface) Vertica::ServerInterface
append(" - ") (defined in Vertica::ServerInterface) Vertica::ServerInterface
append(format) (defined in Vertica::ServerInterface) Vertica::ServerInterface
dbName Vertica::ServerInterface protected
dependencies Vertica::ServerInterface protected
describeBlob(const BlobIdentifier &blobId, BlobDescription &blobDescription, bool errorIfNotFound=true)=0 Vertica::ServerInterface pure virtual
describeFunction(FunctionDescription &func, bool errorIfNotFound=true)=0 Vertica::ServerInterface pure virtual
describeProjection(RelationDescription &proj, bool errorIfNotFound=true)=0 Vertica::ServerInterface pure virtual
describeTable(RelationDescription &baseTable, bool errorIfNotFound=true)=0 Vertica::ServerInterface pure virtual
describeType(TypeDescription &type, bool errorIfNotFound=true)=0 Vertica::ServerInterface pure virtual
EE::UserDefinedAggregate (defined in Vertica::ServerInterface) Vertica::ServerInterface friend
EE::UserDefinedAnalytic (defined in Vertica::ServerInterface) Vertica::ServerInterface friend
EE::UserDefinedTransform (defined in Vertica::ServerInterface) Vertica::ServerInterface friend
fileManager Vertica::ServerInterface
format (defined in Vertica::ServerInterface) Vertica::ServerInterface
formatWithName(sqlName) (defined in Vertica::ServerInterface) Vertica::ServerInterface
funcOid Vertica::ServerInterface protected
getCurrentNodeName() const Vertica::ServerInterface inline
getDatabaseName() const Vertica::ServerInterface inline
getDependencies() const Vertica::ServerInterface inline
getFileSystem(const char *path)=0 Vertica::ServerInterface pure virtual
getFunctionOid() const (defined in Vertica::ServerInterface) Vertica::ServerInterface inline
getLocale() const Vertica::ServerInterface inline
getParamReader() const Vertica::ServerInterface inline
getSessionParamReader() const Vertica::ServerInterface inline
getUDSessionParamReader(std::string nsp) Vertica::ServerInterface inline
getUDSessionParamReader() const Vertica::ServerInterface inline
getUDSessionParamReaderMap() const Vertica::ServerInterface inline
getUserName() const Vertica::ServerInterface inline
libOid Vertica::ServerInterface protected
listBlobs(BlobIdentifier::Namespace nsp=BlobIdentifier::NSP_LIBRARY)=0 Vertica::ServerInterface pure virtual
listDerivedTables(const RelationDescription &baseTable, std::vector &tables, bool errorIfNotFound=false)=0 Vertica::ServerInterface pure virtual
listProjections(const RelationDescription &lookup, std::vector &projections, bool errorIfNotFound=false)=0 Vertica::ServerInterface pure virtual
listTableProjections(const RelationDescription &baseTable, std::vector &projections, bool errorIfNotFound=false)=0 Vertica::ServerInterface pure virtual
listTables(const RelationDescription &lookup, std::vector &tables, bool errorIfNotFound=false)=0 Vertica::ServerInterface pure virtual
locale Vertica::ServerInterface protected
log(const char *format,...) attribute((format(printf Vertica::ServerInterface
logEvent(const std::map &details)=0 Vertica::ServerInterface pure virtual
LoggingFunc typedef (defined in Vertica::ServerInterface) Vertica::ServerInterface
nodeName Vertica::ServerInterface protected
paramReader Vertica::ServerInterface protected
publicOid Vertica::ServerInterface protected
reportError(ClientMessage msg)=0 Vertica::ServerInterface pure virtual
reportInfo(ClientMessage msg)=0 Vertica::ServerInterface pure virtual
reportNotice(ClientMessage msg)=0 Vertica::ServerInterface pure virtual
reportWarning(ClientMessage msg)=0 Vertica::ServerInterface pure virtual
ServerInterface(VTAllocator *allocator, FileManager *fileManager, LoggingFunc func, const std::string &sqlName, const ParamReader mReader, vint udxDebugLogLevel=0) Vertica::ServerInterface inline
ServerInterface(VTAllocator *allocator, LoggingFunc func, const std::string &sqlName, const ParamReader mReader, vint udxDebugLogLevel=0) (defined in Vertica::ServerInterface) Vertica::ServerInterface inline
ServerInterface(VTAllocator *allocator, LoggingFunc func, const std::string &sqlName, vint udxDebugLogLevel=0) (defined in Vertica::ServerInterface) Vertica::ServerInterface inline
sessionParamReader Vertica::ServerInterface protected
setDependencies(const std::map dependencies) Vertica::ServerInterface inline
setFunctionOid(Oid FuncOid) (defined in Vertica::ServerInterface) Vertica::ServerInterface inline
setLibraryOid(Oid libOid_) (defined in Vertica::ServerInterface) Vertica::ServerInterface inline
setParamReader(const ParamReader mReader) Vertica::ServerInterface inline
setPublicOid(Oid publicOid_) (defined in Vertica::ServerInterface) Vertica::ServerInterface inline
setSessionParamReader(const ParamReader &sessionParamReader) Vertica::ServerInterface inline
setUDSessionParameterMap(const SessionParamReaderMap &udSessionParams) Vertica::ServerInterface inline
sqlName Vertica::ServerInterface protected
udSessionParamReaderMap Vertica::ServerInterface protected
udxDebugLogLevel Vertica::ServerInterface
userName Vertica::ServerInterface protected
va_end(ap) (defined in Vertica::ServerInterface) Vertica::ServerInterface
va_start(ap, format) (defined in Vertica::ServerInterface) Vertica::ServerInterface
vlog(format, ap) (defined in Vertica::ServerInterface) Vertica::ServerInterface
vlog(const char *format, va_list ap) Vertica::ServerInterface inline
vlogPtr Vertica::ServerInterface protected
~ServerInterface() (defined in Vertica::ServerInterface) Vertica::ServerInterface inlinevirtual

1.1.188 - Vertica::ServerInterface::FunctionDescription Member List

This is the complete list of members for Vertica::ServerInterface::FunctionDescription, including all inherited members.

argNames (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
argTypes (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
binary (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
databaseName Vertica::ServerInterface::FunctionDescription
FT_AGGREGATE enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_ANALYTIC enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_EXTPROC enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_SCALAR enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_UDAGG enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_UDAN enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_UDFILTER enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_UDPARSE enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_UDSF enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_UDSOURCE enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_UDT enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_UDT_CURSOR enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FT_UDT_MULTI enum value (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
FunctionDescription() (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription inline
functionName Vertica::ServerInterface::FunctionDescription
functionOid Vertica::ServerInterface::FunctionDescription
FunctionType enum name (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
functionType (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
isFenced Vertica::ServerInterface::FunctionDescription
isInternal Vertica::ServerInterface::FunctionDescription
isStrict Vertica::ServerInterface::FunctionDescription
language (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
libraryFileName (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
libraryName (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
libraryOid (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
returnNames (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
returnTypes (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
schemaName Vertica::ServerInterface::FunctionDescription
source (defined in Vertica::ServerInterface::FunctionDescription) Vertica::ServerInterface::FunctionDescription
volatility Vertica::ServerInterface::FunctionDescription

1.1.189 - Vertica::ServerInterface::FunctionDescription Struct Reference

Collaboration diagram for Vertica::ServerInterface::FunctionDescription:

Public Types
enum FunctionType { FT_SCALAR, FT_AGGREGATE, FT_ANALYTIC, FT_EXTPROC, FT_UDSF, FT_UDAGG, FT_UDAN, FT_UDT, FT_UDT_MULTI, FT_UDT_CURSOR, FT_UDPARSE, FT_UDFILTER, FT_UDSOURCE }
Public Attributes
std::vector argNames
std::vector argTypes
std::string binary
std::string databaseName
std::string functionName
Oid functionOid
enum Vertica::ServerInterface::FunctionDescription::FunctionType functionType
bool isFenced
bool isInternal
bool isStrict
std::string language
std::string libraryFileName
std::string libraryName
Oid libraryOid
std::vector returnNames
std::vector returnTypes
std::string schemaName
std::string source
char volatility

Detailed Description

Structure to describe the name and properties of a function, It is to be used in the methods below.

Member Data Documentation

std::string Vertica::ServerInterface::FunctionDescription::databaseName

Database name

std::string Vertica::ServerInterface::FunctionDescription::functionName

Table name, projection basename, or projection name

Oid Vertica::ServerInterface::FunctionDescription::functionOid

Function OID, for lookups if this is nonzero it takes precedence

bool Vertica::ServerInterface::FunctionDescription::isFenced

Is fenced

bool Vertica::ServerInterface::FunctionDescription::isInternal

Is internal / built in function

bool Vertica::ServerInterface::FunctionDescription::isStrict

Is strict

std::string Vertica::ServerInterface::FunctionDescription::schemaName

Schema name; on lookup if empty the search path will be consulted

char Vertica::ServerInterface::FunctionDescription::volatility

Volatility

1.1.190 - Vertica::ServerInterface::RelationDescription Member List

This is the complete list of members for Vertica::ServerInterface::RelationDescription, including all inherited members.

additionalDerivationInfo Vertica::ServerInterface::RelationDescription
baseAttrIdx Vertica::ServerInterface::RelationDescription
baseRelation Vertica::ServerInterface::RelationDescription
colNames Vertica::ServerInterface::RelationDescription
colRLE Vertica::ServerInterface::RelationDescription
colTypes Vertica::ServerInterface::RelationDescription
databaseName Vertica::ServerInterface::RelationDescription
derivationFunctions Vertica::ServerInterface::RelationDescription
isExternal Vertica::ServerInterface::RelationDescription
isFlex Vertica::ServerInterface::RelationDescription
isSystem Vertica::ServerInterface::RelationDescription
isTemp Vertica::ServerInterface::RelationDescription
isUpToDate Vertica::ServerInterface::RelationDescription
nSortedCols Vertica::ServerInterface::RelationDescription
partitionCols Vertica::ServerInterface::RelationDescription
pkCols Vertica::ServerInterface::RelationDescription
presentOnNodeNames Vertica::ServerInterface::RelationDescription
presentOnNodes Vertica::ServerInterface::RelationDescription
RDT_AGGREGATE enum value (defined in Vertica::ServerInterface::RelationDescription) Vertica::ServerInterface::RelationDescription
RDT_FLEX_KEYS enum value (defined in Vertica::ServerInterface::RelationDescription) Vertica::ServerInterface::RelationDescription
RDT_INDEX enum value (defined in Vertica::ServerInterface::RelationDescription) Vertica::ServerInterface::RelationDescription
RDT_NONE enum value (defined in Vertica::ServerInterface::RelationDescription) Vertica::ServerInterface::RelationDescription
RDT_PROJECTION enum value (defined in Vertica::ServerInterface::RelationDescription) Vertica::ServerInterface::RelationDescription
RDT_TOPK enum value (defined in Vertica::ServerInterface::RelationDescription) Vertica::ServerInterface::RelationDescription
RDT_UDT enum value (defined in Vertica::ServerInterface::RelationDescription) Vertica::ServerInterface::RelationDescription
RelationDescription() (defined in Vertica::ServerInterface::RelationDescription) Vertica::ServerInterface::RelationDescription inline
relationName Vertica::ServerInterface::RelationDescription
relationOid Vertica::ServerInterface::RelationDescription
relDerivationType (defined in Vertica::ServerInterface::RelationDescription) Vertica::ServerInterface::RelationDescription
RelDerivationType enum name Vertica::ServerInterface::RelationDescription
schemaName Vertica::ServerInterface::RelationDescription
segCols Vertica::ServerInterface::RelationDescription
segOffset Vertica::ServerInterface::RelationDescription
tabColMapping Vertica::ServerInterface::RelationDescription

1.1.191 - Vertica::ServerInterface::RelationDescription Struct Reference

Collaboration diagram for Vertica::ServerInterface::RelationDescription:

Public Types
enum RelDerivationType { RDT_NONE, RDT_PROJECTION, RDT_AGGREGATE, RDT_TOPK, RDT_UDT, RDT_INDEX, RDT_FLEX_KEYS }
Public Attributes
std::string additionalDerivationInfo
std::vector baseAttrIdx
Oid baseRelation
std::vector colNames
std::vector colRLE
std::vector colTypes
std::string databaseName
std::vector derivationFunctions
bool isExternal
bool isFlex
bool isSystem
bool isTemp
bool isUpToDate
int nSortedCols
std::vector partitionCols
std::vector pkCols
std::set presentOnNodeNames
std::set presentOnNodes
std::string relationName
Oid relationOid
enum Vertica::ServerInterface::RelationDescription::RelDerivationType relDerivationType
std::string schemaName
std::vector segCols
int segOffset
std::vector tabColMapping

Detailed Description

Structure to describe the name and properties of a table or projection, It is to be used in the methods below.

Member Enumeration Documentation

enum Vertica::ServerInterface::RelationDescription::RelDerivationType

Is aggregate, index, etc

Member Data Documentation

std::string Vertica::ServerInterface::RelationDescription::additionalDerivationInfo

Further description of derivation

std::vector Vertica::ServerInterface::RelationDescription::baseAttrIdx

Columns in base that participate in derivation

Oid Vertica::ServerInterface::RelationDescription::baseRelation

Derivation from a base object (table/projection)

std::vector Vertica::ServerInterface::RelationDescription::colNames

Column names

std::vector Vertica::ServerInterface::RelationDescription::colRLE

For projections, indictor if encoding is run-optimized

std::vector Vertica::ServerInterface::RelationDescription::colTypes

Column types

std::string Vertica::ServerInterface::RelationDescription::databaseName

Database name

std::vector Vertica::ServerInterface::RelationDescription::derivationFunctions

Derivation function, for UDT proj, etc.

bool Vertica::ServerInterface::RelationDescription::isExternal

Is for external table?

bool Vertica::ServerInterface::RelationDescription::isFlex

Is this a flex object

bool Vertica::ServerInterface::RelationDescription::isSystem

Is this a system object

bool Vertica::ServerInterface::RelationDescription::isTemp

Is for a temp table?

bool Vertica::ServerInterface::RelationDescription::isUpToDate

Is this up to date / active

int Vertica::ServerInterface::RelationDescription::nSortedCols

For projections, number of columns in sort order, as a prefix

std::vector Vertica::ServerInterface::RelationDescription::partitionCols

For tables / projections, columns involved in partitioning

std::vector Vertica::ServerInterface::RelationDescription::pkCols

For tables / projections, columns involved in a primary key

std::set Vertica::ServerInterface::RelationDescription::presentOnNodeNames

For projections, hosting node names

std::set Vertica::ServerInterface::RelationDescription::presentOnNodes

For projections, hosting nodes

std::string Vertica::ServerInterface::RelationDescription::relationName

Table name, projection basename, or projection name

Oid Vertica::ServerInterface::RelationDescription::relationOid

Relation OID, for lookups if this is nonzero it takes precedence

std::string Vertica::ServerInterface::RelationDescription::schemaName

Schema name; on lookup if empty the search path will be consulted

std::vector Vertica::ServerInterface::RelationDescription::segCols

For projections, columns involved in segmentation

int Vertica::ServerInterface::RelationDescription::segOffset

For buddies, segmentation offset

std::vector Vertica::ServerInterface::RelationDescription::tabColMapping

For projections, mapping to table column number (0-based); negative numbers would indicate things that are not present in the table

1.1.192 - Vertica::ServerInterface::TypeDescription Member List

This is the complete list of members for Vertica::ServerInterface::TypeDescription, including all inherited members.

baseType Vertica::ServerInterface::TypeDescription
databaseName Vertica::ServerInterface::TypeDescription
isInternal Vertica::ServerInterface::TypeDescription
schemaName Vertica::ServerInterface::TypeDescription
TypeDescription() (defined in Vertica::ServerInterface::TypeDescription) Vertica::ServerInterface::TypeDescription inline
typeName Vertica::ServerInterface::TypeDescription
typeOid Vertica::ServerInterface::TypeDescription

1.1.193 - Vertica::ServerInterface::TypeDescription Struct Reference

Collaboration diagram for Vertica::ServerInterface::TypeDescription:

Public Attributes
VerticaType baseType
std::string databaseName
bool isInternal
std::string schemaName
std::string typeName
Oid typeOid

Detailed Description

Structure to describe the name and properties of a type, It is to be used in the methods below.

Member Data Documentation

VerticaType Vertica::ServerInterface::TypeDescription::baseType

Base type

std::string Vertica::ServerInterface::TypeDescription::databaseName

Database name

bool Vertica::ServerInterface::TypeDescription::isInternal

Is internal?

std::string Vertica::ServerInterface::TypeDescription::schemaName

Schema name; on lookup if empty the search path will be consulted

std::string Vertica::ServerInterface::TypeDescription::typeName

Table name, projection basename, or projection name

Oid Vertica::ServerInterface::TypeDescription::typeOid

Function OID, for lookups if this is nonzero it takes precedence

1.1.194 - Vertica::SessionParamReaderMap Class Reference

This class provides an interface for reading the Used defined session parameters.

Collaboration diagram for Vertica::SessionParamReaderMap:

Public Member Functions
void addUDSessionParamReader (const std::string &nsp, ParamReader &sessionParamReader)
Add a Session ParamReader for a namespace.
bool containsNamespace (const std::string nsp) const
Check if a SessionParamReader for the Namespace exists in the map.
std::vector getNamespaces () const
Gets the names of all namespaces.
void getUDSessionParamReader (const std::string &nsp, ParamReader &pReader)
Get a SessionParamReader for a namespace.
const ParamReader & getUDSessionParamReader (const std::string &nsp) const
Get the SessionParamReader for the Namespace.
void setUDSessionParamReaderMap (std::map paramReaderMap)
Set the SessionParamReaderMap.

Detailed Description

This class provides an interface for reading the Used defined session parameters.

Member Function Documentation

void Vertica::SessionParamReaderMap::addUDSessionParamReader(const std::string & nsp, ParamReader & sessionParamReader)

inline Add a Session ParamReader for a namespace.

Parameters

  • The: namespace and the ParamReader
bool Vertica::SessionParamReaderMap::containsNamespace(const std::string nsp) const

inline Check if a SessionParamReader for the Namespace exists in the map.

Parameters

  • The: namespace

Returns true if the SessionParamReader for the Namespace exists false otherwise

std::vector Vertica::SessionParamReaderMap::getNamespaces() const

inline Gets the names of all namespaces.

Returns a vector of column namespaces

void Vertica::SessionParamReaderMap::getUDSessionParamReader(const std::string & nsp, ParamReader & pReader)

inline Get a SessionParamReader for a namespace.

Parameters

  • The: namespace

Returns The SessionParamReader

Referenced by Vertica::ServerInterface::getUDSessionParamReader().

const ParamReader& Vertica::SessionParamReaderMap::getUDSessionParamReader(const std::string & nsp) const

inline Get the SessionParamReader for the Namespace.

Parameters

  • The: namespace

Returns The ParamReader

void Vertica::SessionParamReaderMap::setUDSessionParamReaderMap(std::map paramReaderMap)

inline Set the SessionParamReaderMap.

Parameters

  • The: SessionParamReaderMap

1.1.195 - Vertica::SessionParamReaderMap Member List

This is the complete list of members for Vertica::SessionParamReaderMap, including all inherited members.

addUDSessionParamReader(const std::string &nsp, ParamReader &sessionParamReader) Vertica::SessionParamReaderMap inline
containsNamespace(const std::string nsp) const Vertica::SessionParamReaderMap inline
getNamespaces() const Vertica::SessionParamReaderMap inline
getUDSessionParamReader(const std::string &nsp, ParamReader &pReader) Vertica::SessionParamReaderMap inline
getUDSessionParamReader(const std::string &nsp) const Vertica::SessionParamReaderMap inline
SessionParamReaderMap() (defined in Vertica::SessionParamReaderMap) Vertica::SessionParamReaderMap inline
setUDSessionParamReaderMap(std::map paramReaderMap) Vertica::SessionParamReaderMap inline

1.1.196 - Vertica::SessionParamWriterMap Class Reference

This class provides an interface for writing the Used defined session parameters.

Collaboration diagram for Vertica::SessionParamWriterMap:

Public Member Functions
SessionParamWriterMap (VTAllocator *allocator=NULL)
void addUDSessionParamWriter (const std::string &nsp, ParamWriter &sessionParamWriter)
Add a SessionParamWriter for a namespace.
bool containsNamespace (const std::string nsp) const
Check if a SessionParamWriter for the Namespace exists in the map.
std::vector getNamespaces () const
Gets the names of all namespaces.
ParamWriter & getUDSessionParamWriter (const std::string &nsp)
Get a SessionParamWriter for a namespace.
const ParamWriter & getUDSessionParamWriter (const std::string &nsp) const
Get a SessionParamWriter for a namespace.
ParamWriter & getUDSessionParamWriter ()
Get a SessionParamWriter for a namespace library.
void setAllocator (VTAllocator *allocator)

Detailed Description

This class provides an interface for writing the Used defined session parameters.

Member Function Documentation

void Vertica::SessionParamWriterMap::addUDSessionParamWriter(const std::string & nsp, ParamWriter & sessionParamWriter)

inline Add a SessionParamWriter for a namespace.

Parameters

  • The: namespace and the ParamReader

Referenced by getUDSessionParamWriter().

bool Vertica::SessionParamWriterMap::containsNamespace(const std::string nsp) const

inline Check if a SessionParamWriter for the Namespace exists in the map.

Parameters

  • The: namespace

Returns true if the SessionParamWriter for the Namespace exists false otherwise

std::vector Vertica::SessionParamWriterMap::getNamespaces() const

inline Gets the names of all namespaces.

Returns a vector of column namespaces

ParamWriter& Vertica::SessionParamWriterMap::getUDSessionParamWriter(const std::string & nsp)

inline Get a SessionParamWriter for a namespace.

Parameters

  • The: namespace

Returns The SessionParamWriter

const ParamWriter& Vertica::SessionParamWriterMap::getUDSessionParamWriter(const std::string & nsp) const

inline Get a SessionParamWriter for a namespace.

Parameters

  • The: namespace

Returns The SessionParamWriter

ParamWriter& Vertica::SessionParamWriterMap::getUDSessionParamWriter()

inline Get a SessionParamWriter for a namespace library.

Returns The SessionParamWriter

1.1.197 - Vertica::SessionParamWriterMap Member List

This is the complete list of members for Vertica::SessionParamWriterMap, including all inherited members.

addUDSessionParamWriter(const std::string &nsp, ParamWriter &sessionParamWriter) Vertica::SessionParamWriterMap inline
containsNamespace(const std::string nsp) const Vertica::SessionParamWriterMap inline
getNamespaces() const Vertica::SessionParamWriterMap inline
getUDSessionParamWriter(const std::string &nsp) Vertica::SessionParamWriterMap inline
getUDSessionParamWriter(const std::string &nsp) const Vertica::SessionParamWriterMap inline
getUDSessionParamWriter() Vertica::SessionParamWriterMap inline
SessionParamWriterMap(VTAllocator *allocator=NULL) (defined in Vertica::SessionParamWriterMap) Vertica::SessionParamWriterMap inline
setAllocator(VTAllocator *allocator) (defined in Vertica::SessionParamWriterMap) Vertica::SessionParamWriterMap inline

1.1.198 - Vertica::SimpleArchiveIn Member List

This is the complete list of members for Vertica::SimpleArchiveIn, including all inherited members.

is (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn
is_loading typedef (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn
is_saving typedef (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn
operator&(int64 &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(uint64 &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(long int &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(long unsigned int &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(int32 &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(uint32 &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(int16 &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(uint16 &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(signed char &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(char &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(unsigned char &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(bool &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(double &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(std::basic_string, Alloc > &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(std::vector &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(std::vector &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(std::list &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(std::set &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(std::unordered_set &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(std::pair &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(std::map &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(std::unordered_map &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator&(T &val) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
operator>(int64 &val) Vertica::SimpleArchiveIn inline
operator>>(uint64 &val) Vertica::SimpleArchiveIn inline
operator>>(int32 &val) Vertica::SimpleArchiveIn inline
operator>>(uint32 &val) Vertica::SimpleArchiveIn inline
operator>>(int16 &val) Vertica::SimpleArchiveIn inline
operator>>(uint16 &val) Vertica::SimpleArchiveIn inline
operator>>(signed char &val) Vertica::SimpleArchiveIn inline
operator>>(char &val) Vertica::SimpleArchiveIn inline
operator>>(unsigned char &val) Vertica::SimpleArchiveIn inline
operator>>(bool &b) Vertica::SimpleArchiveIn inline
operator>>(double &d) Vertica::SimpleArchiveIn inline
operator>>(std::basic_string, Alloc > &val) Vertica::SimpleArchiveIn inline
operator>>(std::vector &val) Vertica::SimpleArchiveIn inline
operator>>(std::vector &val) Vertica::SimpleArchiveIn inline
operator>>(std::list &val) Vertica::SimpleArchiveIn inline
operator>>(std::set &val) Vertica::SimpleArchiveIn inline
operator>>(std::unordered_set &val) Vertica::SimpleArchiveIn inline
operator>>(std::pair &val) Vertica::SimpleArchiveIn inline
operator>>(std::map &val) Vertica::SimpleArchiveIn inline
operator>>(std::unordered_map &val) Vertica::SimpleArchiveIn inline
operator>>(T &val) Vertica::SimpleArchiveIn inline
operator>>(T(&val)[n]) Vertica::SimpleArchiveIn inline
read(void *ptr, size_t n) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
readBool() (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
readDouble() (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
readInt() (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
readUint() (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
SimpleArchiveIn(std::istream &istream) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline
write(void *ptr, size_t n) (defined in Vertica::SimpleArchiveIn) Vertica::SimpleArchiveIn inline

1.1.199 - Vertica::SimpleArchiveIn Struct Reference

Collaboration diagram for Vertica::SimpleArchiveIn:

Public Types
typedef std::true_type is_loading
typedef std::false_type is_saving
Public Member Functions
SimpleArchiveIn (std::istream &istream)
void operator& (int64 &val)
void operator& (uint64 &val)
void operator& (long int &val)
void operator& (long unsigned int &val)
void operator& (int32 &val)
void operator& (uint32 &val)
void operator& (int16 &val)
void operator& (uint16 &val)
void operator& (signed char &val)
void operator& (char &val)
void operator& (unsigned char &val)
void operator& (bool &val)
void operator& (double &val)
template
void operator& (std::basic_string, Alloc > &val)
template
void operator& (std::vector &val)
template
void operator& (std::vector &val)
template
void operator& (std::list &val)
template
void operator& (std::set &val)
template
void operator& (std::unordered_set &val)
template
void operator& (std::pair &val)
template
void operator& (std::map &val)
template
void operator& (std::unordered_map &val)
template
void operator& (T &val)
template
SimpleArchiveIn & operator> (int64 &val)
SimpleArchiveIn & operator>> (uint64 &val)
SimpleArchiveIn & operator>> (int32 &val)
SimpleArchiveIn & operator>> (uint32 &val)
SimpleArchiveIn & operator>> (int16 &val)
SimpleArchiveIn & operator>> (uint16 &val)
SimpleArchiveIn & operator>> (signed char &val)
SimpleArchiveIn & operator>> (char &val)
SimpleArchiveIn & operator>> (unsigned char &val)
SimpleArchiveIn & operator>> (bool &b)
SimpleArchiveIn & operator>> (double &d)
template
SimpleArchiveIn & operator>> (std::basic_string, Alloc > &val)
template
SimpleArchiveIn & operator>> (std::vector &val)
template
SimpleArchiveIn & operator>> (std::vector &val)
template
SimpleArchiveIn & operator>> (std::list &val)
template
SimpleArchiveIn & operator>> (std::set &val)
template
SimpleArchiveIn & operator>> (std::unordered_set &val)
template
SimpleArchiveIn & operator>> (std::pair &val)
template
SimpleArchiveIn & operator>> (std::map &val)
template
SimpleArchiveIn & operator>> (std::unordered_map &val)
template
SimpleArchiveIn & operator>> (T &val)
template
SimpleArchiveIn & operator>> (T(&val)[n])
void read (void *ptr, size_t n)
bool readBool ()
double readDouble ()
int64 readInt ()
uint64 readUint ()
void write (void *ptr, size_t n)
Public Attributes
std::istream & is

Detailed Description

Input archive

Member Function Documentation

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(int64 & val)

inline Read a signed integer

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(uint64 & val)

inline Read an unsigned integer

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(int32 & val)

inline Read a signed integer

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(uint32 & val)

inline Read an unsigned integer

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(int16 & val)

inline Read a signed integer

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(uint16 & val)

inline Read an unsigned integer

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(signed char & val)

inline Read a signed integer / char

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(char & val)

inline Read a char

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(unsigned char & val)

inline Read an unsigned char / integer

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(bool & b)

inline Read a double / float

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(double & d)

inline Read a double / float

template<class Alloc >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(std::basic_string, Alloc > & val)

inline Read a string

template<class T , class Alloc >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(std::vector & val)

inline Read a vector

template<class Alloc >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(std::vector & val)

inline Read a vector

template<class T , class Alloc >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(std::list & val)

inline Read a list

template<class T , class Less , class Alloc >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(std::set & val)

inline Read a set

template<class T , class Hash , class Eq , class Alloc >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(std::unordered_set & val)

inline Read an unordered set

template<class T1 , class T2 >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(std::pair & val)

inline Read a pair

template<class K , class V , class Less , class Alloc >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(std::map & val)

inline Read a map

template<class K , class V , class Hash , class Eq , class Alloc >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(std::unordered_map & val)

inline Read an unordered map

template<class T >

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(T & val)

inline Read something with a serialize method, the default thing to do with no specific override

template<typename T , size_t n>

SimpleArchiveIn& Vertica::SimpleArchiveIn::operator>>(T(&) val[n])

inline Fixed array

1.1.200 - Vertica::SimpleArchiveOut Member List

This is the complete list of members for Vertica::SimpleArchiveOut, including all inherited members.

is_loading typedef (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut
is_saving typedef (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut
operator&(const int64 &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const uint64 &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const long int &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const long unsigned int &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const int32 &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const uint32 &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const int16 &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const uint16 &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const signed char &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const char &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const unsigned char &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const bool &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const double &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const std::basic_string, Alloc > &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const std::vector &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const std::vector &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const std::list &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const std::set &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const std::unordered_set &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const std::pair &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const std::map &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const std::unordered_map &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator&(const T &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
operator, Alloc > &val) Vertica::SimpleArchiveOut inline
operator &val) Vertica::SimpleArchiveOut inline
operator &val) Vertica::SimpleArchiveOut inline
operator &val) Vertica::SimpleArchiveOut inline
operator &val) Vertica::SimpleArchiveOut inline
operator &val) Vertica::SimpleArchiveOut inline
operator &val) Vertica::SimpleArchiveOut inline
operator &val) Vertica::SimpleArchiveOut inline
operator &val) Vertica::SimpleArchiveOut inline
operator>(T &val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
os (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut
read(void *ptr, size_t n) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
serializeSigned(vint val, uint8 *buffer) Vertica::SimpleArchiveOut inlinestatic
SimpleArchiveOut(std::ostream &ostream) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
write(const void *ptr, size_t n) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
writeBool(bool b) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
writeDouble(double d) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
writeInt(int64 val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline
writeUint(uint64 val) (defined in Vertica::SimpleArchiveOut) Vertica::SimpleArchiveOut inline

1.1.201 - Vertica::SimpleArchiveOut Struct Reference

Collaboration diagram for Vertica::SimpleArchiveOut:

Public Types
typedef std::false_type is_loading
typedef std::true_type is_saving
Public Member Functions
SimpleArchiveOut (std::ostream &ostream)
void operator& (const int64 &val)
void operator& (const uint64 &val)
void operator& (const long int &val)
void operator& (const long unsigned int &val)
void operator& (const int32 &val)
void operator& (const uint32 &val)
void operator& (const int16 &val)
void operator& (const uint16 &val)
void operator& (const signed char &val)
void operator& (const char &val)
void operator& (const unsigned char &val)
void operator& (const bool &val)
void operator& (const double &val)
template
void operator& (const std::basic_string, Alloc > &val)
template
void operator& (const std::vector &val)
template
void operator& (const std::vector &val)
template
void operator& (const std::list &val)
template
void operator& (const std::set &val)
template
void operator& (const std::unordered_set &val)
template
void operator& (const std::pair &val)
template
void operator& (const std::map &val)
template
void operator& (const std::unordered_map &val)
template
void operator& (const T &val)
SimpleArchiveOut & operator
SimpleArchiveOut & operator, Alloc > &val)
template
SimpleArchiveOut & operator &val)
template
SimpleArchiveOut & operator &val)
template
SimpleArchiveOut & operator &val)
template
SimpleArchiveOut & operator &val)
template
SimpleArchiveOut & operator &val)
template
SimpleArchiveOut & operator &val)
template
SimpleArchiveOut & operator &val)
template
SimpleArchiveOut & operator &val)
template
SimpleArchiveOut & operator
SimpleArchiveOut & operator
SimpleArchiveOut & operator>> (T &val)
void read (void *ptr, size_t n)
void write (const void *ptr, size_t n)
void writeBool (bool b)
void writeDouble (double d)
void writeInt (int64 val)
void writeUint (uint64 val)
Static Public Member Functions
static uint32 serializeSigned (vint val, uint8 *buffer)
Public Attributes
std::ostream & os

Detailed Description

OutputArchive

Member Function Documentation

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out a signed integer

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out an unsigned integer

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out a signed integer

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out an unsigned integer

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out a signed integer

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out an unsigned integer

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out a signed char / integer

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out a char

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out an unsigned char / integer

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out a boolean

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out a double / float

template<class Alloc >
SimpleArchiveOut& Vertica::SimpleArchiveOut::operator, Alloc > & val )

inline Write out a string

template<class T , class Alloc >
SimpleArchiveOut& Vertica::SimpleArchiveOut::operator & val )

inline Write out a vector

template<class Alloc >
SimpleArchiveOut& Vertica::SimpleArchiveOut::operator & val )

inline Write out a vector

template<class T , class Alloc >
SimpleArchiveOut& Vertica::SimpleArchiveOut::operator & val )

inline Write out a list

template<class T , class Less , class Alloc >
SimpleArchiveOut& Vertica::SimpleArchiveOut::operator & val )

inline Write out a set

template<class T , class Hash , class Eq , class Alloc >
SimpleArchiveOut& Vertica::SimpleArchiveOut::operator & val )

inline Write out an unordered set

template<class T1 , class T2 >
SimpleArchiveOut& Vertica::SimpleArchiveOut::operator & val )

inline Write a pair

template<class K , class V , class Less , class Alloc >
SimpleArchiveOut& Vertica::SimpleArchiveOut::operator & val )

inline Write out a map

template<class K , class V , class Hash , class Eq , class Alloc >
SimpleArchiveOut& Vertica::SimpleArchiveOut::operator & val )

inline Write out an unordered map

template<class T >

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Write out something with a serialize method, the default thing to do with no specific override

template<typename T , size_t n>

| SimpleArchiveOut& Vertica::SimpleArchiveOut::operatorinline

Fixed array

static uint32 Vertica::SimpleArchiveOut::serializeSigned(vint val, uint8 * buffer)

inlinestatic

Returns # of bytes written to buffer. Assumes at least 10 bytes are available in buffer prior to write

1.1.202 - Vertica::SizedColumnTypes Class Reference

Represents types and information to determine the size of the columns as input/output of a User Defined Function/Transform.

Inheritance diagram for Vertica::SizedColumnTypes:

Collaboration diagram for Vertica::SizedColumnTypes:

Public Types
using Properties = Field::Properties
Public Member Functions
Fields & addArrayType (const Field &element, const std::string &fieldName="", int maxElems=-1, const Properties &props=Properties())
Fields & addBinary (int32 len, const std::string &fieldName="")
Adds a column of type BINARY.
Fields & addBinary (int32 len, const std::string &fieldName, const Properties &props)
void addBinaryOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type BINARY.
void addBinaryPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type BINARY.
Fields & addBool (const std::string &fieldName="")
Adds a column of type BOOLEAN.
Fields & addBool (const std::string &fieldName, const Properties &props)
void addBoolOrderColumn (const std::string &fieldName="")
Adds an order column of type BOOLEAN.
void addBoolPartitionColumn (const std::string &fieldName="")
Adds a partition column of type BOOLEAN.
Fields & addChar (int32 len, const std::string &fieldName="")
Adds a column of type CHAR.
Fields & addChar (int32 len, const std::string &fieldName, const Properties &props)
void addCharOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type CHAR.
void addCharPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type CHAR.
Fields & addDate (const std::string &fieldName="")
Adds a column of type DATE.
Fields & addDate (const std::string &fieldName, const Properties &props)
void addDateOrderColumn (const std::string &fieldName="")
Adds an order column of type DATE.
void addDatePartitionColumn (const std::string &fieldName="")
Adds a partition column of type DATE.
Fields & addFloat (const std::string &fieldName="")
Adds a column of type FLOAT.
Fields & addFloat (const std::string &fieldName, const Properties &props)
void addFloatOrderColumn (const std::string &fieldName="")
Adds an order column of type FLOAT.
void addFloatPartitionColumn (const std::string &fieldName="")
Adds a partition column of type FLOAT.
Fields & addInt (const std::string &fieldName="")
Adds a column of type INTEGER.
Fields & addInt (const std::string &fieldName, const Properties &props)
Fields & addInterval (int32 precision, int32 range, const std::string &fieldName="")
Adds a column of type INTERVAL/INTERVAL DAY TO SECOND.
Fields & addInterval (int32 precision, int32 range, const std::string &fieldName, const Properties &props)
void addIntervalOrderColumn (int32 precision, int32 range, const std::string &fieldName="")
Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND.
void addIntervalPartitionColumn (int32 precision, int32 range, const std::string &fieldName="")
Adds a partition column of type INTERVAL/INTERVAL DAY TO SECOND.
Fields & addIntervalYM (int32 range, const std::string &fieldName="")
Adds a column of type INTERVAL YEAR TO MONTH.
Fields & addIntervalYM (int32 range, const std::string &fieldName, const Properties &props)
void addIntervalYMOrderColumn (int32 range, const std::string &fieldName="")
Adds an order column of type INTERVAL YEAR TO MONTH.
void addIntervalYMPartitionColumn (int32 range, const std::string &fieldName="")
Adds a partition column of type INTERVAL YEAR TO MONTH.
void addIntOrderColumn (const std::string &fieldName="")
Adds an order column of type INTEGER.
void addIntPartitionColumn (const std::string &fieldName="")
Adds a partition column of type INTEGER.
Fields & addLongVarbinary (int32 len, const std::string &fieldName="")
Adds a column of type LONG VARBINARY.
Fields & addLongVarbinary (int32 len, const std::string &fieldName, const Properties &props)
void addLongVarbinaryOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type VARBINARY.
void addLongVarbinaryPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type VARBINARY.
Fields & addLongVarchar (int32 len, const std::string &fieldName="")
Adds a column of type LONG VARCHAR.
Fields & addLongVarchar (int32 len, const std::string &fieldName, const Properties &props)
void addLongVarcharOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type VARCHAR.
void addLongVarcharPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type VARCHAR.
Fields & addNumeric (int32 precision, int32 scale, const std::string &fieldName="")
Adds a column of type NUMERIC.
Fields & addNumeric (int32 precision, int32 scale, const std::string &fieldName, const Properties &props)
void addNumericOrderColumn (int32 precision, int32 scale, const std::string &fieldName="")
Adds an order column of type NUMERIC.
void addNumericPartitionColumn (int32 precision, int32 scale, const std::string &fieldName="")
Adds a partition column of type NUMERIC.
void addOrderColumn (const VerticaType &dt, const std::string &fieldName="")
Adds an order column of the specified type. (only relevant to multiphase UDTs.)
void addPartitionColumn (const VerticaType &dt, const std::string &fieldName="")
Adds a partition column of the specified type (only relevant to multiphase UDTs.)
Fields & addRowType (const Fields &rowfields, const std::string &fieldName="")
Adds a column of complex row type, with the provided fields.
Fields & addRowType (const Fields &rowfields, const std::string &fieldName, const Properties &props)
void addRowType (const SizedColumnTypes &rowfields, const std::string &fieldName="", const Properties &props=Properties())
Adds a column of complex row type, with the provided fields.
Fields & addTime (int32 precision, const std::string &fieldName="")
Adds a column of type TIME.
Fields & addTime (int32 precision, const std::string &fieldName, const Properties &props)
void addTimeOrderColumn (int32 precision, const std::string &fieldName="")
Adds an order column of type TIME.
void addTimePartitionColumn (int32 precision, const std::string &fieldName="")
Adds a partition column of type TIME.
Fields & addTimestamp (int32 precision, const std::string &fieldName="")
Adds a column of type TIMESTAMP.
Fields & addTimestamp (int32 precision, const std::string &fieldName, const Properties &props)
void addTimestampOrderColumn (int32 precision, const std::string &fieldName="")
Adds an order column of type TIMESTAMP.
void addTimestampPartitionColumn (int32 precision, const std::string &fieldName="")
Adds a partition column of type TIMESTAMP.
Fields & addTimestampTz (int32 precision, const std::string &fieldName="")
Adds a column of type TIMESTAMP WITH TIMEZONE.
Fields & addTimestampTz (int32 precision, const std::string &fieldName, const Properties &props)
void addTimestampTzOrderColumn (int32 precision, const std::string &fieldName="")
Adds an order column of type TIMESTAMP WITH TIMEZONE.
void addTimestampTzPartitionColumn (int32 precision, const std::string &fieldName="")
Adds a partition column of type TIMESTAMP WITH TIMEZONE.
Fields & addTimeTz (int32 precision, const std::string &fieldName="")
Adds a column of type TIME WITH TIMEZONE.
Fields & addTimeTz (int32 precision, const std::string &fieldName, const Properties &props)
void addTimeTzOrderColumn (int32 precision, const std::string &fieldName="")
Adds an order column of type TIME WITH TIMEZONE.
void addTimeTzPartitionColumn (int32 precision, const std::string &fieldName="")
Adds a partition column of type TIME WITH TIMEZONE.
Fields & addUserDefinedType (const char *typeName, int32 len, const std::string &fieldName="")
Adds a column of a user-defined type.
Fields & addUserDefinedType (const char *typeName, int32 len, const std::string &fieldName, const Properties &props)
Fields & addUuid (const std::string &fieldName="")
Adds a column of type UUID.
Fields & addUuid (const std::string &fieldName, const Properties &props)
void addUuidOrderColumn (const std::string &fieldName="")
Adds an order column of type UUID.
Fields & addVarbinary (int32 len, const std::string &fieldName="")
Adds a column of type VARBINARY.
Fields & addVarbinary (int32 len, const std::string &fieldName, const Properties &props)
void addVarbinaryOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type VARBINARY.
void addVarbinaryPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type VARBINARY.
Fields & addVarchar (int32 len, const std::string &fieldName="")
Adds a column of type VARCHAR.
Fields & addVarchar (int32 len, const std::string &fieldName, const Properties &props)
void addVarcharOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type VARCHAR.
void addVarcharPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type VARCHAR.
void getArgumentColumns (std::vector &cols) const
Retrieves indexes of argument columns. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).
size_t getColumnCount () const
Returns the number of columns.
const std::string & getColumnName (size_t idx) const
Returns the name of the column at the specified index.
const Properties & getColumnProperties (size_t idx) const
Returns column properties.
const VerticaType & getColumnType (size_t idx) const
Returns the type of the column at the specified index.
VerticaType & getColumnType (size_t idx)
Returns the type of the column at the specified index.
int getLastOrderColumnIdx () const
Gets the last ORDER BY column index.
int getLastPartitionColumnIdx () const
Gets the last PARTITION BY column index.
void getOrderByColumns (std::vector &cols) const
Retrieves indexes of ORDER BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).
void getPartitionByColumns (std::vector &cols) const
Retrieves indexes of PARTITION BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).
bool isOrderByColumn (int idx) const
Indicates whether the column at the specified index is an ORDER BY column.
bool isPartitionByColumn (int idx) const
Indicates whether the column at the specified index is a PARTITION BY column.
void setColumnProperties (size_t idx, const Properties &props)
Sets column properties.
void setPartitionOrderColumnIdx (int partition_idx, int order_idx)
Sets the PARTITION BY and ORDER BY column indexes.
void setPartitionOrderColumnIdx (const SizedColumnTypes &other)
Sets the PARTITION BY and ORDER BY column indexes from another SizedColumnTypes object.
Protected Member Functions
void validateStringLengthOrThrow (int32 len, const char *typeStr, int32 maxLength)
void validateUDTypeLengthOrThrow (Oid udTypeOid, const char *typeName, int32 len)

Detailed Description

Represents types and information to determine the size of the columns as input/output of a User Defined Function/Transform.

This class is used to exchange size and precision information between Vertica and the user defined function/transform function. Vertica provides the user code with size/precision information about the particular data types that it has been called with, and expects the user code to provide size/precision information about what it will return.

Member Function Documentation

Fields & Vertica::Fields::addBinary(int32 len, const std::string & fieldName = "")

inherited Adds a column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addBinaryOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addBinaryPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addBool(const std::string & fieldName = "")

inherited Adds a column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addBoolOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addBoolPartitionColumn(const std::string & fieldName = "")

inline Adds a partition column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addChar(int32 len, const std::string & fieldName = "")

inherited Adds a column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addCharOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addCharPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addDate(const std::string & fieldName = "")

inherited Adds a column of type DATE.

Parameters

  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addDateOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type DATE.

Parameters

  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addDatePartitionColumn(const std::string & fieldName = "")

inline Adds a partition column of type DATE.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addFloat(const std::string & fieldName = "")

inherited Adds a column of type FLOAT.

Parameters

  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addFloatOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type FLOAT.

Parameters

  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addFloatPartitionColumn(const std::string & fieldName = "")

inline Adds a partition column of type FLOAT.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addInt(const std::string & fieldName = "")

inherited Adds a column of type INTEGER.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addInterval(int32 precision, int32 range, const std::string & fieldName = "")

inherited Adds a column of type INTERVAL/INTERVAL DAY TO SECOND.

Parameters

  • precision: The precision for the interval.
  • range: The range for the interval.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addIntervalOrderColumn(int32 precision, int32 range, const std::string & fieldName = "")

inline Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND.

Parameters

  • precision: The precision for the interval.
  • range: The range for the interval.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addIntervalPartitionColumn(int32 precision, int32 range, const std::string & fieldName = "")

inline Adds a partition column of type INTERVAL/INTERVAL DAY TO SECOND.

Parameters

  • precision: The precision for the interval.
  • range: The range for the interval.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addIntervalYM(int32 range, const std::string & fieldName = "")

inherited Adds a column of type INTERVAL YEAR TO MONTH.

Parameters

  • range: The range for the interval.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addIntervalYMOrderColumn(int32 range, const std::string & fieldName = "")

inline Adds an order column of type INTERVAL YEAR TO MONTH.

Parameters

  • range: The range for the interval.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addIntervalYMPartitionColumn(int32 range, const std::string & fieldName = "")

inline Adds a partition column of type INTERVAL YEAR TO MONTH.

Parameters

  • range: The range for the interval.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addIntOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type INTEGER.

Parameters

  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addIntPartitionColumn(const std::string & fieldName = "")

inline Adds a partition column of type INTEGER.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addLongVarbinary(int32 len, const std::string & fieldName = "")

inherited Adds a column of type LONG VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addLongVarbinaryOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addLongVarbinaryPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addLongVarchar(int32 len, const std::string & fieldName = "")

inherited Adds a column of type LONG VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addLongVarcharOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addLongVarcharPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addNumeric(int32 precision, int32 scale, const std::string & fieldName = "")

inherited Adds a column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addNumericOrderColumn(int32 precision, int32 scale, const std::string & fieldName = "")

inline Adds an order column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addNumericPartitionColumn(int32 precision, int32 scale, const std::string & fieldName = "")

inline Adds a partition column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addRowType(const Fields & rowfields, const std::string & fieldName = "")

inherited Adds a column of complex row type, with the provided fields.

Parameters

  • rowfields: the fields of the complex row type
  • fieldName: the name of the added field

Referenced by addRowType().

void Vertica::SizedColumnTypes::addRowType(const SizedColumnTypes & rowfields, const std::string & fieldName = "", const Properties & props = Properties())

inline Adds a column of complex row type, with the provided fields.

Parameters

  • rowfields: the fields of the complex type row
  • fieldName: the name of the complex row field
  • props: optional field properties
Fields & Vertica::Fields::addTime(int32 precision, const std::string & fieldName = "")

inherited Adds a column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addTimeOrderColumn(int32 precision, const std::string & fieldName = "")

inline Adds an order column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addTimePartitionColumn(int32 precision, const std::string & fieldName = "")

inline Adds a partition column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addTimestamp(int32 precision, const std::string & fieldName = "")

inherited Adds a column of type TIMESTAMP.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addTimestampOrderColumn(int32 precision, const std::string & fieldName = "")

inline Adds an order column of type TIMESTAMP.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addTimestampPartitionColumn(int32 precision, const std::string & fieldName = "")

inline Adds a partition column of type TIMESTAMP.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addTimestampTz(int32 precision, const std::string & fieldName = "")

inherited Adds a column of type TIMESTAMP WITH TIMEZONE.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addTimestampTzOrderColumn(int32 precision, const std::string & fieldName = "")

inline Adds an order column of type TIMESTAMP WITH TIMEZONE.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addTimestampTzPartitionColumn(int32 precision, const std::string & fieldName = "")

inline Adds a partition column of type TIMESTAMP WITH TIMEZONE.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addTimeTz(int32 precision, const std::string & fieldName = "")

inherited Adds a column of type TIME WITH TIMEZONE.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addTimeTzOrderColumn(int32 precision, const std::string & fieldName = "")

inline Adds an order column of type TIME WITH TIMEZONE.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addTimeTzPartitionColumn(int32 precision, const std::string & fieldName = "")

inline Adds a partition column of type TIME WITH TIMEZONE.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addUserDefinedType(const char * typeName, int32 len, const std::string & fieldName = "")

inherited Adds a column of a user-defined type.

Parameters

  • typeName: the name of the type
  • len: the length of the type field, in bytes
  • fieldName: the name of the field
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addUuid(const std::string & fieldName = "")

inherited Adds a column of type UUID.

Parameters

  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addUuidOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type UUID.

Parameters

  • fieldName: The name for the output column.
Fields & Vertica::Fields::addVarbinary(int32 len, const std::string & fieldName = "")

inherited Adds a column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addVarbinaryOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addVarbinaryPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
Fields & Vertica::Fields::addVarchar(int32 len, const std::string & fieldName = "")

inherited Adds a column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addVarcharOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::addVarcharPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void Vertica::SizedColumnTypes::getArgumentColumns(std::vector & cols) const

inline Retrieves indexes of argument columns. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).

Parameters

  • cols: A vector to store the retrieved column indexes.
const std::string& Vertica::SizedColumnTypes::getColumnName(size_t idx) const

inline Returns the name of the column at the specified index.

Parameters

  • idx: The index of the column

Referenced by Vertica::ParserFactory::getParserReturnType().

const Properties& Vertica::SizedColumnTypes::getColumnProperties(size_t idx) const

inline Returns column properties.

Parameters

  • idx: The index of the column
const VerticaType& Vertica::SizedColumnTypes::getColumnType(size_t idx) const

inline Returns the type of the column at the specified index.

Parameters

  • idx: The index of the column

Returns a VerticaType object describing the column's data type.

Referenced by

VerticaType& Vertica::SizedColumnTypes::getColumnType(size_t idx)

inline Returns the type of the column at the specified index.

Parameters

  • idx: The index of the column
void Vertica::SizedColumnTypes::getOrderByColumns(std::vector & cols) const

inline Retrieves indexes of ORDER BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).

Parameters

  • cols: A vector to store the retrieved column indexes.
void Vertica::SizedColumnTypes::getPartitionByColumns(std::vector & cols) const

inline Retrieves indexes of PARTITION BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).

Parameters

  • cols: A vector to store the retrieved column indexes.
bool Vertica::SizedColumnTypes::isOrderByColumn(int idx) const

inline Indicates whether the column at the specified index is an ORDER BY column.

Parameters

  • idx: The index of the column
bool Vertica::SizedColumnTypes::isPartitionByColumn(int idx) const

inline Indicates whether the column at the specified index is a PARTITION BY column.

Parameters

  • idx: The index of the column
void Vertica::SizedColumnTypes::setColumnProperties(size_t idx, const Properties & props)

inline Sets column properties.

Parameters

  • idx: The index of the column
void Vertica::SizedColumnTypes::setPartitionOrderColumnIdx(int partition_idx, int order_idx)

inline Sets the PARTITION BY and ORDER BY column indexes.

Parameters

  • partition_idx: Index of the last partition-by column
  • order_idx: Index of the last order-by column
void Vertica::SizedColumnTypes::setPartitionOrderColumnIdx(const SizedColumnTypes & other)

inline Sets the PARTITION BY and ORDER BY column indexes from another SizedColumnTypes object.

Parameters

  • other: The SizedColumnTypes object to set the indexes from

1.1.203 - Vertica::SizedColumnTypes Member List

This is the complete list of members for Vertica::SizedColumnTypes, including all inherited members.

addArrayType(const Field &element, const std::string &fieldName="", int maxElems=-1, const Properties &props=Properties()) (defined in Vertica::Fields) Vertica::Fields
addBinary(int32 len, const std::string &fieldName="") Vertica::Fields
addBinary(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addBinaryOrderColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addBinaryPartitionColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addBool(const std::string &fieldName="") Vertica::Fields
addBool(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addBoolOrderColumn(const std::string &fieldName="") Vertica::SizedColumnTypes inline
addBoolPartitionColumn(const std::string &fieldName="") Vertica::SizedColumnTypes inline
addChar(int32 len, const std::string &fieldName="") Vertica::Fields
addChar(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addCharOrderColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addCharPartitionColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addDate(const std::string &fieldName="") Vertica::Fields
addDate(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addDateOrderColumn(const std::string &fieldName="") Vertica::SizedColumnTypes inline
addDatePartitionColumn(const std::string &fieldName="") Vertica::SizedColumnTypes inline
addFloat(const std::string &fieldName="") Vertica::Fields
addFloat(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addFloatOrderColumn(const std::string &fieldName="") Vertica::SizedColumnTypes inline
addFloatPartitionColumn(const std::string &fieldName="") Vertica::SizedColumnTypes inline
addInt(const std::string &fieldName="") Vertica::Fields
addInt(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addInterval(int32 precision, int32 range, const std::string &fieldName="") Vertica::Fields
addInterval(int32 precision, int32 range, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addIntervalOrderColumn(int32 precision, int32 range, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addIntervalPartitionColumn(int32 precision, int32 range, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addIntervalYM(int32 range, const std::string &fieldName="") Vertica::Fields
addIntervalYM(int32 range, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addIntervalYMOrderColumn(int32 range, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addIntervalYMPartitionColumn(int32 range, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addIntOrderColumn(const std::string &fieldName="") Vertica::SizedColumnTypes inline
addIntPartitionColumn(const std::string &fieldName="") Vertica::SizedColumnTypes inline
addLongVarbinary(int32 len, const std::string &fieldName="") Vertica::Fields
addLongVarbinary(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addLongVarbinaryOrderColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addLongVarbinaryPartitionColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addLongVarchar(int32 len, const std::string &fieldName="") Vertica::Fields
addLongVarchar(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addLongVarcharOrderColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addLongVarcharPartitionColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addNumeric(int32 precision, int32 scale, const std::string &fieldName="") Vertica::Fields
addNumeric(int32 precision, int32 scale, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addNumericOrderColumn(int32 precision, int32 scale, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addNumericPartitionColumn(int32 precision, int32 scale, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addOrderColumn(const VerticaType &dt, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addPartitionColumn(const VerticaType &dt, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addRowType(const SizedColumnTypes &rowfields, const std::string &fieldName="", const Properties &props=Properties()) Vertica::SizedColumnTypes inline
Vertica::Fields::addRowType(const Fields &rowfields, const std::string &fieldName="") Vertica::Fields
addRowType(const Fields &rowfields, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addTime(int32 precision, const std::string &fieldName="") Vertica::Fields
addTime(int32 precision, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addTimeOrderColumn(int32 precision, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addTimePartitionColumn(int32 precision, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addTimestamp(int32 precision, const std::string &fieldName="") Vertica::Fields
addTimestamp(int32 precision, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addTimestampOrderColumn(int32 precision, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addTimestampPartitionColumn(int32 precision, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addTimestampTz(int32 precision, const std::string &fieldName="") Vertica::Fields
addTimestampTz(int32 precision, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addTimestampTzOrderColumn(int32 precision, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addTimestampTzPartitionColumn(int32 precision, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addTimeTz(int32 precision, const std::string &fieldName="") Vertica::Fields
addTimeTz(int32 precision, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addTimeTzOrderColumn(int32 precision, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addTimeTzPartitionColumn(int32 precision, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addUserDefinedType(const char *typeName, int32 len, const std::string &fieldName="") Vertica::Fields
addUserDefinedType(const char *typeName, int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addUuid(const std::string &fieldName="") Vertica::Fields
addUuid(const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addUuidOrderColumn(const std::string &fieldName="") Vertica::SizedColumnTypes inline
addVarbinary(int32 len, const std::string &fieldName="") Vertica::Fields
addVarbinary(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addVarbinaryOrderColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addVarbinaryPartitionColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addVarchar(int32 len, const std::string &fieldName="") Vertica::Fields
addVarchar(int32 len, const std::string &fieldName, const Properties &props) (defined in Vertica::Fields) Vertica::Fields
addVarcharOrderColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
addVarcharPartitionColumn(int32 len, const std::string &fieldName="") Vertica::SizedColumnTypes inline
Fields() (defined in Vertica::Fields) Vertica::Fields inline
getArgumentColumns(std::vector &cols) const Vertica::SizedColumnTypes inline
getColumnCount() const Vertica::SizedColumnTypes inline
getColumnName(size_t idx) const Vertica::SizedColumnTypes inline
getColumnProperties(size_t idx) const Vertica::SizedColumnTypes inline
getColumnType(size_t idx) const Vertica::SizedColumnTypes inline
getColumnType(size_t idx) Vertica::SizedColumnTypes inline
getLastOrderColumnIdx() const Vertica::SizedColumnTypes inline
getLastPartitionColumnIdx() const Vertica::SizedColumnTypes inline
getOrderByColumns(std::vector &cols) const Vertica::SizedColumnTypes inline
getPartitionByColumns(std::vector &cols) const Vertica::SizedColumnTypes inline
isOrderByColumn(int idx) const Vertica::SizedColumnTypes inline
isPartitionByColumn(int idx) const Vertica::SizedColumnTypes inline
Properties typedef (defined in Vertica::SizedColumnTypes) Vertica::SizedColumnTypes
setColumnProperties(size_t idx, const Properties &props) Vertica::SizedColumnTypes inline
setPartitionOrderColumnIdx(int partition_idx, int order_idx) Vertica::SizedColumnTypes inline
setPartitionOrderColumnIdx(const SizedColumnTypes &other) Vertica::SizedColumnTypes inline
validateStringLengthOrThrow(int32 len, const char *typeStr, int32 maxLength) (defined in Vertica::Fields) Vertica::Fields protected
validateUDTypeLengthOrThrow(Oid udTypeOid, const char *typeName, int32 len) (defined in Vertica::Fields) Vertica::Fields protected

1.1.204 - Vertica::SourceFactory Class Reference

Produces and initializes UDSources to process input data sources.

Inheritance diagram for Vertica::SourceFactory:

Collaboration diagram for Vertica::SourceFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual ssize_t getDesiredThreads (ServerInterface &srvInterface, ExecutorPlanContext &planCtxt) override
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res) override
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override
UDXFactory::UDXType getUDXFactoryType () override
virtual bool isSourceApportionable ()
virtual void plan (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) override
virtual SourceIterator * prepare (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
virtual SourceIterator * prepareExecutor (ServerInterface &srvInterface, ExecutorPlanContext &planCtxt)
virtual std::vector prepareUDSources (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
virtual std::vector prepareUDSourcesExecutor (ServerInterface &srvInterface, ExecutorPlanContext &planCtxt)
Protected Attributes
Oid libOid
std::string sqlName

Detailed Description

Produces and initializes UDSources to process input data sources.

Subclassing SourceFactory is the preferred way to implement a factory corresponding to a UDSource. If you need more flexibility, implement both IterativeSourceFactory and SourceIterator. (See the documentation of IterativeSourceFactory.)

Factories should be registered using the RegisterFactory() macro, defined in Vertica.h.

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual ssize_t Vertica::SourceFactory::getDesiredThreads(ServerInterface & srvInterface, ExecutorPlanContext & planCtxt)

inlinevirtual

Request the number of threads that the SourceFactory wants to use. This function is called on each node before prepareUDSources().

'planCtxt' contains the same parameters stored by plan(). It exposes the maximum number of allowed threads, via 'getMaxAllowedThreads()', and also the actual number of threads, via 'getLoadConcurrency()'.

The default implementation of this invokes prepare(), saves the result in the ExecutorPlanContext, and returns the number of sources as the number of desired threads.

Reimplemented from Vertica::IterativeSourceFactory.

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented from Vertica::UDXFactory.

Referenced by Vertica::UDLFactory::getPerInstanceResources().

virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented from Vertica::UDXFactory.

UDXFactory::UDXType Vertica::IterativeSourceFactory::getUDXFactoryType()

inlinevirtualinherited

Returns the type of UDX Object instance this factory returns.

Note User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Implements Vertica::UDXFactory.

virtual void Vertica::SourceFactory::plan(ServerInterface & srvInterface, NodeSpecifyingPlanContext & planCtxt)

inlinevirtual

Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on.

plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan(). Also provides functionality for specifying which nodes this query will run on.

Reimplemented from Vertica::IterativeSourceFactory.

virtual SourceIterator* Vertica::IterativeSourceFactory::prepareExecutor(ServerInterface & srvInterface, ExecutorPlanContext & planCtxt)

inlinevirtualinherited

Prepare this SourceFactory to start creating sources. This function will be called on each node, prior to the Load operator starting to execute and prior to any other virtual functions on this class being called.

'planCtxt' contains the same data that was placed there by the plan() and getDesiredThreads() methods.

Referenced by getDesiredThreads().

virtual std::vector Vertica::SourceFactory::prepareUDSourcesExecutor(ServerInterface & srvInterface, ExecutorPlanContext & planCtxt)

inlinevirtual

Create UDSources. This function will be called on each node, prior to the Load operator starting to execute and prior to any other virtual functions on this class being called.

'planCtxt' contains the same data that was placed there by the plan() and getDesiredThreads() methods. It also exposes the maximum execution parallelism with 'getMaxAllowedThreads()' and the actual load concurrency with 'getLoadConcurrency()'.

Unlike the standard SourceFactory, this method directly instantiates all of its UDSources, and returns a vector of them. This requires that all UDSources be resident in memory for the duration of the query, which is fine in the common case but which may not be acceptable for some resource-intensive UDSources.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan() and getDesiredThreads(). Also provides functionality for determining which nodes this query is running on and getting the number of available threads.

Returns A vector of UDSources to use for this query. Sources will be loaded in a pooled manner, several at a time.

1.1.205 - Vertica::SourceFactory Member List

This is the complete list of members for Vertica::SourceFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getDesiredThreads(ServerInterface &srvInterface, ExecutorPlanContext &planCtxt) override Vertica::SourceFactory inlinevirtual
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) override Vertica::UDLFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override Vertica::UDLFactory inlinevirtual
getUDXFactoryType() override Vertica::IterativeSourceFactory inlinevirtual
isSourceApportionable() (defined in Vertica::IterativeSourceFactory) Vertica::IterativeSourceFactory inlinevirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
plan(ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) override Vertica::SourceFactory inlinevirtual
prepare(ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) (defined in Vertica::IterativeSourceFactory) Vertica::IterativeSourceFactory inlinevirtual
prepareExecutor(ServerInterface &srvInterface, ExecutorPlanContext &planCtxt) Vertica::IterativeSourceFactory inlinevirtual
prepareUDSources(ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) (defined in Vertica::SourceFactory) Vertica::SourceFactory inlinevirtual
prepareUDSourcesExecutor(ServerInterface &srvInterface, ExecutorPlanContext &planCtxt) Vertica::SourceFactory inlinevirtual
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~UDLFactory() (defined in Vertica::UDLFactory) Vertica::UDLFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.206 - Vertica::SourceIterator Class Reference

Constructs a set of Sources to be used by an IterativeSourceFactory.

Inheritance diagram for Vertica::SourceIterator:

Collaboration diagram for Vertica::SourceIterator:

Public Member Functions
void cancelUDX (ServerInterface &srvInterface)
virtual UnsizedUDSource * createNextSource (ServerInterface &srvInterface)=0
Create the next UDSource to process.
virtual void destroy (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
Tear down this SourceIterator.
virtual size_t getNumberOfSources ()=0
indicate an upper bound for the number of sources this factory will produce.
virtual size_t getSizeOfSource (size_t sourceNum)
bool isCanceled () const
virtual void setup (ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt)
Set up this SourceIterator.
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Detailed Description

Constructs a set of Sources to be used by an IterativeSourceFactory.

Wrappers to help construct and manage UDLs createNextSource() will be called repeatedly until it returns NULL. Each resulting Source will be read to completion, and the contained data passed to the Filter and Parser.

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual UnsizedUDSource* Vertica::SourceIterator::createNextSource(ServerInterface & srvInterface)

pure virtual Create the next UDSource to process.

Should return NULL if no further sources are available for processing.

Note that the previous Source may still be open and in use on a different thread when this function is called.

Returns a new Source instance corresponding to a new input stream

Implemented in Vertica::DefaultSourceIterator.

virtual void Vertica::SourceIterator::destroy(ServerInterface & srvInterface, NodeSpecifyingPlanContext & planCtxt)

inlinevirtual

Tear down this SourceIterator.

Should perform clean-up that should not take place in the destructor due to the exception-handling semantics of destructors.

virtual size_t Vertica::SourceIterator::getNumberOfSources()

pure virtual indicate an upper bound for the number of sources this factory will produce.

If this method returns N, then createNextSource() will be called at most N times ("at most" because it will stop being called when it returns NULL).

Returns the maximum number of Sources that this factory will produce

Implemented in Vertica::DefaultSourceIterator.

Referenced by Vertica::SourceFactory::getDesiredThreads().

virtual size_t Vertica::SourceIterator::getSizeOfSource(size_t sourceNum)

inlinevirtual

Returns the raw-data size of the sourceNum'th source that will be produced by createNextSource(). Should return vint_null if the size is unknown.

This value is used as a hint, and is used by the "load_streams" table to display load progress. If incorrect or not set, "load_streams" may contain incorrect or unhelpful information.

Reimplemented in Vertica::DefaultSourceIterator.

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual void Vertica::SourceIterator::setup(ServerInterface & srvInterface, NodeSpecifyingPlanContext & planCtxt)

inlinevirtual

Set up this SourceIterator.

Should perform setup that should not take place in the constructor due to the exception-handling semantics of constructors

1.1.207 - Vertica::SourceIterator Member List

This is the complete list of members for Vertica::SourceIterator, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
createNextSource(ServerInterface &srvInterface)=0 Vertica::SourceIterator pure virtual
destroy(ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) Vertica::SourceIterator inlinevirtual
getNumberOfSources()=0 Vertica::SourceIterator pure virtual
getSizeOfSource(size_t sourceNum) Vertica::SourceIterator inlinevirtual
isCanceled() const Vertica::UDXObject inline
setup(ServerInterface &srvInterface, NodeSpecifyingPlanContext &planCtxt) Vertica::SourceIterator inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
~SourceIterator() (defined in Vertica::SourceIterator) Vertica::SourceIterator inlinevirtual
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.208 - Vertica::SplitArchiver< false, Archive, T > Member List

This is the complete list of members for Vertica::SplitArchiver, including all inherited members.

archive(Archive &ar, T &t, const unsigned int serializer_version) (defined in Vertica::SplitArchiver) Vertica::SplitArchiver inlinestatic

1.1.209 - Vertica::SplitArchiver< false, Archive, T > Struct Template Reference

Collaboration diagram for Vertica::SplitArchiver< false, Archive, T >:

Static Public Member Functions
static void archive (Archive &ar, T &t, const unsigned int serializer_version)

1.1.210 - Vertica::SplitArchiver< saving, Archive, T > Struct Template Reference

Collaboration diagram for Vertica::SplitArchiver< saving, Archive, T >:

1.1.211 - Vertica::SplitArchiver< true, Archive, T > Member List

This is the complete list of members for Vertica::SplitArchiver, including all inherited members.

archive(Archive &ar, T &t, const unsigned int serializer_version) (defined in Vertica::SplitArchiver) Vertica::SplitArchiver inlinestatic

1.1.212 - Vertica::SplitArchiver< true, Archive, T > Struct Template Reference

Collaboration diagram for Vertica::SplitArchiver< true, Archive, T >:

Static Public Member Functions
static void archive (Archive &ar, T &t, const unsigned int serializer_version)

1.1.213 - Vertica::StreamWriter Class Reference

Provides an iterator-based write interface over output data for a stream of blocks. Automatically makes space a block-at-a-time, as needed.

Inheritance diagram for Vertica::StreamWriter:

Collaboration diagram for Vertica::StreamWriter:

Public Member Functions
StreamWriter (size_t narg, void *udl)
void copy (const VerticaBlock &other)
void copyFromInput (size_t dstIdx, const BlockReader &input_reader, size_t srcIdx)
void copyFromInput (const BlockReader &input_reader)
Array::ArrayWriter getArrayRef (size_t idx)
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
PartitionWriterColumns getColumns ()
const EE::DataArea * getDataArea (size_t idx) const
size_t getNumCols () const
VNumeric & getNumericRef (size_t idx)
int getNumRows () const
BlockWriter * getRowPtr (size_t idx)
BlockWriter & getRowRef (size_t idx)
Get a reference for writing an output Row value.
VString & getStringRef (size_t idx)
VString & getStringRefNoClear (size_t idx)
uint64 getTotalRowCount () const
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
VUuid & getUuidRef (size_t idx)
const void * getVoidPtr (size_t idx=0) const
void * getVoidPtr (size_t idx)
virtual bool getWriteableBlock () override
bool next ()
bool remaining () const
void setBool (size_t idx, vbool r)
void setDataArea (size_t idx, void *dataarea)
void setDate (size_t idx, DateADT r)
void setFloat (size_t idx, vfloat r)
void setInt (size_t idx, vint r)
void setInterval (size_t idx, Interval r)
void setIntervalYM (size_t idx, IntervalYM r)
void setNull (size_t idx)
Set the idx'th argument to null. If a column has the canBeNull attribute set to false, then this throws an exception.
void setNull (size_t idx, bool enforceNotNullProperty)
Set the idx'th argument to null.
void setTime (size_t idx, TimeADT r)
void setTimestamp (size_t idx, Timestamp r)
void setTimestampTz (size_t idx, TimestampTz r)
void setTimeTz (size_t idx, TimeTzADT r)
void throwIncorrectUsageError (size_t idx)
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
bool commitPrefilledRows (int nRows)
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
union {
EE::UserDefinedAnalytic * udan
EE::UserDefinedTransform * udt
EE::UserDefinedProcess * udx_object
};
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
uint64 cumulative_rows
int index
const int * indices
size_t ncols
int nrows
void * parent
std::vector processBlockUserInfoVector
int pstart
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers
Friends
class EE::Loader::UserDefinedLoad

Detailed Description

Provides an iterator-based write interface over output data for a stream of blocks. Automatically makes space a block-at-a-time, as needed.

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

void Vertica::PartitionWriter::copyFromInput(size_t dstIdx, const BlockReader & input_reader, size_t srcIdx)

inherited Copies a column from the input reader to the output writer. Raises an error if the input and output data types are not compatible.

Parameters

  • dstIdx: The destination column index (in the output writer)
  • input_reader: The input reader from which to copy a column
  • srcIdx: The source column index (in the input reader)
EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotectedinherited

Returns a pointer to a DataArea for accumulating an intermediate result

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline inherited Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

size_t Vertica::VerticaBlock::getNumCols() const

inline inherited Returns the number of columns held by this block.

Referenced by

int Vertica::VerticaBlock::getNumRows() const

inline inherited Returns the number of rows held by this block.

BlockWriter& Vertica::PartitionWriter::getRowRef(size_t idx)

inline inherited Get a reference for writing an output Row value.

Parameters

  • idx: the output column

Returns a reference to a BlockWriter which holds output data for the Row value's fields

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline inherited Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline inherited Returns information about the types and numbers of arguments

virtual bool Vertica::StreamWriter::getWriteableBlock()

virtual

Gets a writeable block of data and positions cursor at the beginning.

Reimplemented from Vertica::PartitionWriter.

bool Vertica::VerticaBlock::remaining() const

inline inherited Returns the number of entries remaining in the block

void Vertica::PartitionWriter::setInt(size_t idx, vint r)

inline inherited Setter methods

void Vertica::PartitionWriter::setNull(size_t idx)

inline inherited Set the idx'th argument to null. If a column has the canBeNull attribute set to false, then this throws an exception.

Parameters

  • idx: The column number in the row to set to null
void Vertica::PartitionWriter::setNull(size_t idx, bool enforceNotNullProperty)

inline inherited Set the idx'th argument to null.

Parameters

  • idx: The column number in the row to set to null
  • enforceNotNullProperty: If false, do not throw an exception if canBeNull is false.

1.1.214 - Vertica::StreamWriter Member List

This is the complete list of members for Vertica::StreamWriter, including all inherited members.

addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
commitPrefilledRows(int nRows) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inlineprotected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
copyFromInput(size_t dstIdx, const BlockReader &input_reader, size_t srcIdx) Vertica::PartitionWriter
copyFromInput(const BlockReader &input_reader) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
cumulative_rows (defined in Vertica::StreamWriter) Vertica::StreamWriter protected
EE::Loader::UserDefinedLoad (defined in Vertica::StreamWriter) Vertica::StreamWriter friend
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getArrayRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColumns() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getNumCols() const Vertica::VerticaBlock inline
getNumericRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getNumRows() const Vertica::VerticaBlock inline
getRowPtr(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getRowRef(size_t idx) Vertica::PartitionWriter inline
getStringRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getStringRefNoClear(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getTotalRowCount() const (defined in Vertica::StreamWriter) Vertica::StreamWriter inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getUuidRef(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getVoidPtr(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getWriteableBlock() override Vertica::StreamWriter virtual
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
next() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
parent (defined in Vertica::StreamWriter) Vertica::StreamWriter protected
PartitionWriter(size_t narg) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
PartitionWriter(size_t narg, EE::UserDefinedProcess *udx_object) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
PartitionWriter(size_t narg, size_t nrows, EE::UserDefinedProcess *udx_object) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
pstart (defined in Vertica::PartitionWriter) Vertica::PartitionWriter protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inlineprotected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setBool(size_t idx, vbool r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setDate(size_t idx, DateADT r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setFloat(size_t idx, vfloat r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setInt(size_t idx, vint r) Vertica::PartitionWriter inline
setInterval(size_t idx, Interval r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setIntervalYM(size_t idx, IntervalYM r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setNull(size_t idx) Vertica::PartitionWriter inline
setNull(size_t idx, bool enforceNotNullProperty) Vertica::PartitionWriter inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setTime(size_t idx, TimeADT r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setTimestamp(size_t idx, Timestamp r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setTimestampTz(size_t idx, TimestampTz r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
setTimeTz(size_t idx, TimeTzADT r) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
StreamWriter(size_t narg, void *udl) (defined in Vertica::StreamWriter) Vertica::StreamWriter inline
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
throwIncorrectUsageError(size_t idx) (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inline
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
udan (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
udt (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
udx_object (defined in Vertica::PartitionWriter) Vertica::PartitionWriter
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~PartitionWriter() (defined in Vertica::PartitionWriter) Vertica::PartitionWriter inlinevirtual
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.215 - Vertica::TransformFunction Class Reference

Interface for User-Defined Transform Function (UDTF). A UDTF operates on a table segment and returns zero or more rows of data.

Inheritance diagram for Vertica::TransformFunction:

Collaboration diagram for Vertica::TransformFunction:

Public Member Functions
void cancelUDX (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams)
bool isCanceled () const
virtual void processPartition (ServerInterface &srvInterface, PartitionReader &input_reader, PartitionWriter &output_writer)=0
virtual void setup (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Detailed Description

Interface for User-Defined Transform Function (UDTF). A UDTF operates on a table segment and returns zero or more rows of data.

UDTFs can only be used in the SELECT list of a query. UDTFs are cancelable.

A TransformFunction must have an associated TransformFunctionFactory.

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtualinherited

Perform per instance destruction. This function may throw errors

Referenced by Vertica::UDXFunction::destroy().

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SessionParamWriterMap & udSessionParams)

inlinevirtualinherited

Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual void Vertica::TransformFunction::processPartition(ServerInterface & srvInterface, PartitionReader & input_reader, PartitionWriter & output_writer)

pure virtual Invoke a user defined transform on a set of rows. As the name suggests, a batch of rows are passed in for every invocation to amortize performance.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • input_reader: input rows
  • output_writer: output location
virtual void Vertica::UDXFunction::setup(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtualinherited

Perform per instance initialization. This function may throw errors.

1.1.216 - Vertica::TransformFunction Member List

This is the complete list of members for Vertica::TransformFunction, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams) Vertica::UDXFunction inlinevirtual
isCanceled() const Vertica::UDXObject inline
processPartition(ServerInterface &srvInterface, PartitionReader &input_reader, PartitionWriter &output_writer)=0 Vertica::TransformFunction pure virtual
setup(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.217 - Vertica::TransformFunctionFactory Class Reference

Interface for declaring parameters and return types for, and instantiating, an associated TransformFunction.

Inheritance diagram for Vertica::TransformFunctionFactory:

Collaboration diagram for Vertica::TransformFunctionFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual TransformFunction * createTransformFunction (ServerInterface &srvInterface)=0
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes)
virtual void getPrototype (ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0
virtual void getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)=0
Protected Member Functions
virtual UDXType getUDXFactoryType () override
Protected Attributes
Oid libOid
std::string sqlName

Detailed Description

Interface for declaring parameters and return types for, and instantiating, an associated TransformFunction.

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual TransformFunction* Vertica::TransformFunctionFactory::createTransformFunction(ServerInterface & srvInterface)

pure virtual Called when Vertica needs a new TransformFunction object to process a UDTF function call.

Returns a TransformFunction object which implements the UDx API described by this metadata.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Note More than one object may be instantiated per query.

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented in Vertica::UDLFactory.

Referenced by Vertica::UDXFactory::getPerInstanceResources().

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented in Vertica::UDLFactory.

virtual void Vertica::FunctionFactory::getPrototype(ServerInterface & srvInterface, ColumnTypes & argTypes, ColumnTypes & returnType)

pure virtual inherited Provides the argument and return types of the UDX

Implemented in Vertica::MultiPhaseTransformFunctionFactory.

Referenced by Vertica::ScalarFunctionFactory::getReturnType().

virtual void Vertica::FunctionFactory::getReturnType(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SizedColumnTypes & returnType)

pure virtual inherited Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time/Timestamp types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Implemented in Vertica::MultiPhaseTransformFunctionFactory, and Vertica::ScalarFunctionFactory.

virtual UDXType Vertica::TransformFunctionFactory::getUDXFactoryType()

inlineprotectedvirtual

Returns the object type internally used by Vertica

Implements Vertica::UDXFactory.

1.1.218 - Vertica::TransformFunctionFactory Member List

This is the complete list of members for Vertica::TransformFunctionFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
createTransformFunction(ServerInterface &srvInterface)=0 Vertica::TransformFunctionFactory pure virtual
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) Vertica::UDXFactory inlinevirtual
getPrototype(ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)=0 Vertica::FunctionFactory pure virtual
getReturnType(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)=0 Vertica::FunctionFactory pure virtual
getUDXFactoryType() override Vertica::TransformFunctionFactory inlineprotectedvirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~FunctionFactory() (defined in Vertica::FunctionFactory) Vertica::FunctionFactory inlinevirtual
~TransformFunctionFactory() (defined in Vertica::TransformFunctionFactory) Vertica::TransformFunctionFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.219 - Vertica::TransformFunctionPhase Class Reference

Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function.

Collaboration diagram for Vertica::TransformFunctionPhase:

Public Member Functions
virtual TransformFunction * createTransformFunction (ServerInterface &srvInterface)=0
virtual void getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnTypes)=0
bool isPrepass ()
void setPrepass ()
Indicates that this phase is a pre-pass (i.e., runs before any data movement)

Detailed Description

Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function.

Note that even though this class shares some methods with TransformFunctionFactory, it is explicitly not a subclass (because it is incorrect to implement a getPrototype() method for this class).

Member Function Documentation

virtual TransformFunction* Vertica::TransformFunctionPhase::createTransformFunction(ServerInterface & srvInterface)

pure virtual Called when Vertica needs a new TransformFunction object to process this phase of a multi-phase UDT.

Returns a TransformFunction object which implements the UDx API described by this metadata.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Note More than one object may be instantiated per query.

virtual void Vertica::TransformFunctionPhase::getReturnType(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SizedColumnTypes & returnTypes)

pure virtual Function to tell Vertica what the return types (and length/precision if necessary) and partition-by, order-by of this phase are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time/Timestamp types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • argTypes: Provides the data types of arguments that this phase was called with, along with partition and order information. This may be used to modify the return types accordingly.
  • returnTypes: User code must fill in the names and data types returned by this phase, along with the partition-by and order-by column information (if any).

1.1.220 - Vertica::TransformFunctionPhase Member List

This is the complete list of members for Vertica::TransformFunctionPhase, including all inherited members.

createTransformFunction(ServerInterface &srvInterface)=0 Vertica::TransformFunctionPhase pure virtual
getReturnType(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnTypes)=0 Vertica::TransformFunctionPhase pure virtual
isPrepass() (defined in Vertica::TransformFunctionPhase) Vertica::TransformFunctionPhase inline
setPrepass() Vertica::TransformFunctionPhase inline
TransformFunctionPhase() (defined in Vertica::TransformFunctionPhase) Vertica::TransformFunctionPhase inline
~TransformFunctionPhase() (defined in Vertica::TransformFunctionPhase) Vertica::TransformFunctionPhase inlinevirtual

1.1.221 - Vertica::UDChunker Class Reference

Separates parser input into chunks at record boundaries, allowing parsing to proceed in parallel.

Inheritance diagram for Vertica::UDChunker:

Collaboration diagram for Vertica::UDChunker:

Public Member Functions
virtual ~UDChunker ()
virtual StreamState alignPortion (ServerInterface &srvInterface, DataBuffer &input, InputState inputState)
void cancelUDX (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface, SizedColumnTypes &returnType)
virtual void destroy (ServerInterface &srvInterface, SizedColumnTypes &returnType, SessionParamWriterMap &udSessionParams)
bool isCanceled () const
virtual StreamState process (ServerInterface &srvInterface, DataBuffer &input, InputState input_state)=0
virtual void setup (ServerInterface &srvInterface, SizedColumnTypes &returnType)
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)
Portion getPortion () const

Detailed Description

Separates parser input into chunks at record boundaries, allowing parsing to proceed in parallel.

Vertica invokes a UDChunker (if present) as part of the parsing phase. Chunkers are tightly coupled to parsers.

Note that it is UNSAFE to maintain pointers or references to any of these arguments (or any other argument passed by reference into any other function in this API) beyond the scope of the function call in question. For example, do not store a reference to the server interface or the input block on an instance variable. Vertica may free and replace these objects.

Constructor & Destructor Documentation

virtual Vertica::UDChunker::~UDChunker()

inlinevirtual

Dtor.

Member Function Documentation

virtual StreamState Vertica::UDChunker::alignPortion(ServerInterface & srvInterface, DataBuffer & input, InputState inputState)

inlinevirtual

UDChunker::alignPortion()

See "Apportioned Load".

Reads data from the input stream and aligns the chunker to the beginning of the first chunk in the portion of the stream it is processing.

This is invoked repeatedly during query execution, before any calls to process(), if we are doing an apportioned load. The input buffer initially contains contents from the start of the current portion; future calls may advance along the stream. This method should identify the start of the first chunk that this UDChunker will produce, and indicate that it is now "aligned" to that boundary by setting input.offset to the corresponding offset and returning DONE.

Note that input may contain null bytes, if the source contains null bytes. Note also that input is NOT automatically null-terminated.

alignPortion() must not block indefinitely. If it cannot proceed for an extended period of time, it should return KEEP_GOING. It will be called again shortly. Failure to do this will, among other things, prevent the query from being canceled by the user.

Valid return values for this method are INPUT_NEEDED, KEEP_GOING, and DONE.

Returns KEEP_GOING if the UDChunker must block; INPUT_NEEDED if a record boundary cannot be found in the input. Leaving input.offset unchanged will result in a larger buffer for the next invocation. Advance input.offset to advance through the data stream. DONE if a portion boundary has been identified. Set input.offset to the location of that boundary.

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual void Vertica::UDChunker::destroy(ServerInterface & srvInterface, SizedColumnTypes & returnType)

inlinevirtual

UDChunker::destroy()

Will be invoked during query execution, after the last time that process() is called on this UDChunker instance for a particular input.

May optionally be overridden to perform tear-down/destruction.

See UDChunker::setup() for a note about the restartability of UDChunkers.

Portion Vertica::UDChunker::getPortion() const

inlineprotected

Return a description of the portion of the input source which is being processed by the active load stack. This can be called by the UDChunker implementation to determine how much data to process.

This can be invoked during setup(), process() or destroy().

The Portion object returned will be a valid portion if any part of the load stack is processing portions. This UDChunker instance will see input states START_OF_PORTION (in alignPortion()) and/or END_OF_PORTION (in either alignPortion() or process()) if it is the stack element directly processing portions.

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual StreamState Vertica::UDChunker::process(ServerInterface & srvInterface, DataBuffer & input, InputState input_state)

pure virtual UDChunker::process()

Will be invoked repeatedly during query execution, until it returns DONE or until the query is canceled by the user.

Returns See Vertica::StreamState for details about the following return values:

INPUT_NEEDED

DONE

CHUNK_ALIGNED

On each invocation, process() will be given an input buffer. It should read data from that buffer, find record boundaries and align input.offset with the end of the last record in the buffer. Once it has processed as much as it reasonably can (for example, once it has processed the last complete row in the input buffer), it should return INPUT_NEEDED to indicate that more data is needed, or DONE to indicate that it has completed "parsing" this input stream and will not be reading more bytes from it.

if a few rows were found in current block, move offset forward to point at the start of next (potential) row, and mark state as CHUNK_ALIGNED, indicating the chunker is ready to hand this chunk to parser.

If input_state == END_OF_FILE, then the last byte in input is the last byte in the input stream. Returning INPUT_NEEDED will not result in any new input appearing. process() should return DONE in this case.

If input_state == END_OF_PORTION, then the last byte in input is the last byte in the current portion. Returning CHUNK_ALIGNED or INPUT_NEEDED will result in retrieval of data beyond the portion boundary. If a chunker which supports apportioned load sees END_OF_PORTION, it should (a) align a chunk as usual, and return CHUNK_ALIGNED or INPUT_NEEDED to retrieve the next block, and then (b) align a chunk to the FIRST record boundary which appears in the next portion.

Note that input may contain null bytes, if the source file contains null bytes. Note also that input is NOT automatically null-terminated.

process() must not block indefinitely. If it cannot proceed for an extended period of time, it should return KEEP_GOING. It will be called again shortly. Failure to do this will, among other things, prevent the query from being canceled by the user.

virtual void Vertica::UDChunker::setup(ServerInterface & srvInterface, SizedColumnTypes & returnType)

inlinevirtual

UDChunker::setup()

Will be invoked during query execution, prior to the first time that process() is called on this UDChunker instance for a particular input source.

May optionally be overridden to perform setup/initialzation.

Note that UDChunkers MUST BE RESTARTABLE! If loading large numbers of files, a given UDChunker may be re-used for multiple files. Vertica follows the worker-pool design pattern: At the start of COPY execution, several Chunkers and several Filters are instantiated per node, by calling the corresponding prepare() method multiple times. Each Filter/Chunker pair is then internally assigned to an initial Source (UDSource or internal). At that point, setup() is called; then process() is called until it is finished; then destroy() is called. If there are still sources in the pool waiting to be processed, then the UDFilter/UDChunker pair will be given a second Source; setup() will be called a second time, then process() until it is finished, then destroy(). This repeats until all sources have been read.

1.1.222 - Vertica::UDChunker Member List

This is the complete list of members for Vertica::UDChunker, including all inherited members.

alignPortion(ServerInterface &srvInterface, DataBuffer &input, InputState inputState) Vertica::UDChunker inlinevirtual
cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
destroy(ServerInterface &srvInterface, SizedColumnTypes &returnType) Vertica::UDChunker inlinevirtual
destroy(ServerInterface &srvInterface, SizedColumnTypes &returnType, SessionParamWriterMap &udSessionParams) (defined in Vertica::UDChunker) Vertica::UDChunker inlinevirtual
getPortion() const Vertica::UDChunker inlineprotected
isCanceled() const Vertica::UDXObject inline
process(ServerInterface &srvInterface, DataBuffer &input, InputState input_state)=0 Vertica::UDChunker pure virtual
setup(ServerInterface &srvInterface, SizedColumnTypes &returnType) Vertica::UDChunker inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
~UDChunker() Vertica::UDChunker inlinevirtual
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.223 - Vertica::UDFileOperator Class Reference

Collaboration diagram for Vertica::UDFileOperator:

Public Member Functions
virtual size_t append (const void *buf, size_t count)=0
void appendWithRetry (const void *buffer, size_t size)
virtual void doHurryUp ()
virtual bool eof ()
virtual void fsync ()
virtual off_t getOffset () const =0
virtual void * mmap (void *addr, size_t length, int prot, int flags, off_t offset)
virtual void munmap (void *addr, size_t length)
virtual size_t read (void *buf, size_t count)=0
virtual off_t seek (off_t offset, int whence)=0

Member Function Documentation

void Vertica::UDFileOperator::appendWithRetry(const void * buffer, size_t size)

A wrapper around the append(). Attempt to write the specified data to disk. Retry in cases that didn't succeed in writing all data, but that stand a decent chance of succeeding on a retry. Throws on error.

1.1.224 - Vertica::UDFileOperator Member List

This is the complete list of members for Vertica::UDFileOperator, including all inherited members.

append(const void *buf, size_t count)=0 (defined in Vertica::UDFileOperator) Vertica::UDFileOperator pure virtual
appendWithRetry(const void *buffer, size_t size) Vertica::UDFileOperator
doHurryUp() (defined in Vertica::UDFileOperator) Vertica::UDFileOperator virtual
eof() (defined in Vertica::UDFileOperator) Vertica::UDFileOperator virtual
fsync() (defined in Vertica::UDFileOperator) Vertica::UDFileOperator virtual
getOffset() const =0 (defined in Vertica::UDFileOperator) Vertica::UDFileOperator pure virtual
mmap(void *addr, size_t length, int prot, int flags, off_t offset) (defined in Vertica::UDFileOperator) Vertica::UDFileOperator virtual
munmap(void *addr, size_t length) (defined in Vertica::UDFileOperator) Vertica::UDFileOperator virtual
read(void *buf, size_t count)=0 (defined in Vertica::UDFileOperator) Vertica::UDFileOperator pure virtual
seek(off_t offset, int whence)=0 (defined in Vertica::UDFileOperator) Vertica::UDFileOperator pure virtual
UDFileOperator() (defined in Vertica::UDFileOperator) Vertica::UDFileOperator inline
~UDFileOperator() (defined in Vertica::UDFileOperator) Vertica::UDFileOperator inlinevirtual

1.1.225 - Vertica::UDFileSystem Class Reference

Collaboration diagram for Vertica::UDFileSystem:

Public Member Functions
virtual std::string canonicalizePath (const std::string &path) const
virtual void close (UDFileOperator *udfo) const =0
virtual void copy (const char *srcpath, const char *dstpath) const =0
virtual void copyFrom (const std::string &srcpath, const std::string &destpath, size_t bufsize, size_t srcsize=INVALID_UINT64) const =0
virtual bool deleteSnapshot (const std::string &snapshot_handle) const
virtual std::string getDescription () const
virtual std::string getDisplayName () const
virtual std::string getEncodedURI (const char *path) const
virtual std::string getFanoutDirectory (uint64_t id) const
virtual uint32 getSlowRequestThreshold () const
virtual UDFileSystemStats * getStats () const
virtual std::string getURIEncodedStr (const char *str) const
virtual bool isFanoutDirectory (const std::string &fileName) const
virtual void link (const char *oldpath, const char *newpath) const
virtual void listFiles (const char *path, std::vector &result) const =0
virtual void listStat (const char *dir, std::vector &result) const
virtual void mkdirs (const char *path, mode_t mode) const =0
virtual UDFileOperator * open () const =0
virtual UDFileOperator * open (const char *path, int flags, mode_t mode, const OpenOptions &options=OpenOptions()) const =0
virtual size_t readBufferSizeHint () const
virtual void remove (const char *path) const =0
virtual void rename (const char *oldpath, const char *newpath) const =0
virtual bool restoreSnapshot (const std::string &snapshot_handle, const std::string &path) const
virtual void rmdir (const char *path) const =0
virtual void rmdirRecursive (const char *path) const =0
virtual void setTempPath (const std::string &path)
virtual bool snapshotDirectory (const std::string &path, std::string &snapshot_handle) const
virtual void stat (const char *path, struct::stat *buf) const =0
virtual void statvfs (const char *path, struct::statvfs *buf) const =0
virtual bool supportsAtomicReplacement () const
virtual bool supportsBatchRemove () const
virtual bool supportsDirectories () const
virtual bool supportsDirectorySnapshots () const
virtual void symlink (const char *oldpath, const char *newpath) const
virtual void truncate (const char *path, off_t length) const
virtual void unmount ()
virtual bool validatePath (const std::string &path) const
Static Public Attributes
static const size_t UDFS_DEFAULT_READ_SIZE_HINT = 1024 * 1024

1.1.226 - Vertica::UDFileSystem Member List

This is the complete list of members for Vertica::UDFileSystem, including all inherited members.

canonicalizePath(const std::string &path) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
close(UDFileOperator *udfo) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
copy(const char *srcpath, const char *dstpath) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
copyFrom(const std::string &srcpath, const std::string &destpath, size_t bufsize, size_t srcsize=INVALID_UINT64) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
deleteSnapshot(const std::string &snapshot_handle) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
getDescription() const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
getDisplayName() const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
getEncodedURI(const char *path) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
getFanoutDirectory(uint64_t id) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
getSlowRequestThreshold() const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
getStats() const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
getURIEncodedStr(const char *str) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
isFanoutDirectory(const std::string &fileName) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
link(const char *oldpath, const char *newpath) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
listFiles(const char *path, std::vector &result) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
listStat(const char *dir, std::vector &result) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
mkdirs(const char *path, mode_t mode) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
open() const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
open(const char *path, int flags, mode_t mode, const OpenOptions &options=OpenOptions()) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
readBufferSizeHint() const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
remove(const char *path) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
rename(const char *oldpath, const char *newpath) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
restoreSnapshot(const std::string &snapshot_handle, const std::string &path) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
rmdir(const char *path) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
rmdirRecursive(const char *path) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
setTempPath(const std::string &path) (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
snapshotDirectory(const std::string &path, std::string &snapshot_handle) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
stat(const char *path, struct::stat *buf) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
statvfs(const char *path, struct::statvfs *buf) const =0 (defined in Vertica::UDFileSystem) Vertica::UDFileSystem pure virtual
supportsAtomicReplacement() const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
supportsBatchRemove() const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
supportsDirectories() const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
supportsDirectorySnapshots() const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
symlink(const char *oldpath, const char *newpath) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
truncate(const char *path, off_t length) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem virtual
UDFileSystem() (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inline
UDFS_DEFAULT_READ_SIZE_HINT (defined in Vertica::UDFileSystem) Vertica::UDFileSystem static
unmount() (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
validatePath(const std::string &path) const (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual
~UDFileSystem() (defined in Vertica::UDFileSystem) Vertica::UDFileSystem inlinevirtual

1.1.227 - Vertica::UDFileSystemFactory Class Reference

Inheritance diagram for Vertica::UDFileSystemFactory:

Collaboration diagram for Vertica::UDFileSystemFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual UDFileSystem * createUDFileSystem (ServerInterface &srvInterface)=0
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes)
void getPrototype (ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)
virtual void getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)
Protected Member Functions
virtual UDXType getUDXFactoryType () override
Protected Attributes
Oid libOid
std::string sqlName

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented in Vertica::UDLFactory.

Referenced by Vertica::UDXFactory::getPerInstanceResources().

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented in Vertica::UDLFactory.

void Vertica::UDFileSystemFactory::getPrototype(ServerInterface & srvInterface, ColumnTypes & argTypes, ColumnTypes & returnType)

inline UDFileSystems take no input tuples; as such, their prototype must be empty.

virtual void Vertica::UDFileSystemFactory::getReturnType(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SizedColumnTypes & returnType)

inlinevirtual

UDFileSystems return no output; as such, their prototype must be empty.

virtual UDXType Vertica::UDFileSystemFactory::getUDXFactoryType()

inlineprotectedvirtual

Returns the object type internally used by Vertica

Implements Vertica::UDXFactory.

1.1.228 - Vertica::UDFileSystemFactory Member List

This is the complete list of members for Vertica::UDFileSystemFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
createUDFileSystem(ServerInterface &srvInterface)=0 (defined in Vertica::UDFileSystemFactory) Vertica::UDFileSystemFactory pure virtual
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) Vertica::UDXFactory inlinevirtual
getPrototype(ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType) Vertica::UDFileSystemFactory inline
getReturnType(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType) Vertica::UDFileSystemFactory inlinevirtual
getUDXFactoryType() override Vertica::UDFileSystemFactory inlineprotectedvirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~UDFileSystemFactory() (defined in Vertica::UDFileSystemFactory) Vertica::UDFileSystemFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.229 - Vertica::UDFileSystemStats Class Reference

Collaboration diagram for Vertica::UDFileSystemStats:

Public Member Functions
int64_t getDataReadCount () const
int64_t getDataWriteCount () const
int64_t getDownstreamBytes () const
int64_t getFailureCount () const
int64_t getMappedCount () const
int64_t getMetadataReadCount () const
int64_t getMetadataWriteCount () const
int64_t getOpenHandleCount () const
int64_t getReadingCount () const
int64_t getRetryCount () const
int64_t getSuccessCount () const
int64_t getUpstreamBytes () const
int64_t getWritingCount () const
void incDataRead ()
void incDataWrite ()
void incDownstreamBytes (int64_t size)
void incFailure ()
void incMappedCount (int64_t cnt)
void incMetadataRead ()
void incMetadataWrite ()
void incOpenHandleCount (int64_t cnt)
void incReadingCount (int64_t cnt)
void incRetry ()
void incSuccess ()
void incUpstreamBytes (int64_t size)
void incWritingCount (int64_t cnt)
void resetCounters ()
Protected Member Functions
template
T incrementCounter (T *ptr, T by=1)
Protected Attributes
int64_t dataReadCount_
int64_t dataWriteCount_
int64_t downstreamBytes_
int64_t failureCount_
int64_t mappedCount_
int64_t metadataReadCount_
int64_t metadataWriteCount_
int64_t openHandleCount_
int64_t readingCount_
int64_t retryCount_
int64_t successCount_
int64_t upstreamBytes_
int64_t writingCount_

1.1.230 - Vertica::UDFileSystemStats Member List

This is the complete list of members for Vertica::UDFileSystemStats, including all inherited members.

dataReadCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
dataWriteCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
downstreamBytes_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
failureCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
getDataReadCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getDataWriteCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getDownstreamBytes() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getFailureCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getMappedCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getMetadataReadCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getMetadataWriteCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getOpenHandleCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getReadingCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getRetryCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getSuccessCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getUpstreamBytes() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
getWritingCount() const (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incDataRead() (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incDataWrite() (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incDownstreamBytes(int64_t size) (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incFailure() (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incMappedCount(int64_t cnt) (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incMetadataRead() (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incMetadataWrite() (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incOpenHandleCount(int64_t cnt) (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incReadingCount(int64_t cnt) (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incrementCounter(T *ptr, T by=1) (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inlineprotected
incRetry() (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incSuccess() (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incUpstreamBytes(int64_t size) (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
incWritingCount(int64_t cnt) (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
mappedCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
metadataReadCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
metadataWriteCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
openHandleCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
readingCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
resetCounters() (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
retryCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
successCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
UDFileSystemStats() (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats inline
upstreamBytes_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected
writingCount_ (defined in Vertica::UDFileSystemStats) Vertica::UDFileSystemStats protected

1.1.231 - Vertica::UDFilter Class Reference

Reads input data from a UDSource or another UDFilter and transforms it.

Inheritance diagram for Vertica::UDFilter:

Collaboration diagram for Vertica::UDFilter:

Public Member Functions
void cancelUDX (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface, SessionParamWriterMap &udSessionParams)
bool isCanceled () const
virtual StreamState process (ServerInterface &srvInterface, DataBuffer &input, InputState input_state, DataBuffer &output)=0
virtual StreamState processWithMetadata (ServerInterface &srvInterface, DataBuffer &input, LengthBuffer &input_lengths, InputState input_state, DataBuffer &output, LengthBuffer &output_lengths)
virtual void setup (ServerInterface &srvInterface)
virtual bool useSideChannel ()
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Detailed Description

Reads input data from a UDSource or another UDFilter and transforms it.

For example, a UDFilter might unzip a file, convert UTF-16 to UTF-8, or remove personally identifying information such as social security numbers. UDFilters can be chained, for example unzipping, converting encodings, and then stripping personal information. The first UDFilter in a chain receives its input from a UDSource, and the output of the last one in the chain is sent to a UDParser.

UDFilter is part of the load pipeline. The load pipeline consists of up to one UDSource, any number of UDFilters, and up to one UDParser.

Note that it is UNSAFE to maintain pointers or references to any of these arguments (or any other argument passed by reference into any other function in this API) beyond the scope of the function call in question. For example, do not store a reference to the server interface or the input block on an instance variable. Vertica may free and replace these objects.

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual void Vertica::UDFilter::destroy(ServerInterface & srvInterface)

inlinevirtual

UDFilter::destroy()

Will be invoked during query execution, after the last time that process() is called on this UDFilter instance for a particular input file.

May optionally be overridden to perform tear-down/destruction.

See UDFilter::setup() for a note about the restartability of UDFilters.

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual StreamState Vertica::UDFilter::process(ServerInterface & srvInterface, DataBuffer & input, InputState input_state, DataBuffer & output)

pure virtual UDFilter::process()

Reads data from the input stream and emits data to the output stream. Vertica invokes this method repeatedly during query execution until it returns DONE, or until the query is canceled by the user.

Input: a stream of bytes.

Output: a stream of bytes.

Returns INPUT_NEEDED

OUTPUT_NEEDED

DONE

KEEP_GOING

See Vertica::StreamState for details about return values.

On each invocation, process() is handed some input data and a buffer to write output data to. It is expected to read and process some amount of the input data, write some amount of output data, and return a value that informs Vertica what needs to happen next.

process() must set input.offset to the number of bytes that were successfully read from the input buffer that do not need to be re-consumed by a subsequent invocation of process(). This might not be larger than input.size (input.size is the size of the buffer). If it is set to 0, this indicates that process() cannot process any part of an input buffer of this size, and requires more data per invocation. For example, a block-based decompression algorithm might return 0 if the input buffer does not contain a complete block.

Note that input might contain null bytes if the source file contains null bytes. Additionally, note that input is NOT automatically null-terminated.

If input_state == END_OF_FILE, then the last byte in input is the last byte in the input stream. Returning INPUT_NEEDED does not result in any new input appearing. In this case, process() should return DONE as soon as this operator finishes producing all of the output that it is going to produce.

process() should set output.offset (an output parameter) to the number of bytes that were written to the output buffer. It is common, though not necessary, for this to be the same as output.size (an input parameter). When process() is called, output.offset is uninitialized. To indicate that the buffer is too small to hold a record, process() should set output.offset to 0 and return OUTPUT_NEEDED. Then, process() is called again with a larger buffer.

In general, process() code should assume that buffers, input, and INPUT_NEEDED start at output.buf[output.offset].

As a performance optimization, upstream operators might start processing emitted data (data between output.buf[0] and output.buf[output.offset]) before OUTPUT_NEEDED is returned. For this reason, output.offset must be strictly increasing.

Referenced by processWithMetadata().

virtual StreamState Vertica::UDFilter::processWithMetadata(ServerInterface & srvInterface, DataBuffer & input, LengthBuffer & input_lengths, InputState input_state, DataBuffer & output, LengthBuffer & output_lengths)

inlinevirtual

UDFilter::processWithMetadata()

Reads data from the input stream and emits data to the output stream, and reads record length metadata from the input_lengths stream and outputs it to the output_lengths stream in the side channel. To implement processWithMetadata(), you must override useSideChannel() to return true. Vertica invokes this method repeatedly during query execution, until it returns DONE or until the query is canceled by the user.

Input: a stream of data bytes, and a stream of bytes containing message length metadata.

Output: a stream of data bytes, and a stream of bytes containing message length metadata.

Returns INPUT_NEEDED

OUTPUT_NEEDED

DONE

KEEP_GOING

See Vertica::StreamState for details about return values.

On each invocation, processWithMetadata() is handed some input data and a data buffer to write output data to, and record length metadata and a length buffer to write metadata to. It is expected to read and process some amount of the input data and input metadata, write some amount of output data and output metadata, and return a value that informs Vertica what needs to happen next.

For the DataBuffer, processWithMetadata() must set input.offset to the number of bytes that were successfully read from the input buffer that do not need to be re-consumed by a subsequent invocation of processWithMetadata(). This might not be larger than input.size (input.size is the size of DataBuffer). If it is set to 0, this indicates that processWithMetadata() cannot process any part of an input buffer of this size, and requires more data per invocation. For example, a block-based decompression algorithm might return 0 if the input buffer does not contain a complete block.

For the LengthBuffer, processWithMetadata() must set input_lengths.offset to the number of length values that were successfully read from the input_lengths buffer that do not need to be re-consumed by a subsequent invocation of processWithMetadata(). This cannot be larger than input_lengths.size (input_lengths.size is the number of length values that the LengthBuffer can hold). If it is set to 0, this indicates that processWithMetadata() cannot process any part of an input_lengths buffer of this size, and requires more data per invocation.

Note that input might contain null bytes if the source file contains null bytes. Additionally, note that input is NOT automatically null-terminated.

If input_state == END_OF_FILE, then the last byte in input is the last byte in the input stream. Returning INPUT_NEEDED does not result in any new input appearing. In this case, processWithMetadata() should return DONE as soon as this operator has finished producing all output that it can produce.

For the DataBuffer, processWithMetadata() should set output.offset (an output parameter) to the number of bytes that were written to the output buffer. It is common, though not necessary, for this to be the same as output.size (an input parameter). When processWithMetadata() is called, output.offset is uninitialized. To indicate that the buffer is too small to hold a record, processWithMetadata() should set output.offset and output_lengths.offset to 0 and return OUTPUT_NEEDED. Then, processWithMetadata() is called again with a larger buffer.

For the LengthBuffer, processWithMetadata() should set output_lengths.offset to the number of length values that were written to the output_lengths buffer. If output.offset is set to 0, then output_lengths.offset should also be set to 0.

In general, processWithMetadata() code should assume that data buffers and INPUT_NEEDED start at output.buff[output.offset], and length buffers start at output_lengths.buf[output_lengths.offset].

As a performance optimization, upstream operators might start processing emitted data (data between output.buf[0] and output.buf[output.offset] in the DataBuffer, and between output_lengths.buf[0] and output_lengths.buf[output_lengths.offset] in the LengthBuffer) before OUTPUT_NEEDED is returned. For this reason, output.offset and output_lengths.offset must be strictly increasing.

virtual void Vertica::UDFilter::setup(ServerInterface & srvInterface)

inlinevirtual

UDFilter::setup()

Will be invoked during query execution, prior to the first time that process() is called on this UDFilter instance for a particular input file.

May optionally be overridden to perform setup/initialzation.

Note that UDFilters MUST BE RESTARTABLE! If loading large numbers of files, a given UDFilter may be re-used for multiple files. Vertica follows the worker-pool design pattern: At the start of COPY execution, several Parsers and several Filters are instantiated per node, by calling the corresponding prepare() method multiple times. Each Filter/Parser pair is then internally assigned to an initial Source (UDSource or internal). At that point, setup() is called; then process() is called until it is finished; then destroy() is called. setup() will be called a second time, then process() until it is finished, then destroy(). This repeats until all sources have been read.

virtual bool Vertica::UDFilter::useSideChannel()

inlinevirtual

UDFilter::useSideChannel()

Provides access to the side channel containing record length metadata, when the data source has metadata about record boundaries available in a structured format that is separate from the data payload, and it is retained throughout the load stack.

Override and return true to indicate that processWithMetadata() should be called instead of process().

Return false to implement process().

Returns false by default.

1.1.232 - Vertica::UDFilter Member List

This is the complete list of members for Vertica::UDFilter, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
destroy(ServerInterface &srvInterface) Vertica::UDFilter inlinevirtual
destroy(ServerInterface &srvInterface, SessionParamWriterMap &udSessionParams) (defined in Vertica::UDFilter) Vertica::UDFilter inlinevirtual
isCanceled() const Vertica::UDXObject inline
process(ServerInterface &srvInterface, DataBuffer &input, InputState input_state, DataBuffer &output)=0 Vertica::UDFilter pure virtual
processWithMetadata(ServerInterface &srvInterface, DataBuffer &input, LengthBuffer &input_lengths, InputState input_state, DataBuffer &output, LengthBuffer &output_lengths) Vertica::UDFilter inlinevirtual
setup(ServerInterface &srvInterface) Vertica::UDFilter inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
useSideChannel() Vertica::UDFilter inlinevirtual
~UDFilter() (defined in Vertica::UDFilter) Vertica::UDFilter inlinevirtual
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.233 - Vertica::UDKeyManager Class Reference

Collaboration diagram for Vertica::UDKeyManager:

Public Member Functions
virtual void cleanup ()
do any cleanup tasks that may thow and so shouldn't be in the destructor
virtual void deleteKey (const std::string &name, const std::map &conf={})
drop the key created by generateKey() for name
virtual AESKey generateKey (const std::string &name, const std::map &conf={})
create a new key for object name
virtual std::string getDescription () const
override to get better representation in error message/log/system table
virtual std::string getDisplayName () const
override to get better representation in error message/log/system table
virtual AESKey getKey (const std::string &id, bool internal, const std::map &conf={})=0
return key identified by id; if internal then should use database identity for permissions checks
virtual AESKey getStartupKey (const std::string &password, const std::map &config={}, const std::string &id="")=0
called during startup; returned key is used to decrypt the catalog
virtual std::vector persistParams ()=0
returns the keys for parameters it is safe to write to a configuration file

1.1.234 - Vertica::UDKeyManager Member List

This is the complete list of members for Vertica::UDKeyManager, including all inherited members.

cleanup() Vertica::UDKeyManager inlinevirtual
deleteKey(const std::string &name, const std::map &conf={}) Vertica::UDKeyManager inlinevirtual
generateKey(const std::string &name, const std::map &conf={}) Vertica::UDKeyManager inlinevirtual
getDescription() const Vertica::UDKeyManager inlinevirtual
getDisplayName() const Vertica::UDKeyManager inlinevirtual
getKey(const std::string &id, bool internal, const std::map &conf={})=0 Vertica::UDKeyManager pure virtual
getStartupKey(const std::string &password, const std::map &config={}, const std::string &id="")=0 Vertica::UDKeyManager pure virtual
persistParams()=0 Vertica::UDKeyManager pure virtual
UDKeyManager() (defined in Vertica::UDKeyManager) Vertica::UDKeyManager inline
~UDKeyManager() (defined in Vertica::UDKeyManager) Vertica::UDKeyManager inlinevirtual

1.1.235 - Vertica::UDKeyManagerFactory Class Reference

Inheritance diagram for Vertica::UDKeyManagerFactory:

Collaboration diagram for Vertica::UDKeyManagerFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual UDKeyManager * createUDKeyManager (ServerInterface &srvInterface)=0
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes)
virtual void getPrototype (ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType)
virtual void getReturnType (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType)
Protected Member Functions
virtual UDXType getUDXFactoryType () override
Protected Attributes
Oid libOid
std::string sqlName

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented in Vertica::UDLFactory.

Referenced by Vertica::UDXFactory::getPerInstanceResources().

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtualinherited

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented in Vertica::UDLFactory.

virtual void Vertica::UDKeyManagerFactory::getPrototype(ServerInterface & srvInterface, ColumnTypes & argTypes, ColumnTypes & returnType)

inlinevirtual

UDKeyManagers take no input tuples; as such, their prototype must be empty.

virtual void Vertica::UDKeyManagerFactory::getReturnType(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SizedColumnTypes & returnType)

inlinevirtual

UDKeyManagers return no output; as such, their prototype must be empty.

virtual UDXType Vertica::UDKeyManagerFactory::getUDXFactoryType()

inlineprotectedvirtual

Returns the object type internally used by Vertica

Implements Vertica::UDXFactory.

1.1.236 - Vertica::UDKeyManagerFactory Member List

This is the complete list of members for Vertica::UDKeyManagerFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
createUDKeyManager(ServerInterface &srvInterface)=0 (defined in Vertica::UDKeyManagerFactory) Vertica::UDKeyManagerFactory pure virtual
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) Vertica::UDXFactory inlinevirtual
getPrototype(ServerInterface &srvInterface, ColumnTypes &argTypes, ColumnTypes &returnType) Vertica::UDKeyManagerFactory inlinevirtual
getReturnType(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SizedColumnTypes &returnType) Vertica::UDKeyManagerFactory inlinevirtual
getUDXFactoryType() override Vertica::UDKeyManagerFactory inlineprotectedvirtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~UDKeyManagerFactory() (defined in Vertica::UDKeyManagerFactory) Vertica::UDKeyManagerFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.237 - Vertica::UDLFactory Class Reference

Inheritance diagram for Vertica::UDLFactory:

Collaboration diagram for Vertica::UDLFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res) override
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override
virtual UDXType getUDXFactoryType ()=0
Protected Attributes
Oid libOid
std::string sqlName

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

inherited The type of UDX instance this factory produces

Member Function Documentation

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtualinherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtual

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented from Vertica::UDXFactory.

Referenced by getPerInstanceResources().

virtual void Vertica::UDLFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtual

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented from Vertica::UDXFactory.

virtual UDXType Vertica::UDXFactory::getUDXFactoryType()

pure virtual inherited Returns the type of UDX Object instance this factory returns.

Note User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Implemented in Vertica::UDKeyManagerFactory, Vertica::MultiPhaseTransformFunctionFactory, Vertica::AggregateFunctionFactory, Vertica::AnalyticFunctionFactory, Vertica::TransformFunctionFactory, Vertica::ScalarFunctionFactory, Vertica::ParserFactory, Vertica::FilterFactory, Vertica::IterativeSourceFactory, and Vertica::UDFileSystemFactory.

1.1.238 - Vertica::UDLFactory Member List

This is the complete list of members for Vertica::UDLFactory, including all inherited members.

AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) override Vertica::UDLFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) override Vertica::UDLFactory inlinevirtual
getUDXFactoryType()=0 Vertica::UDXFactory pure virtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~UDLFactory() (defined in Vertica::UDLFactory) Vertica::UDLFactory inlinevirtual
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.239 - Vertica::UDParser Class Reference

Parses an input stream into Vertica tuples (rows to be inserted into a table).

Inheritance diagram for Vertica::UDParser:

Collaboration diagram for Vertica::UDParser:

Public Member Functions
void cancelUDX (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface, SizedColumnTypes &returnType)
virtual void destroy (ServerInterface &srvInterface, SizedColumnTypes &returnType, SessionParamWriterMap &udSessionParams)
virtual RejectedRecord getRejectedRecord ()
bool isCanceled () const
virtual bool isReadyToCooperate (ServerInterface &srvInterface)
virtual void prepareToCooperate (ServerInterface &srvInterface, bool isLeader)
virtual StreamState process (ServerInterface &srvInterface, DataBuffer &input, InputState input_state)=0
virtual StreamState processWithMetadata (ServerInterface &srvInterface, DataBuffer &input, LengthBuffer &input_lengths, InputState input_state)
virtual void setup (ServerInterface &srvInterface, SizedColumnTypes &returnType)
virtual bool useSideChannel ()
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)
Portion getPortion ()
Protected Attributes
Portion portion
vint recordsAcceptedInBatch
bool seen_eob
std::string srcname
StreamWriter * writer

Detailed Description

Parses an input stream into Vertica tuples (rows to be inserted into a table).

A UDParser can be used with up to one UDSource and any number of UDfilters.

Note that it is UNSAFE to maintain pointers or references to any of these arguments (or any other argument passed by reference into any other function in this API) beyond the scope of the function call in question. For example, do not store a reference to the server interface or the input block on an instance variable. Vertica may free and replace these objects.

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual void Vertica::UDParser::destroy(ServerInterface & srvInterface, SizedColumnTypes & returnType)

inlinevirtual

UDParser::destroy()

Will be invoked during query execution, after the last time that process() is called on this UDParser instance for a particular input file.

May optionally be overridden to perform tear-down/destruction.

See UDParser::setup() for a note about the restartability of UDParsers.

Portion Vertica::UDParser::getPortion()

inlineprotected

Return a description of the portion of the input source which is being processed by the active load stack. This can be called by the UDParser implementation to determine how much data to process.

This can be invoked during setup(), process() or destroy().

The Portion object returned will be a valid portion if any part of the load stack is processing portions. This UDParser instance will see input states START_OF_PORTION and/or END_OF_PORTION if it is the stack element directly processing portions.

virtual RejectedRecord Vertica::UDParser::getRejectedRecord()

inlinevirtual

Returns information about the rejected record

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual bool Vertica::UDParser::isReadyToCooperate(ServerInterface & srvInterface)

inlinevirtual

UDParser::isReadyToCooperate()

Called after UDParser::prepareToCooperate(), returns false if this parser is not yet ready to cooperate. Once this method returns true the parser can begin to cooperate. Default implementation returns true, override if some preparation is required before the parser can cooperate (e.g. a certain # of rows must be skipped).

virtual void Vertica::UDParser::prepareToCooperate(ServerInterface & srvInterface, bool isLeader)

inlinevirtual

UDParser::prepareToCooperate()

Notification to this parser that it should prepare to share parsing input with another. This can only happen when a parser has an associated chunker. Default implementation does nothing.

virtual StreamState Vertica::UDParser::process(ServerInterface & srvInterface, DataBuffer & input, InputState input_state)

pure virtual UDParser::process()

Reads data from the input stream and produces tuples to load. Vertica invokes this method repeatedly during query execution until it returns DONE, or until the query is canceled by the user.

Input: a stream of bytes.

Output: a stream of tuples.

Returns INPUT_NEEDED

DONE

REJECT

KEEP_GOING

See Vertica::StreamState for details about return values.

On each invocation, process() is given an input buffer. It must read data from the input buffer, convert the data to fields and tuples, then write those tuples with writer. After it has consumed as much as it reasonably can (for example, after it consumes the last complete row in the input buffer), it must return INPUT_NEEDED to indicate that more data is needed, or DONE to indicate that it has completed parsing the input stream and will not read more bytes.

If input_state == END_OF_FILE, then the last byte in input is the last byte in the input stream. Returning INPUT_NEEDED does not result in any new input. In this case, process() must return DONE as soon as this operator finishes producing all output that it is going to produce.

Note that input might contain null bytes, if the source file contains null bytes. Additionally, note that input is NOT automatically null-terminated.

process() must not block indefinitely. If it cannot proceed for an extended period of time, it should return KEEP_GOING so that it can be called again. Failure to do this causes issues, including preventing the user from canceling the query.

Note that unless INPUT_NEEDED is returned, input is UNMODIFIED the next time process() is called. This means that pointers into the buffer are still valid. It also means that input.offset may be set. In general, process() code should assume that buffers start at input.buf[input.offset].

Row Rejection

process() can "reject" a row, which logs it using Vertica's rejected-rows mechanism. Rejected rows should not be emitted as tuples. All previous input must have been consumed by a call to process(). To reject a row, set input.offset to the position of the row, and return REJECT.

Referenced by processWithMetadata().

virtual StreamState Vertica::UDParser::processWithMetadata(ServerInterface & srvInterface, DataBuffer & input, LengthBuffer & input_lengths, InputState input_state)

inlinevirtual

UDParser::processWithMetadata()

Reads data from the input stream and record length metadata from the side channel and produces tuples to load. To implement processWithMetadata(), you must override useSideChannel() to return true. Vertica invokes this method repeately during query execution until it returns DONE, or until the query is canceled by the user.

Input: a stream of data bytes, and a stream of bytes containing message length metadata.

Output: a stream of tuples.

Returns INPUT_NEEDED

DONE

REJECT

KEEP_GOING

See Vertica::StreamState for details about return values.

On each invocation, processWithMetadata() is given an input buffer and a length buffer. It must read data from the input buffer and metadata from the length buffer, convert the data to fields and tuples, then write the tuples with writer. After it has consumed as much as it reasonably can (for example, after it consumes the last complete row in the input buffer), it must return INPUT_NEEDED to indicate that more data is needed, or DONE to indicate that parsing this input stream is complete and it will not read any more bytes.

If input_state == END_OF_FILE, then the last byte in input is the last byte in the input stream. Returning INPUT_NEEDED does not result in any new input. In this case, processWithMetadata() must return DONE as soon as this operator finishes producing all output that it is going to produce.

Note that input might contain null bytes if the source file contains null bytes. Additionally, note that input are NOT automatically null-terminated.

processWithMetadata() must not block indefinitely. If it cannot proceed for an extended period of time, it should return KEEP_GOING so that it can be called again. Failure to do this causes issues, including preventing the user from canceling the query.

In general, processWithMetadata() code should assume that the DataBuffer starts at input.buf[input.offset] and the LengthBuffer starts at `input_lengths.buf[input_lengths.offset].

Row Rejection

processWithMetadata() can "reject" a row, which logs it using Vertica's rejected-rows mechanism. Rejected rows should not be emitted as tuples. All previous input must have been consumed by a call to process(). To reject a row, set input.offset to the position of the row, and return REJECT.

virtual void Vertica::UDParser::setup(ServerInterface & srvInterface, SizedColumnTypes & returnType)

inlinevirtual

UDParser::setup()

Will be invoked during query execution, prior to the first time that process() is called on this UDParser instance for a particular input source.

May optionally be overridden to perform setup/initialzation.

Note that UDParsers MUST BE RESTARTABLE! If loading large numbers of files, a given UDParsers may be re-used for multiple files. Vertica follows the worker-pool design pattern: At the start of COPY execution, several Parsers and several Filters are instantiated per node, by calling the corresponding prepare() method multiple times. Each Filter/Parser pair is then internally assigned to an initial Source (UDSource or internal). At that point, setup() is called; then process() is called until it is finished; then destroy() is called. If there are still sources in the pool waiting to be processed, then the UDFilter/UDSource pair will be given a second Source; setup() will be called a second time, then process() until it is finished, then destroy(). This repeats until all sources have been read.

virtual bool Vertica::UDParser::useSideChannel()

inlinevirtual

UDParser::useSideChannel()

Provides access to the side channel containing record length metadata, when the data source has metadata about record boundaries available in a structured format that is separate from the data payload, and it is retained throughout the load stack.

Override and return true to indicate that processWithMetadata() should be called instead of process().

Return false to implement process()

Returns false by default.

Member Data Documentation

StreamWriter* Vertica::UDParser::writer

protected

Writer to write parsed tuples to. Has the same API as PartitionWriter, from the UDT framework.

1.1.240 - Vertica::UDParser Member List

This is the complete list of members for Vertica::UDParser, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
destroy(ServerInterface &srvInterface, SizedColumnTypes &returnType) Vertica::UDParser inlinevirtual
destroy(ServerInterface &srvInterface, SizedColumnTypes &returnType, SessionParamWriterMap &udSessionParams) (defined in Vertica::UDParser) Vertica::UDParser inlinevirtual
getPortion() Vertica::UDParser inlineprotected
getRejectedRecord() Vertica::UDParser inlinevirtual
isCanceled() const Vertica::UDXObject inline
isReadyToCooperate(ServerInterface &srvInterface) Vertica::UDParser inlinevirtual
portion (defined in Vertica::UDParser) Vertica::UDParser protected
prepareToCooperate(ServerInterface &srvInterface, bool isLeader) Vertica::UDParser inlinevirtual
process(ServerInterface &srvInterface, DataBuffer &input, InputState input_state)=0 Vertica::UDParser pure virtual
processWithMetadata(ServerInterface &srvInterface, DataBuffer &input, LengthBuffer &input_lengths, InputState input_state) Vertica::UDParser inlinevirtual
recordsAcceptedInBatch (defined in Vertica::UDParser) Vertica::UDParser protected
seen_eob (defined in Vertica::UDParser) Vertica::UDParser protected
setup(ServerInterface &srvInterface, SizedColumnTypes &returnType) Vertica::UDParser inlinevirtual
srcname (defined in Vertica::UDParser) Vertica::UDParser protected
UDParser() (defined in Vertica::UDParser) Vertica::UDParser inline
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
useSideChannel() Vertica::UDParser inlinevirtual
writer Vertica::UDParser protected
~UDParser() (defined in Vertica::UDParser) Vertica::UDParser inlinevirtual
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.241 - Vertica::UDSource Class Reference

Acquires data from an external source (such as a file or URL) and produces that data in a streaming manner.

Inheritance diagram for Vertica::UDSource:

Collaboration diagram for Vertica::UDSource:

Public Member Functions
void cancelUDX (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface) override
virtual void destroy (ServerInterface &srvInterface, SessionParamWriterMap &udSessionParams) override
virtual Portion getPortion () override
virtual vint getSize ()
virtual std::string getUri ()
bool isCanceled () const
virtual StreamState process (ServerInterface &srvInterface, DataBuffer &output) override=0
virtual StreamState processWithMetadata (ServerInterface &srvInterface, DataBuffer &output, LengthBuffer &output_lengths)
virtual size_t requestMinBufferSize (ServerInterface &srvInterface)
virtual void setup (ServerInterface &srvInterface) override
virtual bool useSideChannel ()
Static Public Attributes
static const size_t DEFAULT_MIN_BUFFER_SIZE = 1024 * 1024
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Detailed Description

Acquires data from an external source (such as a file or URL) and produces that data in a streaming manner.

The output of a UDSource can be sent through one or more UDFilters followed by one UDParser.

Note that it is UNSAFE to maintain pointers or references to any of these arguments (or any other argument passed by reference into any other function in this API) beyond the scope of the function call in question. For example, do not store a reference to the server interface or the input block on an instance variable. Vertica may free and replace these objects.

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual void Vertica::UDSource::destroy(ServerInterface & srvInterface)

inlinevirtual

UDSource::destroy()

Will be invoked during query execution, after the last time that process() is called on this UDSource instance.

May optionally be overridden to perform tear-down/destruction.

Reimplemented from Vertica::UnsizedUDSource.

virtual Portion Vertica::UDSource::getPortion()

inlinevirtual

UDSource::getPortion()

Gets this source's split if the source is apportioned. Default implementation return a Portion instance from default constructor {o=-1, s=-1, t=false}.

Implements Vertica::UnsizedUDSource.

virtual vint Vertica::UDSource::getSize()

inlinevirtual

UDSource::getSize()

Returns the estimated number of bytes that process() will return.

This value is treated as advisory only. It is used to indicate the file size in the LOAD_STREAMS and LOAD_SOURCES tables.

IMPORTANT: getSize() can be called at any time, even before setup() is called! (Though not before or during the constructor.)

In the case of Sources whose factories can potentially produce many UDSource instances, getSize() should avoid acquiring resources that last for the life of the object. Doing otherwise can defeat Vertica's attempts to limit the maximum number of Sources that are consuming system resources at any given time. For example, if it opens a file handle and leaves that file handle open for use by process(), and if a large number of UDSources are loaded in a single statement, the query may exceed the operating system limit on file handles and crash, even though Vertica only operates on a small number of files at once. This doesn't apply to singleton Sources, Sources whose factory will only ever produce one UDSource instance.

virtual std::string Vertica::UnsizedUDSource::getUri()

inlinevirtualinherited

UnsizedUDSource::getUri()

Return the URI of the current source of data.

This function will be invoked during execution to fill in monitoring information.

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual StreamState Vertica::UDSource::process(ServerInterface & srvInterface, DataBuffer & output)

pure virtual UDSource::process()

Reads data from the input source and processes it. Vertica invokes this method repeatedly until it returns DONE or the query is canceled by the user.

Input: an external data source.

Output: a stream of bytes.

Returns OUTPUT_NEEDED

DONE

KEEP_GOING

See Vertica::StreamState for details about return values.

On each invocation, process() should acquire more data and write that data to the buffer specified by output.

process() should set output.offset (an output parameter) to the number of bytes that were written to the output buffer. It is common, though not necessary, for this to be the same as output.size (an input parameter). When process() is called, output.offset is uninitialized. To indicate that the buffer is too small to hold a record, process() should set output.offset to 0 and return OUTPUT_NEEDED. Then, process() is called again with a larger buffer.

In general, process() code should assume that buffers start at output.buf[output.offset]. As a performance optimization, upstream operators might start processing emitted data (data between output.buf[0] and output.buf[output.offset]) before OUTPUT_NEEDED is returned. For this reason, output.offset must be strictly increasing.

Implements Vertica::UnsizedUDSource.

virtual StreamState Vertica::UnsizedUDSource::processWithMetadata(ServerInterface & srvInterface, DataBuffer & output, LengthBuffer & output_lengths)

inlinevirtualinherited

UnsizedUDSource::processWithMetadata()

Reads data from the input source and record length metadata from the side channel and processes it. To implement processWithMetadata(), you must override useSideChannel() to return true. Vertica invokes this method repeatedly until it returns DONE or the query is canceled by the user.

Input: an external data source.

Output: a stream of data bytes, and a stream of bytes containing message length metadata from the data source.

Returns OUTPUT_NEEDED

DONE

KEEP_GOING

See Vertica::StreamState for details about return values.

On each invocation, processWithMetadata() should acquire more data and write that data to the buffer specified by output, and write the message lengths to output_lengths.

For the DataBuffer, processWithMetadata() should set output.offset (an output parameter) to the number of bytes that were written to the output buffer. It is common, though not necessary, for this to be the same as output.size (an input parameter). When processWithMetadata() is called, output.offset is uninitialized. To indicate that the buffer is too small to hold a record, processWithMetadata() should set output.offset and output_length.offset to 0 and return OUTPUT_NEEDED. Then processWithMetadata() is called again with a larger buffer.

For the LengthBuffer, processWithMetadata() should set output_lengths.offset to the number of length values that were written to the output_lengths buffer. If output.offset is set to 0, then output_lengths.offset should also be set to 0.

In general, processWithMetadata() code should assume that data buffers start at output.buf[output.offset] and length buffers start at output_lengths.buf[output_lengths.offset].

As a performance optimization, upstream operators might start processing emitted data (data between output.buf[0] and output.buf[output.offset] in the DataBuffer, and between output_lengths.buf[0] and output_lengths.buf[output.offset] in the LengthBuffer) before OUTPUT_NEEDED is returned. For this reason, output.offset and output_lengths.offset must be strictly increasing.

virtual size_t Vertica::UnsizedUDSource::requestMinBufferSize(ServerInterface & srvInterface)

inlinevirtualinherited

Request a minimum buffer size into which this source will read data. This will be called after setup(), before the first call to process().

virtual void Vertica::UDSource::setup(ServerInterface & srvInterface)

inlinevirtual

UDSource::setup()

Will be invoked during query execution, prior to the first time that process() is called on this UDSource instance.

May optionally be overridden to perform setup/initialzation.

Reimplemented from Vertica::UnsizedUDSource.

virtual bool Vertica::UnsizedUDSource::useSideChannel()

inlinevirtualinherited

UnsizedUDSource::useSideChannel()

Provides access to the side channel containing record length metadata, when the UnsizedUDSource has metadata about record boundaries available in a structured format that is separate from the data payload.

Override and return true to indicate that processWithMetadata() should be called instead of process().

Return false to implement process().

Returns false by default.

1.1.242 - Vertica::UDSource Member List

This is the complete list of members for Vertica::UDSource, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
DEFAULT_MIN_BUFFER_SIZE (defined in Vertica::UnsizedUDSource) Vertica::UnsizedUDSource static
destroy(ServerInterface &srvInterface) override Vertica::UDSource inlinevirtual
destroy(ServerInterface &srvInterface, SessionParamWriterMap &udSessionParams) override (defined in Vertica::UDSource) Vertica::UDSource inlinevirtual
getPortion() override Vertica::UDSource inlinevirtual
getSize() Vertica::UDSource inlinevirtual
getUri() Vertica::UnsizedUDSource inlinevirtual
isCanceled() const Vertica::UDXObject inline
process(ServerInterface &srvInterface, DataBuffer &output) override=0 Vertica::UDSource pure virtual
processWithMetadata(ServerInterface &srvInterface, DataBuffer &output, LengthBuffer &output_lengths) Vertica::UnsizedUDSource inlinevirtual
requestMinBufferSize(ServerInterface &srvInterface) Vertica::UnsizedUDSource inlinevirtual
setup(ServerInterface &srvInterface) override Vertica::UDSource inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
useSideChannel() Vertica::UnsizedUDSource inlinevirtual
~UDSource() (defined in Vertica::UDSource) Vertica::UDSource inlinevirtual
~UDXObject() Vertica::UDXObject inlinevirtual
~UnsizedUDSource() (defined in Vertica::UnsizedUDSource) Vertica::UnsizedUDSource inlinevirtual

1.1.243 - Vertica::UDxCounterRequest Member List

This is the complete list of members for Vertica::UDxCounterRequest, including all inherited members.

CounterType enum name Vertica::UDxCounterRequest
CT_END_TIME enum value (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
CT_EXECUTION_TIME enum value (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
CT_INPUT_SIZE_BYTES enum value (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
CT_INPUT_SIZE_ROWS enum value (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
CT_MISC_SCALAR enum value (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
CT_PROCESSED_BYTES enum value (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
CT_PROCESSED_ROWS enum value (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
CT_RESOURCES enum value (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
CT_START_TIME enum value (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
isTimer() (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest inline
isTimeStamper() (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest inline
name Vertica::UDxCounterRequest
tag Vertica::UDxCounterRequest
type (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest
UDxCounterRequest() (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest inline
UDxCounterRequest(std::string _name, std::string _tag, CounterType _type) (defined in Vertica::UDxCounterRequest) Vertica::UDxCounterRequest inline

1.1.244 - Vertica::UDxCounterRequest Struct Reference

Collaboration diagram for Vertica::UDxCounterRequest:

Public Types
enum CounterType { CT_START_TIME, CT_END_TIME, CT_EXECUTION_TIME, CT_INPUT_SIZE_ROWS, CT_INPUT_SIZE_BYTES, CT_PROCESSED_ROWS, CT_PROCESSED_BYTES, CT_RESOURCES, CT_MISC_SCALAR }
Public Member Functions
UDxCounterRequest (std::string _name, std::string _tag, CounterType _type)
bool isTimer ()
bool isTimeStamper ()
Public Attributes
std::string name
std::string tag
enum Vertica::UDxCounterRequest::CounterType type

Detailed Description

Request for a counter

Member Enumeration Documentation

enum Vertica::UDxCounterRequest::CounterType

Type of value held by the counter

Member Data Documentation

std::string Vertica::UDxCounterRequest::name

Name of the counter, describing what is counted

std::string Vertica::UDxCounterRequest::tag

Tag, for cases where the counter name has multiple instances per UDx

1.1.245 - Vertica::UDXFactory Class Reference

Parent class for UDx factories; not intended for direct use by applications.

Inheritance diagram for Vertica::UDXFactory:

Collaboration diagram for Vertica::UDXFactory:

Public Types
enum UDXType { SCALAR = 1, TRANSFORM = 2, ANALYTIC = 3, MULTI_TRANSFORM = 4, AGGREGATE = 5, LOAD_SOURCE = 6, LOAD_FILTER = 7, LOAD_PARSER = 8, FILESYSTEM = 9, TYPE = 10, CURSOR_TRANSFORM = 11, KEYMANAGER = 12 }
Public Member Functions
virtual void getParameterType (ServerInterface &srvInterface, SizedColumnTypes meterTypes)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res)
virtual void getPerInstanceResources (ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes)
virtual UDXType getUDXFactoryType ()=0
Protected Attributes
Oid libOid
std::string sqlName
Friends
class ::UdfSupport

Detailed Description

Parent class for UDx factories; not intended for direct use by applications.

Member Enumeration Documentation

enum Vertica::UDXFactory::UDXType

The type of UDX instance this factory produces

Member Function Documentation

virtual void Vertica::UDXFactory::getParameterType(ServerInterface & srvInterface, SizedColumnTypes & parameterTypes)

inlinevirtual

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Reimplemented in Vertica::ParserFactory.

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res)

inlinevirtual

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Reimplemented in Vertica::UDLFactory.

Referenced by getPerInstanceResources().

virtual void Vertica::UDXFactory::getPerInstanceResources(ServerInterface & srvInterface, VResources & res, const SizedColumnTypes & inputTypes)

inlinevirtual

Set the resource required for each instance of the UDX Object subclass. Users should override only one of the following methods.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDT was called with

Reimplemented in Vertica::UDLFactory.

virtual UDXType Vertica::UDXFactory::getUDXFactoryType()

pure virtual Returns the type of UDX Object instance this factory returns.

Note User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Implemented in Vertica::UDKeyManagerFactory, Vertica::MultiPhaseTransformFunctionFactory, Vertica::AggregateFunctionFactory, Vertica::AnalyticFunctionFactory, Vertica::TransformFunctionFactory, Vertica::ScalarFunctionFactory, Vertica::ParserFactory, Vertica::FilterFactory, Vertica::IterativeSourceFactory, and Vertica::UDFileSystemFactory.

1.1.246 - Vertica::UDXFactory Member List

This is the complete list of members for Vertica::UDXFactory, including all inherited members.

::UdfSupport (defined in Vertica::UDXFactory) Vertica::UDXFactory friend
AGGREGATE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
ANALYTIC enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
CURSOR_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
FILESYSTEM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
getParameterType(ServerInterface &srvInterface, SizedColumnTypes meterTypes) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res) Vertica::UDXFactory inlinevirtual
getPerInstanceResources(ServerInterface &srvInterface, VResources &res, const SizedColumnTypes &inputTypes) Vertica::UDXFactory inlinevirtual
getUDXFactoryType()=0 Vertica::UDXFactory pure virtual
KEYMANAGER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
libOid (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
LOAD_FILTER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_PARSER enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
LOAD_SOURCE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
MULTI_TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
SCALAR enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
sqlName (defined in Vertica::UDXFactory) Vertica::UDXFactory protected
TRANSFORM enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
TYPE enum value (defined in Vertica::UDXFactory) Vertica::UDXFactory
UDXType enum name Vertica::UDXFactory
~UDXFactory() (defined in Vertica::UDXFactory) Vertica::UDXFactory inlinevirtual

1.1.247 - Vertica::UDXFunction Class Reference

Inheritance diagram for Vertica::UDXFunction:

Collaboration diagram for Vertica::UDXFunction:

Public Member Functions
void cancelUDX (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
virtual void destroy (ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams)
bool isCanceled () const
virtual void setup (ServerInterface &srvInterface, const SizedColumnTypes &argTypes)
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtual

Perform per instance destruction. This function may throw errors

Referenced by destroy().

virtual void Vertica::UDXFunction::destroy(ServerInterface & srvInterface, const SizedColumnTypes & argTypes, SessionParamWriterMap & udSessionParams)

inlinevirtual

Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual void Vertica::UDXFunction::setup(ServerInterface & srvInterface, const SizedColumnTypes & argTypes)

inlinevirtual

Perform per instance initialization. This function may throw errors.

1.1.248 - Vertica::UDXFunction Member List

This is the complete list of members for Vertica::UDXFunction, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
destroy(ServerInterface &srvInterface, const SizedColumnTypes &argTypes, SessionParamWriterMap &udSessionParams) Vertica::UDXFunction inlinevirtual
isCanceled() const Vertica::UDXObject inline
setup(ServerInterface &srvInterface, const SizedColumnTypes &argTypes) Vertica::UDXFunction inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.249 - Vertica::UDXObject Class Reference

Base class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications.

Inheritance diagram for Vertica::UDXObject:

Collaboration diagram for Vertica::UDXObject:

Public Member Functions
virtual ~UDXObject ()
void cancelUDX (ServerInterface &srvInterface)
bool isCanceled () const
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Detailed Description

Base class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications.

Constructor & Destructor Documentation

virtual Vertica::UDXObject::~UDXObject()

inlinevirtual

Destructors MAY NOT throw errors / exceptions. Exceptions thrown during the destructor will be ignored.

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtual

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline Cancel callback invoked when the query running the UDX has been canceled. See cancel().

bool Vertica::UDXObject::isCanceled() const

inline Returns true iff this UDX has been canceled

1.1.250 - Vertica::UDXObject Member List

This is the complete list of members for Vertica::UDXObject, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
isCanceled() const Vertica::UDXObject inline
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
~UDXObject() Vertica::UDXObject inlinevirtual

1.1.251 - Vertica::UDxRegistrar Member List

This is the complete list of members for Vertica::UDxRegistrar, including all inherited members.

UDxRegistrar(const char *name) (defined in Vertica::UDxRegistrar) Vertica::UDxRegistrar inline

1.1.252 - Vertica::UDxRegistrar Struct Reference

Collaboration diagram for Vertica::UDxRegistrar:

Public Member Functions
UDxRegistrar (const char *name)

1.1.253 - Vertica::UnsizedUDSource Class Reference

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.

Inheritance diagram for Vertica::UnsizedUDSource:

Collaboration diagram for Vertica::UnsizedUDSource:

Public Member Functions
void cancelUDX (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface)
virtual void destroy (ServerInterface &srvInterface, SessionParamWriterMap &udSessionParams)
virtual Portion getPortion ()=0
virtual std::string getUri ()
bool isCanceled () const
virtual StreamState process (ServerInterface &srvInterface, DataBuffer &output)=0
virtual StreamState processWithMetadata (ServerInterface &srvInterface, DataBuffer &output, LengthBuffer &output_lengths)
virtual size_t requestMinBufferSize (ServerInterface &srvInterface)
virtual void setup (ServerInterface &srvInterface)
virtual bool useSideChannel ()
Static Public Attributes
static const size_t DEFAULT_MIN_BUFFER_SIZE = 1024 * 1024
Protected Member Functions
virtual void cancel (ServerInterface &srvInterface)

Detailed Description

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.

Not intended or optimized for typical applications.

Note that it is UNSAFE to maintain pointers or references to any of these arguments (or any other argument passed by reference into any other function in this API) beyond the scope of the function call in question. For example, do not store a reference to the server interface or the input block on an instance variable. Vertica may free and replace these objects.

Member Function Documentation

virtual void Vertica::UDXObject::cancel(ServerInterface & srvInterface)

inlineprotectedvirtualinherited

Cancel callback to be overridden by the UDX. Called when the query running the UDX has been canceled.

Note

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor or destructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Referenced by Vertica::UDXObject::cancelUDX().

void Vertica::UDXObject::cancelUDX(ServerInterface & srvInterface)

inline inherited Cancel callback invoked when the query running the UDX has been canceled. See cancel().

virtual Portion Vertica::UnsizedUDSource::getPortion()

pure virtual Return the portion this source object is responsible for (if any).

This can be used by other elements of the load stack to determine how much data to process. It also will uniquely identify a source in the load_sources view. As such, this will be called BEFORE setup() (for load_sources) and again after setup() (for data processing).

Implemented in Vertica::UDSource.

virtual std::string Vertica::UnsizedUDSource::getUri()

inlinevirtual

UnsizedUDSource::getUri()

Return the URI of the current source of data.

This function will be invoked during execution to fill in monitoring information.

bool Vertica::UDXObject::isCanceled() const

inline inherited Returns true iff this UDX has been canceled

virtual StreamState Vertica::UnsizedUDSource::processWithMetadata(ServerInterface & srvInterface, DataBuffer & output, LengthBuffer & output_lengths)

inlinevirtual

UnsizedUDSource::processWithMetadata()

Reads data from the input source and record length metadata from the side channel and processes it. To implement processWithMetadata(), you must override useSideChannel() to return true. Vertica invokes this method repeatedly until it returns DONE or the query is canceled by the user.

Input: an external data source.

Output: a stream of data bytes, and a stream of bytes containing message length metadata from the data source.

Returns OUTPUT_NEEDED

DONE

KEEP_GOING

See Vertica::StreamState for details about return values.

On each invocation, processWithMetadata() should acquire more data and write that data to the buffer specified by output, and write the message lengths to output_lengths.

For the DataBuffer, processWithMetadata() should set output.offset (an output parameter) to the number of bytes that were written to the output buffer. It is common, though not necessary, for this to be the same as output.size (an input parameter). When processWithMetadata() is called, output.offset is uninitialized. To indicate that the buffer is too small to hold a record, processWithMetadata() should set output.offset and output_length.offset to 0 and return OUTPUT_NEEDED. Then processWithMetadata() is called again with a larger buffer.

For the LengthBuffer, processWithMetadata() should set output_lengths.offset to the number of length values that were written to the output_lengths buffer. If output.offset is set to 0, then output_lengths.offset should also be set to 0.

In general, processWithMetadata() code should assume that data buffers start at output.buf[output.offset] and length buffers start at output_lengths.buf[output_lengths.offset].

As a performance optimization, upstream operators might start processing emitted data (data between output.buf[0] and output.buf[output.offset] in the DataBuffer, and between output_lengths.buf[0] and output_lengths.buf[output.offset] in the LengthBuffer) before OUTPUT_NEEDED is returned. For this reason, output.offset and output_lengths.offset must be strictly increasing.

virtual size_t Vertica::UnsizedUDSource::requestMinBufferSize(ServerInterface & srvInterface)

inlinevirtual

Request a minimum buffer size into which this source will read data. This will be called after setup(), before the first call to process().

virtual bool Vertica::UnsizedUDSource::useSideChannel()

inlinevirtual

UnsizedUDSource::useSideChannel()

Provides access to the side channel containing record length metadata, when the UnsizedUDSource has metadata about record boundaries available in a structured format that is separate from the data payload.

Override and return true to indicate that processWithMetadata() should be called instead of process().

Return false to implement process().

Returns false by default.

1.1.254 - Vertica::UnsizedUDSource Member List

This is the complete list of members for Vertica::UnsizedUDSource, including all inherited members.

cancel(ServerInterface &srvInterface) Vertica::UDXObject inlineprotectedvirtual
cancelUDX(ServerInterface &srvInterface) Vertica::UDXObject inline
DEFAULT_MIN_BUFFER_SIZE (defined in Vertica::UnsizedUDSource) Vertica::UnsizedUDSource static
destroy(ServerInterface &srvInterface) (defined in Vertica::UnsizedUDSource) Vertica::UnsizedUDSource inlinevirtual
destroy(ServerInterface &srvInterface, SessionParamWriterMap &udSessionParams) (defined in Vertica::UnsizedUDSource) Vertica::UnsizedUDSource inlinevirtual
getPortion()=0 Vertica::UnsizedUDSource pure virtual
getUri() Vertica::UnsizedUDSource inlinevirtual
isCanceled() const Vertica::UDXObject inline
process(ServerInterface &srvInterface, DataBuffer &output)=0 (defined in Vertica::UnsizedUDSource) Vertica::UnsizedUDSource pure virtual
processWithMetadata(ServerInterface &srvInterface, DataBuffer &output, LengthBuffer &output_lengths) Vertica::UnsizedUDSource inlinevirtual
requestMinBufferSize(ServerInterface &srvInterface) Vertica::UnsizedUDSource inlinevirtual
setup(ServerInterface &srvInterface) (defined in Vertica::UnsizedUDSource) Vertica::UnsizedUDSource inlinevirtual
UDXObject() (defined in Vertica::UDXObject) Vertica::UDXObject inline
useSideChannel() Vertica::UnsizedUDSource inlinevirtual
~UDXObject() Vertica::UDXObject inlinevirtual
~UnsizedUDSource() (defined in Vertica::UnsizedUDSource) Vertica::UnsizedUDSource inlinevirtual

1.1.255 - Vertica::ValueRangeReader Class Reference

This class represents the value ranges of the arguments of a UDSF, one range per argument.

Inheritance diagram for Vertica::ValueRangeReader:

Collaboration diagram for Vertica::ValueRangeReader:

Public Types
enum BoundType { LO_BOUND, UP_BOUND }
Public Member Functions
ValueRangeReader (size_t narg)
bool canHaveNulls (size_t idx) const
Indicates if there can be NULL values in the range.
const vbool * getBoolPtrLo (size_t idx) const
Get a pointer to a BOOLEAN value from a range bound.
const vbool * getBoolPtrUp (size_t idx) const
const vbool & getBoolRefLo (size_t idx) const
Get a reference to a BOOLEAN value from a range bound.
const vbool & getBoolRefUp (size_t idx) const
template
const T * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
const DateADT * getDatePtrLo (size_t idx) const
Get a pointer to a DATE value from a range bound.
const DateADT * getDatePtrUp (size_t idx) const
const DateADT & getDateRefLo (size_t idx) const
Get a reference to a DATE value from a range bound.
const DateADT & getDateRefUp (size_t idx) const
const vfloat * getFloatPtrLo (size_t idx) const
Get a pointer to a FLOAT value from a range bound.
const vfloat * getFloatPtrUp (size_t idx) const
const vfloat & getFloatRefLo (size_t idx) const
Get a reference to a FLOAT value from a range bound.
const vfloat & getFloatRefUp (size_t idx) const
const Interval * getIntervalPtrLo (size_t idx) const
Get a pointer to an INTERVAL value from a range bound.
const Interval * getIntervalPtrUp (size_t idx) const
const Interval & getIntervalRefLo (size_t idx) const
Get a reference to an INTERVAL value from a range bound.
const Interval & getIntervalRefUp (size_t idx) const
const IntervalYM * getIntervalYMPtrLo (size_t idx) const
Get a pointer to a INTERVAL YEAR TO MONTH value from a range bound.
const IntervalYM * getIntervalYMPtrUp (size_t idx) const
const IntervalYM & getIntervalYMRefLo (size_t idx) const
Get a reference to an INTERVAL YEAR TO MONTH value from a range bound.
const IntervalYM & getIntervalYMRefUp (size_t idx) const
const vint * getIntPtrLo (size_t idx) const
Get a pointer to an INTEGER value from a range bound.
const vint * getIntPtrUp (size_t idx) const
const vint & getIntRefLo (size_t idx) const
Get a reference to an INTEGER value from a range bound.
const vint & getIntRefUp (size_t idx) const
const VNumeric * getNumericPtrLo (size_t idx) const
Get a pointer to a VNumeric value from a range bound.
const VNumeric * getNumericPtrUp (size_t idx) const
const VNumeric & getNumericRefLo (size_t idx) const
Get a reference to a VNumeric value from a range bound.
const VNumeric & getNumericRefUp (size_t idx) const
size_t getNumRanges () const
Retrieve the number of range arguments.
const VerticaType & getRangeType (size_t idx) const
Returns the data type of the values in a range.
EE::ValueSort getSortedness (size_t idx) const
const VString * getStringPtrLo (size_t idx) const
Get a pointer to a VString value from a range bound.
const VString * getStringPtrUp (size_t idx) const
const VString & getStringRefLo (size_t idx) const
Get a reference to an VString value from a range bound.
const VString & getStringRefUp (size_t idx) const
const TimeADT * getTimePtrLo (size_t idx) const
Get a pointer to a TIME value from a range bound.
const TimeADT * getTimePtrUp (size_t idx) const
const TimeADT & getTimeRefLo (size_t idx) const
Get a reference to a TIME value from a range bound.
const TimeADT & getTimeRefUp (size_t idx) const
const Timestamp * getTimestampPtrLo (size_t idx) const
Get a pointer to a TIMESTAMP value from a range bound.
const Timestamp * getTimestampPtrUp (size_t idx) const
const Timestamp & getTimestampRefLo (size_t idx) const
Get a reference to a TIMESTAMP value from a range bound.
const Timestamp & getTimestampRefUp (size_t idx) const
const TimestampTz * getTimestampTzPtrLo (size_t idx) const
Get a pointer to a TIMESTAMP WITH TIMEZONE value from a range bound.
const TimestampTz * getTimestampTzPtrUp (size_t idx) const
const TimestampTz & getTimestampTzRefLo (size_t idx) const
Get a reference to a TIMESTAMP WITH TIMEZONE value from a range bound.
const TimestampTz & getTimestampTzRefUp (size_t idx) const
const TimeTzADT * getTimeTzPtrLo (size_t idx) const
Get a pointer to a TIME WITH TIMEZONE value from a range bound.
const TimeTzADT * getTimeTzPtrUp (size_t idx) const
const TimeTzADT & getTimeTzRefLo (size_t idx) const
Get a reference to a TIME WITH TIMEZONE value from a range bound.
const TimeTzADT & getTimeTzRefUp (size_t idx) const
const VUuid * getUuidPtrLo (size_t idx) const
Get a pointer to a VUuid value from a range bound.
const VUuid * getUuidPtrUp (size_t idx) const
const VUuid & getUuidRefLo (size_t idx) const
Get a reference to a VUuid value from a range bound.
const VUuid & getUuidRefUp (size_t idx) const
bool hasBounds (size_t idx) const
Check if this range has lower and upper bounds set.
bool isNull (int idx) const
Check if all values in the idx'th input range are NULL.
Protected Member Functions
void addArg (char *loBound, char *upBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls)
void setCanHaveNulls (size_t idx, bool u)
Set a flag to indicate that some values in this range can be NULL.
void setSortedness (size_t idx, EE::ValueSort s)
Protected Attributes
size_t narg
std::vector ranges
std::vector svWrappersLo
std::vector svWrappersUp
std::vector uuWrappersLo
std::vector uuWrappersUp
std::vector vnWrappersLo
std::vector vnWrappersUp
Friends
class EE::VEval

Detailed Description

This class represents the value ranges of the arguments of a UDSF, one range per argument.

Instances of this class are used to let UDSF developers specify the output range of UDSFs via the optional ScalarFunction::getOutputRange() function.

Member Function Documentation

void Vertica::VerticaValueRange::addArg(char * loBound, char * upBound, const VerticaType & dt, EE::ValueSort sortedness, bool canHaveNulls)

inlineprotectedinherited

Add a value range of a particular function argument

Parameters

  • loBound: Base location to find the lower bound data
  • upBound: Base location to find the upper bound data
  • sortedness: Sortedness of values in the range
  • dt: The data type of range bounds
bool Vertica::VerticaValueRange::canHaveNulls(size_t idx) const

inline inherited Indicates if there can be NULL values in the range.

Parameters

  • idx: the range argument number.

Returns TRUE if some range values can be NULL, else FALSE.

const vbool* Vertica::ValueRangeReader::getBoolPtrLo(size_t idx) const

inline Get a pointer to a BOOLEAN value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a BOOLEAN.

Referenced by getBoolRefLo().

const vbool& Vertica::ValueRangeReader::getBoolRefLo(size_t idx) const

inline Get a reference to a BOOLEAN value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as BOOLEAN.

Referenced by isNull().

const DateADT* Vertica::ValueRangeReader::getDatePtrLo(size_t idx) const

inline Get a pointer to a DATE value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a DATE.

Referenced by getDateRefLo().

const DateADT& Vertica::ValueRangeReader::getDateRefLo(size_t idx) const

inline Get a reference to a DATE value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as DATE.

Referenced by isNull().

const vfloat* Vertica::ValueRangeReader::getFloatPtrLo(size_t idx) const

inline Get a pointer to a FLOAT value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a FLOAT.

Referenced by getFloatRefLo().

const vfloat& Vertica::ValueRangeReader::getFloatRefLo(size_t idx) const

inline Get a reference to a FLOAT value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A reference to the idx'th argument, cast as FLOAT.

Referenced by isNull().

const Interval* Vertica::ValueRangeReader::getIntervalPtrLo(size_t idx) const

inline Get a pointer to an INTERVAL value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as an INTERVAL.

Referenced by getIntervalRefLo().

const Interval& Vertica::ValueRangeReader::getIntervalRefLo(size_t idx) const

inline Get a reference to an INTERVAL value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as an INTERVAL.

Referenced by isNull().

const IntervalYM* Vertica::ValueRangeReader::getIntervalYMPtrLo(size_t idx) const

inline Get a pointer to a INTERVAL YEAR TO MONTH value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A point to the retrieved value cast as a INTERVAL YEAR TO MONTH.

Referenced by getIntervalYMRefLo().

const IntervalYM& Vertica::ValueRangeReader::getIntervalYMRefLo(size_t idx) const

inline Get a reference to an INTERVAL YEAR TO MONTH value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as INTERVAL YEAR TO MONTH.

Referenced by isNull().

const vint* Vertica::ValueRangeReader::getIntPtrLo(size_t idx) const

inline Get a pointer to an INTEGER value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a pointer to a chosen bound value, cast appropriately.

Example:

const vint *a = range->getIntPtrLo(0); // gets a pointer to the lower bound of 1st arg

Referenced by getIntRefLo().

const vint& Vertica::ValueRangeReader::getIntRefLo(size_t idx) const

inline Get a reference to an INTEGER value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the chosen bound value, cast as INTEGER.

Example:

const vint& a = range->getIntRefUp(0); // get upper bound of the 1st range argument

Referenced by isNull().

const VNumeric* Vertica::ValueRangeReader::getNumericPtrLo(size_t idx) const

inline Get a pointer to a VNumeric value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a Numeric.

Referenced by getNumericRefLo().

const VNumeric& Vertica::ValueRangeReader::getNumericRefLo(size_t idx) const

inline Get a reference to a VNumeric value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as VNumeric.

Referenced by isNull().

size_t Vertica::VerticaValueRange::getNumRanges() const

inline inherited Retrieve the number of range arguments.

Returns the number of range arguments held by this object.

const VerticaType& Vertica::VerticaValueRange::getRangeType(size_t idx) const

inline inherited Returns the data type of the values in a range.

Parameters

  • idx: The index of the range

Returns a VerticaType object describing the data type of the range values.

const VString* Vertica::ValueRangeReader::getStringPtrLo(size_t idx) const

inline Get a pointer to a VString value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a VString.

Referenced by getStringRefLo().

const VString& Vertica::ValueRangeReader::getStringRefLo(size_t idx) const

inline Get a reference to an VString value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as VString.

Note the returned object is a variable-length prefix of the actual string values in the range. For example, if the range values are {'abc', 'abb', 'bc', 'cab'} the range bounds may be like: Lo='a' and Up='cb'. In the example, the upper bound is not even a prefix of any value in the range, but all values in the range are greater than or equal than Lo and less than or equal to Up.

Referenced by isNull().

const TimeADT* Vertica::ValueRangeReader::getTimePtrLo(size_t idx) const

inline Get a pointer to a TIME value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a TIME.

Referenced by getTimeRefLo().

const TimeADT& Vertica::ValueRangeReader::getTimeRefLo(size_t idx) const

inline Get a reference to a TIME value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as TIME.

Referenced by isNull().

const Timestamp* Vertica::ValueRangeReader::getTimestampPtrLo(size_t idx) const

inline Get a pointer to a TIMESTAMP value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a TIMESTAMP.

Referenced by getTimestampRefLo().

const Timestamp& Vertica::ValueRangeReader::getTimestampRefLo(size_t idx) const

inline Get a reference to a TIMESTAMP value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as TIMESTAMP.

Referenced by isNull().

const TimestampTz* Vertica::ValueRangeReader::getTimestampTzPtrLo(size_t idx) const

inline Get a pointer to a TIMESTAMP WITH TIMEZONE value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a TIMESTAMP WITH TIMEZONE.

Referenced by getTimestampTzRefLo().

const TimestampTz& Vertica::ValueRangeReader::getTimestampTzRefLo(size_t idx) const

inline Get a reference to a TIMESTAMP WITH TIMEZONE value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as TIMESTAMP WITH TIMEZONE.

Referenced by isNull().

const TimeTzADT* Vertica::ValueRangeReader::getTimeTzPtrLo(size_t idx) const

inline Get a pointer to a TIME WITH TIMEZONE value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a TIME WITH TIMEZONE.

Referenced by getTimeTzRefLo().

const TimeTzADT& Vertica::ValueRangeReader::getTimeTzRefLo(size_t idx) const

inline Get a reference to a TIME WITH TIMEZONE value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as TIME WITH TIMEZONE.

Referenced by isNull().

const VUuid* Vertica::ValueRangeReader::getUuidPtrLo(size_t idx) const

inline Get a pointer to a VUuid value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns A pointer to the retrieved value cast as a Uuid.

Referenced by getUuidRefLo().

const VUuid& Vertica::ValueRangeReader::getUuidRefLo(size_t idx) const

inline Get a reference to a VUuid value from a range bound.

Parameters

  • idx: The argument number to retrieve the range bound.

Returns a reference to the idx'th argument, cast as VUuid.

Referenced by isNull().

bool Vertica::ValueRangeReader::hasBounds(size_t idx) const

inline Check if this range has lower and upper bounds set.

Note Callers of the get reference or get pointer functions should always first call this method, and only access the range bounds when this function returns TRUE.

Example:

if (rangeReader.hasBounds(0)) { // Check if bounds of the 1st range argument are set
// OK to access bounds
const vint& i = rangeReader.getIntRefLo(0);
const vint& j = rangeReader.getIntRefUp(0);
}

Returns TRUE if the range bounds are safe to access, else FALSE.

bool Vertica::ValueRangeReader::isNull(int idx) const

inline Check if all values in the idx'th input range are NULL.

Parameters

  • idx: The argument range number.

Returns true if all values in the range are NULL, false otherwise.

void Vertica::VerticaValueRange::setCanHaveNulls(size_t idx, bool u)

inlineprotectedinherited

Set a flag to indicate that some values in this range can be NULL.

Parameters

  • idx: The argument range number.
  • u: true if there can be NULL values in the range, else false.

1.1.256 - Vertica::ValueRangeReader Member List

This is the complete list of members for Vertica::ValueRangeReader, including all inherited members.

addArg(char *loBound, char *upBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls) Vertica::VerticaValueRange inlineprotected
BoundType enum name (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange
canHaveNulls(size_t idx) const Vertica::VerticaValueRange inline
EE::VEval (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader friend
getBoolPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getBoolPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getBoolRefLo(size_t idx) const Vertica::ValueRangeReader inline
getBoolRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getColPtr(size_t idx) const (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
getDatePtrLo(size_t idx) const Vertica::ValueRangeReader inline
getDatePtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getDateRefLo(size_t idx) const Vertica::ValueRangeReader inline
getDateRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getFloatPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getFloatPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getFloatRefLo(size_t idx) const Vertica::ValueRangeReader inline
getFloatRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getIntervalPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getIntervalPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getIntervalRefLo(size_t idx) const Vertica::ValueRangeReader inline
getIntervalRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getIntervalYMPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getIntervalYMPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getIntervalYMRefLo(size_t idx) const Vertica::ValueRangeReader inline
getIntervalYMRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getIntPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getIntPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getIntRefLo(size_t idx) const Vertica::ValueRangeReader inline
getIntRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getNumericPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getNumericPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getNumericRefLo(size_t idx) const Vertica::ValueRangeReader inline
getNumericRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getNumRanges() const Vertica::VerticaValueRange inline
getRangeType(size_t idx) const Vertica::VerticaValueRange inline
getSortedness(size_t idx) const (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
getStringPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getStringPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getStringRefLo(size_t idx) const Vertica::ValueRangeReader inline
getStringRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getTimePtrLo(size_t idx) const Vertica::ValueRangeReader inline
getTimePtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getTimeRefLo(size_t idx) const Vertica::ValueRangeReader inline
getTimeRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getTimestampPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getTimestampPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getTimestampRefLo(size_t idx) const Vertica::ValueRangeReader inline
getTimestampRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getTimestampTzPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getTimestampTzPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getTimestampTzRefLo(size_t idx) const Vertica::ValueRangeReader inline
getTimestampTzRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getTimeTzPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getTimeTzPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getTimeTzRefLo(size_t idx) const Vertica::ValueRangeReader inline
getTimeTzRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getUuidPtrLo(size_t idx) const Vertica::ValueRangeReader inline
getUuidPtrUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
getUuidRefLo(size_t idx) const Vertica::ValueRangeReader inline
getUuidRefUp(size_t idx) const (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
hasBounds(size_t idx) const Vertica::ValueRangeReader inline
isNull(int idx) const Vertica::ValueRangeReader inline
LO_BOUND enum value (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange
narg (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange protected
ranges (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange protected
setCanHaveNulls(size_t idx, bool u) Vertica::VerticaValueRange inlineprotected
setSortedness(size_t idx, EE::ValueSort s) (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inlineprotected
svWrappersLo (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
svWrappersUp (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
UP_BOUND enum value (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange
uuWrappersLo (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
uuWrappersUp (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
ValueRangeReader(size_t narg) (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inline
VerticaValueRange(size_t narg) (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
vnWrappersLo (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
vnWrappersUp (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
~ValueRangeReader() (defined in Vertica::ValueRangeReader) Vertica::ValueRangeReader inlinevirtual
~VerticaValueRange() (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inlinevirtual

1.1.257 - Vertica::ValueRangeWriter Class Reference

This class represents the output value range of a UDSF.

Inheritance diagram for Vertica::ValueRangeWriter:

Collaboration diagram for Vertica::ValueRangeWriter:

Public Types
enum BoundType { LO_BOUND, UP_BOUND }
Public Member Functions
ValueRangeWriter (char *outLoBound, char *outUpBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls)
bool canHaveNulls (size_t idx) const
Indicates if there can be NULL values in the range.
bool canHaveNulls () const
template
const T * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
VNumeric & getNumericRefLo ()
Gets a VNumeric object reference to set the range lower bound.
VNumeric & getNumericRefUp ()
Gets a VNumeric object reference to set the range upper bound.
size_t getNumRanges () const
Retrieve the number of range arguments.
const VerticaType & getRangeType (size_t idx) const
Returns the data type of the values in a range.
EE::ValueSort getSortedness (size_t idx) const
EE::ValueSort getSortedness () const
VString & getStringRefLo ()
Gets a VString object reference to set the range lower bound.
VString & getStringRefUp ()
Gets a VString object reference to set the range upper bound.
VUuid & getUuidRefLo ()
Gets a VUuid object reference to set the range lower bound.
VUuid & getUuidRefUp ()
Gets a VUuid object reference to set the range upper bound.
bool hasBounds () const
void setBoolLo (vbool r)
Sets a range bound as a BOOLEAN value.
void setBoolUp (vbool r)
void setCanHaveNulls (bool u)
void setDateLo (DateADT r)
Sets a range bound as a DATE value.
void setDateUp (DateADT r)
void setFloatLo (vfloat r)
Sets a range bound as a FLOAT value to the output row.
void setFloatUp (vfloat r)
void setHasBounds ()
Lets Vertica know that this output range has user-defined bounds.
void setIntervalLo (Interval r)
Sets a range bound as an INTERVAL value.
void setIntervalUp (Interval r)
void setIntervalYMLo (IntervalYM r)
Sets a range bound as an INTERVAL YEAR TO MONTH value.
void setIntervalYMUp (IntervalYM r)
void setIntLo (vint r)
Sets a range bound as an INTEGER value.
void setIntUp (vint r)
void setNull ()
Sets to NULL all values in this range.
void setSortedness (EE::ValueSort s)
void setTimeLo (TimeADT r)
Sets a range bound as a TIMESTAMP value.
void setTimestampLo (Timestamp r)
Sets a range bound as a TIMESTAMP value.
void setTimestampTzLo (TimestampTz r)
Sets a range bound as a TIMESTAMP WITH TIMEZONE value.
void setTimestampTzUp (TimestampTz r)
void setTimestampUp (Timestamp r)
void setTimeTzLo (TimeTzADT r)
Sets a range bound as a TIMESTAMP WITH TIMEZONE value.
void setTimeTzUp (TimeTzADT r)
void setTimeUp (TimeADT r)
Protected Member Functions
void addArg (char *loBound, char *upBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls)
void setCanHaveNulls (size_t idx, bool u)
Set a flag to indicate that some values in this range can be NULL.
void setSortedness (size_t idx, EE::ValueSort s)
Protected Attributes
size_t narg
std::vector ranges
std::vector svWrappersLo
std::vector svWrappersUp
std::vector uuWrappersLo
std::vector uuWrappersUp
std::vector vnWrappersLo
std::vector vnWrappersUp
Friends
class EE::VEval

Detailed Description

This class represents the output value range of a UDSF.

Instances of this class are used to allow UDSF developers specify the output range of UDSFs via the optional ScalarFunction::getOutputRange() function.

Member Function Documentation

void Vertica::VerticaValueRange::addArg(char * loBound, char * upBound, const VerticaType & dt, EE::ValueSort sortedness, bool canHaveNulls)

inlineprotectedinherited

Add a value range of a particular function argument

Parameters

  • loBound: Base location to find the lower bound data
  • upBound: Base location to find the upper bound data
  • sortedness: Sortedness of values in the range
  • dt: The data type of range bounds
bool Vertica::VerticaValueRange::canHaveNulls(size_t idx) const

inline inherited Indicates if there can be NULL values in the range.

Parameters

  • idx: the range argument number.

Returns TRUE if some range values can be NULL, else FALSE.

VNumeric& Vertica::ValueRangeWriter::getNumericRefLo()

inline Gets a VNumeric object reference to set the range lower bound.

Returns A VNumeric object reference.

Referenced by setNull().

VNumeric& Vertica::ValueRangeWriter::getNumericRefUp()

inline Gets a VNumeric object reference to set the range upper bound.

Returns A VNumeric object reference.

Referenced by setNull().

size_t Vertica::VerticaValueRange::getNumRanges() const

inline inherited Retrieve the number of range arguments.

Returns the number of range arguments held by this object.

const VerticaType& Vertica::VerticaValueRange::getRangeType(size_t idx) const

inline inherited Returns the data type of the values in a range.

Parameters

  • idx: The index of the range

Returns a VerticaType object describing the data type of the range values.

VString& Vertica::ValueRangeWriter::getStringRefLo()

inline Gets a VString object reference to set the range lower bound.

Returns A VString object reference.

Referenced by setNull().

VString& Vertica::ValueRangeWriter::getStringRefUp()

inline Gets a VString object reference to set the range upper bound.

Returns A VString object reference.

Referenced by setNull().

VUuid& Vertica::ValueRangeWriter::getUuidRefLo()

inline Gets a VUuid object reference to set the range lower bound.

Returns A VUuid object reference.

Referenced by setNull().

VUuid& Vertica::ValueRangeWriter::getUuidRefUp()

inline Gets a VUuid object reference to set the range upper bound.

Returns A VUuid object reference.

Referenced by setNull().

void Vertica::ValueRangeWriter::setBoolLo(vbool r)

inline Sets a range bound as a BOOLEAN value.

Parameters

  • r: The BOOLEAN value to set the range bound.

Referenced by setNull().

void Vertica::VerticaValueRange::setCanHaveNulls(size_t idx, bool u)

inlineprotectedinherited

Set a flag to indicate that some values in this range can be NULL.

Parameters

  • idx: The argument range number.
  • u: true if there can be NULL values in the range, else false.
void Vertica::ValueRangeWriter::setDateLo(DateADT r)

inline Sets a range bound as a DATE value.

Parameters

  • r: The DATE value to set the range bound.

Referenced by setNull().

void Vertica::ValueRangeWriter::setFloatLo(vfloat r)

inline Sets a range bound as a FLOAT value to the output row.

Parameters

  • r: The FLOAT value to set the range bound.

Referenced by setNull().

void Vertica::ValueRangeWriter::setIntervalLo(Interval r)

inline Sets a range bound as an INTERVAL value.

Parameters

  • r: The INTERVAL value to set the range bound.

Referenced by setNull().

void Vertica::ValueRangeWriter::setIntervalYMLo(IntervalYM r)

inline Sets a range bound as an INTERVAL YEAR TO MONTH value.

Parameters

  • r: The INTERVAL YEAR TO MONTH value to set the range bound.
void Vertica::ValueRangeWriter::setIntLo(vint r)

inline Sets a range bound as an INTEGER value.

Parameters

  • r: The INTEGER value to set the range bound.

Referenced by setNull().

void Vertica::ValueRangeWriter::setNull()

inline Sets to NULL all values in this range.

Note As side effect of this method, this range will be marked as having NULL values and its sortedness set to EE::SORT_CONSTANT.

void Vertica::ValueRangeWriter::setTimeLo(TimeADT r)

inline Sets a range bound as a TIMESTAMP value.

Parameters

  • r: The TIMESTAMP value to set the range bound.

Referenced by setNull().

void Vertica::ValueRangeWriter::setTimestampLo(Timestamp r)

inline Sets a range bound as a TIMESTAMP value.

Parameters

  • r: The TIMESTAMP value to set the range bound.

Referenced by setNull().

void Vertica::ValueRangeWriter::setTimestampTzLo(TimestampTz r)

inline Sets a range bound as a TIMESTAMP WITH TIMEZONE value.

Parameters

  • r: The TIMESTAMP WITH TIMEZONE value to set the range bound.

Referenced by setNull().

void Vertica::ValueRangeWriter::setTimeTzLo(TimeTzADT r)

inline Sets a range bound as a TIMESTAMP WITH TIMEZONE value.

Parameters

  • r: The TIMESTAMP WITH TIMEZONE value to set the range bound.

Referenced by setNull().

1.1.258 - Vertica::ValueRangeWriter Member List

This is the complete list of members for Vertica::ValueRangeWriter, including all inherited members.

addArg(char *loBound, char *upBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls) Vertica::VerticaValueRange inlineprotected
BoundType enum name (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange
canHaveNulls() const (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
Vertica::VerticaValueRange::canHaveNulls(size_t idx) const Vertica::VerticaValueRange inline
EE::VEval (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter friend
getColPtr(size_t idx) const (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
getNumericRefLo() Vertica::ValueRangeWriter inline
getNumericRefUp() Vertica::ValueRangeWriter inline
getNumRanges() const Vertica::VerticaValueRange inline
getRangeType(size_t idx) const Vertica::VerticaValueRange inline
getSortedness() const (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
getSortedness(size_t idx) const (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
getStringRefLo() Vertica::ValueRangeWriter inline
getStringRefUp() Vertica::ValueRangeWriter inline
getUuidRefLo() Vertica::ValueRangeWriter inline
getUuidRefUp() Vertica::ValueRangeWriter inline
hasBounds() const (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
LO_BOUND enum value (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange
narg (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange protected
ranges (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange protected
setBoolLo(vbool r) Vertica::ValueRangeWriter inline
setBoolUp(vbool r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setCanHaveNulls(bool u) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
Vertica::VerticaValueRange::setCanHaveNulls(size_t idx, bool u) Vertica::VerticaValueRange inlineprotected
setDateLo(DateADT r) Vertica::ValueRangeWriter inline
setDateUp(DateADT r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setFloatLo(vfloat r) Vertica::ValueRangeWriter inline
setFloatUp(vfloat r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setHasBounds() Vertica::ValueRangeWriter inline
setIntervalLo(Interval r) Vertica::ValueRangeWriter inline
setIntervalUp(Interval r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setIntervalYMLo(IntervalYM r) Vertica::ValueRangeWriter inline
setIntervalYMUp(IntervalYM r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setIntLo(vint r) Vertica::ValueRangeWriter inline
setIntUp(vint r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setNull() Vertica::ValueRangeWriter inline
setSortedness(EE::ValueSort s) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setSortedness(size_t idx, EE::ValueSort s) (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inlineprotected
setTimeLo(TimeADT r) Vertica::ValueRangeWriter inline
setTimestampLo(Timestamp r) Vertica::ValueRangeWriter inline
setTimestampTzLo(TimestampTz r) Vertica::ValueRangeWriter inline
setTimestampTzUp(TimestampTz r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setTimestampUp(Timestamp r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setTimeTzLo(TimeTzADT r) Vertica::ValueRangeWriter inline
setTimeTzUp(TimeTzADT r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
setTimeUp(TimeADT r) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
svWrappersLo (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
svWrappersUp (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
UP_BOUND enum value (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange
uuWrappersLo (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
uuWrappersUp (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
ValueRangeWriter(char *outLoBound, char *outUpBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls) (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inline
VerticaValueRange(size_t narg) (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
vnWrappersLo (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
vnWrappersUp (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
~ValueRangeWriter() (defined in Vertica::ValueRangeWriter) Vertica::ValueRangeWriter inlinevirtual
~VerticaValueRange() (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inlinevirtual

1.1.259 - Vertica::VerticaBlock Class Reference

: Represents an in-memory block of tuples

Inheritance diagram for Vertica::VerticaBlock:

Collaboration diagram for Vertica::VerticaBlock:

Classes
struct NestedBlockPtr
Public Member Functions
VerticaBlock (size_t ncols, int rowcount, const int *indices)
void copy (const VerticaBlock &other)
template
const T * getColPtr (size_t idx) const
template<>
const VString * getColPtr (size_t idx) const
template<>
const VNumeric * getColPtr (size_t idx) const
template<>
const VUuid * getColPtr (size_t idx) const
template<>
const BlockReader * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
template<>
VString * getColPtrForWrite (size_t idx)
template<>
VNumeric * getColPtrForWrite (size_t idx)
template<>
VUuid * getColPtrForWrite (size_t idx)
template<>
BlockWriter * getColPtrForWrite (size_t idx)
template
const T & getColRef (size_t idx) const
template
T & getColRefForWrite (size_t idx)
int getColStride (size_t idx) const
const EE::DataArea * getDataArea (size_t idx) const
size_t getNumCols () const
int getNumRows () const
const SizedColumnTypes & getTypeMetaData () const
SizedColumnTypes & getTypeMetaData ()
void * getVoidPtr (size_t idx=0)
const void * getVoidPtr (size_t idx=0) const
bool remaining () const
void setDataArea (size_t idx, void *dataarea)
Protected Member Functions
void addCol (char *arg, int colstride, const Field &field)
void addCol (const char *arg, int colstride, const Field &field)
bool checkStringUserBlockInfo (size_t idx) const
bool checkTimeUserBlockInfo (size_t idx) const
EE::DataArea ** getArrayIntermediateDataArea (size_t c)
void reset ()
void resetIndex ()
void setRowCount (int rowCount)
void validateStringColumn (size_t idx, const VString &s, size_t colLength) const
Protected Attributes
std::vector cols
std::vector colstrides
int count
std::vector ctWrappers
int index
const int * indices
size_t ncols
int nrows
std::vector processBlockUserInfoVector
std::vector svWrappers
SizedColumnTypes typeMetaData
std::vector uuWrappers
std::vector vnWrappers
Friends
class ::EE::Loader::OrcParser
class ::EE::Loader::ParquetParser
class ::EE::MVExprSupport
class ::EE::UserDefinedAggregate
class ::EE::UserDefinedAnalytic
class ::EE::UserDefinedProcess
class ::EE::UserDefinedTransform
class ::EE::VEval
class AggregateFunction
class Array::BlockSaver
struct CPPExecContext
class VerticaBlockSerializer

Detailed Description

: Represents an in-memory block of tuples

Member Function Documentation

void Vertica::VerticaBlock::addCol(char * arg, int colstride, const Field & field)

protected

Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • field: metadata for the added column
  • dt: The type of input.
  • fieldname: the name of the field

Referenced by Vertica::ParamReader::addParameter().

EE::DataArea** Vertica::VerticaBlock::getArrayIntermediateDataArea(size_t c)

inlineprotected

Returns a pointer to a DataArea for accumulating an intermediate result

template<class T >

const T* Vertica::VerticaBlock::getColPtr(size_t idx) const

inline Returns a pointer to the idx'th argument, cast appropriately.

Example:

const vint *a = arg_reader->getColPtr(0);

template<class T >

const T& Vertica::VerticaBlock::getColRef(size_t idx) const

inline Returns a pointer to the idx'th argument, cast appropriately.

Example

const vint a = arg_reader->getColRef<vint>(0);

size_t Vertica::VerticaBlock::getNumCols() const

inline Returns the number of columns held by this block.

Referenced by

int Vertica::VerticaBlock::getNumRows() const

inline Returns the number of rows held by this block.

const SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData() const

inline Returns information about the types and numbers of arguments

Referenced by

SizedColumnTypes& Vertica::VerticaBlock::getTypeMetaData()

inline Returns information about the types and numbers of arguments

bool Vertica::VerticaBlock::remaining() const

inline Returns the number of entries remaining in the block

1.1.260 - Vertica::VerticaBlock Member List

This is the complete list of members for Vertica::VerticaBlock, including all inherited members.

::EE::Loader::OrcParser (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
::EE::Loader::ParquetParser (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
::EE::MVExprSupport (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
::EE::UserDefinedAggregate (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
::EE::UserDefinedAnalytic (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
::EE::UserDefinedProcess (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
::EE::UserDefinedTransform (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
::EE::VEval (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
addCol(char *arg, int colstride, const Field &field) Vertica::VerticaBlock protected
addCol(const char *arg, int colstride, const Field &field) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
AggregateFunction (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
Array::BlockSaver (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
checkStringUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
checkTimeUserBlockInfo(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
cols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
colstrides (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
copy(const VerticaBlock &other) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
count (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
CPPExecContext (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
ctWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
getArrayIntermediateDataArea(size_t c) Vertica::VerticaBlock inlineprotected
getColPtr(size_t idx) const Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtr(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColRef(size_t idx) const Vertica::VerticaBlock inline
getColRefForWrite(size_t idx) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getColStride(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getDataArea(size_t idx) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getNumCols() const Vertica::VerticaBlock inline
getNumRows() const Vertica::VerticaBlock inline
getTypeMetaData() const Vertica::VerticaBlock inline
getTypeMetaData() Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
getVoidPtr(size_t idx=0) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
index (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
indices (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
ncols (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
nrows (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
processBlockUserInfoVector (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
remaining() const Vertica::VerticaBlock inline
reset() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
resetIndex() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
setDataArea(size_t idx, void *dataarea) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
setRowCount(int rowCount) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlineprotected
svWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
typeMetaData (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
uuWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
validateStringColumn(size_t idx, const VString &s, size_t colLength) const (defined in Vertica::VerticaBlock) Vertica::VerticaBlock protected
VerticaBlock(size_t ncols, int rowcount, const int *indices) (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inline
VerticaBlockSerializer (defined in Vertica::VerticaBlock) Vertica::VerticaBlock friend
vnWrappers (defined in Vertica::VerticaBlock) Vertica::VerticaBlock mutableprotected
~VerticaBlock() (defined in Vertica::VerticaBlock) Vertica::VerticaBlock inlinevirtual

1.1.261 - Vertica::VerticaBlock::NestedBlockPtr Member List

This is the complete list of members for Vertica::VerticaBlock::NestedBlockPtr, including all inherited members.

NestedBlockPtr(VerticaBlock *block) (defined in Vertica::VerticaBlock::NestedBlockPtr) Vertica::VerticaBlock::NestedBlockPtr inline
NestedBlockPtr(NestedBlockPtr &&movefrom) noexcept (defined in Vertica::VerticaBlock::NestedBlockPtr) Vertica::VerticaBlock::NestedBlockPtr inline
NestedBlockPtr(const NestedBlockPtr &other) (defined in Vertica::VerticaBlock::NestedBlockPtr) Vertica::VerticaBlock::NestedBlockPtr inline
operator=(const T &other)=delete (defined in Vertica::VerticaBlock::NestedBlockPtr) Vertica::VerticaBlock::NestedBlockPtr
operator=(const NestedBlockPtr &other) (defined in Vertica::VerticaBlock::NestedBlockPtr) Vertica::VerticaBlock::NestedBlockPtr inline

1.1.262 - Vertica::VerticaBlock::NestedBlockPtr Struct Reference

Inheritance diagram for Vertica::VerticaBlock::NestedBlockPtr:

Collaboration diagram for Vertica::VerticaBlock::NestedBlockPtr:

Public Member Functions
NestedBlockPtr (VerticaBlock *block)
NestedBlockPtr (NestedBlockPtr &&movefrom) noexcept
NestedBlockPtr (const NestedBlockPtr &other)
template
NestedBlockPtr & operator= (const T &other)=delete
NestedBlockPtr & operator= (const NestedBlockPtr &other)

Detailed Description

Wraps a nested VerticaBlock, as for a complex type or array column. Assignment does a deep copy of the source block.

1.1.263 - Vertica::VerticaBuildInfo Member List

This is the complete list of members for Vertica::VerticaBuildInfo, including all inherited members.

branch (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo
brand_name (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo
brand_version (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo
build_date (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo
build_machine (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo
checksum (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo
codename (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo
revision (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo
sdk_version (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo
VerticaBuildInfo() (defined in Vertica::VerticaBuildInfo) Vertica::VerticaBuildInfo inline

1.1.264 - Vertica::VerticaBuildInfo Struct Reference

Collaboration diagram for Vertica::VerticaBuildInfo:

Public Attributes
const char * branch
const char * brand_name
const char * brand_version
const char * build_date
const char * build_machine
const char * checksum
const char * codename
const char * revision
const char * sdk_version

1.1.265 - Vertica::VerticaType Class Reference

Represents types of data that are passed into and returned back from user's code.

Collaboration diagram for Vertica::VerticaType:

Public Member Functions
VerticaType (Oid oid, Typemod typmod)
VerticaType (const VerticaType &other)
Oid getArray1DOid () const
VerticaType getArray1DType () const
int32 getCollectionBinarySize (bool checkType=true) const
For Collection data types, returns the length of the binary backing the array/set.
Field getElementField () const
Oid getElementOid () const
VerticaType getElementType () const
Field getField (size_t idx) const
std::string getFieldName (size_t idx) const
VerticaType getFieldType (size_t idx) const
int32 getIntervalPrecision () const
For INTERVAL data types, returns the precision.
int32 getIntervalRange () const
For INTERVAL data types, returns the range.
int32 getMaxSize () const
Returns the maximum size, in bytes, of a data element of this type.
int32 getNumericFractional () const
For NUMERIC data types, returns the number of fractional digits (i.e., digits right of the decimal point)
int32 getNumericIntegral () const
For NUMERIC data types, returns the number of integral digits (i.e., digits left of the decimal point)
int32 getNumericLength () const
For NUMERIC data types, returns the number of bytes required to store an element. Calling this with a non-numeric data type can cause a crash.
int32 getNumericPrecision () const
For NUMERIC data types, returns the precision.
int32 getNumericScale () const
For NUMERIC data types, returns the scale.
int32 getNumericWordCount () const
size_t getNumFields () const
std::string getPrettyPrintStr () const
Return human readable type string.
Oid getSetOid () const
VerticaType getSetType () const
int32 getStringLength (bool checkType=true) const
For VARCHAR/CHAR/VARBINARY/BINARY data types, returns the length of the string.
int32 getTimePrecision () const
For TIMESTAMP data types, returns the precision.
int32 getTimestampPrecision () const
For TIMESTAMP data types, returns the precision.
const char * getTypeStr () const
Oid getUnderlyingType () const
bool isArray1DType () const
bool isArrayType () const
bool isBinary () const
Returns true if this type is BINARY, false otherwise.
bool isBool () const
Returns true if this type is BOOLEAN, false otherwise.
bool isChar () const
Returns true if this type is CHAR, false otherwise.
bool iscoercedStringType () const
Return true if it is of string type or it is uuid, date, time, etc..
bool isCollection1DType () const
bool isCollectionType () const
bool isComplexArrayType () const
bool isComplexRowArrayType () const
bool isComplexRowType () const
bool isComplexType () const
bool isDate () const
Returns true if this type is DATE, false otherwise.
bool isFloat () const
Returns true if this type is FLOAT, false otherwise.
bool isInt () const
Returns true if this type is INTEGER, false otherwise.
bool isInterval () const
Returns true if this type is INTERVAL, false otherwise.
bool isIntervalYM () const
Returns true if this type is INTERVAL YEAR TO MONTH, false otherwise.
bool isLongVarbinary () const
Returns true if this type is LONG VARCHAR, false otherwise.
bool isLongVarchar () const
Returns true if this type is LONG VARCHAR, false otherwise.
bool isNestedArrayType () const
bool isNumeric () const
Returns true if this type is NUMERIC, false otherwise.
bool isSetType () const
bool isStringCollectionType () const
bool isStringOid (Oid typeOid) const
bool isStringType () const
Return true for VARCHAR/CHAR/VARBINARY/BINARY/LONG VARCHAR/LONG VARBINARY data types.
bool isTime () const
Returns true if this type is TIME, false otherwise.
bool isTimestamp () const
Returns true if this type is TIMESTAMP, false otherwise.
bool isTimestampTz () const
Returns true if this type is TIMESTAMP WITH TIMEZONE, false otherwise.
bool isTimeTz () const
Returns true if this type is TIME WITH TIMEZONE, false otherwise.
bool isUuid () const
Returns true if this type is UUID, false otherwise.
bool isVarbinary () const
Returns true if this type is VARBINARY, false otherwise.
bool isVarchar () const
Returns true if this type is VARCHAR, false otherwise.
bool operator!= (const VerticaType &rhs) const
bool operator== (const VerticaType &rhs) const
void setIntervalPrecision (int32 precision)
For INTERVAL data types, sets the precision.
void setIntervalRange (int32 range)
For INTERVAL data types, sets the range.
void setNumericPrecision (int32 precision)
For NUMERIC data types, sets the precision.
void setNumericScale (int32 scale)
For NUMERIC data types, sets the scale.
void setTimePrecision (int32 precision)
For TIMESTAMP data types, sets the precision.
void setTimestampPrecision (int32 precision)
For TIMESTAMP data types, sets the precision.
Static Public Member Functions
static VerticaType ArrayType (const Field &element, int maxElems=-1)
static const char * getTypeStr (Oid typeOid)
static Oid isBuiltInType (const Oid typeOid)
static VerticaType RowType (const Fields &rowfields)

Detailed Description

Represents types of data that are passed into and returned back from user's code.

Member Function Documentation

Field Vertica::VerticaType::getElementField() const

Returns A Field representing the element type of this collection or complex array. The returned Field's getType() will be this->getElementType().

VerticaType Vertica::VerticaType::getElementType() const

Returns A type representing the element type of this collection or complex array. Throws an exception if this is not a collection or complex array type.

Referenced by

Field Vertica::VerticaType::getField(size_t idx) const

Parameters

  • idx: The position of the field type to look up.

Returns A Field representing the field type at position idx of this ROW type. The returned Field's getType() will be this->getFieldType(idx).

Referenced by getFieldName().

std::string Vertica::VerticaType::getFieldName(size_t idx) const

Parameters

  • idx: The position of the field name to look up.

Returns The name of the field at the provided index.

VerticaType Vertica::VerticaType::getFieldType(size_t idx) const

Parameters

  • idx: The position of the field type to look up.

Returns A type representing the field type at position idx of this ROW type. Throws an exception if this is not a row type, or if idx is out of range.

Referenced by getField().

size_t Vertica::VerticaType::getNumFields() const

Returns The number of fields for this ROW type. Should only be called on ROW types.

Oid Vertica::VerticaType::getUnderlyingType() const

inline Returns If this is a built in type, returns the typeOid. Otherwise, returns the base type oid on which the type is based.

Referenced by

bool Vertica::VerticaType::isCollection1DType() const

inline Returns true if this is a one-dimension collection type, e.g. ARRAY[INTEGER] or SET[VARCHAR]

Returns false if this type is an element of a complex array, even if it itself a 1D array type.

Referenced by

bool Vertica::VerticaType::isComplexRowArrayType() const

Returns true if this type is an ARRAY[ROW(...)] type

Referenced by getMaxSize().

bool Vertica::VerticaType::isComplexRowType() const

inline Returns true if this is a ROW(...) type

Referenced by

bool Vertica::VerticaType::isNestedArrayType() const

Returns true if this type is an ARRAY[ARRAY[...]] type

bool Vertica::VerticaType::isStringCollectionType() const

inline Returns true if this is a one-dimension collection type whose element is a string type. See isCollection1DType().

1.1.266 - Vertica::VerticaType Member List

This is the complete list of members for Vertica::VerticaType, including all inherited members.

ArrayType(const Field &element, int maxElems=-1) (defined in Vertica::VerticaType) Vertica::VerticaType static
getArray1DOid() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
getArray1DType() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
getCollectionBinarySize(bool checkType=true) const Vertica::VerticaType
getElementField() const Vertica::VerticaType
getElementOid() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
getElementType() const Vertica::VerticaType
getField(size_t idx) const Vertica::VerticaType
getFieldName(size_t idx) const Vertica::VerticaType
getFieldType(size_t idx) const Vertica::VerticaType
getIntervalPrecision() const Vertica::VerticaType inline
getIntervalRange() const Vertica::VerticaType inline
getMaxSize() const Vertica::VerticaType inline
getNumericFractional() const Vertica::VerticaType inline
getNumericIntegral() const Vertica::VerticaType inline
getNumericLength() const Vertica::VerticaType inline
getNumericPrecision() const Vertica::VerticaType inline
getNumericScale() const Vertica::VerticaType inline
getNumericWordCount() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
getNumFields() const Vertica::VerticaType
getPrettyPrintStr() const Vertica::VerticaType inline
getSetOid() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
getSetType() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
getStringLength(bool checkType=true) const Vertica::VerticaType inline
getTimePrecision() const Vertica::VerticaType inline
getTimestampPrecision() const Vertica::VerticaType inline
getTypeStr(Oid typeOid) (defined in Vertica::VerticaType) Vertica::VerticaType inlinestatic
getTypeStr() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
getUnderlyingType() const Vertica::VerticaType inline
isArray1DType() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
isArrayType() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
isBinary() const Vertica::VerticaType inline
isBool() const Vertica::VerticaType inline
isBuiltInType(const Oid typeOid) (defined in Vertica::VerticaType) Vertica::VerticaType inlinestatic
isChar() const Vertica::VerticaType inline
iscoercedStringType() const Vertica::VerticaType inline
isCollection1DType() const Vertica::VerticaType inline
isCollectionType() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
isComplexArrayType() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
isComplexRowArrayType() const Vertica::VerticaType
isComplexRowType() const Vertica::VerticaType inline
isComplexType() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
isDate() const Vertica::VerticaType inline
isFloat() const Vertica::VerticaType inline
isInt() const Vertica::VerticaType inline
isInterval() const Vertica::VerticaType inline
isIntervalYM() const Vertica::VerticaType inline
isLongVarbinary() const Vertica::VerticaType inline
isLongVarchar() const Vertica::VerticaType inline
isNestedArrayType() const Vertica::VerticaType
isNumeric() const Vertica::VerticaType inline
isSetType() const (defined in Vertica::VerticaType) Vertica::VerticaType inline
isStringCollectionType() const Vertica::VerticaType inline
isStringOid(Oid typeOid) const (defined in Vertica::VerticaType) Vertica::VerticaType inline
isStringType() const Vertica::VerticaType inline
isTime() const Vertica::VerticaType inline
isTimestamp() const Vertica::VerticaType inline
isTimestampTz() const Vertica::VerticaType inline
isTimeTz() const Vertica::VerticaType inline
isUuid() const Vertica::VerticaType inline
isVarbinary() const Vertica::VerticaType inline
isVarchar() const Vertica::VerticaType inline
operator!=(const VerticaType &rhs) const (defined in Vertica::VerticaType) Vertica::VerticaType inline
operator==(const VerticaType &rhs) const (defined in Vertica::VerticaType) Vertica::VerticaType inline
RowType(const Fields &rowfields) (defined in Vertica::VerticaType) Vertica::VerticaType inlinestatic
setIntervalPrecision(int32 precision) Vertica::VerticaType inline
setIntervalRange(int32 range) Vertica::VerticaType inline
setNumericPrecision(int32 precision) Vertica::VerticaType inline
setNumericScale(int32 scale) Vertica::VerticaType inline
setTimePrecision(int32 precision) Vertica::VerticaType inline
setTimestampPrecision(int32 precision) Vertica::VerticaType inline
VerticaType(Oid oid, Typemod typmod) (defined in Vertica::VerticaType) Vertica::VerticaType inline
VerticaType(const VerticaType &other) (defined in Vertica::VerticaType) Vertica::VerticaType inline

1.1.267 - Vertica::VerticaValueRange Class Reference

This class represents value ranges used in analyzing the output of UDSFs. A range is expressed as a minimum/maximum value (inclusive) pair.

Inheritance diagram for Vertica::VerticaValueRange:

Collaboration diagram for Vertica::VerticaValueRange:

Classes
struct ValueRange
Public Types
enum BoundType { LO_BOUND, UP_BOUND }
Public Member Functions
VerticaValueRange (size_t narg)
bool canHaveNulls (size_t idx) const
Indicates if there can be NULL values in the range.
template
const T * getColPtr (size_t idx) const
template
T * getColPtrForWrite (size_t idx)
size_t getNumRanges () const
Retrieve the number of range arguments.
const VerticaType & getRangeType (size_t idx) const
Returns the data type of the values in a range.
EE::ValueSort getSortedness (size_t idx) const
Protected Member Functions
void addArg (char *loBound, char *upBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls)
void setCanHaveNulls (size_t idx, bool u)
Set a flag to indicate that some values in this range can be NULL.
void setSortedness (size_t idx, EE::ValueSort s)
Protected Attributes
size_t narg
std::vector ranges
std::vector svWrappersLo
std::vector svWrappersUp
std::vector uuWrappersLo
std::vector uuWrappersUp
std::vector vnWrappersLo
std::vector vnWrappersUp
Friends
struct ::AnalyzeUDSFHandler
struct ::UDxExecContext

Detailed Description

This class represents value ranges used in analyzing the output of UDSFs. A range is expressed as a minimum/maximum value (inclusive) pair.

Instances of this class are used to allow UDSF developers to specify what the output range of of the function is. The UDSF developer is responsible to override ScalarFunction::getOutputRange() and set the function's output range using the knowledge of the input argument ranges passed as references to ScalarFunction::getOutputRange().

Member Function Documentation

void Vertica::VerticaValueRange::addArg(char * loBound, char * upBound, const VerticaType & dt, EE::ValueSort sortedness, bool canHaveNulls)

inlineprotected

Add a value range of a particular function argument

Parameters

  • loBound: Base location to find the lower bound data
  • upBound: Base location to find the upper bound data
  • sortedness: Sortedness of values in the range
  • dt: The data type of range bounds
bool Vertica::VerticaValueRange::canHaveNulls(size_t idx) const

inline Indicates if there can be NULL values in the range.

Parameters

  • idx: the range argument number.

Returns TRUE if some range values can be NULL, else FALSE.

size_t Vertica::VerticaValueRange::getNumRanges() const

inline Retrieve the number of range arguments.

Returns the number of range arguments held by this object.

const VerticaType& Vertica::VerticaValueRange::getRangeType(size_t idx) const

inline Returns the data type of the values in a range.

Parameters

  • idx: The index of the range

Returns a VerticaType object describing the data type of the range values.

void Vertica::VerticaValueRange::setCanHaveNulls(size_t idx, bool u)

inlineprotected

Set a flag to indicate that some values in this range can be NULL.

Parameters

  • idx: The argument range number.
  • u: true if there can be NULL values in the range, else false.

1.1.268 - Vertica::VerticaValueRange Member List

This is the complete list of members for Vertica::VerticaValueRange, including all inherited members.

::AnalyzeUDSFHandler (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange friend
::UDxExecContext (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange friend
addArg(char *loBound, char *upBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls) Vertica::VerticaValueRange inlineprotected
BoundType enum name (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange
canHaveNulls(size_t idx) const Vertica::VerticaValueRange inline
getColPtr(size_t idx) const (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
getColPtrForWrite(size_t idx) (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
getNumRanges() const Vertica::VerticaValueRange inline
getRangeType(size_t idx) const Vertica::VerticaValueRange inline
getSortedness(size_t idx) const (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
LO_BOUND enum value (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange
narg (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange protected
ranges (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange protected
setCanHaveNulls(size_t idx, bool u) Vertica::VerticaValueRange inlineprotected
setSortedness(size_t idx, EE::ValueSort s) (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inlineprotected
svWrappersLo (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
svWrappersUp (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
UP_BOUND enum value (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange
uuWrappersLo (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
uuWrappersUp (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
VerticaValueRange(size_t narg) (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inline
vnWrappersLo (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
vnWrappersUp (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange mutableprotected
~VerticaValueRange() (defined in Vertica::VerticaValueRange) Vertica::VerticaValueRange inlinevirtual

1.1.269 - Vertica::VerticaValueRange::ValueRange Member List

This is the complete list of members for Vertica::VerticaValueRange::ValueRange, including all inherited members.

canHaveNulls (defined in Vertica::VerticaValueRange::ValueRange) Vertica::VerticaValueRange::ValueRange
dt (defined in Vertica::VerticaValueRange::ValueRange) Vertica::VerticaValueRange::ValueRange
loBound (defined in Vertica::VerticaValueRange::ValueRange) Vertica::VerticaValueRange::ValueRange
sortedness (defined in Vertica::VerticaValueRange::ValueRange) Vertica::VerticaValueRange::ValueRange
upBound (defined in Vertica::VerticaValueRange::ValueRange) Vertica::VerticaValueRange::ValueRange
ValueRange(char *loBound, char *upBound, VerticaType dt, EE::ValueSort sortedness, bool canHaveNulls) (defined in Vertica::VerticaValueRange::ValueRange) Vertica::VerticaValueRange::ValueRange inline

1.1.270 - Vertica::VerticaValueRange::ValueRange Struct Reference

Collaboration diagram for Vertica::VerticaValueRange::ValueRange:

Public Member Functions
ValueRange (char *loBound, char *upBound, VerticaType dt, EE::ValueSort sortedness, bool canHaveNulls)
Public Attributes
bool canHaveNulls
VerticaType dt
char * loBound
EE::ValueSort sortedness
char * upBound

1.1.271 - Vertica::VInterval Class Reference

Representation of an Interval in Vertica.

Collaboration diagram for Vertica::VInterval:

Static Public Member Functions
static void breakUp (Interval i, int64 &days, int64 &hour, int64 &min, float &sec)
Break up an Interval and set the arguments.
static Interval combine (int64 days, int64 hour, int64 min, double sec)
Compute an Interval from its components.

Detailed Description

Representation of an Interval in Vertica.

Member Function Documentation

static void Vertica::VInterval::breakUp(Interval i, int64 & days, int64 & hour, int64 & min, float & sec)

inlinestatic

Break up an Interval and set the arguments.

Returns None

Parameters

  • i]: Vertica Interval.
  • days]: Number of days in the interval.
  • hour]: Number of hours in the interval.
  • min]: Number of minutes in the interval.
  • sec]: Number of seconds including fractions of a second.
static Interval Vertica::VInterval::combine(int64 days, int64 hour, int64 min, double sec)

inlinestatic

Compute an Interval from its components.

Returns the value of the specified Interval

Parameters

  • days]: Number of days in the interval.
  • hour]: Number of hours in the interval.
  • min]: Number of minutes in the interval.
  • sec]: Number of seconds including fractions of a second.

1.1.272 - Vertica::VInterval Member List

This is the complete list of members for Vertica::VInterval, including all inherited members.

breakUp(Interval i, int64 &days, int64 &hour, int64 &min, float &sec) Vertica::VInterval inlinestatic
combine(int64 days, int64 hour, int64 min, double sec) Vertica::VInterval inlinestatic

1.1.273 - Vertica::VIntervalYM Class Reference

Representation of an IntervalYM in Vertica. An Interval can be broken up into years and months.

Collaboration diagram for Vertica::VIntervalYM:

Static Public Member Functions
static void breakUp (IntervalYM i, int64 &years, int64 &months)
Break up an Interval and set the arguments.

Detailed Description

Representation of an IntervalYM in Vertica. An Interval can be broken up into years and months.

Member Function Documentation

static void Vertica::VIntervalYM::breakUp(IntervalYM i, int64 & years, int64 & months)

inlinestatic

Break up an Interval and set the arguments.

Returns None

Parameters

  • i]: Vertica IntervalYM.
  • years]: Number of years in the interval.
  • months]: Number of months in the interval.

1.1.274 - Vertica::VIntervalYM Member List

This is the complete list of members for Vertica::VIntervalYM, including all inherited members.

breakUp(IntervalYM i, int64 &years, int64 &months) Vertica::VIntervalYM inlinestatic

1.1.275 - Vertica::VNumeric Class Reference

Representation of NUMERIC, fixed point data types in Vertica.

Inheritance diagram for Vertica::VNumeric:

Collaboration diagram for Vertica::VNumeric:

Public Member Functions
VNumeric (uint64 *words, int32 precision, int32 scale)
Create a VNumeric with the provided storage location, precision and scale.
VNumeric (const VNumeric &other)
void accumulate (const VNumeric *from)
Adds another VNumeric to this VNumeric.
void add (const VNumeric *a, const VNumeric *b)
int compare (const VNumeric *from) const
Compares this (signed) VNumeric to another.
int compareUnsigned (const VNumeric *from) const
Compares this (unsigned) VNumeric to another.
void copy (const VNumeric *from)
Copy data from another VNumeric.
bool copy (ifloat value, bool round=true)
Copy data from a floating-point number.
void div (const VNumeric *a, const VNumeric *b)
bool equal (const VNumeric *from) const
Indicates whether some other VNumeric is equal to this one.
int32 getPrecision () const
int32 getScale () const
void incr ()
void invertSign ()
Inverts the sign of this VNumeric (equivalent to multiplying this VNumeric by -1)
bool isNeg () const
Indicates if this VNumeric is negative.
bool isNull () const
Indicates if this VNumeric is the SQL NULL value.
bool isZero () const
Indicates if this VNumeric is zero.
void mul (const VNumeric *a, const VNumeric *b)
VNumeric & operator*= (const VNumeric &other)
VNumeric & operator+= (const VNumeric &other)
VNumeric & operator-= (const VNumeric &other)
VNumeric & operator/= (const VNumeric &other)
bool operator (const VNumeric &other) const
bool operator>= (const VNumeric &other) const
VNumeric & operator>>= (unsigned shift)
void setNull ()
Sets this VNumeric to the SQL NULL value.
void setZero ()
Sets this VNumeric to zero.
void shiftLeft (unsigned bitsToShift)
void shiftRight (unsigned bitsToShift)
void sub (const VNumeric *a, const VNumeric *b)
ifloat toFloat () const
Convert the VNumeric value into floating-point.
size_t toString (char *outBuf, int olen) const

Detailed Description

Representation of NUMERIC, fixed point data types in Vertica.

Constructor & Destructor Documentation

Vertica::VNumeric::VNumeric(uint64 * words, int32 precision, int32 scale)

inline Create a VNumeric with the provided storage location, precision and scale.

Note It is the callers responsibility to allocate enough memory for the words parameter

Member Function Documentation

int Vertica::VNumeric::compare(const VNumeric * from) const

inline Compares this (signed) VNumeric to another.

Returns -1 if this < other, 0 if equal, 1 if this > other

Note SQL NULL compares less than anything else; two SQL NULLs are considered equal

int Vertica::VNumeric::compareUnsigned(const VNumeric * from) const

inline Compares this (unsigned) VNumeric to another.

Returns -1 if this < other, 0 if equal, 1 if this > other

Note SQL NULL compares less than anything else; two SQL NULLs are considered equal

void Vertica::VNumeric::copy(const VNumeric * from)

inline Copy data from another VNumeric.

Parameters

  • from: The source VNumeric
bool Vertica::VNumeric::copy(ifloat value, bool round = true)

inline Copy data from a floating-point number.

Parameters

  • value: The source floating-point number
  • round: Truncates if false; otherwise the numeric result is rounded

Returns false if conversion failed (precision lost or overflow, etc); true otherwise

ifloat Vertica::VNumeric::toFloat() const

inline Convert the VNumeric value into floating-point.

Returns the value in 80-bit floating-point

1.1.276 - Vertica::VNumeric Member List

This is the complete list of members for Vertica::VNumeric, including all inherited members.

accumulate(const VNumeric *from) Vertica::VNumeric inline
add(const VNumeric *a, const VNumeric *b) (defined in Vertica::VNumeric) Vertica::VNumeric inline
compare(const VNumeric *from) const Vertica::VNumeric inline
compareUnsigned(const VNumeric *from) const Vertica::VNumeric inline
copy(const VNumeric *from) Vertica::VNumeric inline
copy(ifloat value, bool round=true) Vertica::VNumeric inline
div(const VNumeric *a, const VNumeric *b) (defined in Vertica::VNumeric) Vertica::VNumeric inline
equal(const VNumeric *from) const Vertica::VNumeric inline
getPrecision() const (defined in Vertica::VNumeric) Vertica::VNumeric inline
getScale() const (defined in Vertica::VNumeric) Vertica::VNumeric inline
incr() (defined in Vertica::VNumeric) Vertica::VNumeric inline
invertSign() Vertica::VNumeric inline
isNeg() const Vertica::VNumeric inline
isNull() const Vertica::VNumeric inline
isZero() const Vertica::VNumeric inline
mul(const VNumeric *a, const VNumeric *b) (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator*=(const VNumeric &other) (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator+=(const VNumeric &other) (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator-=(const VNumeric &other) (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator/=(const VNumeric &other) (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator(const VNumeric &other) const (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator>=(const VNumeric &other) const (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator>>=(unsigned shift) (defined in Vertica::VNumeric) Vertica::VNumeric inline
setNull() Vertica::VNumeric inline
setZero() Vertica::VNumeric inline
shiftLeft(unsigned bitsToShift) (defined in Vertica::VNumeric) Vertica::VNumeric inline
shiftRight(unsigned bitsToShift) (defined in Vertica::VNumeric) Vertica::VNumeric inline
sub(const VNumeric *a, const VNumeric *b) (defined in Vertica::VNumeric) Vertica::VNumeric inline
toFloat() const Vertica::VNumeric inline
toString(char *outBuf, int olen) const (defined in Vertica::VNumeric) Vertica::VNumeric inline
VNumeric(uint64 *words, int32 precision, int32 scale) Vertica::VNumeric inline
VNumeric(const VNumeric &other) (defined in Vertica::VNumeric) Vertica::VNumeric inline

1.1.277 - Vertica::VNumericTemp< Alloc > Class Template Reference

Inheritance diagram for Vertica::VNumericTemp< Alloc >:

Collaboration diagram for Vertica::VNumericTemp< Alloc >:

Public Member Functions
VNumericTemp (int32 precision, int32 scale, const Alloc &alloc=Alloc())
VNumericTemp (Typemod typmod, const Alloc &alloc=Alloc())
VNumericTemp (int32 attr, const Alloc &alloc=Alloc())
VNumericTemp (VNumericTemp &&from)
void accumulate (const VNumeric *from)
Adds another VNumeric to this VNumeric.
void add (const VNumeric *a, const VNumeric *b)
int compare (const VNumeric *from) const
Compares this (signed) VNumeric to another.
int compareUnsigned (const VNumeric *from) const
Compares this (unsigned) VNumeric to another.
void copy (const VNumeric *from)
Copy data from another VNumeric.
bool copy (ifloat value, bool round=true)
Copy data from a floating-point number.
void div (const VNumeric *a, const VNumeric *b)
bool equal (const VNumeric *from) const
Indicates whether some other VNumeric is equal to this one.
int32 getPrecision () const
int32 getScale () const
void incr ()
void invertSign ()
Inverts the sign of this VNumeric (equivalent to multiplying this VNumeric by -1)
bool isNeg () const
Indicates if this VNumeric is negative.
bool isNull () const
Indicates if this VNumeric is the SQL NULL value.
bool isZero () const
Indicates if this VNumeric is zero.
void mul (const VNumeric *a, const VNumeric *b)
VNumericTemp & operator*= (const VNumeric &other)
VNumericTemp & operator+= (const VNumeric &other)
VNumericTemp & operator-= (const VNumeric &other)
VNumericTemp & operator/= (const VNumeric &other)
bool operator (const VNumeric &other) const
bool operator>= (const VNumeric &other) const
VNumericTemp & operator>>= (unsigned shift)
void setNull ()
Sets this VNumeric to the SQL NULL value.
void setZero ()
Sets this VNumeric to zero.
void shiftLeft (unsigned bitsToShift)
void shiftRight (unsigned bitsToShift)
void sub (const VNumeric *a, const VNumeric *b)
ifloat toFloat () const
Convert the VNumeric value into floating-point.
size_t toString (char *outBuf, int olen) const
Static Public Member Functions
static int32 getCoveringTypeMod (int32 attra, int32 attrb)

Detailed Description

template>

class Vertica::VNumericTemp

Represents an intermediate result in an arithmetic expression of VNumerics

Member Function Documentation

int Vertica::VNumeric::compare(const VNumeric * from) const

inline inherited Compares this (signed) VNumeric to another.

Returns -1 if this < other, 0 if equal, 1 if this > other

Note SQL NULL compares less than anything else; two SQL NULLs are considered equal

int Vertica::VNumeric::compareUnsigned(const VNumeric * from) const

inline inherited Compares this (unsigned) VNumeric to another.

Returns -1 if this < other, 0 if equal, 1 if this > other

Note SQL NULL compares less than anything else; two SQL NULLs are considered equal

void Vertica::VNumeric::copy(const VNumeric * from)

inline inherited Copy data from another VNumeric.

Parameters

  • from: The source VNumeric
bool Vertica::VNumeric::copy(ifloat value, bool round = true)

inline inherited Copy data from a floating-point number.

Parameters

  • value: The source floating-point number
  • round: Truncates if false; otherwise the numeric result is rounded

Returns false if conversion failed (precision lost or overflow, etc); true otherwise

template<class Alloc = std::allocator<uint64>>

static int32 Vertica::VNumericTemp::getCoveringTypeMod(int32 attra, int32 attrb)

inlinestatic

Returns the typmod needed for a result of adding/subtracting numeric values with typmods a and b respectively

ifloat Vertica::VNumeric::toFloat() const

inline inherited Convert the VNumeric value into floating-point.

Returns the value in 80-bit floating-point

1.1.278 - Vertica::VNumericTemp< Alloc > Member List

This is the complete list of members for Vertica::VNumericTemp, including all inherited members.

accumulate(const VNumeric *from) Vertica::VNumeric inline
add(const VNumeric *a, const VNumeric *b) (defined in Vertica::VNumeric) Vertica::VNumeric inline
compare(const VNumeric *from) const Vertica::VNumeric inline
compareUnsigned(const VNumeric *from) const Vertica::VNumeric inline
copy(const VNumeric *from) Vertica::VNumeric inline
copy(ifloat value, bool round=true) Vertica::VNumeric inline
div(const VNumeric *a, const VNumeric *b) (defined in Vertica::VNumeric) Vertica::VNumeric inline
equal(const VNumeric *from) const Vertica::VNumeric inline
getCoveringTypeMod(int32 attra, int32 attrb) Vertica::VNumericTemp inlinestatic
getPrecision() const (defined in Vertica::VNumeric) Vertica::VNumeric inline
getScale() const (defined in Vertica::VNumeric) Vertica::VNumeric inline
incr() (defined in Vertica::VNumeric) Vertica::VNumeric inline
invertSign() Vertica::VNumeric inline
isNeg() const Vertica::VNumeric inline
isNull() const Vertica::VNumeric inline
isZero() const Vertica::VNumeric inline
mul(const VNumeric *a, const VNumeric *b) (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator*=(const VNumeric &other) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
operator+=(const VNumeric &other) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
operator-=(const VNumeric &other) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
operator/=(const VNumeric &other) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
operator) Vertica::VNumericTemp inline
operator) Vertica::VNumericTemp inline
operator=(const VNumeric &other) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
operator==(const VNumeric &other) const (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator>(const VNumeric &other) const (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator>=(const VNumeric &other) const (defined in Vertica::VNumeric) Vertica::VNumeric inline
operator>>=(unsigned shift) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
setNull() Vertica::VNumeric inline
setZero() Vertica::VNumeric inline
shiftLeft(unsigned bitsToShift) (defined in Vertica::VNumeric) Vertica::VNumeric inline
shiftRight(unsigned bitsToShift) (defined in Vertica::VNumeric) Vertica::VNumeric inline
sub(const VNumeric *a, const VNumeric *b) (defined in Vertica::VNumeric) Vertica::VNumeric inline
toFloat() const Vertica::VNumeric inline
toString(char *outBuf, int olen) const (defined in Vertica::VNumeric) Vertica::VNumeric inline
VNumeric(uint64 *words, int32 precision, int32 scale) Vertica::VNumeric inline
VNumeric(const VNumeric &other) (defined in Vertica::VNumeric) Vertica::VNumeric inline
VNumericTemp(int32 precision, int32 scale, const Alloc &alloc=Alloc()) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
VNumericTemp(Typemod typmod, const Alloc &alloc=Alloc()) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
VNumericTemp(int32 attr, const Alloc &alloc=Alloc()) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
VNumericTemp(VNumericTemp &&from) (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline
~VNumericTemp() (defined in Vertica::VNumericTemp) Vertica::VNumericTemp inline

1.1.279 - Vertica::VResources Member List

This is the complete list of members for Vertica::VResources, including all inherited members.

nFileHandles Vertica::VResources
nHelperThreads Vertica::VResources
scratchMemory Vertica::VResources
VResources() (defined in Vertica::VResources) Vertica::VResources inline

1.1.280 - Vertica::VResources Struct Reference

Collaboration diagram for Vertica::VResources:

Public Attributes
int nFileHandles
int nHelperThreads
vint scratchMemory

Detailed Description

Representation of the resources user code can ask Vertica for

Member Data Documentation

int Vertica::VResources::nFileHandles

Number of file handles / sockets required

int Vertica::VResources::nHelperThreads

Number of suggested helper threads

vint Vertica::VResources::scratchMemory

Amount of RAM in bytes used by User defined function

Referenced by Vertica::UDXFactory::getPerInstanceResources().

1.1.281 - Vertica::VString Class Reference

Representation of a String in Vertica. All character data is internally encoded as UTF-8 characters and is not NULL terminated.

Collaboration diagram for Vertica::VString:

Public Member Functions
VString (const VString &other)
void alloc (vsize len)
Allocate the VString's internal buffer and initialize to 'len' 0 bytes.
int compare (const VString *other) const
Compares this VString to another.
void copy (const char *s, vsize len)
Copy character data from C string to the VString's internal buffer.
void copy (const char *s)
Copy character data from null terminated C string to the VString's internal buffer.
void copy (const std::string &s)
Copy character data from std::string.
void copy (const VString *from)
Copy data from another VString.
void copy (const VString &from)
Copy data from another VString.
const char * data () const
Provides a read-only pointer to this VString's internal data.
char * data ()
Provides a writeable pointer to this VString's internal data.
int equal (const VString *other) const
Indicates whether some other VString is equal to this one.
bool isNull () const
Indicates if this VString contains the SQL NULL value.
vsize length () const
Returns the length of this VString.
bool operator
VString & operator= (const stringtype &s)
VString & operator= (const VString &other)
bool operator== (const VString &other) const
bool operator> (const VString &other) const
bool operator>= (const VString &other) const
void setNull ()
Sets this VString to the SQL NULL value.
template
stringtype str () const
Provides a copy of this VString's data as a std::string.

Detailed Description

Representation of a String in Vertica. All character data is internally encoded as UTF-8 characters and is not NULL terminated.

Member Function Documentation

void Vertica::VString::alloc(vsize len)

inline Allocate the VString's internal buffer and initialize to 'len' 0 bytes.

The VString is allocated and set to 'len' zero bytes. It is the caller's responsibility to not provide a value of 'len' that is larger than the maximum size of this VString

Parameters

  • len: length in bytes
int Vertica::VString::compare(const VString * other) const

inline Compares this VString to another.

Returns -1 if this < other, 0 if equal, 1 if this > other (just like memcmp)

Note SQL NULL compares greater than anything else; two SQL NULLs are considered equal

void Vertica::VString::copy(const char * s, vsize len)

inline Copy character data from C string to the VString's internal buffer.

Data is copied from s into this VString. It is the caller's responsibility to not provide a value of 'len' that is larger than the maximum size of this VString

Parameters

  • s: character input data
  • len: length in bytes, not including the terminating null character

Referenced by

void Vertica::VString::copy(const char * s)

inline Copy character data from null terminated C string to the VString's internal buffer.

Parameters

  • s: null-terminated character input data

Referenced by copy().

void Vertica::VString::copy(const std::string & s)

inline Copy character data from std::string.

Parameters

  • s: null-terminated character input data

Referenced by copy().

void Vertica::VString::copy(const VString * from)

inline Copy data from another VString.

Parameters

  • from: The source VString
void Vertica::VString::copy(const VString & from)

inline Copy data from another VString.

Parameters

  • from: The source VString

Referenced by copy().

const char* Vertica::VString::data() const

inline Provides a read-only pointer to this VString's internal data.

Returns the read only character data for this string, as a pointer.

Note The returned string is not null terminated

Referenced by

char* Vertica::VString::data()

inline Provides a writeable pointer to this VString's internal data.

Returns the writeable character data for this string, as a pointer.

Note The returned string is not null terminated

int Vertica::VString::equal(const VString * other) const

inline Indicates whether some other VString is equal to this one.

Returns -1 if both are SQL NULL, 0 if not equal, 1 if equal so you can easily consider two NULL values to be equal to each other, or not

bool Vertica::VString::isNull() const

inline Indicates if this VString contains the SQL NULL value.

Returns true if this string contains the SQL NULL value, false otherwise

Referenced by

vsize Vertica::VString::length() const

inline Returns the length of this VString.

Returns the length of the string, in bytes. Does not include any extra space for null characters.

Referenced by

template<typename stringtype >

VString& Vertica::VString::operator=(const stringtype & s)

inline Set this object to have the contents of any string object

VString& Vertica::VString::operator=(const VString & other)

inline Copy this object to have the same contents of another VString

template<typename stringtype = std::string>

stringtype Vertica::VString::str() const

inline Provides a copy of this VString's data as a std::string.

Returns a std::string copy of the data in this VString

Referenced by Vertica::operator+().

1.1.282 - Vertica::VString Member List

This is the complete list of members for Vertica::VString, including all inherited members.

alloc(vsize len) Vertica::VString inline
compare(const VString *other) const Vertica::VString inline
copy(const char *s, vsize len) Vertica::VString inline
copy(const char *s) Vertica::VString inline
copy(const std::string &s) Vertica::VString inline
copy(const VString *from) Vertica::VString inline
copy(const VString &from) Vertica::VString inline
data() const Vertica::VString inline
data() Vertica::VString inline
equal(const VString *other) const Vertica::VString inline
isNull() const Vertica::VString inline
length() const Vertica::VString inline
operator(const VString &other) const (defined in Vertica::VString) Vertica::VString inline
operator>=(const VString &other) const (defined in Vertica::VString) Vertica::VString inline
setNull() Vertica::VString inline
str() const Vertica::VString inline
VString(const VString &other) (defined in Vertica::VString) Vertica::VString inline

1.1.283 - Vertica::VTAllocator Class Reference

A pool-based allocator that is provided to simplify memory management for UDF implementors.

Collaboration diagram for Vertica::VTAllocator:

Public Member Functions
virtual void * alloc (size_t size)=0
virtual void free (void *ptr, size_t size)

Detailed Description

A pool-based allocator that is provided to simplify memory management for UDF implementors.

Member Function Documentation

virtual void* Vertica::VTAllocator::alloc(size_t size)

pure virtual Allocate size_t bytes of memory on a pool. This memory is guaranteed to persist beyond the destroy call but might have been destroyed when the dtor is run or freed explicitly.

virtual void Vertica::VTAllocator::free(void * ptr, size_t size)

inlinevirtual

Free size_t bytes of memory allocated for ptr. Caution: safety is only guaranteed if free() is called on the same VTAllocator object that performed the alloc()

1.1.284 - Vertica::VTAllocator Member List

This is the complete list of members for Vertica::VTAllocator, including all inherited members.

alloc(size_t size)=0 Vertica::VTAllocator pure virtual
free(void *ptr, size_t size) Vertica::VTAllocator inlinevirtual
~VTAllocator() (defined in Vertica::VTAllocator) Vertica::VTAllocator inlinevirtual

1.1.285 - Vertica::VUuid Class Reference

Representation of Universally Unique Identifier (UUID) data type in Vertica.

Collaboration diagram for Vertica::VUuid:

Public Member Functions
VUuid (vuuid_t *data)
Create a Universally Unique Identifier type from a vuuid_t array.
VUuid (const VUuid &other)
int compare (const VUuid &from) const
Compares this VUuid to another.
void copy (const VUuid &from)
Copy data from another VUuid.
bool equal (const VUuid &from) const
Indicates whether another VUuid is equal to this one.
bool fromCharArray (const char *str)
Populate this UUID's data array from a string representation.
bool fromString (const std::string &str)
Populate this UUID's data array from a string representation.
vuuid_t & getData ()
Get a reference to the data array.
const vuuid_t & getData () const
Get a const reference to the data array.
bool isNull () const
Indicates if this VUuid is the SQL NULL value.
bool operator (const VUuid &other) const
bool operator>= (const VUuid &other) const
void setNull ()
Sets this VUuid to the SQL NULL value.
void toCharArray (char *buf, size_t bufLen) const
Return a string representation of this UUID.
std::string toString () const
Return a string representation of this UUID.

Detailed Description

Representation of Universally Unique Identifier (UUID) data type in Vertica.

Constructor & Destructor Documentation

Vertica::VUuid::VUuid(vuuid_t * data)

inline Create a Universally Unique Identifier type from a vuuid_t array.

Note It is the callers responsibility to allocate and manage the lifetime of the data array, which is UUID_LEN bytes long.

Example:

vuuid_t data = {
0x06, 0xbe, 0x07, 0x79, 0xc0, 0xb7, 0x46, 0xcb,
0x8a, 0x16, 0x99, 0x09, 0x26, 0x99, 0x9a, 0xfd,
};
VUuid uuid(data);

Member Function Documentation

int Vertica::VUuid::compare(const VUuid & from) const

inline Compares this VUuid to another.

Parameters

  • from: The VUuid to compare to

Returns -1 if this < other, 0 if equal, 1 if this > other

Note SQL NULL compares less than anything else; two SQL NULLs are considered equal

Referenced by equal().

void Vertica::VUuid::copy(const VUuid & from)

inline Copy data from another VUuid.

Parameters

  • from: The source VUuid
bool Vertica::VUuid::equal(const VUuid & from) const

inline Indicates whether another VUuid is equal to this one.

Parameters

  • other: The VUuid to compare to
bool Vertica::VUuid::fromCharArray(const char * str)

inline Populate this UUID's data array from a string representation.

Note str should be valid UUID format

Returns true on success

bool Vertica::VUuid::fromString(const std::string & str)

inline Populate this UUID's data array from a string representation.

Returns true on success

bool Vertica::VUuid::isNull() const

inline Indicates if this VUuid is the SQL NULL value.

Note NULL is the UUID NIL value 00000000-0000-0000-0000-000000000000

Referenced by Vertica::BlockReader::isNull().

void Vertica::VUuid::setNull()

inline Sets this VUuid to the SQL NULL value.

Note NULL is the UUID NIL value 00000000-0000-0000-0000-000000000000

Referenced by

void Vertica::VUuid::toCharArray(char * buf, size_t bufLen) const

inline Return a string representation of this UUID.

Parameters

  • Buffer: for result, must be at least UUID_PRINT_LEN bytes

Note Format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

std::string Vertica::VUuid::toString() const

inline Return a string representation of this UUID.

Note Format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

1.1.286 - Vertica::VUuid Member List

This is the complete list of members for Vertica::VUuid, including all inherited members.

compare(const VUuid &from) const Vertica::VUuid inline
copy(const VUuid &from) Vertica::VUuid inline
equal(const VUuid &from) const Vertica::VUuid inline
fromCharArray(const char *str) Vertica::VUuid inline
fromString(const std::string &str) Vertica::VUuid inline
getData() Vertica::VUuid inline
getData() const Vertica::VUuid inline
isNull() const Vertica::VUuid inline
operator(const VUuid &other) const (defined in Vertica::VUuid) Vertica::VUuid inline
operator>=(const VUuid &other) const (defined in Vertica::VUuid) Vertica::VUuid inline
setNull() Vertica::VUuid inline
toCharArray(char *buf, size_t bufLen) const Vertica::VUuid inline
toString() const Vertica::VUuid inline
VUuid(vuuid_t *data) Vertica::VUuid inline
VUuid(const VUuid &other) (defined in Vertica::VUuid) Vertica::VUuid inline
~VUuid() (defined in Vertica::VUuid) Vertica::VUuid inline

1.2 - File List

Here is a list of all documented files with brief descriptions:

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

1.2.1 - Arrays Directory Reference

Files
file Accessors.h

1.2.2 - globals

Here is a list of all documented file members with links to the documentation:

1.2.3 - globals defs

1.2.4 - Graph Legend

This page explains how to interpret the graphs that are generated by doxygen.

Consider the following example:

/*! Invisible class because of truncation */
class Invisible { };

/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };

/* Class not documented with doxygen comments */
class Undocumented { };

/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };

/*! A template class */
template class Templ { };

/*! Class that is inherited using protected inheritance */
class ProtectedBase { };

/*! Class that is inherited using private inheritance */
class PrivateBase { };

/*! Class that is used by the Inherited class */
class Used { };

/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
protected ProtectedBase,
private PrivateBase,
public Undocumented,
public Templ
{
private:
Used *m_usedClass;
};

This will result in the following graph:

image

The boxes in the above graph have the following meaning:

  • A filled gray box represents the struct or class for which the graph is generated.

  • A box with a black border denotes a documented struct or class.

  • A box with a grey border denotes an undocumented struct or class.

  • A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.

The arrows have the following meaning:

  • A dark blue arrow is used to visualize a public inheritance relation between two classes.

  • A dark green arrow is used for protected inheritance.

  • A dark red arrow is used for private inheritance.

  • A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible.

  • A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance.

1.2.5 - include Directory Reference

Directories
directory Arrays
Files
file BasicsSupport.h
file BasicsUDxShared.h
file BigInt.cpp
file BigInt.h
file BigIntSubs.h
file BuildAssertions.h
file BuildInfo.h
file DateTimeParsing.h
file EEUDxShared.h
file IntervalUDx.h
file Logging.h
file Oids.h
file PGUDxShared.h
file ServerFunctions.h
file TimestampUDxShared.h
file UdfException.h
file VArchive.h
file VAssert.h
file Vertica.cpp
file Vertica.h
Contains the classes needed to write User-Defined things in Vertica.
file VerticaDFS.h
file VerticaErrorCodes.h
file VerticaErrorMacros.h
file VerticaModel.h
file VerticaSymbols.h
file VerticaUDFS.h
file VerticaUDFSImpl.h
file VerticaUDl.h
file VerticaUDx.h
file VerticaUDxDebug.h
file VerticaUDxInternal.h
file VValgrind.h

1.2.6 - 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

#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:102
Vertica::uint8unsigned char uint8unsigned 8-bit integer Definition: BasicsUDxShared.h:72

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.

#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:3114

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);

1.3 - Namespace List

Here is a list of all documented namespaces with brief descriptions:

Basics Basic utilities mainly for data types
Vertica

1.3.1 - Basics Namespace Reference

basic utilities mainly for data types.

Classes
struct BigInt
struct FiveToScale
struct Uuid
Functions
NUMERIC_ROUTINES_PRE_RT uint64 NUMERIC_ROUTINES_POST_RT accumulateNN (void *outBuf, const void *buf1, int nWords)
NUMERIC_ROUTINES_PRE_RT uint64 NUMERIC_ROUTINES_POST_RT addNN (void *outBuf, const void *buf1, const void *buf2, int nWords)
NUMERIC_ROUTINES_PRE_RT int NUMERIC_ROUTINES_POST_RT compareNN (const void *buf1, const void *buf2, int nWords)
NUMERIC_ROUTINES_PRE_RT long double NUMERIC_ROUTINES_POST_RT convertPosToFloatNN (const void *bbuf, int bwords)
bool DivideBignumStep (uint64 hi, uint64 lo, uint64 d, uint64 &_q, uint64 &_r)
NUMERIC_ROUTINES_PRE_RT uint64 NUMERIC_ROUTINES_POST_RT divUnsignedN1 (void *qbuf, int qw, int round, const void *ubuf, int uw, uint64 v)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT divUnsignedNN (void *qbuf, int qw, int round, uint64 *rbuf, int rw, const void *ubuf, int uw, const void *vbuf, int vw)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT fromIntNN (void *buf, int nWords, int64 val)
int32 getNumericLength (int32 attr)
Get Numeric data length from typmod.
int32 getNumericLength (Typemod typmod)
int32 getNumericPrecision (int32 attr)
Get Numeric precision from typmod.
int32 getNumericPrecision (Typemod typmod)
int32 getNumericScale (int32 attr)
Get Numeric scale from typmod.
int32 getNumericScale (Typemod typmod)
int32 getNumericWordCount (int32 precision)
Get Numeric word count from precision.
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT incrementNN (void *buf, int nWords)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT invertSign (void *buf, int nWords)
NUMERIC_ROUTINES_PRE_RT bool NUMERIC_ROUTINES_POST_RT isEqualNN (const void *buf1, const void *buf2, int nWords)
NUMERIC_ROUTINES_PRE_RT bool NUMERIC_ROUTINES_POST_RT isNull (const void *buf, int nWords)
bool isSimilarNumericTypmod (int32 attra, int32 attrb)
Return true if these have the same EE representation.
bool isSimilarNumericTypmod (Typemod a, Typemod b)
NUMERIC_ROUTINES_PRE_RT bool NUMERIC_ROUTINES_POST_RT isZero (const void *buf, int nWords)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT mulUnsignedN1 (void *obuf, const void *ubuf, int uw, uint64 v)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT mulUnsignedNN (void *obuf, const void *buf1, int nw1, const void *buf2, int nw2)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT numericMultiply (const uint64 *pa, int nwdsa, const uint64 *pb, int nwdsb, uint64 *outNum, int nwdso)
NUMERIC_ROUTINES_PRE_RT ifloat NUMERIC_ROUTINES_POST_RT numericToFloat (const void *buf, int nwds, ifloat tenthtoscale)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT setNull (void *buf, int nWords)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT setZero (void *buf, int nWords)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT shiftLeftNN (void *buf, unsigned nw, unsigned bitsToShift)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT shiftRightNN (void *buf, unsigned nw, unsigned bitsToShift)
NUMERIC_ROUTINES_PRE_RT void NUMERIC_ROUTINES_POST_RT subNN (void *outBuf, const void *buf1, const void *buf2, int nWords)
Subtract 2 numbers w/ same number of digits No null handling.
NUMERIC_ROUTINES_PRE_RT bool NUMERIC_ROUTINES_POST_RT toIntNN (int64 &out, const void *buf, int nWords)
NUMERIC_ROUTINES_PRE_RT int NUMERIC_ROUTINES_POST_RT usedWordsUnsigned (const void *buf, int nWords)

Detailed Description

basic utilities mainly for data types.

1.3.2 - namespacemembers

Here is a list of all documented namespace members with links to the namespaces they belong to:

- b -

- c -

- d -

- g -

- i -

- l -

- o -

- s -

- t -

- u -

- v -

1.3.3 - namespacemembers enum

1.3.4 - namespacemembers func

- b -

- c -

- d -

  • describeIntervalTypeMod() : Vertica

- g -

- i -

  • isSimilarNumericTypmod() : Basics

- l -

- o -

- s -

- v -

1.3.5 - namespacemembers type

1.3.6 - namespacemembers vars

1.3.7 - Vertica Namespace Reference

Classes
struct AESKey
class AggregateFunction
Interface for User-Defined Aggregate Function (UDAF). A UDAF operates on one column of data and returns one column of data.
class AggregateFunctionFactory
Interface for declaring parameters and return types for, and instantiating, an associated AggregateFunction.
class AnalyticFunction
Interface for User-Defined Analytic Function (UDAnF). A UDAnF operates on rows of data and returns rows of data, not necessarily 1:1.
class AnalyticFunctionFactory
Interface for declaring parameters and return types for, and instantiating, an associated AnalyticFunction.
class AnalyticPartitionReader
Provides an iterator-based read interface over all the partition_by keys, order_by keys, and function arguments in a partition.
class AnalyticPartitionWriter
Partition writer for all input data in a single partition. It automatically makes space as needed.
class BasePartitionWriterColumn
Base class for vectorized writing to columns. Efficiently writes each element in a single column.
struct BlobCreateOptions
struct BlobRequest
struct BlockFormatter
struct BlockFormatterCout
class BlockReader
Iterator interface for reading rows in a Vertica block.
class BlockWriter
Iterator interface for writing rows to a Vertica block.
class ClientMessage
Holds the contents of a user-defined message to be reported by a UDx.
class ColumnTypes
Represents (unsized) types of the columns used as input/output of a User Defined Function/Transform Function.
struct ConcurrencyModel
class CounterController
Class to interact with counters.
class CursorRequest
class CursorTransformFunction
Interface for Cursored UDTF, the actual code to process a partition of data coming in as a stream, or to access projection cursors.
class CursorTransformFunctionFactory
Interface for declaring parameters and return types for, and instantiating, an associated CursorTransformFunction.
struct DataBuffer
class DefaultSourceIterator
struct defserializer
struct defserializer
struct defserializer
struct defserializer
class 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.
class 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.
struct Field
class Fields
class FilterFactory
Produces and initializes UDFilters to transform input data before parsing.
union FIunion
class FunctionFactory
class IntermediateAggs
A wrapper around a single intermediate aggregate value.
class IterativeSourceFactory
Source factory that works with a SourceIterator to produce UDSources.
struct LengthBuffer
struct LibraryRegistrar
class Model
class 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.
class MultipleIntermediateAggs
A wrapper around multiple intermediate aggregates.
class NodeSpecifyingPlanContext
Interface that allows storage of query-plan state, when different parts of query planning take place on different computers.
struct OpenOptions
struct ParallelismInfo
class ParamReader
Provides read access to a set of named parameters. This class provides type-specific methods to retrieve values.
class ParamWriter
Provides write access to a set of named parameters. This class extends ParamReader to add type-specific methods to write values.
class ParserFactory
Produces and initializes UDParsers to parse input into tuples.
struct PartitionOrderColumnInfo
Represents the partition by and order by column information for each phase in a multi-phase transform function.
class PartitionReader
provides an iterator-based read interface over all input data in a single partition. Automatically fetches data a block-at-a-time, as needed.
class PartitionWriter
Provides an iterator-based write interface over output data for a single partition. Automatically makes space a block-at-a-time, as needed.
class PartitionWriterColumn
class PartitionWriterColumns
PartitionWriterColumns allow column-by-column access to PartitionWriter data.
class PartitionWriterNumericColumn
class PartitionWriterStringColumn
class PartitionWriterUuidColumn
class PerColumnParamReader
A wrapper around a map from column to ParamReader.
class 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.
struct Portion
struct RejectedRecord
class ScalarFunction
Interface for User-Defined Scalar Function (UDSF). A UDSF produces a single value from a row of data.
class ScalarFunctionFactory
Interface for declaring parameters and return types for, and instantiating, an associated ScalarFunction.
class ScopedTimerCounter
Class to start an execution timer on construction and to automatically stop the timer on deconstruction or when manually called with stop()
class ServerInterface
Provides UDxs with access to the Vertica server.
class SessionParamReaderMap
This class provides an interface for reading the Used defined session parameters.
class SessionParamWriterMap
This class provides an interface for writing the Used defined session parameters.
struct SimpleArchiveIn
struct SimpleArchiveOut
class SizedColumnTypes
Represents types and information to determine the size of the columns as input/output of a User Defined Function/Transform.
class SourceFactory
Produces and initializes UDSources to process input data sources.
class SourceIterator
Constructs a set of Sources to be used by an IterativeSourceFactory.
struct SplitArchiver
struct SplitArchiver
struct SplitArchiver
class 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.
class TransformFunction
Interface for User-Defined Transform Function (UDTF). A UDTF operates on a table segment and returns zero or more rows of data.
class TransformFunctionFactory
Interface for declaring parameters and return types for, and instantiating, an associated TransformFunction.
class TransformFunctionPhase
Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function.
class UDChunker
Separates parser input into chunks at record boundaries, allowing parsing to proceed in parallel.
class UDFileOperator
class UDFileSystem
class UDFileSystemFactory
class UDFileSystemStats
class UDFilter
Reads input data from a UDSource or another UDFilter and transforms it.
class UDKeyManager
class UDKeyManagerFactory
class UDLFactory
class UDParser
Parses an input stream into Vertica tuples (rows to be inserted into a table).
class UDSource
Acquires data from an external source (such as a file or URL) and produces that data in a streaming manner.
class UDxBlobCursor
Class for reading and writing to a blob. A blob is divided internally into several chunks, this gives a cursor to one of the chunks. To change which chunk the cursor points to, the user may call a function 'switchToChunk(i)'. It also contains metadata about its blob.
struct UDxCounterRequest
class UDxCursor
class UDXFactory
Parent class for UDx factories; not intended for direct use by applications.
class UDXFunction
class UDXObject
Base class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications.
struct UDxRegistrar
class 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.
class ValueRangeReader
This class represents the value ranges of the arguments of a UDSF, one range per argument.
class ValueRangeWriter
This class represents the output value range of a UDSF.
class VerticaBlock
: Represents an in-memory block of tuples
struct VerticaBuildInfo
class VerticaType
Represents types of data that are passed into and returned back from user's code.
class VerticaValueRange
This class represents value ranges used in analyzing the output of UDSFs. A range is expressed as a minimum/maximum value (inclusive) pair.
class VInterval
Representation of an Interval in Vertica.
class VIntervalYM
Representation of an IntervalYM in Vertica. An Interval can be broken up into years and months.
class VNumeric
Representation of NUMERIC, fixed point data types in Vertica.
class VNumericTemp
struct VResources
class VString
Representation of a String in Vertica. All character data is internally encoded as UTF-8 characters and is not NULL terminated.
class VTAllocator
A pool-based allocator that is provided to simplify memory management for UDF implementors.
class VUuid
Representation of Universally Unique Identifier (UUID) data type in Vertica.
Typedefs
typedef int64 DateADT
typedef long double ifloat
vertica 80-bit intermediate result
typedef ScalarFunction IndexListScalarFunction
typedef signed short int16
signed 16-bit integer
typedef signed int int32
signed 32-bit integer
typedef signed long long int64
signed 64-bit integer
typedef signed char int8
8-bit integer
typedef int64 Interval
typedef int64 IntervalYM
typedef std::pair NameStatPair
typedef std::vector RequestedBlobs
typedef std::vector RequestedCounters
typedef std::vector RequestedCursors
typedef std::map RequestedNodes
typedef int64 TimeADT
typedef int64 Timestamp
typedef int64 TimestampTz
Vertica timestamp data type.
typedef int64 TimeTzADT
typedef unsigned short uint16
unsigned 16-bit integer
typedef unsigned int uint32
unsigned 32-bit integer
typedef unsigned long long uint64
unsigned 64-bit integer
typedef unsigned char uint8
unsigned 8-bit integer
typedef uint8 vbool
vertica 8-bit boolean (t,f,null)
typedef double vfloat
Represents Vertica 64-bit floating-point type for NULL checking use vfloatIsNull(), assignment to NULL use vfloat_null for NaN checking use vfloatIsNaN(), assignment to NaN use vfloat_NaN.
typedef signed long long vint
vertica 64-bit integer (not int64)
typedef unsigned long long vpos
64-bit vertica position
typedef uint32 vsize
vertica 32-bit block size
typedef int(* VT_ERRMSG )(const char *fmt,...)
typedef void(* VT_THROW_EXCEPTION )(int errcode, const std::string &message, const char *filename, int lineno)
typedef void(* VT_THROW_INTERNAL_EXCEPTION )(int errcode, const std::string &message, const std::string &info, const char *filename, int lineno, const char *funcname)
Enumerations
enum ClientMessageErrorLevel { MSG_INFO = 0, MSG_NOTICE = 1, MSG_WARNING = 2, MSG_ERROR = 3 }
The possible types of messages to be reported from a UDx.
enum DTtype { RESERV = 0, MONTH = 1, YEAR = 2, DAY = 3, NEG_INTERVAL = 4, TZ = 5, DTZ = 6, DTZMOD = 7, IGNORE_DTF = 8, AMPM = 9, HOUR = 10, MINUTE = 11, SECOND = 12, DOY = 13, DOW = 14, UNITS = 15, ADBC = 16, AGO = 17, ISODATE = 20, ISOTIME = 21, UNKNOWN_FIELD = 31 }
enum InputState { OK = 0, END_OF_FILE = 1, END_OF_CHUNK = 2, START_OF_PORTION = 3, END_OF_PORTION = 4 }
enum StreamState { INPUT_NEEDED = 0, OUTPUT_NEEDED = 1, DONE = 2, REJECT = 3, KEEP_GOING = 4, CHUNK_ALIGNED = 5 }
enum strictness { DEFAULT_STRICTNESS, CALLED_ON_NULL_INPUT, RETURN_NULL_ON_NULL_INPUT, STRICT }
enum UDXDebugLevels { UDXDebugging_WARNING = 0x0001, UDXDebugging_INFO = 0x0002, UDXDebugging_BASIC = 0x0008, UDXDebugging_ALL = 0xFFFF }
enum VBool { VFalse = 0, VTrue = 1, VUnknown = 2 }
Enumeration for Boolean data values.
enum volatility { DEFAULT_VOLATILITY, VOLATILE, IMMUTABLE, STABLE }
Functions
template
void bserialize (Archive &ar, T &val, const uint serializer_version)
template
void bserialize (Archive &ar, T(&x)[n], const unsigned int version)
template
void copyBlockColumn (DstBlock &dstblock, const SrcBlock &srcblock, size_t dstIdx, size_t srcIdx)
DateADT dateIn (const char *str, bool report_error)
DateADT dateInFormatted (const char *str, const std::string format, bool report_error)
DateADT dateInNoTzNameCheck (const char *str, bool report_error)
int32 dateToChar (DateADT d, char *res, int32 max_size, int32 date_style, bool report_error)
static void describeIntervalTypeMod (char *result, Typemod typemod)
void dummy ()
UserLibraryManifest * get_library_manifest ()
void get_vertica_build_info (VerticaBuildInfo &vbi)
static DateADT getDateFromUnixTime (time_t time)
static int64 getGMTTz (TimeTzADT time)
static uint64 getTime (TimeADT time)
static TimeADT getTimeFromUnixTime (time_t time)
static Timestamp getTimestampFromUnixDouble (double time)
static Timestamp getTimestampFromUnixTime (time_t time)
static TimestampTz getTimestampTzFromUnixDouble (double time)
static TimestampTz getTimestampTzFromUnixTime (time_t time)
static int64 getTimeTz (TimeTzADT time)
std::string getUDTypeName (Oid typeOid)
Oid getUDTypeOid (const char *typeName)
Oid getUDTypeUnderlyingOid (Oid typeOid)
vint getUDxDebugLogLevel ()
static double getUnixDoubleFromTimestamp (Timestamp timestamp)
static time_t getUnixTimeFromDate (DateADT date)
static time_t getUnixTimeFromTime (TimeADT t)
static time_t getUnixTimeFromTimestamp (Timestamp timestamp)
static time_t getUnixTimeFromTimestampTz (TimestampTz timestamp)
static int32 getZoneTz (TimeTzADT time)
UserLibraryManifest & GlobalLibraryManifest ()
Interval intervalIn (const char *str, Typemod typmod, bool report_error)
Interval intervalIn (const char *str, int32 precision, bool report_error)
int32 intervalToChar (Interval i, Typemod typmod, char *res, int32 max_size, int32 date_style, bool report_error)
int32 intervalToChar (Interval i, int32 precision, char *res, int32 max_size, int32 date_style, bool report_error)
bool isUDType (Oid typeOid)
void log (const char *format,...) attribute((format(printf
int makeErrMsg (std::basic_ostream > &err_msg, const char *fmt,...)
template>
VNumericTemp operator* (const VNumeric &left, const VNumeric &right)
template
stringtype operator+ (const VString &left, const VString &right)
template>
VNumericTemp operator+ (const VNumeric &left, const VNumeric &right)
template>
VNumericTemp operator- (const VNumeric &left, const VNumeric &right)
template>
VNumericTemp operator/ (const VNumeric &left, const VNumeric &right)
template>
VNumericTemp operator>
VNumericTemp operator>> (const VNumeric &operand, unsigned shift)
static TimeADT setTime (int64 time)
static TimeTzADT setTimeTz (int64 time, int32 zone)
void setup_global_function_pointers (VT_THROW_EXCEPTION throw_exception, VT_THROW_INTERNAL_EXCEPTION throw_internal_exception, VT_ERRMSG server_errmsg, ServerFunctions *fns)
TimeADT timeIn (const char *str, Typemod typmod, bool report_error)
TimeADT timeIn (const char *str, int32 precision, bool report_error)
TimeADT timeInFormatted (const char *str, Typemod typmod, const std::string format, bool report_error)
TimeADT timeInFormatted (const char *str, int32 precision, const std::string format, bool report_error)
TimeADT timeInNoTzNameCheck (const char *str, Typemod typmod, bool report_error)
TimeADT timeInNoTzNameCheck (const char *str, int32 precision, bool report_error)
Timestamp timestampIn (const char *str, Typemod typmod, bool report_error)
Timestamp timestampIn (const char *str, int32 precision, bool report_error)
Timestamp timestampInFormatted (const char *str, Typemod typmod, const std::string format, bool report_error)
Timestamp timestampInFormatted (const char *str, int32 precision, const std::string format, bool report_error)
Timestamp timestampInNoTzNameCheck (const char *str, Typemod typmod, bool report_error)
Timestamp timestampInNoTzNameCheck (const char *str, int32 precision, bool report_error)
int32 timestampToChar (Timestamp dt, char *res, int32 max_size, int32 date_style, bool report_error)
TimestampTz timestamptzIn (const char *str, Typemod typmod, bool report_error)
TimestampTz timestamptzIn (const char *str, int32 precision, bool report_error)
TimestampTz timestamptzInFormatted (const char *str, Typemod typmod, const std::string format, bool report_error)
TimestampTz timestamptzInFormatted (const char *str, int32 precision, const std::string format, bool report_error)
TimestampTz timestamptzInNoTzNameCheck (const char *str, Typemod typmod, bool report_error)
TimestampTz timestamptzInNoTzNameCheck (const char *str, int32 precision, bool report_error)
int32 timestamptzToChar (TimestampTz dtz, char *res, int32 max_size, int32 date_style, bool report_error)
int32 timeToChar (TimeADT t, char *res, int32 max_size, bool report_error)
TimeTzADT timetzIn (const char *str, Typemod typmod, bool report_error)
TimeTzADT timetzIn (const char *str, int32 precision, bool report_error)
TimeTzADT timetzInFormatted (const char *str, Typemod typmod, const std::string format, bool report_error)
TimeTzADT timetzInFormatted (const char *str, int32 precision, const std::string format, bool report_error)
TimeTzADT timetzInNoTzNameCheck (const char *str, Typemod typmod, bool report_error)
TimeTzADT timetzInNoTzNameCheck (const char *str, int32 precision, bool report_error)
int32 timetzToChar (TimeTzADT tz, char *res, int32 max_size, bool report_error)
bool vfixedIsNull (const void *ptr, size_t len)
bool vfloatIsNaN (const vfloat *f)
bool vfloatIsNaN (const vfloat f)
bool vfloatIsNull (const vfloat *vf)
bool vfloatIsNull (const vfloat vf)
void vsmemclr (void *dst, size_t len)
void vsmemcpy (void *dst, const void *src, size_t len)
bool vsmemne (const void *p1, const void *p2, size_t len)
Version of memcmp for detecting not equal only. Inline function for comparing small things of arbitrary length.
template
TRET * vt_createFuncObject (VTAllocator *allocator)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1, T2 arg2)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1, T2 arg2, T3 arg3)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1, T2 arg2, T3 arg3, T4 arg4)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7, T8 arg8)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7, T8 arg8, T9 arg9)
template
TRET * vt_createFuncObject (VTAllocator *allocator, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7, T8 arg8, T9 arg9, T10 arg10)
Variables
const uint8 byte_null = 0xff
Indicates NULL byte.
const char char_null = 0xff
Indicates NULL char.
static const uint64 INVALID_UINT64 = std::numeric_limits::max()
static const size_t UDFS_DEFAULT_FANOUT_LEN = 3
static const size_t UDFS_DEFAULT_FANOUT_MOD = 1000
const vbool vbool_false = VFalse
Value for Boolean FALSE.
const vbool vbool_null = VUnknown
Value for Boolean NULL.
const vbool vbool_true = VTrue
Value for Boolean TRUE.
ServerFunctions * VERTICA_INTERNAL_fns = NULL
const vfloat vfloat_null = vfn.vf
union Vertica::FIunion vfn = {0x7ffffffffffffffeLL}
union FIunion vfNaN = { static_cast(0xFFF8000000000000LL) }
const vint vint_null = 0x8000000000000000LL
Value for Integer NULLs.
VT_ERRMSG vt_server_errmsg = 0
VT_THROW_EXCEPTION vt_throw_exception = 0
VT_THROW_INTERNAL_EXCEPTION vt_throw_internal_exception = 0

Detailed Description

Defines classes for Vertica User Defined Functions

Typedef Documentation

typedef int64 Vertica::DateADT

The value in DateADT is the number of days

typedef int64 Vertica::Interval

Represents delta time.

The value in Interval is number of microseconds, which is limited to +/- 2^63-1 microseconds = 106751991 days 4 hours 54.775807 seconds or +/-9223372036854775807 months = 768614336404564650 years 7 months

Interval can be directly added/subtracted from Timestamp/TimestampTz to have a meaningful result

typedef int64 Vertica::IntervalYM

Represents delta time.

The value in IntervalYM is number of months

So Interval can be directly added/subtracted from Timestamp/TimestampTz to have a meaningful result, but IntervalYM cannot

typedef int64 Vertica::TimeADT

TimeADT represents time within a day

The value in TimeADT number of microseconds within 24 hours

typedef int64 Vertica::Timestamp

Represents absolute time and date.

The value in Timestamp is the number of microseconds since 2000-01-01 00:00:00 with no timezone implied

typedef int64 Vertica::TimestampTz

Vertica timestamp data type.

Represents absolute time and date with time zone.

The value in TimestampTz is the number of microseconds since 2000-01-01 00:00:00 GMT

typedef int64 Vertica::TimeTzADT

Represents time within a day in a timezone

The value in TimeADT consists of 2 parts:

  • The lower 24 bits (defined as ZoneFieldWidth) contains the timezone plus 24 hours, specified in seconds SQL-2008 limits the timezone itself to range between +/-14 hours

  • The rest of higher bits contains the time in GMT, value specified as number of microseconds within 24 hours

Enumeration Type Documentation

enum Vertica::InputState

InputState

Applies only to input streams; namely, UDFilter and UDParser.

OK Currently at the start of or in the middle of a stream.

END_OF_FILE Reached the end of the input stream. No further data is available. Returning a StreamState of INPUT_NEEDED at this point is invalid, as there is no more input.

END_OF_CHUNK Reached the end of an input chunk. Applies only to a parser and only when fed by a Chunker, it means the current data block ends on a record boundary. In this state a parser should consume all data in the block before returning from process.

START_OF_PORTION Used when a load stack is apportioned. This mode indicates input does not start at the beginning of a source. Typical response of a parser is to find the first end-of-record and return PORTION_START. Subsequent calls to process will use InputState = OK, until the end of the portion/source is reached.

END_OF_PORTION Used when a load stack is apportioned. This mode indicates the underlying source has reached the end of its allotted portion. The typical response from a parser is to finish the last record it started but proceed no farther.

enum Vertica::StreamState

StreamState

Indicates the state of a stream after process() has handled some input and some output data.

The different enum values have the following meanings:

INPUT_NEEDED

Indicates that a stream is unable to continue without being given more input. It may not have consumed all of its available input yet. It does not need to have consumed every byte of input. Not valid for output-only streams, ie., UDSources.

OUTPUT_NEEDED

Indicates that a stream is unable to write more output without being given a new or larger output buffer. Basically that it has "filled" the buffer as much as it is reasonably able to (which may be every byte full, some bytes full, even completely empty – in which case Vertica assumes that the UDL needs a larger buffer). Not valid for input-only streams, ie., UDParsers.

DONE

The stream has completed; it will not be writing any more output nor consuming any more input.

REJECT

Only valid for UDParsers. Indicates that the last row the Parser consumed is invalid and should be processed as a rejected row.

KEEP_GOING

The stream has not filled all of its output buffer or consumed all of its input buffer, but would like to yield to the server. It is important to yield back to the server occasionally so that command have an opportunity to be canceled. Additionally, yielding to the server helps you to avoid a tight loop when waiting for data to arrive.

Return KEEP_GOING if a stream cannot proceed for an extended period of time (e.g. while waiting on an external operation to complete). This allows the stream to be called again, and prevents it from blocking indefinitely. Pointers into input or output buffers remain valid, and buffer offsets can be set.

CHUNK_ALIGNED

Used by UDChunker only. The chunker has found as many rows as possible in current block, and would like to hand off to parser a data block that is aligned with record boundary (input offset points to the start of the row after last row found in current block).

See the UDSource, UDFilter, and UDParser classes for how these streams are used.

enum Vertica::UDXDebugLevels

Bit mast for communicatnig the available UDx debug logging levels.

enum Vertica::volatility

Enums to allow programmatic specification of volatility and strictness

Function Documentation

template<class Archive , class T >

void Vertica::bserialize(Archive & ar, T & val, const uint serializer_version)

inline Allow free serializer

Referenced by Vertica::SimpleArchiveOut::operator>().

template<class Archive , typename T , size_t n>

void Vertica::bserialize(Archive & ar, T(&) x[n], const unsigned int version)

Handle arrays

template<typename DstBlock , typename SrcBlock >

void Vertica::copyBlockColumn(DstBlock & dstblock, const SrcBlock & srcblock, size_t dstIdx, size_t srcIdx)

Function to copy a column from one block to another

static void Vertica::describeIntervalTypeMod(char * result, Typemod typemod)

inlinestatic

Format interval "" where often starts with a space Call with char buf[64] to hold the result.

Referenced by Vertica::VerticaType::getPrettyPrintStr().

static DateADT Vertica::getDateFromUnixTime(time_t time)

inlinestatic

Convert Unix time_t to Date

static int64 Vertica::getGMTTz(TimeTzADT time)

inlinestatic

Get the GMT time of the TimeTz value (in microseconds)

static uint64 Vertica::getTime(TimeADT time)

inlinestatic

Get the time from a Time value

static TimeADT Vertica::getTimeFromUnixTime(time_t time)

inlinestatic

Convert Unix time_t to Time

static Timestamp Vertica::getTimestampFromUnixDouble(double time)

inlinestatic

keep the microseconds while converting!

static Timestamp Vertica::getTimestampFromUnixTime(time_t time)

inlinestatic

Convert Unix time_t to Timestamp

static TimestampTz Vertica::getTimestampTzFromUnixDouble(double time)

inlinestatic

double to timestamp tz to TimestampTz without truncation

static TimestampTz Vertica::getTimestampTzFromUnixTime(time_t time)

inlinestatic

Convert Unix time_t to TimestampTz

static int64 Vertica::getTimeTz(TimeTzADT time)

inlinestatic

Get the time at the timezone specified in TimeTz value itself (in microseconds)

static double Vertica::getUnixDoubleFromTimestamp(Timestamp timestamp)

inlinestatic

Convert Timestamp to unix time in seconds WITHOUT TRUNCATING MICROSECONDS

static time_t Vertica::getUnixTimeFromDate(DateADT date)

inlinestatic

Convert Date to Unix Time

static time_t Vertica::getUnixTimeFromTime(TimeADT t)

inlinestatic

Convert Time to Unix Time

static time_t Vertica::getUnixTimeFromTimestamp(Timestamp timestamp)

inlinestatic

Convert Timestamp to Unix time_t value (which is number of seconds since the Unix epoch) The internal representation of Timestamps is number of microseconds since the Postgres epoch date. This will truncate the timestamp to number of seconds (instead of microseconds)

static int32 Vertica::getZoneTz(TimeTzADT time)

inlinestatic

Get timezone from a TimeTz value (in seconds) (seconds field should be 0)

Referenced by getTimeTz().

void Vertica::log(const char * format, ...)

Write a message to the vertica.log system log.

Parameters

  • format: a printf style format string specifying the log message format.
template<class Alloc = std::allocator<uint64>>

VNumericTemp Vertica::operator*(const VNumeric & left, const VNumeric & right)

Multiplies two VNumerics and returns a temporary numeric

template<typename stringtype = std::string>

stringtype Vertica::operator+(const VString & left, const VString & right)

Concatenate VStrings into a std::string

template<class Alloc = std::allocator<uint64>>

VNumericTemp Vertica::operator+(const VNumeric & left, const VNumeric & right)

Adds two VNumerics and returns a temporary numeric

template<class Alloc = std::allocator<uint64>>

VNumericTemp Vertica::operator-(const VNumeric & left, const VNumeric & right)

Subtracts one VNumeric from another and returns a temporary numeric

template<class Alloc = std::allocator<uint64>>

VNumericTemp Vertica::operator/(const VNumeric & left, const VNumeric & right)

Divides one VNumeric from another and returns a temporary numeric

template<class Alloc = std::allocator<uint64>>

| VNumericTemp Vertica::operator

template<class Alloc = std::allocator<uint64>>

VNumericTemp Vertica::operator>>(const VNumeric & operand, unsigned shift)

Shift the bits of a VNumeric right the indicated number of bits; returns the result in a VNumericTemp

static TimeADT Vertica::setTime(int64 time)

inlinestatic

Produce a Time value

static TimeTzADT Vertica::setTimeTz(int64 time, int32 zone)

inlinestatic

Produce a TimeTz value from time (in microseconds) at a timezone (in seconds, seconds field does not need to be 0 as zoneinfo record all those historical change, and historical change may have hour/minute/seconds adjustment

void Vertica::vsmemcpy(void * dst, const void * src, size_t len)

inline Version of memcpy optimized for vertica's small data types. Inline function for copying small things of arbitrary length.

This copy is forward-only (i.e. lower addresses are read and written first) - callers may depend on that.

Note If you are using this function in a C++ UDX AND compiling with -O3 make sure you disable tree-vectorize optimization (-fno-tree-vectorize)

Note Avoid using pragma and function attributes here as it may have a negative impact on inlining.

Referenced by Vertica::VUuid::copy().

2 - Java SDK Documentation

Welcome to the Vertica Java SDK Documentation. This documentation covers all of the classes that make up the Java SDK. Using this SDK, you can create User Defined Extensions (UDxs) that integrate your own features into the Vertica Analytics Platform.

See Developing User-Defined Extensions.

2.1 - Class Index

A | B | C | D | E | F | I | K | M | N | P | R | S | T | U | V

A

DFSConstants (com.vertica.sdk)   

M

ScalarFunctionFactory (com.vertica.sdk)   

UDFilter (com.vertica.sdk)   

DFSFile.DFSDistribution (com.vertica.sdk)   

ServerInterface (com.vertica.sdk)   

UDLFactory (com.vertica.sdk)   

AnalyticFunction (com.vertica.sdk)   

DFSFile (com.vertica.sdk)   

Encoder.MatchingKeySelector (com.vertica.sdk.vmap.v1)   

SessionParamReaderMap (com.vertica.sdk)   

UDParser (com.vertica.sdk)   

AnalyticFunctionFactory (com.vertica.sdk)   

DFSFileReader (com.vertica.sdk)   

TypeCoercion.MetaType (com.vertica.sdk)   

SessionParamWriterMap (com.vertica.sdk)   

UDSource (com.vertica.sdk)   

AnalyticPartitionReader (com.vertica.sdk)   

DFSFileStatus (com.vertica.sdk)   

MultiPhaseTransformFunctionFactory (com.vertica.sdk)   

SizedColumnTypes (com.vertica.sdk)   

UDXFactory (com.vertica.sdk)   

AnalyticPartitionWriter (com.vertica.sdk)   

DFSFileWriter (com.vertica.sdk)   

N

SourceFactory (com.vertica.sdk)   

UDXFunction (com.vertica.sdk)   

B

DFSFile.DFSRootParentType (com.vertica.sdk)   

SourceIterator (com.vertica.sdk)   

UDXLibrary (com.vertica.sdk)   

DFSFile.DFSScope (com.vertica.sdk)   

NodeSpecifyingPlanContext (com.vertica.sdk)   

StandardTypeCoercion.SpecialBigDecimal (com.vertica.sdk)   

UDXObject (com.vertica.sdk)   

BaseDataOID (com.vertica.sdk)   

TimestampUDxShared.DTtype (com.vertica.sdk)   

NoopTypeCoercion (com.vertica.sdk)   

StandardTypeCoercion (com.vertica.sdk)   

UDXFactory.UDXType (com.vertica.sdk)   

Basics (com.vertica.sdk)   

E

NullTypeCoercion (com.vertica.sdk)   

State (com.vertica.sdk)   

UnsizedUDSource (com.vertica.sdk)   

BlockReader (com.vertica.sdk)   

P

State.StreamState (com.vertica.sdk)   

V

BlockWriter (com.vertica.sdk)   

Encoder (com.vertica.sdk.vmap.v1)   

StreamWriter (com.vertica.sdk)   

StandardTypeCoercion.BooleanEvaluation (com.vertica.sdk)   

ExecutorParamWriter (com.vertica.sdk)   

ParamReader (com.vertica.sdk)   

ScalarFunctionFactory.strictness (com.vertica.sdk)   

VerticaBlock (com.vertica.sdk)   

BuildInfo (com.vertica.sdk)   

ExecutorPlanContext (com.vertica.sdk)   

ParamWriter (com.vertica.sdk)   

StringUtils (com.vertica.sdk)   

VerticaType (com.vertica.sdk)   

C
F

ParserFactory (com.vertica.sdk)   

T

VMapEncodingException (com.vertica.sdk.vmap)   

PartitionReader (com.vertica.sdk)   

VNumeric (com.vertica.sdk)   

ColumnTypes (com.vertica.sdk)   

FileManager (com.vertica.sdk)   

PartitionWriter (com.vertica.sdk)   

TimestampUDxShared (com.vertica.sdk)   

ScalarFunctionFactory.volatility (com.vertica.sdk)   

ContinuousReader (com.vertica.sdk)   

FilterFactory (com.vertica.sdk)   

PerColumnParamReader (com.vertica.sdk)   

TransformFunction (com.vertica.sdk)   

VResources (com.vertica.sdk)   

ContinuousRejecter (com.vertica.sdk)   

I

PGUDxShared (com.vertica.sdk)   

TransformFunctionFactory (com.vertica.sdk)   

VString (com.vertica.sdk)   

ContinuousUDParser (com.vertica.sdk)   

PlanContext (com.vertica.sdk)   

TransformFunctionPhase (com.vertica.sdk)   

ContinuousUDParser.CoroutineState (com.vertica.sdk)   

IdentComparator (com.vertica.sdk)   

Portion (com.vertica.sdk)   

TypeCoercion (com.vertica.sdk)   

D

State.InputState (com.vertica.sdk)   

R

TypeCoercionException (com.vertica.sdk)   

ScalarFunction.InterfaceType (com.vertica.sdk)   

TypeCoercionPolicy (com.vertica.sdk)   

DataBuffer (com.vertica.sdk)   

InvalidMapKeyException (com.vertica.sdk.vmap)   

RejectedRecord (com.vertica.sdk)   

U

DefaultSourceIterator (com.vertica.sdk)   

IterativeSourceFactory (com.vertica.sdk)   

S

DestroyInvocation (com.vertica.sdk)   

K

UdfException (com.vertica.sdk)   

ScalarFunction (com.vertica.sdk)   

KeySelector (com.vertica.sdk.vmap.v1)   

A | B | C | D | E | F | I | K | M | N | P | R | S | T | U | V

2.1.1 - Class Hierarchy

Go to the graphical class hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

[detail level 12345]

com.vertica.sdk.BaseDataOID
com.vertica.sdk.Basics
com.vertica.sdk.BuildInfo
com.vertica.sdk.ColumnTypes
com.vertica.sdk.ContinuousReader
com.vertica.sdk.ContinuousRejecter
com.vertica.sdk.ContinuousUDParser.CoroutineState
com.vertica.sdk.DataBuffer
com.vertica.sdk.DFSConstants
com.vertica.sdk.DFSFile
com.vertica.sdk.DFSFile.DFSDistribution
com.vertica.sdk.DFSFile.DFSRootParentType
com.vertica.sdk.DFSFile.DFSScope
com.vertica.sdk.DFSFileReader
com.vertica.sdk.DFSFileStatus
com.vertica.sdk.DFSFileWriter
com.vertica.sdk.FileManager
com.vertica.sdk.PerColumnParamReader
com.vertica.sdk.PGUDxShared
com.vertica.sdk.PlanContext
com.vertica.sdk.NodeSpecifyingPlanContext
com.vertica.sdk.ExecutorPlanContext
com.vertica.sdk.Portion
com.vertica.sdk.RejectedRecord
com.vertica.sdk.ScalarFunction.InterfaceType
com.vertica.sdk.ScalarFunctionFactory.strictness
com.vertica.sdk.ScalarFunctionFactory.volatility
com.vertica.sdk.ServerInterface
com.vertica.sdk.SessionParamReaderMap
com.vertica.sdk.SessionParamWriterMap
com.vertica.sdk.SizedColumnTypes
com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation
com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal
com.vertica.sdk.State
com.vertica.sdk.State.InputState
com.vertica.sdk.State.StreamState
com.vertica.sdk.StringUtils
com.vertica.sdk.TimestampUDxShared
com.vertica.sdk.TimestampUDxShared.DTtype
com.vertica.sdk.TransformFunctionPhase Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function
com.vertica.sdk.TypeCoercion
com.vertica.sdk.NullTypeCoercion
com.vertica.sdk.NoopTypeCoercion
com.vertica.sdk.StandardTypeCoercion
com.vertica.sdk.TypeCoercion.MetaType
com.vertica.sdk.TypeCoercionPolicy
com.vertica.sdk.UDXFactory
com.vertica.sdk.AnalyticFunctionFactory
com.vertica.sdk.MultiPhaseTransformFunctionFactory
com.vertica.sdk.ScalarFunctionFactory
com.vertica.sdk.TransformFunctionFactory
com.vertica.sdk.UDLFactory
com.vertica.sdk.FilterFactory
com.vertica.sdk.IterativeSourceFactory
com.vertica.sdk.SourceFactory
com.vertica.sdk.ParserFactory
com.vertica.sdk.UDXFactory.UDXType
com.vertica.sdk.UDXLibrary
com.vertica.sdk.UDXObject
com.vertica.sdk.SourceIterator
com.vertica.sdk.DefaultSourceIterator
com.vertica.sdk.UDFilter
com.vertica.sdk.UDParser
com.vertica.sdk.ContinuousUDParser
com.vertica.sdk.UDXFunction
com.vertica.sdk.AnalyticFunction
com.vertica.sdk.ScalarFunction
com.vertica.sdk.TransformFunction
com.vertica.sdk.UnsizedUDSource
com.vertica.sdk.UDSource
com.vertica.sdk.VerticaBlock
com.vertica.sdk.BlockReader
com.vertica.sdk.ParamReader
com.vertica.sdk.ParamWriter
com.vertica.sdk.ExecutorParamWriter
com.vertica.sdk.PartitionReader
com.vertica.sdk.AnalyticPartitionReader
com.vertica.sdk.BlockWriter
com.vertica.sdk.PartitionWriter
com.vertica.sdk.AnalyticPartitionWriter
com.vertica.sdk.StreamWriter
com.vertica.sdk.VerticaType
com.vertica.sdk.vmap.v1.KeySelector
com.vertica.sdk.vmap.v1.Encoder
com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector
com.vertica.sdk.VNumeric
com.vertica.sdk.VResources
com.vertica.sdk.VString
RuntimeException
com.vertica.sdk.UdfException
Throwable
com.vertica.sdk.DestroyInvocation
IllegalArgumentException
com.vertica.sdk.TypeCoercionException
com.vertica.sdk.vmap.VMapEncodingException
com.vertica.sdk.vmap.InvalidMapKeyException
Comparator
com.vertica.sdk.IdentComparator

2.1.2 - Class Hierarchy

Go to the textual class hierarchy

2.1.3 - Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 1234567]

com
vertica
sdk
vmap
v1
Encoder
MatchingKeySelector
KeySelector
InvalidMapKeyException
VMapEncodingException
AnalyticFunction
AnalyticFunctionFactory
AnalyticPartitionReader
AnalyticPartitionWriter
BaseDataOID
Basics
BlockReader
BlockWriter
BuildInfo
ColumnTypes
ContinuousReader
ContinuousRejecter
ContinuousUDParser
CoroutineState
DataBuffer
DefaultSourceIterator
DestroyInvocation
DFSConstants
DFSFile
DFSDistribution
DFSRootParentType
DFSScope
DFSFileReader
DFSFileStatus
DFSFileWriter
ExecutorParamWriter
ExecutorPlanContext
FileManager
FilterFactory
IdentComparator
IterativeSourceFactory
MultiPhaseTransformFunctionFactory
NodeSpecifyingPlanContext
NoopTypeCoercion
NullTypeCoercion
ParamReader
ParamWriter
ParserFactory
PartitionReader
PartitionWriter
PerColumnParamReader
PGUDxShared
PlanContext
Portion
RejectedRecord
ScalarFunction
InterfaceType
ScalarFunctionFactory
strictness
volatility
ServerInterface
SessionParamReaderMap
SessionParamWriterMap
SizedColumnTypes
SourceFactory
SourceIterator
StandardTypeCoercion
BooleanEvaluation
SpecialBigDecimal
State
InputState
StreamState
StreamWriter
StringUtils
TimestampUDxShared
DTtype
TransformFunction
TransformFunctionFactory
TransformFunctionPhase Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function
TypeCoercion
MetaType
TypeCoercionException
TypeCoercionPolicy
UdfException
UDFilter
UDLFactory
UDParser
UDSource
UDXFactory
UDXType
UDXFunction
UDXLibrary
UDXObject
UnsizedUDSource
VerticaBlock
VerticaType
VNumeric
VResources
VString

2.1.4 - com.vertica.sdk.AnalyticFunction Class Reference

Inheritance diagram for com.vertica.sdk.AnalyticFunction:

Collaboration diagram for com.vertica.sdk.AnalyticFunction:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes)
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)
boolean isCanceled ()
abstract void processPartition (ServerInterface srvInterface, AnalyticPartitionReader input_reader, AnalyticPartitionWriter output_writer) throws UdfException, DestroyInvocation
void setup (ServerInterface srvInterface, SizedColumnTypes argTypes)
Protected Member Functions
void cancel (ServerInterface srvInterface)

Detailed Description

Interface for User-Defined Analytic Function (UDAnF). A UDAnF operates on rows of data and returns rows of data, not necessarily 1:1.

An AnalyticFunction must have an associated AnalyticFunctionFactory.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
void com.vertica.sdk.UDXFunction.destroy(ServerInterface srvInterface, SizedColumnTypes argTypes)

inherited Perform per instance destruction. This function may throw errors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)

Referenced by com.vertica.sdk.UDXFunction.destroy().

void com.vertica.sdk.UDXFunction.destroy(ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)

inherited Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)
  • udSessionParams: a SessionParamWriterMap
boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

abstract void com.vertica.sdk.AnalyticFunction.processPartition(ServerInterface srvInterface, AnalyticPartitionReader input_reader, AnalyticPartitionWriter output_writer) throws UdfException, DestroyInvocation

pure virtual Invoke a user defined analytic on a set of rows. As the name suggests, a batch of rows are passed in for every invocation to amortize performance.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • input_reader: input rows
  • output_writer: output location

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
void com.vertica.sdk.UDXFunction.setup(ServerInterface srvInterface, SizedColumnTypes argTypes)

inherited Perform per instance initialization. This function may throw errors.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)

2.1.5 - com.vertica.sdk.AnalyticFunction Member List

This is the complete list of members for com.vertica.sdk.AnalyticFunction, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
destroy(ServerInterface srvInterface, SizedColumnTypes argTypes) com.vertica.sdk.UDXFunction
destroy(ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams) com.vertica.sdk.UDXFunction
isCanceled() com.vertica.sdk.UDXObject
processPartition(ServerInterface srvInterface, AnalyticPartitionReader input_reader, AnalyticPartitionWriter output_writer) com.vertica.sdk.AnalyticFunction pure virtual
setup(ServerInterface srvInterface, SizedColumnTypes argTypes) com.vertica.sdk.UDXFunction
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.6 - com.vertica.sdk.AnalyticFunctionFactory Class Reference

Inheritance diagram for com.vertica.sdk.AnalyticFunctionFactory:

Collaboration diagram for com.vertica.sdk.AnalyticFunctionFactory:

Public Member Functions
abstract AnalyticFunction createAnalyticFunction (ServerInterface srvInterface)
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
abstract void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
abstract void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException
UDXType getUDXFactoryType ()
Protected Attributes
long libOid
String sqlName

Detailed Description

Interface for declaring parameters and return types for, and instantiating, an associated AnalyticFunction.

Member Function Documentation

abstract AnalyticFunction com.vertica.sdk.AnalyticFunctionFactory.createAnalyticFunction(ServerInterface srvInterface)

pure virtual Called when Vertica needs a new AnalyticFunction object to process a function call.

Note More than one object may be instantiated per query.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Returns an AnalyticFunction object which implements the UDx API described by this metadata.

void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

inherited Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Referenced by com.vertica.sdk.UDXFactory.getPerInstanceResources().

void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
abstract void com.vertica.sdk.UDXFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

pure virtual inherited Provides the argument and return types of the UDX

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments
  • returnType: the type(s) of the return

Implemented in com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.

Referenced by com.vertica.sdk.ScalarFunctionFactory.getReturnType().

abstract void com.vertica.sdk.UDXFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException

pure virtual inherited Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Implemented in com.vertica.sdk.ScalarFunctionFactory, com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.

UDXType com.vertica.sdk.AnalyticFunctionFactory.getUDXFactoryType()

virtual

Returns the object type internally used by Vertica

Implements com.vertica.sdk.UDXFactory.

2.1.7 - com.vertica.sdk.AnalyticFunctionFactory Member List

This is the complete list of members for com.vertica.sdk.AnalyticFunctionFactory, including all inherited members.

createAnalyticFunction(ServerInterface srvInterface) com.vertica.sdk.AnalyticFunctionFactory pure virtual
getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDXFactory
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.UDXFactory pure virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.UDXFactory pure virtual
getUDXFactoryType() com.vertica.sdk.AnalyticFunctionFactory virtual
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected

2.1.8 - com.vertica.sdk.AnalyticPartitionReader Class Reference

Inheritance diagram for com.vertica.sdk.AnalyticPartitionReader:

Collaboration diagram for com.vertica.sdk.AnalyticPartitionReader:

Public Member Functions
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
boolean getBoolean (int idx)
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
java.sql.Date getDate (int idx)
double getDouble (int idx)
long getLong (int idx)
int getNumCols ()
int getNumRows ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
String getString (int idx)
int getStringLength (int idx)
int getStringLoc (int idx)
java.sql.Timestamp getTimestamp (int idx)
SizedColumnTypes getTypeMetaData ()
VNumeric getVNumeric (int idx)
VString getVString (int idx)
boolean isBooleanNull (int idx)
boolean isDateNull (int idx)
boolean isDoubleNull (int idx)
boolean isLongNull (int idx)
boolean isNewOrderByKey ()
boolean isStringNull (int idx)
boolean isTimestampInfinite (int idx)
boolean isTimestampInfiniteNeg (int idx)
boolean isTimestampInfinitePos (int idx)
boolean isTimestampNull (int idx)
boolean next () throws UdfException, DestroyInvocation
abstract boolean readNextBlock () throws UdfException, DestroyInvocation
void resetBuffers ()
abstract void setupColsAndStrides ()
Public Attributes
int count
int index
int ncols
int nrows
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos
ArrayList newOrderMarkers

Detailed Description

Provides an iterator-based read interface over all the partition_by keys, order_by keys, and function arguments in a partition.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
boolean com.vertica.sdk.BlockReader.getBoolean(int idx)

inherited Get a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a BOOLEAN.

ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

java.sql.Date com.vertica.sdk.BlockReader.getDate(int idx)

inherited Get a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DATE; null if the column is NULL.

double com.vertica.sdk.BlockReader.getDouble(int idx)

inherited Get a DOUBLE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DOUBLE.

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

long com.vertica.sdk.BlockReader.getLong(int idx)

inherited Get a LONG INTEGER value from the input row.

Example

long a = arg_reader.getLong(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a LONG INTEGER.

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

String com.vertica.sdk.BlockReader.getString(int idx)

inherited Get a reference to an VARCHAR/CHAR/VARBINARY/BINARY value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an String.

int com.vertica.sdk.BlockReader.getStringLength(int idx)

inherited Get length of the String from the input row

Parameters

  • idx: The column number to retrieve from the input row.

Returns The length of the String in specified column.

Referenced by

int com.vertica.sdk.BlockReader.getStringLoc(int idx)

inherited Get 'location' of the String from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The location of the String in specified column. If zero, data is inlined immediately after the header, otherwise data is at offset loc within the data area.

Referenced by com.vertica.sdk.BlockReader.getVString().

java.sql.Timestamp com.vertica.sdk.BlockReader.getTimestamp(int idx)

inherited Get a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a TIMESTAMP; null if the column is NULL or represents 'infinity'.

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

VNumeric com.vertica.sdk.BlockReader.getVNumeric(int idx)

inherited Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the retrieved value cast as a Numeric.

VString com.vertica.sdk.BlockReader.getVString(int idx)

inherited Get a reference from the input row to an VString value, which represents a SQL VARCHAR/CHAR/VARBINARY/BINARY value.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isBooleanNull(int idx)

inherited Check whether a value from the input row is NULL in BOOLEAN type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.BlockReader.isDateNull(int idx)

inherited Check whether a value from the input row is NULL in DATE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getDate().

boolean com.vertica.sdk.BlockReader.isDoubleNull(int idx)

inherited Check whether a value from the input row is NULL in DOUBLE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.BlockReader.isLongNull(int idx)

inherited Check whether a value from the input row is NULL in LONG INTERGER type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by

boolean com.vertica.sdk.BlockReader.isStringNull(int idx)

inherited Check whether a value from the input row is NULL in SQL VARCHAR/CHAR/VARBINARY/BINARY type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isTimestampInfinite(int idx)

inherited Check whether a TIMESTAMP value from the input row represents 'infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity' or '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.isTimestampInfiniteNeg(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '-infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampInfinitePos(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '+infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampNull(int idx)

inherited Check whether a value from the input row is NULL in TIMESTAMP type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

abstract boolean com.vertica.sdk.AnalyticPartitionReader.readNextBlock() throws UdfException, DestroyInvocation

pure virtual

Reads in the next block of data and positions cursor at the

beginning.

Returns false if there's no more input data

Implements com.vertica.sdk.PartitionReader.

2.1.9 - com.vertica.sdk.AnalyticPartitionReader Member List

This is the complete list of members for com.vertica.sdk.AnalyticPartitionReader, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
AnalyticPartitionReader() (defined in com.vertica.sdk.AnalyticPartitionReader) com.vertica.sdk.AnalyticPartitionReader
BlockReader() (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader
BlockReader(int _ncols, int _rowcount) (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader protected
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getBoolean(int idx) com.vertica.sdk.BlockReader
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getDate(int idx) com.vertica.sdk.BlockReader
getDouble(int idx) com.vertica.sdk.BlockReader
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getLong(int idx) com.vertica.sdk.BlockReader
getNumCols() com.vertica.sdk.VerticaBlock
getNumRows() com.vertica.sdk.VerticaBlock
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getString(int idx) com.vertica.sdk.BlockReader
getStringLength(int idx) com.vertica.sdk.BlockReader
getStringLoc(int idx) com.vertica.sdk.BlockReader
getTimestamp(int idx) com.vertica.sdk.BlockReader
getTypeMetaData() com.vertica.sdk.VerticaBlock
getVNumeric(int idx) com.vertica.sdk.BlockReader
getVString(int idx) com.vertica.sdk.BlockReader
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
isBooleanNull(int idx) com.vertica.sdk.BlockReader
isDateNull(int idx) com.vertica.sdk.BlockReader
isDoubleNull(int idx) com.vertica.sdk.BlockReader
isLongNull(int idx) com.vertica.sdk.BlockReader
isNewOrderByKey() (defined in com.vertica.sdk.AnalyticPartitionReader) com.vertica.sdk.AnalyticPartitionReader
isStringNull(int idx) com.vertica.sdk.BlockReader
isTimestampInfinite(int idx) com.vertica.sdk.BlockReader
isTimestampInfiniteNeg(int idx) com.vertica.sdk.BlockReader
isTimestampInfinitePos(int idx) com.vertica.sdk.BlockReader
isTimestampNull(int idx) com.vertica.sdk.BlockReader
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
newOrderMarkers (defined in com.vertica.sdk.AnalyticPartitionReader) com.vertica.sdk.AnalyticPartitionReader protected
next() (defined in com.vertica.sdk.PartitionReader) com.vertica.sdk.PartitionReader
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
PartitionReader() (defined in com.vertica.sdk.PartitionReader) com.vertica.sdk.PartitionReader
readNextBlock() com.vertica.sdk.AnalyticPartitionReader pure virtual
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
setupColsAndStrides() (defined in com.vertica.sdk.AnalyticPartitionReader) com.vertica.sdk.AnalyticPartitionReader pure virtual
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.10 - com.vertica.sdk.AnalyticPartitionWriter Class Reference

Inheritance diagram for com.vertica.sdk.AnalyticPartitionWriter:

Collaboration diagram for com.vertica.sdk.AnalyticPartitionWriter:

Public Member Functions
AnalyticPartitionWriter (int nargs)
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
void copyFromInput (int dstIdx, PartitionReader input_reader, int srcIdx) throws UdfException
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
TypeCoercion getDefaultTypeCoercion ()
int getNumCols ()
VNumeric getNumericWriter (int idx)
int getNumRows ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
VString getStringWriter (int idx)
SizedColumnTypes getTypeMetaData ()
abstract boolean getWriteableBlock () throws UdfException, DestroyInvocation
boolean next () throws UdfException, DestroyInvocation
void resetBuffers ()
void setBoolean (int idx, boolean r)
void setBooleanNull (int idx)
void setBooleanValue (int idx, Boolean value)
void setDate (int idx, java.sql.Date r)
void setDateNull (int idx)
void setDateValue (int idx, java.sql.Date value)
TypeCoercion setDefaultTypeCoercion (TypeCoercion coerce)
void setDouble (int idx, double r)
void setDoubleNull (int idx)
void setDoubleValue (int idx, Double value)
void setLong (int idx, long r)
void setLongNull (int idx)
void setLongValue (int idx, Long value)
void setNumeric (int idx, BigDecimal bd)
void setNumericNull (int idx)
void setNumericValue (int idx, BigDecimal value)
void setRowFromMap (Map rowData)
void setRowFromMap (Map rowData, TypeCoercion coerce)
void setString (int idx, String r)
void setStringBytes (int idx, ByteBuffer bytes)
void setStringNull (int idx)
void setStringValue (int idx, String value)
void setTimestamp (int idx, java.sql.Timestamp r)
void setTimestampInfiniteNeg (int idx)
void setTimestampInfinitePos (int idx)
void setTimestampNull (int idx)
void setTimestampValue (int idx, java.sql.Timestamp value)
void setValue (int idx, Object value, TypeCoercion coerce)
void setVMap (int idx, Map data)
void setVMap (int idx, Map data, TypeCoercion coerce)
void throwInCorrectUsageError (int idx)
: Throwing UdfException for incorrect setter usage
Public Attributes
int count
int index
int ncols
int nrows
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
long getRowSize (SizedColumnTypes types)
void setRowCount (SizedColumnTypes types)
Static Protected Member Functions
static long blockSizeGivenRowSize (long row_size)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos

Detailed Description

Partition writer for all input data in a single partition. It automatically makes space as needed.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
void com.vertica.sdk.PartitionWriter.copyFromInput(int dstIdx, PartitionReader input_reader, int srcIdx) throws UdfException

inherited Copies a column from the input reader to the output writer. The data types and sizes of the source and destination columns must match exactly.

Parameters

  • dstIdx: The destination column index (in the output writer)
  • input_reader: The input reader from which to copy a column
  • srcIdx: The source column index (in the input reader)
ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

TypeCoercion com.vertica.sdk.PartitionWriter.getDefaultTypeCoercion()

inherited Give the default TypeCoercion instance, creating one if necessary. This may be useful in cases where the calling code would like to change the TypeCoercionPolicy or do TypeCoercion in the same manner as this PartitionWriter.

If a TypeCoercion is created, it is an instance of StandardTypeCoercion.

See Also #setRowFromMap(Map)

Returns the current default TypeCoercion, creating one if necessary.

Referenced by

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

abstract boolean com.vertica.sdk.AnalyticPartitionWriter.getWriteableBlock() throws UdfException, DestroyInvocation

pure virtual Gets a writeable block of data and positions cursor at the beginning.

Returns true on success; use other methods to manipulate the block

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: Invocation needed to be destroyed

Implements com.vertica.sdk.PartitionWriter.

void com.vertica.sdk.PartitionWriter.setBooleanValue(int idx, Boolean value)

inherited Set a Boolean value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setDateValue(int idx, java.sql.Date value)

inherited Set a Date value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
TypeCoercion com.vertica.sdk.PartitionWriter.setDefaultTypeCoercion(TypeCoercion coerce)

inherited Set the default type coercion instance.

See Also #setRowFromMap(Map)

Parameters

  • coerce: A TypeCoercion instance.

Returns the former default, which may be null.

void com.vertica.sdk.PartitionWriter.setDoubleValue(int idx, Double value)

inherited Set a Double value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setLongValue(int idx, Long value)

inherited Set a Long value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setNumericValue(int idx, BigDecimal value)

inherited Set a Numeric value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setRowFromMap(Map rowData)

inherited Sets all columns on the current row according to the data provided, using the column names to match the data keys. See setRowFromMap(Map, TypeCoercion) for more details. This is a shortcut for using the default type coercion.

Parameters

  • rowData: The data. Null data is treated as empty.

See Also #setRowFromMap(Map, TypeCoercion)

getDefaultTypeCoercion()

void com.vertica.sdk.PartitionWriter.setRowFromMap(Map rowData, TypeCoercion coerce)

inherited Sets all columns on the current row according to the data provided, using the column names to match the data keys.

For each column, TypeCoercion will be used to convert a value in rowData to the appropriate type for that column. This is done via setValue and may cause a TypeCoercion exception.

To find the corresponding value, the 'first' matching key (according to case-insensitive SQL identifier matching) in the map will be used. 'first' is not well defined, but is consistent.

If no corresponding value is found, the column will be set to null. This never raises an exception, regardless of the target column type. That is, FAIL_SDK_UNSUPPORTED_TYPE is ignored in that case.

In addition, if the target row structure appears to be a flex table, the necessary internal structures will be populated with an encoded vmap via setVMap(int, Map, TypeCoercion).

Parameters

  • rowData: The data. Null data is treated as empty.
  • coerce: The implementation of coercion

See Also #setVMap(int, Map, TypeCoercion)

setValue(int, Object, TypeCoercion)

void com.vertica.sdk.PartitionWriter.setStringBytes(int idx, ByteBuffer bytes)

inherited Set a String value for column at index idx. Accepts null values.

Parameters

  • idx: The column index
  • bytes: A ByteBuffer with bytes between position and limit that are a string encoded according to Vertica's requirements. This buffer must fit within the column's length requirements.

Exceptions

  • IllegalArgumentException: if bytes is too long
void com.vertica.sdk.PartitionWriter.setStringValue(int idx, String value)

inherited Set a String value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setTimestampValue(int idx, java.sql.Timestamp value)

inherited Set a Timestamp value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setValue(int idx, Object value, TypeCoercion coerce)

inherited Set a value for a column using type coercion. Type coercion attempts to generate an appropriate value for the target column type based on the input type.

The following target column types are supported by the SDK for this method. All others will generate a TypeCoercionException due to FAIL_SDK_UNSUPPORTED_TYPE if appropriate.

  • Bools

  • Integers (excluding Numeric)

  • Floats

  • String-like types (char and binary, along with var- and long variants)

  • Timestamp and timestamptz

  • Dates

Parameters

  • idx: The column index
  • value: The value to store in the column. May be null.
  • coerce: The type coercion policy.

Referenced by com.vertica.sdk.PartitionWriter.setRowFromMap().

void com.vertica.sdk.PartitionWriter.setVMap(int idx, Map data)

inherited Encodes a VMap into the given column, which must be of binary type.

Parameters

  • idx: The index of the binary or varbinary column.
  • data: The data. Null data is treated as empty.

See Also #setVMap(int, Map, TypeCoercion)

getDefaultTypeCoercion()

void com.vertica.sdk.PartitionWriter.setVMap(int idx, Map data, TypeCoercion coerce)

inherited Encodes a VMap into the given column, which must be of binary type. Uses standard type coercion to identify aggregate values and to serialize all values.

Parameters

  • idx: The index of the binary or varbinary column.
  • data: The data. Null data is treated as empty.
  • coerce: Ignored but still here for backwards compatibility.

See Also #setVMap(int, Map)

getDefaultTypeCoercion()

2.1.11 - com.vertica.sdk.AnalyticPartitionWriter Member List

This is the complete list of members for com.vertica.sdk.AnalyticPartitionWriter, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
AnalyticPartitionWriter(int nargs) (defined in com.vertica.sdk.AnalyticPartitionWriter) com.vertica.sdk.AnalyticPartitionWriter
blockSizeGivenRowSize(long row_size) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter protectedstatic
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
copyFromInput(int dstIdx, PartitionReader input_reader, int srcIdx) com.vertica.sdk.PartitionWriter
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getDefaultTypeCoercion() com.vertica.sdk.PartitionWriter
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getNumCols() com.vertica.sdk.VerticaBlock
getNumericWriter(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
getNumRows() com.vertica.sdk.VerticaBlock
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getRowSize(SizedColumnTypes types) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter protected
getStringWriter(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
getTypeMetaData() com.vertica.sdk.VerticaBlock
getWriteableBlock() com.vertica.sdk.AnalyticPartitionWriter pure virtual
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
next() (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
PartitionWriter(int nargs) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
setBoolean(int idx, boolean r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setBooleanNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setBooleanValue(int idx, Boolean value) com.vertica.sdk.PartitionWriter
setDate(int idx, java.sql.Date r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDateNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDateValue(int idx, java.sql.Date value) com.vertica.sdk.PartitionWriter
setDefaultTypeCoercion(TypeCoercion coerce) com.vertica.sdk.PartitionWriter
setDouble(int idx, double r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDoubleNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDoubleValue(int idx, Double value) com.vertica.sdk.PartitionWriter
setLong(int idx, long r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setLongNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setLongValue(int idx, Long value) com.vertica.sdk.PartitionWriter
setNumeric(int idx, BigDecimal bd) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setNumericNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setNumericValue(int idx, BigDecimal value) com.vertica.sdk.PartitionWriter
setRowCount(SizedColumnTypes types) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter protected
setRowFromMap(Map rowData) com.vertica.sdk.PartitionWriter
setRowFromMap(Map rowData, TypeCoercion coerce) com.vertica.sdk.PartitionWriter
setString(int idx, String r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setStringBytes(int idx, ByteBuffer bytes) com.vertica.sdk.PartitionWriter
setStringNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setStringValue(int idx, String value) com.vertica.sdk.PartitionWriter
setTimestamp(int idx, java.sql.Timestamp r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampInfiniteNeg(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampInfinitePos(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampValue(int idx, java.sql.Timestamp value) com.vertica.sdk.PartitionWriter
setValue(int idx, Object value, TypeCoercion coerce) com.vertica.sdk.PartitionWriter
setVMap(int idx, Map data) com.vertica.sdk.PartitionWriter
setVMap(int idx, Map data, TypeCoercion coerce) com.vertica.sdk.PartitionWriter
throwInCorrectUsageError(int idx) com.vertica.sdk.PartitionWriter
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.12 - com.vertica.sdk.BaseDataOID Enum Reference

Collaboration diagram for com.vertica.sdk.BaseDataOID:

Public Member Functions
BaseDataOID (long oid)
long getLong ()
Static Public Member Functions
static BaseDataOID getBaseDataOID (long oid)
static String getTypeStr (long oid)
Public Attributes
BinaryOID =(117)
BoolOID =(5)
CharOID =(8)
DateOID =(10)
Float8OID =(7)
Int8OID =(6)
IntervalOID =(14)
IntervalYMOID =(114)
LongVarbinaryOID =(116)
LongVarcharOID =(115)
NumericOID =(16)
RecordOID =(3)
RLETuple =(18)
TimeOID =(11)
TimestampOID =(12)
TimestampTzOID =(13)
TimeTzOID =(15)
UnknownOID =(4)
VarbinaryOID =(17)
VarcharOID =(9)
VPosOID =(2)
VTuple =(1)
VUnspecOID =(0)

2.1.13 - com.vertica.sdk.BaseDataOID Member List

This is the complete list of members for com.vertica.sdk.BaseDataOID, including all inherited members.

BaseDataOID(long oid) (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
BinaryOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
BoolOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
CharOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
DateOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
Float8OID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
getBaseDataOID(long oid) (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID static
getLong() (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
getTypeStr(long oid) (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID static
Int8OID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
IntervalOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
IntervalYMOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
LongVarbinaryOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
LongVarcharOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
NumericOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
RecordOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
RLETuple (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
TimeOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
TimestampOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
TimestampTzOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
TimeTzOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
UnknownOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
VarbinaryOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
VarcharOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
VPosOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
VTuple (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID
VUnspecOID (defined in com.vertica.sdk.BaseDataOID) com.vertica.sdk.BaseDataOID

2.1.14 - com.vertica.sdk.Basics Class Reference

Collaboration diagram for com.vertica.sdk.Basics:

Static Public Member Functions
static int getNumericPrecision (int typmod)
Get Numeric precision from typmod.
static int getNumericScale (int typmod)
Get Numeric scale from typmod.
static int getNumericWordCount (int precision)
Get Numeric word count from precision.
static boolean isSimilarNumericTypmod (int a, int b)
Return true if these have the same EE representation.
static long JavaSQLDateToVerticaDate (java.sql.Date d)
static long JavaSQLTimestampToVerticaTimestamp (java.sql.Timestamp ts)
static java.sql.Date VerticaDateToJavaSQLDate (long num_days)
static java.sql.Timestamp VerticaTimestampToJavaSQLTimestamp (long vts)
Static Public Attributes
static final int DataAreaHeaderLen = 16
static final int maxTimestampPricision = 6
static final int StringValueHeaderLen = 8
static final int StringValueLenOffset = 0
static final int StringValueLocOffset = 4
static final long TimestampInfiniteNeg = -0x7fffffffffffffffL
static final long TimestampInfinitePos = 0x7fffffffffffffffL
static final byte vbool_false = 0
static final byte vbool_null = 2
static final byte vbool_true = 1
static final long vfloat_null_long_bits = 0x7ffffffffffffffeL
static final long vint_null = 0x8000000000000000L

Member Function Documentation

static long com.vertica.sdk.Basics.JavaSQLDateToVerticaDate(java.sql.Date d)

static

Get the internal value that Vertica stores for the date type.

Parameters

  • d: A date value. Java stores Date objects as an offset from 1970-01-01 00:00:00 GMT. The day represented by d is the calendar date of d in GMT.

Returns as a date type internally to vertica

Referenced by

static java.sql.Date com.vertica.sdk.Basics.VerticaDateToJavaSQLDate(long num_days)

static

Parameters

  • num_days: number of days since 2000-01-01

Returns the Date

static java.sql.Timestamp com.vertica.sdk.Basics.VerticaTimestampToJavaSQLTimestamp(long vts)

static

Parameters

  • vts: number of microseconds since 2000-01-01 00:00:00 GMT

Returns the Timestamp

2.1.15 - com.vertica.sdk.Basics Member List

This is the complete list of members for com.vertica.sdk.Basics, including all inherited members.

DataAreaHeaderLen (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
getNumericPrecision(int typmod) com.vertica.sdk.Basics static
getNumericScale(int typmod) com.vertica.sdk.Basics static
getNumericWordCount(int precision) com.vertica.sdk.Basics static
isSimilarNumericTypmod(int a, int b) com.vertica.sdk.Basics static
JavaSQLDateToVerticaDate(java.sql.Date d) com.vertica.sdk.Basics static
JavaSQLTimestampToVerticaTimestamp(java.sql.Timestamp ts) (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
maxTimestampPricision (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
StringValueHeaderLen (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
StringValueLenOffset (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
StringValueLocOffset (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
TimestampInfiniteNeg (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
TimestampInfinitePos (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
vbool_false (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
vbool_null (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
vbool_true (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
VerticaDateToJavaSQLDate(long num_days) com.vertica.sdk.Basics static
VerticaTimestampToJavaSQLTimestamp(long vts) com.vertica.sdk.Basics static
vfloat_null_long_bits (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static
vint_null (defined in com.vertica.sdk.Basics) com.vertica.sdk.Basics static

2.1.16 - com.vertica.sdk.BlockReader Class Reference

Inheritance diagram for com.vertica.sdk.BlockReader:

Collaboration diagram for com.vertica.sdk.BlockReader:

Public Member Functions
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
boolean getBoolean (int idx)
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
java.sql.Date getDate (int idx)
double getDouble (int idx)
long getLong (int idx)
int getNumCols ()
int getNumRows ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
String getString (int idx)
int getStringLength (int idx)
int getStringLoc (int idx)
java.sql.Timestamp getTimestamp (int idx)
SizedColumnTypes getTypeMetaData ()
VNumeric getVNumeric (int idx)
VString getVString (int idx)
boolean isBooleanNull (int idx)
boolean isDateNull (int idx)
boolean isDoubleNull (int idx)
boolean isLongNull (int idx)
boolean isStringNull (int idx)
boolean isTimestampInfinite (int idx)
boolean isTimestampInfiniteNeg (int idx)
boolean isTimestampInfinitePos (int idx)
boolean isTimestampNull (int idx)
boolean next () throws UdfException, DestroyInvocation
void resetBuffers ()
Public Attributes
int count
int index
int ncols
int nrows
SizedColumnTypes typeMetaData
Protected Member Functions
BlockReader (int _ncols, int _rowcount)
void clear ()
ByteBuffer getInlineColBuffer (int idx)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos

Detailed Description

Iterator interface for reading rows in a Vertica block.

This class provides the input to the ScalarFunction.processBlock() function. You extract values from the input row using data type specific functions to extract each column value. You can also determine the number of columns and their data types, if your processBlock function does not have hard-coded input expectations.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
boolean com.vertica.sdk.BlockReader.getBoolean(int idx)

Get a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a BOOLEAN.

ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

java.sql.Date com.vertica.sdk.BlockReader.getDate(int idx)

Get a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DATE; null if the column is NULL.

double com.vertica.sdk.BlockReader.getDouble(int idx)

Get a DOUBLE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DOUBLE.

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

long com.vertica.sdk.BlockReader.getLong(int idx)

Get a LONG INTEGER value from the input row.

Example

long a = arg_reader.getLong(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a LONG INTEGER.

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

String com.vertica.sdk.BlockReader.getString(int idx)

Get a reference to an VARCHAR/CHAR/VARBINARY/BINARY value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an String.

int com.vertica.sdk.BlockReader.getStringLength(int idx)

Get length of the String from the input row

Parameters

  • idx: The column number to retrieve from the input row.

Returns The length of the String in specified column.

Referenced by

int com.vertica.sdk.BlockReader.getStringLoc(int idx)

Get 'location' of the String from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The location of the String in specified column. If zero, data is inlined immediately after the header, otherwise data is at offset loc within the data area.

Referenced by com.vertica.sdk.BlockReader.getVString().

java.sql.Timestamp com.vertica.sdk.BlockReader.getTimestamp(int idx)

Get a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a TIMESTAMP; null if the column is NULL or represents 'infinity'.

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

VNumeric com.vertica.sdk.BlockReader.getVNumeric(int idx)

Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the retrieved value cast as a Numeric.

VString com.vertica.sdk.BlockReader.getVString(int idx)

Get a reference from the input row to an VString value, which represents a SQL VARCHAR/CHAR/VARBINARY/BINARY value.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isBooleanNull(int idx)

Check whether a value from the input row is NULL in BOOLEAN type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.BlockReader.isDateNull(int idx)

Check whether a value from the input row is NULL in DATE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getDate().

boolean com.vertica.sdk.BlockReader.isDoubleNull(int idx)

Check whether a value from the input row is NULL in DOUBLE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.BlockReader.isLongNull(int idx)

Check whether a value from the input row is NULL in LONG INTERGER type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by

boolean com.vertica.sdk.BlockReader.isStringNull(int idx)

Check whether a value from the input row is NULL in SQL VARCHAR/CHAR/VARBINARY/BINARY type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isTimestampInfinite(int idx)

Check whether a TIMESTAMP value from the input row represents 'infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity' or '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.isTimestampInfiniteNeg(int idx)

Check whether a TIMESTAMP value from the input row represents '-infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampInfinitePos(int idx)

Check whether a TIMESTAMP value from the input row represents '+infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampNull(int idx)

Check whether a value from the input row is NULL in TIMESTAMP type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.next() throws UdfException, DestroyInvocation

Advance to the next record.

Returns true if there are more rows to read, false otherwise.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: Invocation needed to be destroyed

2.1.17 - com.vertica.sdk.BlockReader Member List

This is the complete list of members for com.vertica.sdk.BlockReader, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
BlockReader() (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader
BlockReader(int _ncols, int _rowcount) (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader protected
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getBoolean(int idx) com.vertica.sdk.BlockReader
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getDate(int idx) com.vertica.sdk.BlockReader
getDouble(int idx) com.vertica.sdk.BlockReader
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getLong(int idx) com.vertica.sdk.BlockReader
getNumCols() com.vertica.sdk.VerticaBlock
getNumRows() com.vertica.sdk.VerticaBlock
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getString(int idx) com.vertica.sdk.BlockReader
getStringLength(int idx) com.vertica.sdk.BlockReader
getStringLoc(int idx) com.vertica.sdk.BlockReader
getTimestamp(int idx) com.vertica.sdk.BlockReader
getTypeMetaData() com.vertica.sdk.VerticaBlock
getVNumeric(int idx) com.vertica.sdk.BlockReader
getVString(int idx) com.vertica.sdk.BlockReader
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
isBooleanNull(int idx) com.vertica.sdk.BlockReader
isDateNull(int idx) com.vertica.sdk.BlockReader
isDoubleNull(int idx) com.vertica.sdk.BlockReader
isLongNull(int idx) com.vertica.sdk.BlockReader
isStringNull(int idx) com.vertica.sdk.BlockReader
isTimestampInfinite(int idx) com.vertica.sdk.BlockReader
isTimestampInfiniteNeg(int idx) com.vertica.sdk.BlockReader
isTimestampInfinitePos(int idx) com.vertica.sdk.BlockReader
isTimestampNull(int idx) com.vertica.sdk.BlockReader
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
next() com.vertica.sdk.BlockReader
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.18 - com.vertica.sdk.BlockWriter Class Reference

Inheritance diagram for com.vertica.sdk.BlockWriter:

Collaboration diagram for com.vertica.sdk.BlockWriter:

Public Member Functions
BlockWriter (int rowcount, VerticaType returnType)
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
int getNumCols ()
int getNumRows ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
SizedColumnTypes getTypeMetaData ()
VString getVStringWriter ()
Allocates a new VString object to use as output.
void next ()
Complete writing this row of output and move to the next row.
void resetBuffers ()
void setBoolean (boolean r)
Adds a BOOLEAN value to the output row.
void setBooleanNull ()
Adds NULL as a BOOLEAN value to the output row.
void setDate (java.sql.Date r)
Adds a DATE value to the output row.
void setDateNull ()
Adds NULL as a DATE value to the output row.
void setDouble (double r)
Adds a DOUBLE value to the output row.
void setDoubleNull ()
Adds NULL as a DOUBLE value to the output row.
void setLong (long r)
Adds a LONG INTEGER value to the output row.
void setLongNull ()
Adds NULL as a LONG INTEGER value to the output row.
void setNumeric (BigDecimal bd)
Allocate a new VNumeric object to use as output.
void setNumericNull ()
void setString (String r)
Adds a String value to the output row.
void setStringNull ()
Adds NULL as a String value to the output row.
void setTimestamp (java.sql.Timestamp r)
Adds a TIMESTAMP value to the output row.
void setTimestampInfiniteNeg ()
Adds a '-infinity' TIMESTAMP value to the output row.
void setTimestampInfinitePos ()
Adds a '+infinity' TIMESTAMP value to the output row.
void setTimestampNull ()
Adds NULL as a TIMESTAMP value to the output row.
void throwInCorrectUsageError ()
: Throwing UdfException for incorrect setter usage
Public Attributes
int count
int index
int ncols
int nrows
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos

Detailed Description

Iterator interface for writing rows to a Vertica block

This class provides the output rows that ScalarFunction.processBlock() writes to.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

VString com.vertica.sdk.BlockWriter.getVStringWriter()

Allocates a new VString object to use as output.

Returns A new VString object to hold output. This object automatically added to the output row.

void com.vertica.sdk.BlockWriter.next()

Complete writing this row of output and move to the next row.

void com.vertica.sdk.BlockWriter.setBoolean(boolean r)

Adds a BOOLEAN value to the output row.

Parameters

  • r: The BOOLEAN value to insert into the output row.
void com.vertica.sdk.BlockWriter.setDate(java.sql.Date r)

Adds a DATE value to the output row.

Parameters

  • r: The DATE value to insert into the output row.
void com.vertica.sdk.BlockWriter.setDouble(double r)

Adds a DOUBLE value to the output row.

Parameters

  • r: The DOUBLE value to insert into the output row.
void com.vertica.sdk.BlockWriter.setLong(long r)

Adds a LONG INTEGER value to the output row.

Parameters

  • r: The LONG INTEGER value to insert into the output row.
void com.vertica.sdk.BlockWriter.setNumeric(BigDecimal bd)

Allocate a new VNumeric object to use as output.

Returns A new VNumeric object to hold output. This object automatically added to the output row.

void com.vertica.sdk.BlockWriter.setString(String r)

Adds a String value to the output row.

Parameters

  • r: The String value to insert into the output row.
void com.vertica.sdk.BlockWriter.setTimestamp(java.sql.Timestamp r)

Adds a TIMESTAMP value to the output row.

Parameters

  • r: The TIMESTAMP value to insert into the output row.

2.1.19 - com.vertica.sdk.BlockWriter Member List

This is the complete list of members for com.vertica.sdk.BlockWriter, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
BlockWriter(int rowcount, VerticaType returnType) (defined in com.vertica.sdk.BlockWriter) com.vertica.sdk.BlockWriter
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getNumCols() com.vertica.sdk.VerticaBlock
getNumRows() com.vertica.sdk.VerticaBlock
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getTypeMetaData() com.vertica.sdk.VerticaBlock
getVStringWriter() com.vertica.sdk.BlockWriter
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
next() com.vertica.sdk.BlockWriter
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
setBoolean(boolean r) com.vertica.sdk.BlockWriter
setBooleanNull() com.vertica.sdk.BlockWriter
setDate(java.sql.Date r) com.vertica.sdk.BlockWriter
setDateNull() com.vertica.sdk.BlockWriter
setDouble(double r) com.vertica.sdk.BlockWriter
setDoubleNull() com.vertica.sdk.BlockWriter
setLong(long r) com.vertica.sdk.BlockWriter
setLongNull() com.vertica.sdk.BlockWriter
setNumeric(BigDecimal bd) com.vertica.sdk.BlockWriter
setNumericNull() (defined in com.vertica.sdk.BlockWriter) com.vertica.sdk.BlockWriter
setString(String r) com.vertica.sdk.BlockWriter
setStringNull() com.vertica.sdk.BlockWriter
setTimestamp(java.sql.Timestamp r) com.vertica.sdk.BlockWriter
setTimestampInfiniteNeg() com.vertica.sdk.BlockWriter
setTimestampInfinitePos() com.vertica.sdk.BlockWriter
setTimestampNull() com.vertica.sdk.BlockWriter
throwInCorrectUsageError() com.vertica.sdk.BlockWriter
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.20 - com.vertica.sdk.BuildInfo Class Reference

Collaboration diagram for com.vertica.sdk.BuildInfo:

Static Public Member Functions
static VerticaBuildInfo get_vertica_build_info ()
static long VERTICA_BUILD_ID_SDK_Version_as_int (int major, int minor, int sp, int hotfix)
static Boolean VERTICA_BUILD_ID_SDK_Version_at_least (int major, int minor, int sp, int hotfix)
Static Public Attributes
static final String VERTICA_BUILD_ID_Branch = ""
static final String VERTICA_BUILD_ID_Brand_Name = "Vertica Analytic Database"
static final String VERTICA_BUILD_ID_Brand_Version = "v12.0.1"
static final String VERTICA_BUILD_ID_Checksum = "adbe7a50176c695fbbaa54b75cb349ff"
static final String VERTICA_BUILD_ID_Codename = "Knuckleboom"
static final String VERTICA_BUILD_ID_Date = "Thu Jun 9 05:40:54 2022"
static final String VERTICA_BUILD_ID_Machine = "5699b4e3341f"
static final String VERTICA_BUILD_ID_Revision = "ca9522dd9836db35c18fb44568b8af7d70045698"
static final String VERTICA_BUILD_ID_SDK_Version = "12.0.0"
static final int VERTICA_BUILD_ID_SDK_Version_Hotfix = 0
static final long VERTICA_BUILD_ID_SDK_Version_Int = VERTICA_BUILD_ID_SDK_Version_as_int(VERTICA_BUILD_ID_SDK_Version_Major, VERTICA_BUILD_ID_SDK_Version_Minor, VERTICA_BUILD_ID_SDK_Version_SP, VERTICA_BUILD_ID_SDK_Version_Hotfix)
static final int VERTICA_BUILD_ID_SDK_Version_Major = 12
static final int VERTICA_BUILD_ID_SDK_Version_Minor = 0
static final int VERTICA_BUILD_ID_SDK_Version_SP = 0

2.1.21 - com.vertica.sdk.BuildInfo Member List

This is the complete list of members for com.vertica.sdk.BuildInfo, including all inherited members.

get_vertica_build_info() (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_Branch (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_Brand_Name (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_Brand_Version (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_Checksum (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_Codename (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_Date (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_Machine (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_Revision (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_SDK_Version (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_SDK_Version_as_int(int major, int minor, int sp, int hotfix) (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_SDK_Version_at_least(int major, int minor, int sp, int hotfix) (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_SDK_Version_Hotfix (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_SDK_Version_Int (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_SDK_Version_Major (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_SDK_Version_Minor (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static
VERTICA_BUILD_ID_SDK_Version_SP (defined in com.vertica.sdk.BuildInfo) com.vertica.sdk.BuildInfo static

2.1.22 - com.vertica.sdk.ColumnTypes Class Reference

Collaboration diagram for com.vertica.sdk.ColumnTypes:

Public Member Functions
void addAny ()
Indicates that function can take any number and type of arguments.
void addBinary ()
Adds a column of type BINARY.
void addBool ()
Adds a column of type BOOLEAN.
void addChar ()
Adds a column of type CHAR.
void addDate ()
Adds a column of type DATE.
void addFloat ()
Adds a column of type FLOAT.
void addInt ()
Adds a column of type INTEGER.
void addInterval ()
Adds a column of type INTERVAL/INTERVAL DAY TO SECOND.
void addIntervalYM ()
Adds a column of type INTERVAL YEAR TO MONTH.
void addLongVarbinary ()
Adds a column of type LONGVARBINARY.
void addLongVarchar ()
Adds a column of type LONGVARCHAR.
void addNumeric ()
Adds a column of type NUMERIC.
void addTime ()
Adds a column of type TIME.
void addTimestamp ()
Adds a column of type TIMESTAMP.
void addTimestampTz ()
Adds a column of type TIMESTAMP WITH TIMEZONE.
void addTimeTz ()
Adds a column of type TIME WITH TIMEZONE.
void addVarbinary ()
Adds a column of type VARBINARY.
void addVarchar ()
Adds a column of type VARCHAR.

Detailed Description

Represents (unsized) types of the columns used as input/output of a User Defined Function/Transform Function.

This class is used only for generating the function or transform function prototype, where the sizes and/or precisions of the data types are not known.

2.1.23 - com.vertica.sdk.ColumnTypes Member List

This is the complete list of members for com.vertica.sdk.ColumnTypes, including all inherited members.

addAny() com.vertica.sdk.ColumnTypes
addBinary() com.vertica.sdk.ColumnTypes
addBool() com.vertica.sdk.ColumnTypes
addChar() com.vertica.sdk.ColumnTypes
addDate() com.vertica.sdk.ColumnTypes
addFloat() com.vertica.sdk.ColumnTypes
addInt() com.vertica.sdk.ColumnTypes
addInterval() com.vertica.sdk.ColumnTypes
addIntervalYM() com.vertica.sdk.ColumnTypes
addLongVarbinary() com.vertica.sdk.ColumnTypes
addLongVarchar() com.vertica.sdk.ColumnTypes
addNumeric() com.vertica.sdk.ColumnTypes
addTime() com.vertica.sdk.ColumnTypes
addTimestamp() com.vertica.sdk.ColumnTypes
addTimestampTz() com.vertica.sdk.ColumnTypes
addTimeTz() com.vertica.sdk.ColumnTypes
addVarbinary() com.vertica.sdk.ColumnTypes
addVarchar() com.vertica.sdk.ColumnTypes

2.1.24 - com.vertica.sdk.ContinuousReader Class Reference

Inheritance diagram for com.vertica.sdk.ContinuousReader:

Collaboration diagram for com.vertica.sdk.ContinuousReader:

Public Member Functions
ContinuousReader (ContinuousUDParserLocks continuousUDParserLocks)
int capacity ()
int getBytesConsumed ()
CoroutineState getCs ()
DataBuffer getCurrentBuffer ()
byte getDataAt (int pos)
int getLastReservationSize ()
int getPrev_reserved ()
InputState getState ()
boolean isEOF ()
boolean isNeedInput ()
boolean noMoreData ()
byte[] read (int n)
int reserve (int size) throws UdfException
int seek (int distance) throws UdfException
void setCs (CoroutineState cs)
void setCurrentBuffer (DataBuffer currentBuffer)
void setLastReservationSize (int lastReservationSize)
void setNeedInput (boolean needInput)
void setPrev_reserved (int prev_reserved)
void setState (InputState state)

Detailed Description

ContinuousReader intended for reading data

Member Function Documentation

int com.vertica.sdk.ContinuousStreamer.capacity()

inherited Returns Number of bytes reserved

int com.vertica.sdk.ContinuousStreamer.getBytesConsumed()

inherited Returns returns the number of bytes consumed so far by the ContinuousStreamer.

CoroutineState com.vertica.sdk.ContinuousStreamer.getCs()

inherited Returns returns the Co-routine state.

DataBuffer com.vertica.sdk.ContinuousStreamer.getCurrentBuffer()

inherited Returns Returns current Buffer of the ContinuousStreamer.

byte com.vertica.sdk.ContinuousStreamer.getDataAt(int pos)

inherited Parameters

  • pos: - the position at which data needs to be retrieved.

Returns Returns the byte to the start of a buffer containing the next N bytes of the input stream, where n is equal to value returned by last call to reserve()

int com.vertica.sdk.ContinuousStreamer.getLastReservationSize()

inherited Returns Returns the Last reservation size of the ContinuousStreamer.

int com.vertica.sdk.ContinuousStreamer.getPrev_reserved()

inherited Returns returns the previous reservation size.

InputState com.vertica.sdk.ContinuousStreamer.getState()

inherited Returns Returns the Input State of ContinuousStreamer.

boolean com.vertica.sdk.ContinuousStreamer.isEOF()

inherited Returns true iff we have reached the end of input stream and no data can be reserved

boolean com.vertica.sdk.ContinuousStreamer.isNeedInput()

inherited Returns boolean flag to indicate whether more input is needed or not.

boolean com.vertica.sdk.ContinuousStreamer.noMoreData()

inherited Returns true iff no more data can be reserved. The current reservation can still be valid and of nonZero size

byte [] com.vertica.sdk.ContinuousReader.read(int n)

Reads upto 'n' bytes from the input stream, and copies them to a byte buffer.

A wrapper on top of reserve() and seek().

Note Read is incompatible with row rejection at this time because the row to be rejected is no longer available to Vertica once it has been seek()'ed past. See reserve()/seek() API for an alternative that doesn't have this limitation.

Parameters

  • n: integer representing number of bytes to read.

Returns byte array containing the bytes read.

int com.vertica.sdk.ContinuousStreamer.reserve(int size) throws UdfException

inherited Parameters

  • size: integer indicating number of bytes to reserve. if size is less than or equal to capacity(), this call has no effect. Otherwise, it is a request to allocate more memory.

Returns Returns size if at least 'size' bytes could be reserved, or some value smaller than 'size', indicating how many bytes were successfully reserved, if end_of_file was reached and fewer than 'size' bytes are available. check capacity to see how many bytes were reserved.

int com.vertica.sdk.ContinuousStreamer.seek(int distance) throws UdfException

inherited Seek forward in the input stream.

Attempt to seek forward 'distance' bytes. If this is successful then return 'distance'

if this is unsuccessful due to reaching the end of the input stream, return a value less than'distance' thant is equal to the number of bytes that have been consumed.

Calling seek() invalidates any reserved data; to guarantee that data is still available, it is necessary to call reserve() immediately after calling seek().

Parameters

  • distance: an integer indicating position to seek forward.

Returns the actual distance the Streamer could seek

void com.vertica.sdk.ContinuousStreamer.setCs(CoroutineState cs)

inherited Parameters

  • cs: used to set the Co-routine state
void com.vertica.sdk.ContinuousStreamer.setCurrentBuffer(DataBuffer currentBuffer)

inherited Parameters

  • currentBuffer: used to set the currentBuffer of the ContinuousStreamer.
void com.vertica.sdk.ContinuousStreamer.setLastReservationSize(int lastReservationSize)

inherited Parameters

  • lastReservationSize: Used to set the lastReservationSize of the ContinuousStreamer
void com.vertica.sdk.ContinuousStreamer.setNeedInput(boolean needInput)

inherited Parameters

  • needInput: used to set the needInput flag of ContinuousStreamer.
void com.vertica.sdk.ContinuousStreamer.setPrev_reserved(int prev_reserved)

inherited Parameters

  • prev_reserved: used to set the previous reservation size.
void com.vertica.sdk.ContinuousStreamer.setState(InputState state)

inherited Parameters

  • state: used to set the InputState of ContinuousStreamer.

2.1.25 - com.vertica.sdk.ContinuousReader Member List

This is the complete list of members for com.vertica.sdk.ContinuousReader, including all inherited members.

capacity() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
ContinuousReader(ContinuousUDParserLocks continuousUDParserLocks) (defined in com.vertica.sdk.ContinuousReader) com.vertica.sdk.ContinuousReader
ContinuousStreamer(ContinuousUDParserLocks continuousUDParserLocks) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
getBytesConsumed() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
getCs() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
getCurrentBuffer() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
getDataAt(int pos) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
getLastReservationSize() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
getPrev_reserved() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
getState() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
isEOF() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
isNeedInput() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
noMoreData() (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
read(int n) com.vertica.sdk.ContinuousReader
reserve(int size) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
seek(int distance) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
setCs(CoroutineState cs) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
setCurrentBuffer(DataBuffer currentBuffer) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
setLastReservationSize(int lastReservationSize) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
setNeedInput(boolean needInput) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
setPrev_reserved(int prev_reserved) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer
setState(InputState state) (defined in com.vertica.sdk.ContinuousStreamer) com.vertica.sdk.ContinuousStreamer

2.1.26 - com.vertica.sdk.ContinuousRejecter Class Reference

Collaboration diagram for com.vertica.sdk.ContinuousRejecter:

Public Member Functions
ContinuousRejecter (ContinuousUDParserLocks continuousUDParserLocks)
void reject (RejectedRecord rr) throws UdfException
Protected Attributes
boolean haveRejectedRecord
RejectedRecord rejectedRecord

Constructor & Destructor Documentation

com.vertica.sdk.ContinuousRejecter.ContinuousRejecter(ContinuousUDParserLocks continuousUDParserLocks)

Default Constructor

Parameters

  • continuousUDParserLocks: the locks

Member Function Documentation

void com.vertica.sdk.ContinuousRejecter.reject(RejectedRecord rr) throws UdfException

Request that Vertica process the current raw data as a rejected row. Emit the rejected record via the rejected-rows mechanism specified in the COPY statement, with error message specified by 'reason', and delimited by the record terminator specified by 'recordTerminator'.

Parameters

  • rr: a RejectedRecord object

2.1.27 - com.vertica.sdk.ContinuousRejecter Member List

This is the complete list of members for com.vertica.sdk.ContinuousRejecter, including all inherited members.

ContinuousRejecter(ContinuousUDParserLocks continuousUDParserLocks) com.vertica.sdk.ContinuousRejecter
haveRejectedRecord (defined in com.vertica.sdk.ContinuousRejecter) com.vertica.sdk.ContinuousRejecter protected
reject(RejectedRecord rr) com.vertica.sdk.ContinuousRejecter
rejectedRecord (defined in com.vertica.sdk.ContinuousRejecter) com.vertica.sdk.ContinuousRejecter protected

2.1.28 - com.vertica.sdk.ContinuousUDParser Class Reference

Inheritance diagram for com.vertica.sdk.ContinuousUDParser:

Collaboration diagram for com.vertica.sdk.ContinuousUDParser:

Classes
enum CoroutineState
Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
void deinitialize (ServerInterface srvInterface, SizedColumnTypes returnType)
final void destroy (ServerInterface srvInterface, SizedColumnTypes returnTypes)
void destroy (ServerInterface srvInterface, SizedColumnTypes returnType, SessionParamWriterMap udSessionParams) throws UdfException
ContinuousReader getContinuousReader ()
ContinuousRejecter getContinuousRejector ()
int getRecordsAcceptedInBatch ()
RejectedRecord getRejectedRecord ()
boolean getSeenEOB ()
ServerInterface getServerInterface ()
StreamWriter getStreamWriter ()
void increRecordsAcceptedInBatch ()
void initialize (ServerInterface srvInterface, SizedColumnTypes returnType)
boolean isCanceled ()
final StreamState process (ServerInterface srvInterface, DataBuffer input, InputState input_state) throws UdfException,DestroyInvocation
abstract void run () throws UdfException
void setRecordsAcceptedInBatch (int i)
void setSeenEOB (Boolean b)
void setStreamWriter (StreamWriter writer)
final void setup (ServerInterface srvInterface, SizedColumnTypes returnTypes) throws UdfException
Protected Member Functions
void cancel (ServerInterface srvInterface)
Protected Attributes
int recordsAcceptedInBatch
boolean seen_eob
StreamWriter writer

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
void com.vertica.sdk.ContinuousUDParser.deinitialize(ServerInterface srvInterface, SizedColumnTypes returnType)

May optionally be overridden

Will be invoked during query execution, after run() has returned.

Parameters

  • srvInterface: a ServerInterface object.
  • returnType: a SizedColumnTypes object.

Referenced by com.vertica.sdk.ContinuousUDParser.destroy().

final void com.vertica.sdk.ContinuousUDParser.destroy(ServerInterface srvInterface, SizedColumnTypes returnTypes)

De-initialization to be done for ContinuousUDParser.

Note Internally implemented for ContinuousUDParser. Do not override.

Parameters

  • srvInterface: a ServerInterface object.
  • returnTypes: a SizedColumnTypes object.
ContinuousReader com.vertica.sdk.ContinuousUDParser.getContinuousReader()

Returns returns ContinuousReader object of the ContinuousUDParser.

ContinuousRejecter com.vertica.sdk.ContinuousUDParser.getContinuousRejector()

Returns returns ContinuousRejector object of the ContinuousUDParser.

RejectedRecord com.vertica.sdk.ContinuousUDParser.getRejectedRecord()

Returns Returns information about the Rejected Record

ServerInterface com.vertica.sdk.ContinuousUDParser.getServerInterface()

Returns returns ServerInterface object of the ContinuousUDParser.

void com.vertica.sdk.ContinuousUDParser.initialize(ServerInterface srvInterface, SizedColumnTypes returnType)

May optionally be overridden

Will be invoked during query execution, prior to run() being called.
**Parameters:** `srvInterface` - a ServerInterface object.

Parameters

  • returnType: a SizedColumnTypes object.

Referenced by com.vertica.sdk.ContinuousUDParser.setup().

boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final StreamState com.vertica.sdk.ContinuousUDParser.process(ServerInterface srvInterface, DataBuffer input, InputState input_state) throws UdfException,DestroyInvocation

virtual

Override the built-in process() method with internal logic for ContinuousUDParser. Abstract away the state-machine interface by stuffing run() into a coroutine. Whenever run() wants more data than we have right now, context-switch out of the coroutine and back into process(), and go get whatever run() needs.

Note Internally implemented for ContinuousUDParser. Do not override.

Parameters

  • srvInterface: a ServerInterface Object
  • input: a DataBuffer object.
  • input_state: an InputState object.

Implements com.vertica.sdk.UDParser.

abstract void com.vertica.sdk.ContinuousUDParser.run() throws UdfException

pure virtual Method exposed to user to write their custom code

User-implemented method that processes data. Called exactly once per ContinuousUDParser instance. It should read data using the reserve() and seek() (or read()) methods, and write data using the standard UDParser StreamWriter. It should return once it has either finished processing the input stream, or it (for whatever reason) wants to close the input stream and not process any further data.

run() should be very careful about keeping pointers or references to internal values returned by methods on the ContinuousUDParser class. Unless documentation explicitly indicates that it is safe to do so, it is not safe to keep such pointers or references, even for objects (such as the server interface) that one might otherwise expect to be persistent. Instead, call the accessor function for each use.

final void com.vertica.sdk.ContinuousUDParser.setup(ServerInterface srvInterface, SizedColumnTypes returnTypes) throws UdfException

Initialization to be done for ContinuousUDParser.

Note Internally implemented for ContinuousUDParser. Do not override.

Parameters

  • srvInterface: a ServerInterface object.
  • returnTypes: a SizedColumnTypes object.

Member Data Documentation

StreamWriter com.vertica.sdk.UDParser.writer

protected inherited Writer to write parsed tuples to. Has the same API as PartitionWriter, from the UDT framework.

2.1.29 - com.vertica.sdk.ContinuousUDParser Member List

This is the complete list of members for com.vertica.sdk.ContinuousUDParser, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
deinitialize(ServerInterface srvInterface, SizedColumnTypes returnType) com.vertica.sdk.ContinuousUDParser
destroy(ServerInterface srvInterface, SizedColumnTypes returnTypes) com.vertica.sdk.ContinuousUDParser
destroy(ServerInterface srvInterface, SizedColumnTypes returnType, SessionParamWriterMap udSessionParams) (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
getContinuousReader() com.vertica.sdk.ContinuousUDParser
getContinuousRejector() com.vertica.sdk.ContinuousUDParser
getRecordsAcceptedInBatch() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
getRejectedRecord() com.vertica.sdk.ContinuousUDParser
getSeenEOB() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
getServerInterface() com.vertica.sdk.ContinuousUDParser
getStreamWriter() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
increRecordsAcceptedInBatch() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
initialize(ServerInterface srvInterface, SizedColumnTypes returnType) com.vertica.sdk.ContinuousUDParser
isCanceled() com.vertica.sdk.UDXObject
process(ServerInterface srvInterface, DataBuffer input, InputState input_state) com.vertica.sdk.ContinuousUDParser virtual
recordsAcceptedInBatch (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser protected
run() com.vertica.sdk.ContinuousUDParser pure virtual
seen_eob (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser protected
setRecordsAcceptedInBatch(int i) (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
setSeenEOB(Boolean b) (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
setStreamWriter(StreamWriter writer) (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
setup(ServerInterface srvInterface, SizedColumnTypes returnTypes) com.vertica.sdk.ContinuousUDParser
UDParser() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject
writer com.vertica.sdk.UDParser protected

2.1.30 - com.vertica.sdk.ContinuousUDParser.CoroutineState Enum Reference

Collaboration diagram for com.vertica.sdk.ContinuousUDParser.CoroutineState:

Public Member Functions
int getCode ()
Public Attributes
CLOSED =(3)
FINISHED =(2)
NOT_INITIALIZED =(0)
REPORT_ERROR =(4)
RUN_START =(1)

Detailed Description

Internal state of Coroutine context

2.1.31 - com.vertica.sdk.ContinuousUDParser.CoroutineState Member List

This is the complete list of members for com.vertica.sdk.ContinuousUDParser.CoroutineState, including all inherited members.

CLOSED (defined in com.vertica.sdk.ContinuousUDParser.CoroutineState) com.vertica.sdk.ContinuousUDParser.CoroutineState
FINISHED (defined in com.vertica.sdk.ContinuousUDParser.CoroutineState) com.vertica.sdk.ContinuousUDParser.CoroutineState
getCode() (defined in com.vertica.sdk.ContinuousUDParser.CoroutineState) com.vertica.sdk.ContinuousUDParser.CoroutineState
NOT_INITIALIZED (defined in com.vertica.sdk.ContinuousUDParser.CoroutineState) com.vertica.sdk.ContinuousUDParser.CoroutineState
REPORT_ERROR (defined in com.vertica.sdk.ContinuousUDParser.CoroutineState) com.vertica.sdk.ContinuousUDParser.CoroutineState
RUN_START (defined in com.vertica.sdk.ContinuousUDParser.CoroutineState) com.vertica.sdk.ContinuousUDParser.CoroutineState

2.1.32 - com.vertica.sdk.DataBuffer Class Reference

Collaboration diagram for com.vertica.sdk.DataBuffer:

Public Attributes
byte[] buf
int offset

Detailed Description

DataBuffer is a a contiguous in-memory buffer of data.

Member Data Documentation

byte [] com.vertica.sdk.DataBuffer.buf

The buffer of data.

int com.vertica.sdk.DataBuffer.offset

An offset into the buffer that is typically used to track progress through the DataBuffer. For example, a UDParser advances the offset as it consumes data from the DataBuffer.

2.1.33 - com.vertica.sdk.DataBuffer Member List

This is the complete list of members for com.vertica.sdk.DataBuffer, including all inherited members.

buf com.vertica.sdk.DataBuffer
offset com.vertica.sdk.DataBuffer

2.1.34 - com.vertica.sdk.DefaultSourceIterator Class Reference

Inheritance diagram for com.vertica.sdk.DefaultSourceIterator:

Collaboration diagram for com.vertica.sdk.DefaultSourceIterator:

Public Member Functions
DefaultSourceIterator (ArrayList sources)
final void cancelUDX (ServerInterface srvInterface)
UnsizedUDSource createNextSource (ServerInterface srvInterface)
void destroy (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
int getNumberOfSources ()
Integer getSizeOfSource (int sourceNum)
boolean isCanceled ()
void setup (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
Protected Member Functions
void cancel (ServerInterface srvInterface)

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
UnsizedUDSource com.vertica.sdk.DefaultSourceIterator.createNextSource(ServerInterface srvInterface)

virtual

Create the next UDSource to process.

Should return NULL if no further sources are available for processing.

Note that the previous Source may still be open and in use on a different thread when this function is called.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Returns a new Source instance corresponding to a new input stream

Exceptions

  • UdfException: UDF problem

Implements com.vertica.sdk.SourceIterator.

void com.vertica.sdk.SourceIterator.destroy(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

inherited Tear down this SourceIterator

Should perform clean-up

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • planCtxt: a plan context

Exceptions

  • UdfException: UDF problem
int com.vertica.sdk.DefaultSourceIterator.getNumberOfSources()

virtual

Returns the total number of Sources that this factory will produce

Exceptions

  • UdfException: UDF problem

Implements com.vertica.sdk.SourceIterator.

boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

void com.vertica.sdk.SourceIterator.setup(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

inherited Set up this SourceIterator

Should perform setup that should not take place in the constructor due to the exception-handling semantics of constructors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • planCtxt: a plan context

Exceptions

  • UdfException: UDF problem

2.1.35 - com.vertica.sdk.DefaultSourceIterator Member List

This is the complete list of members for com.vertica.sdk.DefaultSourceIterator, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
createNextSource(ServerInterface srvInterface) com.vertica.sdk.DefaultSourceIterator virtual
DefaultSourceIterator(ArrayList sources) (defined in com.vertica.sdk.DefaultSourceIterator) com.vertica.sdk.DefaultSourceIterator
destroy(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) com.vertica.sdk.SourceIterator
getNumberOfSources() com.vertica.sdk.DefaultSourceIterator virtual
getSizeOfSource(int sourceNum) (defined in com.vertica.sdk.DefaultSourceIterator) com.vertica.sdk.DefaultSourceIterator
isCanceled() com.vertica.sdk.UDXObject
setup(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) com.vertica.sdk.SourceIterator
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.36 - com.vertica.sdk.DestroyInvocation Class Reference

Inheritance diagram for com.vertica.sdk.DestroyInvocation:

Collaboration diagram for com.vertica.sdk.DestroyInvocation:

Detailed Description

Used to support canceling UDx and invoking the UDx's destroy call back function. This exception is thrown when Vertica needs to cancel the running UDx to jump out of current control flow

For UDx to work properly, please do not catch and handle this exception

2.1.37 - com.vertica.sdk.DFSConstants Class Reference

Collaboration diagram for com.vertica.sdk.DFSConstants:

Static Public Attributes
static final String CLOSE_FLAG = "isCloseInProcess"
static final String DIRECTORY = "is_directory"
static final String EXCEPTION_IN_PROCESS_FLAG = "isThrowErrorInProcess"
static final String FILE_PATH = "file_path"
static final String LIST_DIR = "is_list_dir"
static final String MODEL_NAME = "model_name"
static final String OPEN_FLAG = "isBeforeProcess"
static final String OVERWRITE = "is_overwrite"
static final String PARENT_OBJECT_TYPE = "parentObjectType"
static final int SEEK_CUR = 1
static final int SEEK_END = 2
static final int SEEK_SET = 0
static final String SLEEP_SECONDS = "sleep_seconds"
static final String UNIQUE_NAME = "is_unique_name"

2.1.38 - com.vertica.sdk.DFSConstants Member List

This is the complete list of members for com.vertica.sdk.DFSConstants, including all inherited members.

CLOSE_FLAG (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
DIRECTORY (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
EXCEPTION_IN_PROCESS_FLAG (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
FILE_PATH (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
LIST_DIR (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
MODEL_NAME (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
OPEN_FLAG (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
OVERWRITE (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
PARENT_OBJECT_TYPE (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
SEEK_CUR (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
SEEK_END (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
SEEK_SET (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
SLEEP_SECONDS (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static
UNIQUE_NAME (defined in com.vertica.sdk.DFSConstants) com.vertica.sdk.DFSConstants static

2.1.39 - com.vertica.sdk.DFSFile Class Reference

Collaboration diagram for com.vertica.sdk.DFSFile:

Classes
enum DFSDistribution
enum DFSRootParentType
enum DFSScope
Public Member Functions
DFSFile ()
DFSFile (ServerInterface srvInterface)
DFSFile (ServerInterface srvInterface, String fName) throws UdfException, DestroyInvocation
DFSFile (ServerInterface srvInterface, String fName, DFSRootParentType parentType, String parentName) throws UdfException, DestroyInvocation
DFSFile (String fName, FileManager fmgr) throws UdfException, DestroyInvocation
DFSFile (String fName, FileManager fmgr, boolean is_dir, boolean is_file, boolean exists, long fSize) throws UdfException, DestroyInvocation
void create (DFSScope dfsScope, DFSDistribution dfsDistrib) throws UdfException, DestroyInvocation
int deleteIt (boolean isRecursively) throws UdfException, DestroyInvocation
boolean exists () throws UdfException
DFSRootParentType getDFSRootParentType ()
DFSDistribution getDistribution ()
FileManager getFileManager ()
long getFileWriter ()
String getName ()
String getRootDFSParentObjectName ()
DFSScope getScope ()
ServerInterface getServerInterface ()
long getSize ()
DFSFileStatus getStatus ()
boolean isDir ()
boolean isFile ()
List listFiles () throws UdfException, DestroyInvocation
void setDir (boolean thisIsaDirectory)
void setDistribution (DFSDistribution dfsDist)
void setFile (boolean thisIsaFile)
void setFileManager (ServerInterface srvInterface)
void setName (String fName) throws UdfException, DestroyInvocation
void setScope (DFSScope dfsScope)
void setSize (long fSize)
void setStatus (DFSFileStatus dfsStatus)

Detailed Description

The main class used by users to initiate DFS operations

Constructor & Destructor Documentation

com.vertica.sdk.DFSFile.DFSFile()

DFSFile INITIATION IS ONLY AVAILABLE DURING THE PLANNING/SETUP AND FINALIZE/DESTROY PHASES OF A PLAN. NOT AVAILABLE DURING EXECUTION/PROCESSING.

Member Function Documentation

int com.vertica.sdk.DFSFile.deleteIt(boolean isRecursively) throws UdfException, DestroyInvocation

Deletes a DFS file.

Parameters

  • isRecursively: delete recursively

Returns 0 is successful, throw exceptions if there are errors.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
List com.vertica.sdk.DFSFile.listFiles() throws UdfException, DestroyInvocation

Lists files under the path specified by 'fileName'

Returns a list of DFSFile found under the path.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle

2.1.40 - com.vertica.sdk.DFSFile Member List

This is the complete list of members for com.vertica.sdk.DFSFile, including all inherited members.

create(DFSScope dfsScope, DFSDistribution dfsDistrib) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
deleteIt(boolean isRecursively) com.vertica.sdk.DFSFile
DFSFile() com.vertica.sdk.DFSFile
DFSFile(ServerInterface srvInterface) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
DFSFile(ServerInterface srvInterface, String fName) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
DFSFile(ServerInterface srvInterface, String fName, DFSRootParentType parentType, String parentName) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
DFSFile(String fName, FileManager fmgr) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
DFSFile(String fName, FileManager fmgr, boolean is_dir, boolean is_file, boolean exists, long fSize) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
exists() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getDFSRootParentType() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getDistribution() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getFileManager() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getFileWriter() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getName() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getRootDFSParentObjectName() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getScope() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getServerInterface() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getSize() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
getStatus() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
isDir() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
isFile() (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
listFiles() com.vertica.sdk.DFSFile
setDir(boolean thisIsaDirectory) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
setDistribution(DFSDistribution dfsDist) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
setFile(boolean thisIsaFile) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
setFileManager(ServerInterface srvInterface) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
setName(String fName) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
setScope(DFSScope dfsScope) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
setSize(long fSize) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile
setStatus(DFSFileStatus dfsStatus) (defined in com.vertica.sdk.DFSFile) com.vertica.sdk.DFSFile

2.1.41 - com.vertica.sdk.DFSFile.DFSDistribution Enum Reference

Collaboration diagram for com.vertica.sdk.DFSFile.DFSDistribution:

Public Attributes
HINT_INITIATOR
HINT_REPLICATE
HINT_SEGMENTED

Detailed Description

Defines how a file is replicated across nodes in the cluster. Used at the file creation time.

2.1.42 - com.vertica.sdk.DFSFile.DFSDistribution Member List

This is the complete list of members for com.vertica.sdk.DFSFile.DFSDistribution, including all inherited members.

HINT_INITIATOR (defined in com.vertica.sdk.DFSFile.DFSDistribution) com.vertica.sdk.DFSFile.DFSDistribution
HINT_REPLICATE (defined in com.vertica.sdk.DFSFile.DFSDistribution) com.vertica.sdk.DFSFile.DFSDistribution
HINT_SEGMENTED (defined in com.vertica.sdk.DFSFile.DFSDistribution) com.vertica.sdk.DFSFile.DFSDistribution

2.1.43 - com.vertica.sdk.DFSFile.DFSRootParentType Enum Reference

Collaboration diagram for com.vertica.sdk.DFSFile.DFSRootParentType:

Public Attributes
DATABASE
MODEL

Detailed Description

Enum to represent which object the root of DFSFile is attached to.

2.1.44 - com.vertica.sdk.DFSFile.DFSRootParentType Member List

This is the complete list of members for com.vertica.sdk.DFSFile.DFSRootParentType, including all inherited members.

DATABASE (defined in com.vertica.sdk.DFSFile.DFSRootParentType) com.vertica.sdk.DFSFile.DFSRootParentType
MODEL (defined in com.vertica.sdk.DFSFile.DFSRootParentType) com.vertica.sdk.DFSFile.DFSRootParentType

2.1.45 - com.vertica.sdk.DFSFile.DFSScope Enum Reference

Collaboration diagram for com.vertica.sdk.DFSFile.DFSScope:

Public Attributes
NS_GLOBAL
NS_SESSION
NS_TRANSACTION

Detailed Description

Defines the scope fo the file. Used at the file creation time.

2.1.46 - com.vertica.sdk.DFSFile.DFSScope Member List

This is the complete list of members for com.vertica.sdk.DFSFile.DFSScope, including all inherited members.

NS_GLOBAL (defined in com.vertica.sdk.DFSFile.DFSScope) com.vertica.sdk.DFSFile.DFSScope
NS_SESSION (defined in com.vertica.sdk.DFSFile.DFSScope) com.vertica.sdk.DFSFile.DFSScope
NS_TRANSACTION (defined in com.vertica.sdk.DFSFile.DFSScope) com.vertica.sdk.DFSFile.DFSScope

2.1.47 - com.vertica.sdk.DFSFileReader Class Reference

Collaboration diagram for com.vertica.sdk.DFSFileReader:

Public Member Functions
DFSFileReader (DFSFile dfsFile)
void close () throws UdfException, DestroyInvocation
boolean isOpen ()
void open () throws UdfException, DestroyInvocation
int read (ByteBuffer buffer, int size) throws UdfException, DestroyInvocation
long seek (long offset, int origin) throws UdfException, DestroyInvocation
long size ()

Member Function Documentation

void com.vertica.sdk.DFSFileReader.close() throws UdfException, DestroyInvocation

Closes the file opened for reading

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
int com.vertica.sdk.DFSFileReader.read(ByteBuffer buffer, int size) throws UdfException, DestroyInvocation

Reads 'size' of bytes into buffer pointed by 'ptr' from the file opened for reading.

Parameters

  • buffer: buffer to read into
  • size: number of bytes to read

Returns number of bytes actually read, 0 if no bytes were read, indicates the EOF.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
long com.vertica.sdk.DFSFileReader.seek(long offset, int origin) throws UdfException, DestroyInvocation

Reposition the read file offset.

Parameters

  • offset: location to seek to
  • origin: origin from which to seek

Returns the new file offset.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle

2.1.48 - com.vertica.sdk.DFSFileReader Member List

This is the complete list of members for com.vertica.sdk.DFSFileReader, including all inherited members.

close() com.vertica.sdk.DFSFileReader
DFSFileReader() (defined in com.vertica.sdk.DFSFileReader) com.vertica.sdk.DFSFileReader
DFSFileReader(DFSFile dfsFile) (defined in com.vertica.sdk.DFSFileReader) com.vertica.sdk.DFSFileReader
isOpen() (defined in com.vertica.sdk.DFSFileReader) com.vertica.sdk.DFSFileReader
open() (defined in com.vertica.sdk.DFSFileReader) com.vertica.sdk.DFSFileReader
read(ByteBuffer buffer, int size) com.vertica.sdk.DFSFileReader
seek(long offset, int origin) com.vertica.sdk.DFSFileReader
size() (defined in com.vertica.sdk.DFSFileReader) com.vertica.sdk.DFSFileReader

2.1.49 - com.vertica.sdk.DFSFileStatus Enum Reference

Collaboration diagram for com.vertica.sdk.DFSFileStatus:

Public Attributes
READ_OPEN
WRITE_CREATED
WRITE_OPEN

Detailed Description

Internal DFSFile status to indicate its state

2.1.50 - com.vertica.sdk.DFSFileStatus Member List

This is the complete list of members for com.vertica.sdk.DFSFileStatus, including all inherited members.

READ_OPEN (defined in com.vertica.sdk.DFSFileStatus) com.vertica.sdk.DFSFileStatus
WRITE_CREATED (defined in com.vertica.sdk.DFSFileStatus) com.vertica.sdk.DFSFileStatus
WRITE_OPEN (defined in com.vertica.sdk.DFSFileStatus) com.vertica.sdk.DFSFileStatus

2.1.51 - com.vertica.sdk.DFSFileWriter Class Reference

Collaboration diagram for com.vertica.sdk.DFSFileWriter:

Public Member Functions
DFSFileWriter (DFSFile dfsFile)
void close () throws UdfException, DestroyInvocation
boolean isOpen ()
void open () throws UdfException, DestroyInvocation
int write (ByteBuffer buffer) throws UdfException, DestroyInvocation

Member Function Documentation

void com.vertica.sdk.DFSFileWriter.close() throws UdfException, DestroyInvocation

Closes the file opened for writing.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
void com.vertica.sdk.DFSFileWriter.open() throws UdfException, DestroyInvocation

Opens a file for writing.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
int com.vertica.sdk.DFSFileWriter.write(ByteBuffer buffer) throws UdfException, DestroyInvocation

Writes bytes into the file from the ByteBuffer

Bytes are retrieved from the buffer starting from the current position till it's limit. Current position will be advanced depending on how many bytes are written.

Parameters

  • buffer: the ByteBuffer to write

Returns number of bytes written, could be 0.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle

2.1.52 - com.vertica.sdk.DFSFileWriter Member List

This is the complete list of members for com.vertica.sdk.DFSFileWriter, including all inherited members.

close() com.vertica.sdk.DFSFileWriter
DFSFileWriter() (defined in com.vertica.sdk.DFSFileWriter) com.vertica.sdk.DFSFileWriter
DFSFileWriter(DFSFile dfsFile) (defined in com.vertica.sdk.DFSFileWriter) com.vertica.sdk.DFSFileWriter
isOpen() (defined in com.vertica.sdk.DFSFileWriter) com.vertica.sdk.DFSFileWriter
open() com.vertica.sdk.DFSFileWriter
write(ByteBuffer buffer) com.vertica.sdk.DFSFileWriter

2.1.53 - com.vertica.sdk.ExecutorParamWriter Class Reference

Inheritance diagram for com.vertica.sdk.ExecutorParamWriter:

Collaboration diagram for com.vertica.sdk.ExecutorParamWriter:

Public Member Functions
ExecutorParamWriter (ParamReader params)
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
void clearParameter (String fieldName)
boolean containsParameter (String paramName)
boolean getBoolean (int idx)
boolean getBoolean (String paramName) throws UdfException
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
java.sql.Date getDate (String paramName) throws UdfException
java.sql.Date getDate (int idx)
double getDouble (int idx)
double getDouble (String paramName) throws UdfException
int getIndex (String paramName) throws UdfException
long getLong (int idx)
long getLong (String paramName) throws UdfException
int getNumCols ()
int getNumRows ()
ArrayList getParamNames ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
String getString (String paramName) throws UdfException
String getString (int idx)
int getStringLength (String paramName) throws UdfException
int getStringLength (int idx)
int getStringLoc (int idx)
java.sql.Timestamp getTimestamp (String paramName) throws UdfException
java.sql.Timestamp getTimestamp (int idx)
VerticaType getType (String paramName) throws UdfException
SizedColumnTypes getTypeMetaData ()
VNumeric getVNumeric (String paramName) throws UdfException
VNumeric getVNumeric (int idx)
VString getVString (String paramName) throws UdfException
VString getVString (int idx)
boolean isBooleanNull (int idx)
boolean isBooleanNull (String paramName) throws UdfException
boolean isDateNull (String paramName) throws UdfException
boolean isDateNull (int idx)
boolean isDoubleNull (int idx)
boolean isDoubleNull (String paramName) throws UdfException
boolean isEmpty ()
boolean isLongNull (int idx)
boolean isLongNull (String paramName) throws UdfException
boolean isStringNull (String paramName) throws UdfException
boolean isStringNull (int idx)
boolean isTimestampInfinite (String paramName) throws UdfException
boolean isTimestampInfinite (int idx)
boolean isTimestampInfiniteNeg (String paramName) throws UdfException
boolean isTimestampInfiniteNeg (int idx)
boolean isTimestampInfinitePos (String paramName) throws UdfException
boolean isTimestampInfinitePos (int idx)
boolean isTimestampNull (String paramName) throws UdfException
boolean isTimestampNull (int idx)
boolean next () throws UdfException, DestroyInvocation
void resetBuffers ()
void setBool (String fieldName, boolean r) throws UdfException
Adds a BOOLEAN value to the output row.
void setDate (String fieldName, java.sql.Date r) throws UdfException
Adds a DATE value to the output row.
void setDouble (String fieldName, double r) throws UdfException
Adds a FLOAT value to the output row.
void setLong (String fieldName, Long r) throws UdfException
Adds a LONG INTEGER value to the output row.
void setLongString (String fieldName, String r) throws UdfException
Adds a Long String value to the output row.
void setNumeric (String fieldName, BigDecimal bd)
Allocate a new VNumeric object to use as output.
void setObjects (Map objects)
void setString (String fieldName, String r) throws UdfException
Adds a String value to the output row.
void setTimestamp (String fieldName, java.sql.Timestamp r) throws UdfException
Adds a TIMESTAMP value to the output row.
void setTimestampInfiniteNeg (String fieldName) throws UdfException
void setTimestampInfinitePos (String fieldName) throws UdfException
Map viewObjects ()
Public Attributes
int count
int index
int ncols
int nrows
HashMap paramNameToIndex
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos

Detailed Description

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.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
boolean com.vertica.sdk.ParamReader.containsParameter(String paramName)

inherited Function to see if the ParamReader has a value for the parameter

Parameters

  • paramName: parameter name to check

Returns true if it does

boolean com.vertica.sdk.BlockReader.getBoolean(int idx)

inherited Get a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a BOOLEAN.

ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

java.sql.Date com.vertica.sdk.BlockReader.getDate(int idx)

inherited Get a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DATE; null if the column is NULL.

double com.vertica.sdk.BlockReader.getDouble(int idx)

inherited Get a DOUBLE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DOUBLE.

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

long com.vertica.sdk.BlockReader.getLong(int idx)

inherited Get a LONG INTEGER value from the input row.

Example

long a = arg_reader.getLong(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a LONG INTEGER.

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

ArrayList com.vertica.sdk.ParamReader.getParamNames()

inherited Returns all names of parameters stored in this ParamReader

String com.vertica.sdk.BlockReader.getString(int idx)

inherited Get a reference to an VARCHAR/CHAR/VARBINARY/BINARY value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an String.

int com.vertica.sdk.BlockReader.getStringLength(int idx)

inherited Get length of the String from the input row

Parameters

  • idx: The column number to retrieve from the input row.

Returns The length of the String in specified column.

Referenced by

int com.vertica.sdk.BlockReader.getStringLoc(int idx)

inherited Get 'location' of the String from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The location of the String in specified column. If zero, data is inlined immediately after the header, otherwise data is at offset loc within the data area.

Referenced by com.vertica.sdk.BlockReader.getVString().

java.sql.Timestamp com.vertica.sdk.BlockReader.getTimestamp(int idx)

inherited Get a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a TIMESTAMP; null if the column is NULL or represents 'infinity'.

VerticaType com.vertica.sdk.ParamReader.getType(String paramName) throws UdfException

inherited Parameters

  • paramName: parameter name

Returns the type of the given parameter

Exceptions

  • UdfException: UDF problem
SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

VNumeric com.vertica.sdk.BlockReader.getVNumeric(int idx)

inherited Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the retrieved value cast as a Numeric.

VString com.vertica.sdk.BlockReader.getVString(int idx)

inherited Get a reference from the input row to an VString value, which represents a SQL VARCHAR/CHAR/VARBINARY/BINARY value.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isBooleanNull(int idx)

inherited Check whether a value from the input row is NULL in BOOLEAN type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.BlockReader.isDateNull(int idx)

inherited Check whether a value from the input row is NULL in DATE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getDate().

boolean com.vertica.sdk.BlockReader.isDoubleNull(int idx)

inherited Check whether a value from the input row is NULL in DOUBLE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.ParamReader.isEmpty()

inherited Returns true if there are no parameters

boolean com.vertica.sdk.BlockReader.isLongNull(int idx)

inherited Check whether a value from the input row is NULL in LONG INTERGER type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by

boolean com.vertica.sdk.BlockReader.isStringNull(int idx)

inherited Check whether a value from the input row is NULL in SQL VARCHAR/CHAR/VARBINARY/BINARY type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isTimestampInfinite(int idx)

inherited Check whether a TIMESTAMP value from the input row represents 'infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity' or '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.isTimestampInfiniteNeg(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '-infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampInfinitePos(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '+infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampNull(int idx)

inherited Check whether a value from the input row is NULL in TIMESTAMP type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.next() throws UdfException, DestroyInvocation

inherited Advance to the next record.

Returns true if there are more rows to read, false otherwise.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: Invocation needed to be destroyed
void com.vertica.sdk.ParamWriter.setBool(String fieldName, boolean r) throws UdfException

inherited Adds a BOOLEAN value to the output row.

Parameters

  • r: The BOOLEAN value to insert into the output row.
void com.vertica.sdk.ParamWriter.setDate(String fieldName, java.sql.Date r) throws UdfException

inherited Adds a DATE value to the output row.

Parameters

  • r: The DATE value to insert into the output row.
void com.vertica.sdk.ParamWriter.setDouble(String fieldName, double r) throws UdfException

inherited Adds a FLOAT value to the output row.

Parameters

  • r: The FLOAT value to insert into the output row.
void com.vertica.sdk.ParamWriter.setLong(String fieldName, Long r) throws UdfException

inherited Adds a LONG INTEGER value to the output row.

Parameters

  • r: The LONG INTEGER value to insert into the output row.

Referenced by

void com.vertica.sdk.ParamWriter.setLongString(String fieldName, String r) throws UdfException

inherited Adds a Long String value to the output row.

Parameters

  • r: The Long String value to insert into the output row.
void com.vertica.sdk.ParamWriter.setNumeric(String fieldName, BigDecimal bd)

inherited Allocate a new VNumeric object to use as output.

Returns A new VNumeric object to hold output. This object automatically added to the output row.

void com.vertica.sdk.ParamWriter.setString(String fieldName, String r) throws UdfException

inherited Adds a String value to the output row.

Parameters

  • r: The String value to insert into the output row.
void com.vertica.sdk.ParamWriter.setTimestamp(String fieldName, java.sql.Timestamp r) throws UdfException

inherited Adds a TIMESTAMP value to the output row.

Parameters

  • r: The TIMESTAMP value to insert into the output row.

2.1.54 - com.vertica.sdk.ExecutorParamWriter Member List

This is the complete list of members for com.vertica.sdk.ExecutorParamWriter, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
BlockReader() (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader
BlockReader(int _ncols, int _rowcount) (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader protected
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
clearParameter(String fieldName) (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
containsParameter(String paramName) com.vertica.sdk.ParamReader
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
ExecutorParamWriter() (defined in com.vertica.sdk.ExecutorParamWriter) com.vertica.sdk.ExecutorParamWriter
ExecutorParamWriter(ParamReader params) (defined in com.vertica.sdk.ExecutorParamWriter) com.vertica.sdk.ExecutorParamWriter
getBoolean(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getBoolean(int idx) com.vertica.sdk.BlockReader
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getDate(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getDate(int idx) com.vertica.sdk.BlockReader
getDouble(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getDouble(int idx) com.vertica.sdk.BlockReader
getIndex(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getLong(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getLong(int idx) com.vertica.sdk.BlockReader
getNumCols() com.vertica.sdk.VerticaBlock
getNumRows() com.vertica.sdk.VerticaBlock
getParamNames() com.vertica.sdk.ParamReader
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getString(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getString(int idx) com.vertica.sdk.BlockReader
getStringLength(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getStringLength(int idx) com.vertica.sdk.BlockReader
getStringLoc(int idx) com.vertica.sdk.BlockReader
getTimestamp(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getTimestamp(int idx) com.vertica.sdk.BlockReader
getType(String paramName) com.vertica.sdk.ParamReader
getTypeMetaData() com.vertica.sdk.VerticaBlock
getVNumeric(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getVNumeric(int idx) com.vertica.sdk.BlockReader
getVString(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getVString(int idx) com.vertica.sdk.BlockReader
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
isBooleanNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isBooleanNull(int idx) com.vertica.sdk.BlockReader
isDateNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isDateNull(int idx) com.vertica.sdk.BlockReader
isDoubleNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isDoubleNull(int idx) com.vertica.sdk.BlockReader
isEmpty() com.vertica.sdk.ParamReader
isLongNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isLongNull(int idx) com.vertica.sdk.BlockReader
isStringNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isStringNull(int idx) com.vertica.sdk.BlockReader
isTimestampInfinite(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampInfinite(int idx) com.vertica.sdk.BlockReader
isTimestampInfiniteNeg(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampInfiniteNeg(int idx) com.vertica.sdk.BlockReader
isTimestampInfinitePos(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampInfinitePos(int idx) com.vertica.sdk.BlockReader
isTimestampNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampNull(int idx) com.vertica.sdk.BlockReader
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
next() com.vertica.sdk.BlockReader
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
paramNameToIndex (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
ParamReader() (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
ParamWriter() (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
ParamWriter(ParamReader params) (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
setBool(String fieldName, boolean r) com.vertica.sdk.ParamWriter
setDate(String fieldName, java.sql.Date r) com.vertica.sdk.ParamWriter
setDouble(String fieldName, double r) com.vertica.sdk.ParamWriter
setLong(String fieldName, Long r) com.vertica.sdk.ParamWriter
setLongString(String fieldName, String r) com.vertica.sdk.ParamWriter
setNumeric(String fieldName, BigDecimal bd) com.vertica.sdk.ParamWriter
setObjects(Map objects) (defined in com.vertica.sdk.ExecutorParamWriter) com.vertica.sdk.ExecutorParamWriter
setString(String fieldName, String r) com.vertica.sdk.ParamWriter
setTimestamp(String fieldName, java.sql.Timestamp r) com.vertica.sdk.ParamWriter
setTimestampInfiniteNeg(String fieldName) (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
setTimestampInfinitePos(String fieldName) (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
viewObjects() (defined in com.vertica.sdk.ExecutorParamWriter) com.vertica.sdk.ExecutorParamWriter

2.1.55 - com.vertica.sdk.ExecutorPlanContext Class Reference

Inheritance diagram for com.vertica.sdk.ExecutorPlanContext:

Collaboration diagram for com.vertica.sdk.ExecutorPlanContext:

Public Member Functions
ExecutorPlanContext (ExecutorParamWriter writer, ArrayList clusterNodes, ArrayList targetNodes, boolean canApportionSource, int maxAllowedThreads)
ExecutorPlanContext (ExecutorParamWriter writer, ArrayList clusterNodes, ArrayList targetNodes, boolean canApportionSource, int maxAllowedThreads, int actualThreads)
boolean canApportionSource ()
ArrayList getClusterNodes ()
int getLoadConcurrency ()
int getMaxAllowedThreads ()
ParamReader getReader ()
SourceIterator getSources ()
ArrayList getTargetNodes ()
ExecutorParamWriter getWriter ()
void setSources (SourceIterator sources)
void setTargetNodes (ArrayList nodes) throws UdfException

Detailed Description

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. This class is used for UDLs.

Member Function Documentation

ArrayList com.vertica.sdk.PlanContext.getClusterNodes()

inherited Returns A list of all of the nodes in the current cluster, by node name

ParamReader com.vertica.sdk.PlanContext.getReader()

inherited Returns A read-only instance of the current context

ArrayList com.vertica.sdk.NodeSpecifyingPlanContext.getTargetNodes()

inherited Returns The set of nodes that this query is currently set to run on

void com.vertica.sdk.NodeSpecifyingPlanContext.setTargetNodes(ArrayList nodes) throws UdfException

inherited Change the set of nodes that the query is intended to run on.

Parameters

  • nodes: new target nodes

Exceptions

  • UdfException: if any of the specified node names is not actually the name of any node in the cluster.

2.1.56 - com.vertica.sdk.ExecutorPlanContext Member List

This is the complete list of members for com.vertica.sdk.ExecutorPlanContext, including all inherited members.

canApportionSource() (defined in com.vertica.sdk.NodeSpecifyingPlanContext) com.vertica.sdk.NodeSpecifyingPlanContext
ExecutorPlanContext(ExecutorParamWriter writer, ArrayList clusterNodes, ArrayList targetNodes, boolean canApportionSource, int maxAllowedThreads) (defined in com.vertica.sdk.ExecutorPlanContext) com.vertica.sdk.ExecutorPlanContext
ExecutorPlanContext(ExecutorParamWriter writer, ArrayList clusterNodes, ArrayList targetNodes, boolean canApportionSource, int maxAllowedThreads, int actualThreads) (defined in com.vertica.sdk.ExecutorPlanContext) com.vertica.sdk.ExecutorPlanContext
getClusterNodes() com.vertica.sdk.PlanContext
getLoadConcurrency() (defined in com.vertica.sdk.ExecutorPlanContext) com.vertica.sdk.ExecutorPlanContext
getMaxAllowedThreads() (defined in com.vertica.sdk.ExecutorPlanContext) com.vertica.sdk.ExecutorPlanContext
getReader() com.vertica.sdk.PlanContext
getSources() (defined in com.vertica.sdk.ExecutorPlanContext) com.vertica.sdk.ExecutorPlanContext
getTargetNodes() com.vertica.sdk.NodeSpecifyingPlanContext
getWriter() (defined in com.vertica.sdk.ExecutorPlanContext) com.vertica.sdk.ExecutorPlanContext
NodeSpecifyingPlanContext(ParamWriter writer, ArrayList clusterNodes, boolean canApportionSource) (defined in com.vertica.sdk.NodeSpecifyingPlanContext) com.vertica.sdk.NodeSpecifyingPlanContext
NodeSpecifyingPlanContext(ParamWriter writer, ArrayList clusterNodes, ArrayList targetNodes, boolean canApportionSource) (defined in com.vertica.sdk.NodeSpecifyingPlanContext) com.vertica.sdk.NodeSpecifyingPlanContext
PlanContext(ParamWriter writer, ArrayList clusterNodes) (defined in com.vertica.sdk.PlanContext) com.vertica.sdk.PlanContext
PlanContext(ParamWriter writer) (defined in com.vertica.sdk.PlanContext) com.vertica.sdk.PlanContext
setSources(SourceIterator sources) (defined in com.vertica.sdk.ExecutorPlanContext) com.vertica.sdk.ExecutorPlanContext
setTargetNodes(ArrayList nodes) com.vertica.sdk.NodeSpecifyingPlanContext

2.1.57 - com.vertica.sdk.FileManager Class Reference

Collaboration diagram for com.vertica.sdk.FileManager:

Public Member Functions
abstract void closeReader (long readerID) throws UdfException, DestroyInvocation
abstract void closeWriter (long writerID) throws UdfException, DestroyInvocation
abstract int deleteIt (String fileName, boolean isRecursively) throws UdfException, DestroyInvocation
abstract void finalize ()
abstract boolean initDFSFile (DFSFile file) throws UdfException, DestroyInvocation
abstract List listFiles (String fileName) throws UdfException, DestroyInvocation
abstract long openForRead (String fileName, DFSFile.DFSRootParentType parentType, String parentName) throws UdfException, DestroyInvocation
abstract long openForWrite (String fileName, DFSFile.DFSScope dfsScope, DFSFile.DFSDistribution dfsDistrib) throws UdfException, DestroyInvocation
abstract int read (long readerID, ByteBuffer buffer, int size) throws UdfException, DestroyInvocation
abstract long seek (long readerID, long offset, int origin) throws UdfException, DestroyInvocation
abstract int write (long writerID, ByteBuffer buffer) throws UdfException, DestroyInvocation

Detailed Description

File Manager is a session level co-ordinator, which will be used by DFSFile, DFSFileReader and DFSFileWriter to interact with Catalog and Storage system of Vertica.

Member Function Documentation

abstract void com.vertica.sdk.FileManager.closeReader(long readerID) throws UdfException, DestroyInvocation

pure virtual Closes the file opened for reading, identified by 'readerID'

Parameters

  • readerID: id of the reader to close

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
abstract void com.vertica.sdk.FileManager.closeWriter(long writerID) throws UdfException, DestroyInvocation

pure virtual Closes the file opened for writing, identified by 'writerID'

Parameters

  • writerID: id of the writer to close

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
abstract int com.vertica.sdk.FileManager.deleteIt(String fileName, boolean isRecursively) throws UdfException, DestroyInvocation

pure virtual Deletes a DFSFile, identified by full path 'fileName'.

Parameters

  • fileName: the file or directory to delete
  • isRecursively: whether to delete recursively

Returns 0 if successful, throw exceptions if there are errors

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
abstract void com.vertica.sdk.FileManager.finalize()

pure virtual Finalizes a plan/query/statement. Should only invoke on the initiator node of a query. Complete file replication and commit metadata into the catalog. returns nothing, throws exceptions if there are errors.

abstract boolean com.vertica.sdk.FileManager.initDFSFile(DFSFile file) throws UdfException, DestroyInvocation

pure virtual Initialize a DFSFile upon constructing.

Parameters

  • file: the DFS file to initialize

Returns true if file exists in the DFS, false otherwise

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
abstract List com.vertica.sdk.FileManager.listFiles(String fileName) throws UdfException, DestroyInvocation

pure virtual Lists file under the path specified by 'fileName'

Parameters

  • fileName: name of file/directory to list

Returns a list of DFSFile found under the path.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
abstract long com.vertica.sdk.FileManager.openForRead(String fileName, DFSFile.DFSRootParentType parentType, String parentName) throws UdfException, DestroyInvocation

pure virtual Opens a file for reading

Parameters

  • fileName: the filename
  • parentType: type of the parent
  • parentName: name of the parent

Returns A unique identifier for the file opened. Return value is less than 0 if there are errors

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
abstract long com.vertica.sdk.FileManager.openForWrite(String fileName, DFSFile.DFSScope dfsScope, DFSFile.DFSDistribution dfsDistrib) throws UdfException, DestroyInvocation

pure virtual Opens a file for writing

Parameters

  • fileName: name of file
  • dfsScope: scope
  • dfsDistrib: distribution

Returns A unique identifier for the file opened. Return value is less tan 0 if there are errors

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
abstract int com.vertica.sdk.FileManager.read(long readerID, ByteBuffer buffer, int size) throws UdfException, DestroyInvocation

pure virtual Reads 'size' of bytes into buffer from the file identified by 'readerID'.

Parameters

  • readerID: id of the file reader
  • buffer: ByteBuffer to read into
  • size: number of bytes to read

Returns number of bytes actually read, 0 if no bytes were read, indicates the EOF.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
abstract long com.vertica.sdk.FileManager.seek(long readerID, long offset, int origin) throws UdfException, DestroyInvocation

pure virtual Reposition the read file offset

Parameters

  • readerID: id of the file reader
  • offset: offset to seek to
  • origin: origin from which to seek

Returns the new file offset.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
abstract int com.vertica.sdk.FileManager.write(long writerID, ByteBuffer buffer) throws UdfException, DestroyInvocation

pure virtual Writes bytes into the file identified by 'writerID' from the buffer.

Bytes are retrieved from buffer starting from the current position till it's limit. Current position will be advanced depending on how many bytes are written.

Parameters

  • writerID: id of the writer
  • buffer: ByteBuffer from which to write

Returns number of bytes actually written, less than 0 if there are any errors.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle

2.1.58 - com.vertica.sdk.FileManager Member List

This is the complete list of members for com.vertica.sdk.FileManager, including all inherited members.

closeReader(long readerID) com.vertica.sdk.FileManager pure virtual
closeWriter(long writerID) com.vertica.sdk.FileManager pure virtual
deleteIt(String fileName, boolean isRecursively) com.vertica.sdk.FileManager pure virtual
finalize() com.vertica.sdk.FileManager pure virtual
initDFSFile(DFSFile file) com.vertica.sdk.FileManager pure virtual
listFiles(String fileName) com.vertica.sdk.FileManager pure virtual
openForRead(String fileName, DFSFile.DFSRootParentType parentType, String parentName) com.vertica.sdk.FileManager pure virtual
openForWrite(String fileName, DFSFile.DFSScope dfsScope, DFSFile.DFSDistribution dfsDistrib) com.vertica.sdk.FileManager pure virtual
read(long readerID, ByteBuffer buffer, int size) com.vertica.sdk.FileManager pure virtual
seek(long readerID, long offset, int origin) com.vertica.sdk.FileManager pure virtual
write(long writerID, ByteBuffer buffer) com.vertica.sdk.FileManager pure virtual

2.1.59 - com.vertica.sdk.FilterFactory Class Reference

Inheritance diagram for com.vertica.sdk.FilterFactory:

Collaboration diagram for com.vertica.sdk.FilterFactory:

Public Member Functions
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)
UDXType getUDXFactoryType ()
void plan (ServerInterface srvInterface, PlanContext planCtxt) throws UdfException
abstract UDFilter prepare (ServerInterface srvInterface, PlanContext planCtxt) throws UdfException
Protected Attributes
long libOid
String sqlName

Detailed Description

Produces and initializes UDFilters to transform input data before parsing.

Note that FilterFactories are singletons. Subclasses should be stateless, with no fields containing data, just methods. plan() and prepare() methods must never modify any global variables or state; they may only modify the variables that they are given as arguments.

Member Function Documentation

void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

inherited Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDLFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
void com.vertica.sdk.UDLFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

virtualinherited

Provides the argument and return types of the UDL. UDL's take no input tuples; as such, their prototype is empty.

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.UDLFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)

virtualinherited

Not used in this form

Implements com.vertica.sdk.UDXFactory.

UDXType com.vertica.sdk.FilterFactory.getUDXFactoryType()

virtual

User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Returns the type of UDX Object instance this factory returns.

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.FilterFactory.plan(ServerInterface srvInterface, PlanContext planCtxt) throws UdfException

Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on (through srvInterface).

plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().

Exceptions

  • UdfException: UDF problem
abstract UDFilter com.vertica.sdk.FilterFactory.prepare(ServerInterface srvInterface, PlanContext planCtxt) throws UdfException

pure virtual Initialize a UDFilter. This function will be called on each node, prior to the Load operator starting to execute.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().

Returns UDFilter instance to use for this query

Exceptions

  • UdfException: UDF problem

2.1.60 - com.vertica.sdk.FilterFactory Member List

This is the complete list of members for com.vertica.sdk.FilterFactory, including all inherited members.

getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) (defined in com.vertica.sdk.UDLFactory) com.vertica.sdk.UDLFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDLFactory
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getUDXFactoryType() com.vertica.sdk.FilterFactory virtual
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
plan(ServerInterface srvInterface, PlanContext planCtxt) com.vertica.sdk.FilterFactory
prepare(ServerInterface srvInterface, PlanContext planCtxt) com.vertica.sdk.FilterFactory pure virtual
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected

2.1.61 - com.vertica.sdk.IdentComparator Class Reference

Inheritance diagram for com.vertica.sdk.IdentComparator:

Collaboration diagram for com.vertica.sdk.IdentComparator:

Public Member Functions
int compare (String a, String b)
Static Public Member Functions
static IdentComparator getInstance ()

Detailed Description

Compares two SQL Identifiers; for example, column names. SQL Identifiers are case and locale insensitive.

Warning: The current implementation handles ASCII identifiers only; For performance reasons, input values are not checked for non-ASCII characters. Future implementations will provide support for all non-ASCII identifiers. Using this comparator now will ensure ease of upgrade in the future.

Member Function Documentation

static IdentComparator com.vertica.sdk.IdentComparator.getInstance()

static

Retrieve a singleton instance of IdentComparator. IdentComparator is stateless and threadsafe.

Returns Instance of IdentComparator

2.1.62 - com.vertica.sdk.IdentComparator Member List

This is the complete list of members for com.vertica.sdk.IdentComparator, including all inherited members.

compare(String a, String b) (defined in com.vertica.sdk.IdentComparator) com.vertica.sdk.IdentComparator
getInstance() com.vertica.sdk.IdentComparator static

2.1.63 - com.vertica.sdk.IterativeSourceFactory Class Reference

Inheritance diagram for com.vertica.sdk.IterativeSourceFactory:

Collaboration diagram for com.vertica.sdk.IterativeSourceFactory:

Public Member Functions
int getDesiredThreads (ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)
UDXType getUDXFactoryType ()
boolean isSourceApportionable ()
void plan (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
SourceIterator prepare (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
SourceIterator prepare (ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException
Protected Attributes
long libOid
String sqlName

Detailed Description

Source factory that works with a SourceIterator to produce UDSources.

Usually it is easier to subclass SourceFactory and have its prepareUDSources() method return a vector of UDSource objects. Behind the scenes, Vertica uses a built-in iterator to pull sources from that vector. However, if you need to be able to control source management at this level, you can instead write your own SourceIterator and use it with an IterativeSourceFactory.

This class performs initial validation and planning of a query, before it is distributed over the network. It also instantiates objects to perform further initialization on each node, once the query has been distributed.

Note that SourceFactories are singletons. Subclasses should be stateless, with no fields containing data, just methods. plan() and prepare() methods must never modify any global variables or state; they may only modify the variables that they are given as arguments. (If global state must be modified, use SourceIterator.)

Member Function Documentation

int com.vertica.sdk.IterativeSourceFactory.getDesiredThreads(ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException

Request the number of threads that the SourceFactory wants to use. This function is called on each node before prepare().

'planCtxt' contains the same parameters stored by plan() method. It also exposes the maximum number of allowed threads, via 'getMaxAllowedThreads()'. Further computations can be stored in its 'ExecutorParamWriter' object, for use in prepare().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • planCtxt: plan context specifying nodes

Returns number of threads the SourceFactory wants to use

Exceptions

  • UdfException: UDF problem
void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

inherited Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDLFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
void com.vertica.sdk.UDLFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

virtualinherited

Provides the argument and return types of the UDL. UDL's take no input tuples; as such, their prototype is empty.

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.UDLFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)

virtualinherited

Not used in this form

Implements com.vertica.sdk.UDXFactory.

UDXType com.vertica.sdk.IterativeSourceFactory.getUDXFactoryType()

virtual

User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Returns the type of UDX Object instance this factory returns.

Implements com.vertica.sdk.UDXFactory.

boolean com.vertica.sdk.IterativeSourceFactory.isSourceApportionable()

Returns if this source factory has the capability to generate source with portions

void com.vertica.sdk.IterativeSourceFactory.plan(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on.

plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • planCtxt: plan context specifying nodes

Exceptions

  • UdfException: UDF problem
SourceIterator com.vertica.sdk.IterativeSourceFactory.prepare(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

Prepare this SourceFactory to start creating sources. This function will be called on each node, prior to the Load operator starting to execute and prior to any other virtual functions on this class being called.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup.
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan() and getDesiredThreads(). It also provides functionality for determining which nodes this query is running on.

Returns A SourceIterator object for use in the query.

Exceptions

  • UdfException: UDF problem

Referenced by com.vertica.sdk.IterativeSourceFactory.prepare().

SourceIterator com.vertica.sdk.IterativeSourceFactory.prepare(ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException

Prepare this SourceFactory to start creating sources. This function will be called on each node, prior to the Load operator starting to execute and prior to any other virtual functions on this class being called.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup.
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan() and getDesiredThreads(). It provides functionality for determining which nodes this query is running on, as well as the number of threads allowed by the resource pool (via getMaxAllowedThreads()) and, more importantly, the actual load concurrency (via getLoadConcurrency()).

Returns A SourceIterator object for use in the query.

Exceptions

  • UdfException: UDF problem

2.1.64 - com.vertica.sdk.IterativeSourceFactory Member List

This is the complete list of members for com.vertica.sdk.IterativeSourceFactory, including all inherited members.

getDesiredThreads(ServerInterface srvInterface, ExecutorPlanContext planCtxt) com.vertica.sdk.IterativeSourceFactory
getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) (defined in com.vertica.sdk.UDLFactory) com.vertica.sdk.UDLFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDLFactory
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getUDXFactoryType() com.vertica.sdk.IterativeSourceFactory virtual
isSourceApportionable() com.vertica.sdk.IterativeSourceFactory
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
plan(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) com.vertica.sdk.IterativeSourceFactory
prepare(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) com.vertica.sdk.IterativeSourceFactory
prepare(ServerInterface srvInterface, ExecutorPlanContext planCtxt) com.vertica.sdk.IterativeSourceFactory
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected

2.1.65 - com.vertica.sdk.MultiPhaseTransformFunctionFactory Class Reference

Inheritance diagram for com.vertica.sdk.MultiPhaseTransformFunctionFactory:

Collaboration diagram for com.vertica.sdk.MultiPhaseTransformFunctionFactory:

Public Member Functions
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
abstract void getPhases (ServerInterface srvInterface, Vector phases)
void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException
UDXType getUDXFactoryType ()
Protected Attributes
long libOid
String sqlName

Detailed Description

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.

A multi-phase transform function is made up of TransformFunctionPhase instances. For each phase of your transform, extend this class (not TransformFunction). In getPhases(), return a vector of instances of those classes. Semantically, getPhases() replaces TransformFunctionFactory.createTransformFunction().

Member Function Documentation

void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

inherited Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Referenced by com.vertica.sdk.UDXFactory.getPerInstanceResources().

void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
abstract void com.vertica.sdk.MultiPhaseTransformFunctionFactory.getPhases(ServerInterface srvInterface, Vector phases)

pure virtual Called when Vertica needs a new TransformFunctionPhase pipeline to process a multi-phase UDTF function call. Vertica invokes the phases in order; collectively they behave like a TransformFunction.

Note More than one object may be instantiated per query.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • phases: output TransformFunctionPhase objects

Referenced by com.vertica.sdk.MultiPhaseTransformFunctionFactory.getReturnType().

void com.vertica.sdk.MultiPhaseTransformFunctionFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

virtual

Provides the argument and return types of the UDX

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments
  • returnType: the type(s) of the return

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.MultiPhaseTransformFunctionFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException

virtual

Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Implements com.vertica.sdk.UDXFactory.

UDXType com.vertica.sdk.MultiPhaseTransformFunctionFactory.getUDXFactoryType()

virtual

Returns the object type internally used by Vertica

Implements com.vertica.sdk.UDXFactory.

2.1.66 - com.vertica.sdk.MultiPhaseTransformFunctionFactory Member List

This is the complete list of members for com.vertica.sdk.MultiPhaseTransformFunctionFactory, including all inherited members.

getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDXFactory
getPhases(ServerInterface srvInterface, Vector phases) com.vertica.sdk.MultiPhaseTransformFunctionFactory pure virtual
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.MultiPhaseTransformFunctionFactory virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.MultiPhaseTransformFunctionFactory virtual
getUDXFactoryType() com.vertica.sdk.MultiPhaseTransformFunctionFactory virtual
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected

2.1.67 - com.vertica.sdk.NodeSpecifyingPlanContext Class Reference

Inheritance diagram for com.vertica.sdk.NodeSpecifyingPlanContext:

Collaboration diagram for com.vertica.sdk.NodeSpecifyingPlanContext:

Public Member Functions
NodeSpecifyingPlanContext (ParamWriter writer, ArrayList clusterNodes, boolean canApportionSource)
NodeSpecifyingPlanContext (ParamWriter writer, ArrayList clusterNodes, ArrayList targetNodes, boolean canApportionSource)
boolean canApportionSource ()
ArrayList getClusterNodes ()
ParamReader getReader ()
ArrayList getTargetNodes ()
ParamWriter getWriter ()
void setTargetNodes (ArrayList nodes) throws UdfException

Detailed Description

Interface that allows storage of query-plan state, when different parts of query planning take place on different computers. For example, if some work is done on the query initiator node and some is done on each node executing the query.

In addition to the functionality provided by PlanContext, NodeSpecifyingPlanContext allows you to specify which nodes the query should run on. This is used for UDLs.

Member Function Documentation

ArrayList com.vertica.sdk.PlanContext.getClusterNodes()

inherited Returns A list of all of the nodes in the current cluster, by node name

ParamReader com.vertica.sdk.PlanContext.getReader()

inherited Returns A read-only instance of the current context

ArrayList com.vertica.sdk.NodeSpecifyingPlanContext.getTargetNodes()

Returns The set of nodes that this query is currently set to run on

ParamWriter com.vertica.sdk.PlanContext.getWriter()

inherited Returns The current context for writing

void com.vertica.sdk.NodeSpecifyingPlanContext.setTargetNodes(ArrayList nodes) throws UdfException

Change the set of nodes that the query is intended to run on.

Parameters

  • nodes: new target nodes

Exceptions

  • UdfException: if any of the specified node names is not actually the name of any node in the cluster.

2.1.68 - com.vertica.sdk.NodeSpecifyingPlanContext Member List

This is the complete list of members for com.vertica.sdk.NodeSpecifyingPlanContext, including all inherited members.

canApportionSource() (defined in com.vertica.sdk.NodeSpecifyingPlanContext) com.vertica.sdk.NodeSpecifyingPlanContext
getClusterNodes() com.vertica.sdk.PlanContext
getReader() com.vertica.sdk.PlanContext
getTargetNodes() com.vertica.sdk.NodeSpecifyingPlanContext
getWriter() com.vertica.sdk.PlanContext
NodeSpecifyingPlanContext(ParamWriter writer, ArrayList clusterNodes, boolean canApportionSource) (defined in com.vertica.sdk.NodeSpecifyingPlanContext) com.vertica.sdk.NodeSpecifyingPlanContext
NodeSpecifyingPlanContext(ParamWriter writer, ArrayList clusterNodes, ArrayList targetNodes, boolean canApportionSource) (defined in com.vertica.sdk.NodeSpecifyingPlanContext) com.vertica.sdk.NodeSpecifyingPlanContext
PlanContext(ParamWriter writer, ArrayList clusterNodes) (defined in com.vertica.sdk.PlanContext) com.vertica.sdk.PlanContext
PlanContext(ParamWriter writer) (defined in com.vertica.sdk.PlanContext) com.vertica.sdk.PlanContext
setTargetNodes(ArrayList nodes) com.vertica.sdk.NodeSpecifyingPlanContext

2.1.69 - com.vertica.sdk.NoopTypeCoercion Class Reference

Inheritance diagram for com.vertica.sdk.NoopTypeCoercion:

Collaboration diagram for com.vertica.sdk.NoopTypeCoercion:

Public Member Functions
ByteBuffer asBinaryBytes (Object value, int length, VerticaType type)
Boolean asBoolean (Object value, VerticaType type)
ByteBuffer asCharBytes (Object value, int length, VerticaType type)
java.sql.Date asDate (Object value, VerticaType type)
Double asDouble (Object value, VerticaType type)
Long asLong (Object value, VerticaType type)
java.sql.Timestamp asTimestamp (Object value, VerticaType type)
Iterator getListIterator (Object value)
Iterator > getMapIterator (Object value)
MetaType getMetaType (Object value)
Set getPolicy ()
void setPolicy (Collection policy)
Protected Member Functions
Collection getDefaultPolicy ()
void invalidInputType (Object value, VerticaType type)
void unsupportedType (Object value, VerticaType type)
void valueTooLarge (Object value, VerticaType type)

Detailed Description

NoopTypeCoercion implements no type conversions, but passes already-valid types to the destination. Values may be truncated if the policy includes TRUNCATE_VALUES.

The default policy favors errors and avoids modifying data. See getDefaultPolicy().

Member Function Documentation

ByteBuffer com.vertica.sdk.NullTypeCoercion.asBinaryBytes(Object value, int length, VerticaType type)

inherited Not supported; returns null or raises TypeCoercionException.

Implements com.vertica.sdk.TypeCoercion.

Boolean com.vertica.sdk.NoopTypeCoercion.asBoolean(Object value, VerticaType type)

Generates a Boolean (or null) value out of null objects or Boolean type objects. All other types are invalid and will result in null or a TypeCoercionException according to the policy.

Implements com.vertica.sdk.TypeCoercion.

ByteBuffer com.vertica.sdk.NoopTypeCoercion.asCharBytes(Object value, int length, VerticaType type)

Generates a ByteBuffer (or null) value out of null objects or String type objects. All other types are invalid and will result in null or a TypeCoercionException according to the policy.

The bytes will not include trailing spaces if the type is 'char'.

The value will be truncated to length when necessary if TRUNCATE_VALUES is specified in the policy. Otherwise values that are too long are treated as invalid input values (see FAIL_INVALID_INPUT_VALUE).

See Also

VerticaType::isChar()

Implements com.vertica.sdk.TypeCoercion.

java.sql.Date com.vertica.sdk.NoopTypeCoercion.asDate(Object value, VerticaType type)

Generate a java.sql.Date (or null) value out of values that are either null, java.sql.Date, or java.util.Date (which includes java.sql.Timestamp and java.sql.Time types).

Note that this is an exception to the general principle of NoopTypeCoercion: some coercion may actually take place here. This is because java.util.Date is so closely related to the java.sql.Date type and much more prevalent.

Implements com.vertica.sdk.TypeCoercion.

Double com.vertica.sdk.NoopTypeCoercion.asDouble(Object value, VerticaType type)

Generates a Double (or null) value out of null objects or Double type objects. All other types are invalid and will result in null or a TypeCoercionException according to the policy.

Implements com.vertica.sdk.TypeCoercion.

Long com.vertica.sdk.NoopTypeCoercion.asLong(Object value, VerticaType type)

Generates a Long (or null) value out of null objects or Long type objects. All other types are invalid and will result in null or a TypeCoercionException according to the policy.

Implements com.vertica.sdk.TypeCoercion.

java.sql.Timestamp com.vertica.sdk.NoopTypeCoercion.asTimestamp(Object value, VerticaType type)

Generate a java.sql.Timestamp (or null) value out of values that are either null, java.sql.Timestamp, or java.util.Date (which includes java.sql.Date and java.sql.Time types).

Note that this is an exception to the general principle of NoopTypeCoercion; some coercion may actually take place here. This is because java.util.Date is so closely related to the java.sql.Timestamp type and much more prevalent.

Implements com.vertica.sdk.TypeCoercion.

Collection com.vertica.sdk.NoopTypeCoercion.getDefaultPolicy()

protected

Provides the default policy installed by the constructor.

For NoopTypeCoercion, the default policy favors errors and avoids modifying data:

  • FAIL_SDK_UNSUPPORTED_TYPE

  • FAIL_UNSUPPORTED_TYPE

  • FAIL_INVALID_INPUT_TYPE

  • FAIL_INVALID_INPUT_VALUE

Iterator com.vertica.sdk.NoopTypeCoercion.getListIterator(Object value)

Provides an Iterator over Objects for a given Iterable input.

Parameters

  • value: Something implementing Iterable

Implements com.vertica.sdk.TypeCoercion.

Iterator > com.vertica.sdk.NoopTypeCoercion.getMapIterator(Object value)

Provides an Iterator over map entries for a given Map.

Internal maps are assumed to have String keys. A ClassCastException will eventually result if there are internal maps with keys that are not Strings.

Parameters

  • value: Something implementing Map

Implements com.vertica.sdk.TypeCoercion.

MetaType com.vertica.sdk.NoopTypeCoercion.getMetaType(Object value)

Detects Java standard Map and Iterable types.

Internal maps are assumed to have String keys. A ClassCastException will result if there are internal maps with keys that are not Strings.

Implements com.vertica.sdk.TypeCoercion.

Set com.vertica.sdk.NullTypeCoercion.getPolicy()

inherited Returns an unmodifiable version of the policy.

Returns The policy collection.

See Also

setPolicy

Implements com.vertica.sdk.TypeCoercion.

Referenced by

void com.vertica.sdk.NoopTypeCoercion.invalidInputType(Object value, VerticaType type)

protected

Throws a TypeCoercionException if the policy includes FAIL_INVALID_INPUT_TYPE. Otherwise does nothing.

Parameters

  • value: The value being coerced.
  • type: The target type.

See Also

getPolicy() #setPolicy(Collection)

Referenced by

void com.vertica.sdk.NullTypeCoercion.setPolicy(Collection policy)

inherited Sets the policies for this TypeCoercion instance. Policies generally dictate which scenarios generate exceptions and allow for different error handling choices without implementing a new TypeCoercion class.

Parameters

  • policy: The policy collection

See Also

TypeCoercionPolicy

getPolicy()

Implements com.vertica.sdk.TypeCoercion.

Referenced by com.vertica.sdk.NullTypeCoercion.NullTypeCoercion().

void com.vertica.sdk.NullTypeCoercion.unsupportedType(Object value, VerticaType type)

protected inherited Throws a TypeCoercionException if the policy includes TypeCoercionPolicy#FAIL_UNSUPPORTED_TYPE. Otherwise does nothing.

Parameters

  • value: The value provided which could not be coerced.
  • type: The target Vertica type.

See Also

getPolicy() #setPolicy(Collection)

Referenced by

void com.vertica.sdk.NoopTypeCoercion.valueTooLarge(Object value, VerticaType type)

protected

Throws a TypeCoercionException with a TRUNCATE_VALUES cause if the policy includes FAIL_INVALID_INPUT_VALUE. Otherwise does nothing.

This should only be called if the policy does not request truncation via TRUNCATE_VALUES.

Parameters

  • value: The value being coerced.
  • type: The target type.

See Also

getPolicy() #setPolicy(Collection)

Referenced by

2.1.70 - com.vertica.sdk.NoopTypeCoercion Member List

This is the complete list of members for com.vertica.sdk.NoopTypeCoercion, including all inherited members.

asBinaryBytes(Object value, int length, VerticaType type) com.vertica.sdk.NullTypeCoercion
asBoolean(Object value, VerticaType type) com.vertica.sdk.NoopTypeCoercion
asCharBytes(Object value, int length, VerticaType type) com.vertica.sdk.NoopTypeCoercion
asDate(Object value, VerticaType type) com.vertica.sdk.NoopTypeCoercion
asDouble(Object value, VerticaType type) com.vertica.sdk.NoopTypeCoercion
asLong(Object value, VerticaType type) com.vertica.sdk.NoopTypeCoercion
asTimestamp(Object value, VerticaType type) com.vertica.sdk.NoopTypeCoercion
getDefaultPolicy() com.vertica.sdk.NoopTypeCoercion protected
getListIterator(Object value) com.vertica.sdk.NoopTypeCoercion
getMapIterator(Object value) com.vertica.sdk.NoopTypeCoercion
getMetaType(Object value) com.vertica.sdk.NoopTypeCoercion
getPolicy() com.vertica.sdk.NullTypeCoercion
invalidInputType(Object value, VerticaType type) com.vertica.sdk.NoopTypeCoercion protected
NullTypeCoercion() com.vertica.sdk.NullTypeCoercion
setPolicy(Collection policy) com.vertica.sdk.NullTypeCoercion
unsupportedType(Object value, VerticaType type) com.vertica.sdk.NullTypeCoercion protected
valueTooLarge(Object value, VerticaType type) com.vertica.sdk.NoopTypeCoercion protected

2.1.71 - com.vertica.sdk.NullTypeCoercion Class Reference

Inheritance diagram for com.vertica.sdk.NullTypeCoercion:

Collaboration diagram for com.vertica.sdk.NullTypeCoercion:

Public Member Functions
NullTypeCoercion ()
ByteBuffer asBinaryBytes (Object value, int length, VerticaType type)
Boolean asBoolean (Object value, VerticaType type)
ByteBuffer asCharBytes (Object value, int length, VerticaType type)
java.sql.Date asDate (Object value, VerticaType type)
Double asDouble (Object value, VerticaType type)
Long asLong (Object value, VerticaType type)
java.sql.Timestamp asTimestamp (Object value, VerticaType type)
Iterator getListIterator (Object value)
Iterator > getMapIterator (Object value)
MetaType getMetaType (Object value)
Set getPolicy ()
void setPolicy (Collection policy)
Protected Member Functions
Collection getDefaultPolicy ()
void unsupportedType (Object value, VerticaType type)

Detailed Description

An implementation of TypeCoercion that always returns null. By default, it has an empty policy, causing all attempts to return null without raising any exceptions under any circumstances.

If FAIL_UNSUPPORTED_TYPE is added to the policy, all coercions will raise exceptions.

This is a good choice for a superclass for users implementing their own type coercion and not interesting in using any standard type coercion. In that case, use of FAIL_UNSUPPORTED_TYPE is recommended to identify gaps in support. For a more functional starting point, see NoopTypeCoercion.

Constructor & Destructor Documentation

com.vertica.sdk.NullTypeCoercion.NullTypeCoercion()

Constructor. Initializes this TypeCoercion with an empty policy.

See Also

getDefaultPolicy()

Member Function Documentation

ByteBuffer com.vertica.sdk.NullTypeCoercion.asBinaryBytes(Object value, int length, VerticaType type)

Not supported; returns null or raises TypeCoercionException.

Implements com.vertica.sdk.TypeCoercion.

Boolean com.vertica.sdk.NullTypeCoercion.asBoolean(Object value, VerticaType type)

Not supported; returns null or raises TypeCoercionException.

Implements com.vertica.sdk.TypeCoercion.

ByteBuffer com.vertica.sdk.NullTypeCoercion.asCharBytes(Object value, int length, VerticaType type)

Not supported; returns null or raises TypeCoercionException.

Implements com.vertica.sdk.TypeCoercion.

java.sql.Date com.vertica.sdk.NullTypeCoercion.asDate(Object value, VerticaType type)

Not supported; returns null or raises TypeCoercionException.

Implements com.vertica.sdk.TypeCoercion.

Double com.vertica.sdk.NullTypeCoercion.asDouble(Object value, VerticaType type)

Not supported; returns null or raises TypeCoercionException.

Implements com.vertica.sdk.TypeCoercion.

Long com.vertica.sdk.NullTypeCoercion.asLong(Object value, VerticaType type)

Not supported; returns null or raises TypeCoercionException.

Implements com.vertica.sdk.TypeCoercion.

java.sql.Timestamp com.vertica.sdk.NullTypeCoercion.asTimestamp(Object value, VerticaType type)

Not supported; returns null or raises TypeCoercionException.

Implements com.vertica.sdk.TypeCoercion.

Collection com.vertica.sdk.NullTypeCoercion.getDefaultPolicy()

protected

Provides the default policy installed by the constructor.

For NullTypeCoercion, this policy is empty.

Returns A new collection of the default policy for this instance of TypeCoercion.

See Also

getPolicy() #setPolicy(Collection)

Referenced by com.vertica.sdk.NullTypeCoercion.NullTypeCoercion().

Iterator com.vertica.sdk.NullTypeCoercion.getListIterator(Object value)

Not implemented on NullTypeCoercion. Throws UnsupportedOperationException.

Implements com.vertica.sdk.TypeCoercion.

Iterator > com.vertica.sdk.NullTypeCoercion.getMapIterator(Object value)

Not implemented on NullTypeCoercion. Throws UnsupportedOperationException.

Implements com.vertica.sdk.TypeCoercion.

MetaType com.vertica.sdk.NullTypeCoercion.getMetaType(Object value)

Always returns SCALAR since this TypeCoercion doesn't know how to convert anything to LIST or MAP types.

Implements com.vertica.sdk.TypeCoercion.

Set com.vertica.sdk.NullTypeCoercion.getPolicy()

Returns an unmodifiable version of the policy.

Returns The policy collection.

See Also

setPolicy

Implements com.vertica.sdk.TypeCoercion.

Referenced by

void com.vertica.sdk.NullTypeCoercion.setPolicy(Collection policy)

Sets the policies for this TypeCoercion instance. Policies generally dictate which scenarios generate exceptions and allow for different error handling choices without implementing a new TypeCoercion class.

Parameters

  • policy: The policy collection

See Also

TypeCoercionPolicy

getPolicy()

Implements com.vertica.sdk.TypeCoercion.

Referenced by com.vertica.sdk.NullTypeCoercion.NullTypeCoercion().

void com.vertica.sdk.NullTypeCoercion.unsupportedType(Object value, VerticaType type)

protected

Throws a TypeCoercionException if the policy includes TypeCoercionPolicy#FAIL_UNSUPPORTED_TYPE. Otherwise does nothing.

Parameters

  • value: The value provided which could not be coerced.
  • type: The target Vertica type.

See Also

getPolicy() #setPolicy(Collection)

Referenced by

2.1.72 - com.vertica.sdk.NullTypeCoercion Member List

This is the complete list of members for com.vertica.sdk.NullTypeCoercion, including all inherited members.

asBinaryBytes(Object value, int length, VerticaType type) com.vertica.sdk.NullTypeCoercion
asBoolean(Object value, VerticaType type) com.vertica.sdk.NullTypeCoercion
asCharBytes(Object value, int length, VerticaType type) com.vertica.sdk.NullTypeCoercion
asDate(Object value, VerticaType type) com.vertica.sdk.NullTypeCoercion
asDouble(Object value, VerticaType type) com.vertica.sdk.NullTypeCoercion
asLong(Object value, VerticaType type) com.vertica.sdk.NullTypeCoercion
asTimestamp(Object value, VerticaType type) com.vertica.sdk.NullTypeCoercion
getDefaultPolicy() com.vertica.sdk.NullTypeCoercion protected
getListIterator(Object value) com.vertica.sdk.NullTypeCoercion
getMapIterator(Object value) com.vertica.sdk.NullTypeCoercion
getMetaType(Object value) com.vertica.sdk.NullTypeCoercion
getPolicy() com.vertica.sdk.NullTypeCoercion
NullTypeCoercion() com.vertica.sdk.NullTypeCoercion
setPolicy(Collection policy) com.vertica.sdk.NullTypeCoercion
unsupportedType(Object value, VerticaType type) com.vertica.sdk.NullTypeCoercion protected

2.1.73 - com.vertica.sdk.ParamReader Class Reference

Inheritance diagram for com.vertica.sdk.ParamReader:

Collaboration diagram for com.vertica.sdk.ParamReader:

Public Member Functions
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
boolean containsParameter (String paramName)
boolean getBoolean (int idx)
boolean getBoolean (String paramName) throws UdfException
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
java.sql.Date getDate (String paramName) throws UdfException
java.sql.Date getDate (int idx)
double getDouble (int idx)
double getDouble (String paramName) throws UdfException
int getIndex (String paramName) throws UdfException
long getLong (int idx)
long getLong (String paramName) throws UdfException
int getNumCols ()
int getNumRows ()
ArrayList getParamNames ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
String getString (String paramName) throws UdfException
String getString (int idx)
int getStringLength (String paramName) throws UdfException
int getStringLength (int idx)
int getStringLoc (int idx)
java.sql.Timestamp getTimestamp (String paramName) throws UdfException
java.sql.Timestamp getTimestamp (int idx)
VerticaType getType (String paramName) throws UdfException
SizedColumnTypes getTypeMetaData ()
VNumeric getVNumeric (String paramName) throws UdfException
VNumeric getVNumeric (int idx)
VString getVString (String paramName) throws UdfException
VString getVString (int idx)
boolean isBooleanNull (int idx)
boolean isBooleanNull (String paramName) throws UdfException
boolean isDateNull (String paramName) throws UdfException
boolean isDateNull (int idx)
boolean isDoubleNull (int idx)
boolean isDoubleNull (String paramName) throws UdfException
boolean isEmpty ()
boolean isLongNull (int idx)
boolean isLongNull (String paramName) throws UdfException
boolean isStringNull (String paramName) throws UdfException
boolean isStringNull (int idx)
boolean isTimestampInfinite (String paramName) throws UdfException
boolean isTimestampInfinite (int idx)
boolean isTimestampInfiniteNeg (String paramName) throws UdfException
boolean isTimestampInfiniteNeg (int idx)
boolean isTimestampInfinitePos (String paramName) throws UdfException
boolean isTimestampInfinitePos (int idx)
boolean isTimestampNull (String paramName) throws UdfException
boolean isTimestampNull (int idx)
boolean next () throws UdfException, DestroyInvocation
void resetBuffers ()
Public Attributes
int count
int index
int ncols
int nrows
HashMap paramNameToIndex
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos

Detailed Description

Provides read access to a set of named parameters. This class provides type-specific methods to retrieve values.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
boolean com.vertica.sdk.ParamReader.containsParameter(String paramName)

Function to see if the ParamReader has a value for the parameter

Parameters

  • paramName: parameter name to check

Returns true if it does

boolean com.vertica.sdk.BlockReader.getBoolean(int idx)

inherited Get a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a BOOLEAN.

ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

java.sql.Date com.vertica.sdk.BlockReader.getDate(int idx)

inherited Get a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DATE; null if the column is NULL.

double com.vertica.sdk.BlockReader.getDouble(int idx)

inherited Get a DOUBLE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DOUBLE.

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

long com.vertica.sdk.BlockReader.getLong(int idx)

inherited Get a LONG INTEGER value from the input row.

Example

long a = arg_reader.getLong(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a LONG INTEGER.

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

ArrayList com.vertica.sdk.ParamReader.getParamNames()

Returns all names of parameters stored in this ParamReader

String com.vertica.sdk.BlockReader.getString(int idx)

inherited Get a reference to an VARCHAR/CHAR/VARBINARY/BINARY value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an String.

int com.vertica.sdk.BlockReader.getStringLength(int idx)

inherited Get length of the String from the input row

Parameters

  • idx: The column number to retrieve from the input row.

Returns The length of the String in specified column.

Referenced by

int com.vertica.sdk.BlockReader.getStringLoc(int idx)

inherited Get 'location' of the String from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The location of the String in specified column. If zero, data is inlined immediately after the header, otherwise data is at offset loc within the data area.

Referenced by com.vertica.sdk.BlockReader.getVString().

java.sql.Timestamp com.vertica.sdk.BlockReader.getTimestamp(int idx)

inherited Get a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a TIMESTAMP; null if the column is NULL or represents 'infinity'.

VerticaType com.vertica.sdk.ParamReader.getType(String paramName) throws UdfException

Parameters

  • paramName: parameter name

Returns the type of the given parameter

Exceptions

  • UdfException: UDF problem
SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

VNumeric com.vertica.sdk.BlockReader.getVNumeric(int idx)

inherited Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the retrieved value cast as a Numeric.

VString com.vertica.sdk.BlockReader.getVString(int idx)

inherited Get a reference from the input row to an VString value, which represents a SQL VARCHAR/CHAR/VARBINARY/BINARY value.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isBooleanNull(int idx)

inherited Check whether a value from the input row is NULL in BOOLEAN type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.BlockReader.isDateNull(int idx)

inherited Check whether a value from the input row is NULL in DATE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getDate().

boolean com.vertica.sdk.BlockReader.isDoubleNull(int idx)

inherited Check whether a value from the input row is NULL in DOUBLE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.ParamReader.isEmpty()

Returns true if there are no parameters

boolean com.vertica.sdk.BlockReader.isLongNull(int idx)

inherited Check whether a value from the input row is NULL in LONG INTERGER type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by

boolean com.vertica.sdk.BlockReader.isStringNull(int idx)

inherited Check whether a value from the input row is NULL in SQL VARCHAR/CHAR/VARBINARY/BINARY type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isTimestampInfinite(int idx)

inherited Check whether a TIMESTAMP value from the input row represents 'infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity' or '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.isTimestampInfiniteNeg(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '-infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampInfinitePos(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '+infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampNull(int idx)

inherited Check whether a value from the input row is NULL in TIMESTAMP type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.next() throws UdfException, DestroyInvocation

inherited Advance to the next record.

Returns true if there are more rows to read, false otherwise.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: Invocation needed to be destroyed

2.1.74 - com.vertica.sdk.ParamReader Member List

This is the complete list of members for com.vertica.sdk.ParamReader, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
BlockReader() (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader
BlockReader(int _ncols, int _rowcount) (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader protected
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
containsParameter(String paramName) com.vertica.sdk.ParamReader
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getBoolean(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getBoolean(int idx) com.vertica.sdk.BlockReader
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getDate(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getDate(int idx) com.vertica.sdk.BlockReader
getDouble(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getDouble(int idx) com.vertica.sdk.BlockReader
getIndex(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getLong(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getLong(int idx) com.vertica.sdk.BlockReader
getNumCols() com.vertica.sdk.VerticaBlock
getNumRows() com.vertica.sdk.VerticaBlock
getParamNames() com.vertica.sdk.ParamReader
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getString(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getString(int idx) com.vertica.sdk.BlockReader
getStringLength(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getStringLength(int idx) com.vertica.sdk.BlockReader
getStringLoc(int idx) com.vertica.sdk.BlockReader
getTimestamp(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getTimestamp(int idx) com.vertica.sdk.BlockReader
getType(String paramName) com.vertica.sdk.ParamReader
getTypeMetaData() com.vertica.sdk.VerticaBlock
getVNumeric(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getVNumeric(int idx) com.vertica.sdk.BlockReader
getVString(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getVString(int idx) com.vertica.sdk.BlockReader
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
isBooleanNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isBooleanNull(int idx) com.vertica.sdk.BlockReader
isDateNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isDateNull(int idx) com.vertica.sdk.BlockReader
isDoubleNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isDoubleNull(int idx) com.vertica.sdk.BlockReader
isEmpty() com.vertica.sdk.ParamReader
isLongNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isLongNull(int idx) com.vertica.sdk.BlockReader
isStringNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isStringNull(int idx) com.vertica.sdk.BlockReader
isTimestampInfinite(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampInfinite(int idx) com.vertica.sdk.BlockReader
isTimestampInfiniteNeg(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampInfiniteNeg(int idx) com.vertica.sdk.BlockReader
isTimestampInfinitePos(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampInfinitePos(int idx) com.vertica.sdk.BlockReader
isTimestampNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampNull(int idx) com.vertica.sdk.BlockReader
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
next() com.vertica.sdk.BlockReader
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
paramNameToIndex (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
ParamReader() (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.75 - com.vertica.sdk.ParamWriter Class Reference

Inheritance diagram for com.vertica.sdk.ParamWriter:

Collaboration diagram for com.vertica.sdk.ParamWriter:

Public Member Functions
ParamWriter (ParamReader params)
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
void clearParameter (String fieldName)
boolean containsParameter (String paramName)
boolean getBoolean (int idx)
boolean getBoolean (String paramName) throws UdfException
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
java.sql.Date getDate (String paramName) throws UdfException
java.sql.Date getDate (int idx)
double getDouble (int idx)
double getDouble (String paramName) throws UdfException
int getIndex (String paramName) throws UdfException
long getLong (int idx)
long getLong (String paramName) throws UdfException
int getNumCols ()
int getNumRows ()
ArrayList getParamNames ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
String getString (String paramName) throws UdfException
String getString (int idx)
int getStringLength (String paramName) throws UdfException
int getStringLength (int idx)
int getStringLoc (int idx)
java.sql.Timestamp getTimestamp (String paramName) throws UdfException
java.sql.Timestamp getTimestamp (int idx)
VerticaType getType (String paramName) throws UdfException
SizedColumnTypes getTypeMetaData ()
VNumeric getVNumeric (String paramName) throws UdfException
VNumeric getVNumeric (int idx)
VString getVString (String paramName) throws UdfException
VString getVString (int idx)
boolean isBooleanNull (int idx)
boolean isBooleanNull (String paramName) throws UdfException
boolean isDateNull (String paramName) throws UdfException
boolean isDateNull (int idx)
boolean isDoubleNull (int idx)
boolean isDoubleNull (String paramName) throws UdfException
boolean isEmpty ()
boolean isLongNull (int idx)
boolean isLongNull (String paramName) throws UdfException
boolean isStringNull (String paramName) throws UdfException
boolean isStringNull (int idx)
boolean isTimestampInfinite (String paramName) throws UdfException
boolean isTimestampInfinite (int idx)
boolean isTimestampInfiniteNeg (String paramName) throws UdfException
boolean isTimestampInfiniteNeg (int idx)
boolean isTimestampInfinitePos (String paramName) throws UdfException
boolean isTimestampInfinitePos (int idx)
boolean isTimestampNull (String paramName) throws UdfException
boolean isTimestampNull (int idx)
boolean next () throws UdfException, DestroyInvocation
void resetBuffers ()
void setBool (String fieldName, boolean r) throws UdfException
Adds a BOOLEAN value to the output row.
void setDate (String fieldName, java.sql.Date r) throws UdfException
Adds a DATE value to the output row.
void setDouble (String fieldName, double r) throws UdfException
Adds a FLOAT value to the output row.
void setLong (String fieldName, Long r) throws UdfException
Adds a LONG INTEGER value to the output row.
void setLongString (String fieldName, String r) throws UdfException
Adds a Long String value to the output row.
void setNumeric (String fieldName, BigDecimal bd)
Allocate a new VNumeric object to use as output.
void setString (String fieldName, String r) throws UdfException
Adds a String value to the output row.
void setTimestamp (String fieldName, java.sql.Timestamp r) throws UdfException
Adds a TIMESTAMP value to the output row.
void setTimestampInfiniteNeg (String fieldName) throws UdfException
void setTimestampInfinitePos (String fieldName) throws UdfException
Public Attributes
int count
int index
int ncols
int nrows
HashMap paramNameToIndex
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos

Detailed Description

Provides write access to a set of named parameters. This class extends ParamReader to add type-specific methods to write values.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
boolean com.vertica.sdk.ParamReader.containsParameter(String paramName)

inherited Function to see if the ParamReader has a value for the parameter

Parameters

  • paramName: parameter name to check

Returns true if it does

boolean com.vertica.sdk.BlockReader.getBoolean(int idx)

inherited Get a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a BOOLEAN.

ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

java.sql.Date com.vertica.sdk.BlockReader.getDate(int idx)

inherited Get a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DATE; null if the column is NULL.

double com.vertica.sdk.BlockReader.getDouble(int idx)

inherited Get a DOUBLE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DOUBLE.

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

long com.vertica.sdk.BlockReader.getLong(int idx)

inherited Get a LONG INTEGER value from the input row.

Example

long a = arg_reader.getLong(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a LONG INTEGER.

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

ArrayList com.vertica.sdk.ParamReader.getParamNames()

inherited Returns all names of parameters stored in this ParamReader

String com.vertica.sdk.BlockReader.getString(int idx)

inherited Get a reference to an VARCHAR/CHAR/VARBINARY/BINARY value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an String.

int com.vertica.sdk.BlockReader.getStringLength(int idx)

inherited Get length of the String from the input row

Parameters

  • idx: The column number to retrieve from the input row.

Returns The length of the String in specified column.

Referenced by

int com.vertica.sdk.BlockReader.getStringLoc(int idx)

inherited Get 'location' of the String from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The location of the String in specified column. If zero, data is inlined immediately after the header, otherwise data is at offset loc within the data area.

Referenced by com.vertica.sdk.BlockReader.getVString().

java.sql.Timestamp com.vertica.sdk.BlockReader.getTimestamp(int idx)

inherited Get a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a TIMESTAMP; null if the column is NULL or represents 'infinity'.

VerticaType com.vertica.sdk.ParamReader.getType(String paramName) throws UdfException

inherited Parameters

  • paramName: parameter name

Returns the type of the given parameter

Exceptions

  • UdfException: UDF problem
SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

VNumeric com.vertica.sdk.BlockReader.getVNumeric(int idx)

inherited Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the retrieved value cast as a Numeric.

VString com.vertica.sdk.BlockReader.getVString(int idx)

inherited Get a reference from the input row to an VString value, which represents a SQL VARCHAR/CHAR/VARBINARY/BINARY value.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isBooleanNull(int idx)

inherited Check whether a value from the input row is NULL in BOOLEAN type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.BlockReader.isDateNull(int idx)

inherited Check whether a value from the input row is NULL in DATE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getDate().

boolean com.vertica.sdk.BlockReader.isDoubleNull(int idx)

inherited Check whether a value from the input row is NULL in DOUBLE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.ParamReader.isEmpty()

inherited Returns true if there are no parameters

boolean com.vertica.sdk.BlockReader.isLongNull(int idx)

inherited Check whether a value from the input row is NULL in LONG INTERGER type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by

boolean com.vertica.sdk.BlockReader.isStringNull(int idx)

inherited Check whether a value from the input row is NULL in SQL VARCHAR/CHAR/VARBINARY/BINARY type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isTimestampInfinite(int idx)

inherited Check whether a TIMESTAMP value from the input row represents 'infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity' or '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.isTimestampInfiniteNeg(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '-infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampInfinitePos(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '+infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampNull(int idx)

inherited Check whether a value from the input row is NULL in TIMESTAMP type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.next() throws UdfException, DestroyInvocation

inherited Advance to the next record.

Returns true if there are more rows to read, false otherwise.

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: Invocation needed to be destroyed
void com.vertica.sdk.ParamWriter.setBool(String fieldName, boolean r) throws UdfException

Adds a BOOLEAN value to the output row.

Parameters

  • r: The BOOLEAN value to insert into the output row.
void com.vertica.sdk.ParamWriter.setDate(String fieldName, java.sql.Date r) throws UdfException

Adds a DATE value to the output row.

Parameters

  • r: The DATE value to insert into the output row.
void com.vertica.sdk.ParamWriter.setDouble(String fieldName, double r) throws UdfException

Adds a FLOAT value to the output row.

Parameters

  • r: The FLOAT value to insert into the output row.
void com.vertica.sdk.ParamWriter.setLong(String fieldName, Long r) throws UdfException

Adds a LONG INTEGER value to the output row.

Parameters

  • r: The LONG INTEGER value to insert into the output row.

Referenced by

void com.vertica.sdk.ParamWriter.setLongString(String fieldName, String r) throws UdfException

Adds a Long String value to the output row.

Parameters

  • r: The Long String value to insert into the output row.
void com.vertica.sdk.ParamWriter.setNumeric(String fieldName, BigDecimal bd)

Allocate a new VNumeric object to use as output.

Returns A new VNumeric object to hold output. This object automatically added to the output row.

void com.vertica.sdk.ParamWriter.setString(String fieldName, String r) throws UdfException

Adds a String value to the output row.

Parameters

  • r: The String value to insert into the output row.
void com.vertica.sdk.ParamWriter.setTimestamp(String fieldName, java.sql.Timestamp r) throws UdfException

Adds a TIMESTAMP value to the output row.

Parameters

  • r: The TIMESTAMP value to insert into the output row.

2.1.76 - com.vertica.sdk.ParamWriter Member List

This is the complete list of members for com.vertica.sdk.ParamWriter, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
BlockReader() (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader
BlockReader(int _ncols, int _rowcount) (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader protected
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
clearParameter(String fieldName) (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
containsParameter(String paramName) com.vertica.sdk.ParamReader
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getBoolean(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getBoolean(int idx) com.vertica.sdk.BlockReader
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getDate(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getDate(int idx) com.vertica.sdk.BlockReader
getDouble(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getDouble(int idx) com.vertica.sdk.BlockReader
getIndex(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getLong(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getLong(int idx) com.vertica.sdk.BlockReader
getNumCols() com.vertica.sdk.VerticaBlock
getNumRows() com.vertica.sdk.VerticaBlock
getParamNames() com.vertica.sdk.ParamReader
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getString(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getString(int idx) com.vertica.sdk.BlockReader
getStringLength(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getStringLength(int idx) com.vertica.sdk.BlockReader
getStringLoc(int idx) com.vertica.sdk.BlockReader
getTimestamp(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getTimestamp(int idx) com.vertica.sdk.BlockReader
getType(String paramName) com.vertica.sdk.ParamReader
getTypeMetaData() com.vertica.sdk.VerticaBlock
getVNumeric(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getVNumeric(int idx) com.vertica.sdk.BlockReader
getVString(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.getVString(int idx) com.vertica.sdk.BlockReader
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
isBooleanNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isBooleanNull(int idx) com.vertica.sdk.BlockReader
isDateNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isDateNull(int idx) com.vertica.sdk.BlockReader
isDoubleNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isDoubleNull(int idx) com.vertica.sdk.BlockReader
isEmpty() com.vertica.sdk.ParamReader
isLongNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isLongNull(int idx) com.vertica.sdk.BlockReader
isStringNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isStringNull(int idx) com.vertica.sdk.BlockReader
isTimestampInfinite(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampInfinite(int idx) com.vertica.sdk.BlockReader
isTimestampInfiniteNeg(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampInfiniteNeg(int idx) com.vertica.sdk.BlockReader
isTimestampInfinitePos(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampInfinitePos(int idx) com.vertica.sdk.BlockReader
isTimestampNull(String paramName) (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
com::vertica::sdk::BlockReader.isTimestampNull(int idx) com.vertica.sdk.BlockReader
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
next() com.vertica.sdk.BlockReader
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
paramNameToIndex (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
ParamReader() (defined in com.vertica.sdk.ParamReader) com.vertica.sdk.ParamReader
ParamWriter() (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
ParamWriter(ParamReader params) (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
setBool(String fieldName, boolean r) com.vertica.sdk.ParamWriter
setDate(String fieldName, java.sql.Date r) com.vertica.sdk.ParamWriter
setDouble(String fieldName, double r) com.vertica.sdk.ParamWriter
setLong(String fieldName, Long r) com.vertica.sdk.ParamWriter
setLongString(String fieldName, String r) com.vertica.sdk.ParamWriter
setNumeric(String fieldName, BigDecimal bd) com.vertica.sdk.ParamWriter
setString(String fieldName, String r) com.vertica.sdk.ParamWriter
setTimestamp(String fieldName, java.sql.Timestamp r) com.vertica.sdk.ParamWriter
setTimestampInfiniteNeg(String fieldName) (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
setTimestampInfinitePos(String fieldName) (defined in com.vertica.sdk.ParamWriter) com.vertica.sdk.ParamWriter
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.77 - com.vertica.sdk.ParserFactory Class Reference

Inheritance diagram for com.vertica.sdk.ParserFactory:

Collaboration diagram for com.vertica.sdk.ParserFactory:

Public Member Functions
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getParserReturnType (ServerInterface srvInterface, PerColumnParamReader perColumnParamReader, PlanContext planCtxt, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)
UDXType getUDXFactoryType ()
void plan (ServerInterface srvInterface, PerColumnParamReader perColumnParamReader, PlanContext planCtxt) throws UdfException
abstract UDParser prepare (ServerInterface srvInterface, PerColumnParamReader perColumnParamReader, PlanContext planCtxt, SizedColumnTypes returnType) throws UdfException
Protected Attributes
long libOid
String sqlName

Detailed Description

Produces and initializes UDParsers to parse input into tuples.

Note that ParserFactories are singletons. Subclasses should be stateless, with no fields containing data, just methods. plan() and prepare() methods must never modify any global variables or state; they may only modify the variables that they are given as arguments.

Member Function Documentation

void com.vertica.sdk.ParserFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

Inherited from the parent "UDXFactory" class in VerticaUDx.h

void com.vertica.sdk.ParserFactory.getParserReturnType(ServerInterface srvInterface, PerColumnParamReader perColumnParamReader, PlanContext planCtxt, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException

Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are. Called, possibly multiple times, on each node executing the query.

The default provided implementation configures Vertica to use the same output column types as the destination table. This requires that the UDParser validate the expected output column types and emit appropriate tuples.

Note that the default provided implementation of this function should be sufficient for most Parsers, so this method should not be overridden by most Parser implementations.

If a COPY statement has a return type that doesn't match the destination table, Vertica will emit an appropriate error. Users can use COPY expressions to perform typecasting and conversion if necessary.

For CHAR/VARCHAR types, specify the max length,

For Time/Timestamp types (with or without time zone), specify the precision, -1 means unspecified/don't care

For all other types, no length/precision specification needed

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • perColumnParamReader: Per-column parameters passed into the query
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().
  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Exceptions

  • UdfException: UDF problem
void com.vertica.sdk.UDLFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
void com.vertica.sdk.UDLFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

virtualinherited

Provides the argument and return types of the UDL. UDL's take no input tuples; as such, their prototype is empty.

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.UDLFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)

virtualinherited

Not used in this form

Implements com.vertica.sdk.UDXFactory.

UDXType com.vertica.sdk.ParserFactory.getUDXFactoryType()

virtual

User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Returns the type of UDX Object instance this factory returns.

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.ParserFactory.plan(ServerInterface srvInterface, PerColumnParamReader perColumnParamReader, PlanContext planCtxt) throws UdfException

Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on (through srvInterface).

plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • perColumnParamReader: Per-column parameters passed into the query
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().

Exceptions

  • UdfException: UDF problem
abstract UDParser com.vertica.sdk.ParserFactory.prepare(ServerInterface srvInterface, PerColumnParamReader perColumnParamReader, PlanContext planCtxt, SizedColumnTypes returnType) throws UdfException

pure virtual Instantiate a UDParser instance. This function will be called on each node, prior to the Load operator starting to execute.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • perColumnParamReader: Per-column parameters passed into the query
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().
  • returnType: The data types of the columns that this Parser must produce

Returns The UDParser instance to be used by this query

Exceptions

  • UdfException: UDF problem

2.1.78 - com.vertica.sdk.ParserFactory Member List

This is the complete list of members for com.vertica.sdk.ParserFactory, including all inherited members.

getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.ParserFactory
getParserReturnType(ServerInterface srvInterface, PerColumnParamReader perColumnParamReader, PlanContext planCtxt, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.ParserFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) (defined in com.vertica.sdk.UDLFactory) com.vertica.sdk.UDLFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDLFactory
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getUDXFactoryType() com.vertica.sdk.ParserFactory virtual
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
plan(ServerInterface srvInterface, PerColumnParamReader perColumnParamReader, PlanContext planCtxt) com.vertica.sdk.ParserFactory
prepare(ServerInterface srvInterface, PerColumnParamReader perColumnParamReader, PlanContext planCtxt, SizedColumnTypes returnType) com.vertica.sdk.ParserFactory pure virtual
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected

2.1.79 - com.vertica.sdk.PartitionReader Class Reference

Inheritance diagram for com.vertica.sdk.PartitionReader:

Collaboration diagram for com.vertica.sdk.PartitionReader:

Public Member Functions
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
boolean getBoolean (int idx)
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
java.sql.Date getDate (int idx)
double getDouble (int idx)
long getLong (int idx)
int getNumCols ()
int getNumRows ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
String getString (int idx)
int getStringLength (int idx)
int getStringLoc (int idx)
java.sql.Timestamp getTimestamp (int idx)
SizedColumnTypes getTypeMetaData ()
VNumeric getVNumeric (int idx)
VString getVString (int idx)
boolean isBooleanNull (int idx)
boolean isDateNull (int idx)
boolean isDoubleNull (int idx)
boolean isLongNull (int idx)
boolean isStringNull (int idx)
boolean isTimestampInfinite (int idx)
boolean isTimestampInfiniteNeg (int idx)
boolean isTimestampInfinitePos (int idx)
boolean isTimestampNull (int idx)
boolean next () throws UdfException, DestroyInvocation
abstract boolean readNextBlock () throws UdfException, DestroyInvocation
void resetBuffers ()
Public Attributes
int count
int index
int ncols
int nrows
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos

Detailed Description

PartitionReader provides an iterator-based read interface over all input data in a single partition. Automatically fetches data a block-at-a-time, as needed.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
boolean com.vertica.sdk.BlockReader.getBoolean(int idx)

inherited Get a BOOLEAN value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a BOOLEAN.

ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

java.sql.Date com.vertica.sdk.BlockReader.getDate(int idx)

inherited Get a DATE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DATE; null if the column is NULL.

double com.vertica.sdk.BlockReader.getDouble(int idx)

inherited Get a DOUBLE value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a DOUBLE.

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

long com.vertica.sdk.BlockReader.getLong(int idx)

inherited Get a LONG INTEGER value from the input row.

Example

long a = arg_reader.getLong(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a LONG INTEGER.

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

String com.vertica.sdk.BlockReader.getString(int idx)

inherited Get a reference to an VARCHAR/CHAR/VARBINARY/BINARY value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an String.

int com.vertica.sdk.BlockReader.getStringLength(int idx)

inherited Get length of the String from the input row

Parameters

  • idx: The column number to retrieve from the input row.

Returns The length of the String in specified column.

Referenced by

int com.vertica.sdk.BlockReader.getStringLoc(int idx)

inherited Get 'location' of the String from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The location of the String in specified column. If zero, data is inlined immediately after the header, otherwise data is at offset loc within the data area.

Referenced by com.vertica.sdk.BlockReader.getVString().

java.sql.Timestamp com.vertica.sdk.BlockReader.getTimestamp(int idx)

inherited Get a TIMESTAMP value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns The value of the idx'th argument, cast as a TIMESTAMP; null if the column is NULL or represents 'infinity'.

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

VNumeric com.vertica.sdk.BlockReader.getVNumeric(int idx)

inherited Get a reference to a VNumeric value from the input row.

Parameters

  • idx: The column number to retrieve from the input row.

Returns A reference to the retrieved value cast as a Numeric.

VString com.vertica.sdk.BlockReader.getVString(int idx)

inherited Get a reference from the input row to an VString value, which represents a SQL VARCHAR/CHAR/VARBINARY/BINARY value.

Parameters

  • idx: The column number to retrieve from the input row.

Returns a reference to the idx'th argument, cast as an VString.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isBooleanNull(int idx)

inherited Check whether a value from the input row is NULL in BOOLEAN type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.BlockReader.isDateNull(int idx)

inherited Check whether a value from the input row is NULL in DATE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getDate().

boolean com.vertica.sdk.BlockReader.isDoubleNull(int idx)

inherited Check whether a value from the input row is NULL in DOUBLE type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

boolean com.vertica.sdk.BlockReader.isLongNull(int idx)

inherited Check whether a value from the input row is NULL in LONG INTERGER type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by

boolean com.vertica.sdk.BlockReader.isStringNull(int idx)

inherited Check whether a value from the input row is NULL in SQL VARCHAR/CHAR/VARBINARY/BINARY type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getString().

boolean com.vertica.sdk.BlockReader.isTimestampInfinite(int idx)

inherited Check whether a TIMESTAMP value from the input row represents 'infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity' or '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

boolean com.vertica.sdk.BlockReader.isTimestampInfiniteNeg(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '-infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '-infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampInfinitePos(int idx)

inherited Check whether a TIMESTAMP value from the input row represents '+infinity'.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the TIMESTAMP value is '+infinity', false otherwise.

Referenced by com.vertica.sdk.BlockReader.isTimestampInfinite().

boolean com.vertica.sdk.BlockReader.isTimestampNull(int idx)

inherited Check whether a value from the input row is NULL in TIMESTAMP type.

Parameters

  • idx: The column number to retrieve from the input row.

Returns true if the value is NULL, false otherwise.

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

abstract boolean com.vertica.sdk.PartitionReader.readNextBlock() throws UdfException, DestroyInvocation

pure virtual Reads in the next block of data and positions cursor at the beginning.

Returns false if there's no more input data

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: Invocation needed to be destroyed

Implemented in com.vertica.sdk.AnalyticPartitionReader.

2.1.80 - com.vertica.sdk.PartitionReader Member List

This is the complete list of members for com.vertica.sdk.PartitionReader, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
BlockReader() (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader
BlockReader(int _ncols, int _rowcount) (defined in com.vertica.sdk.BlockReader) com.vertica.sdk.BlockReader protected
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getBoolean(int idx) com.vertica.sdk.BlockReader
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getDate(int idx) com.vertica.sdk.BlockReader
getDouble(int idx) com.vertica.sdk.BlockReader
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getLong(int idx) com.vertica.sdk.BlockReader
getNumCols() com.vertica.sdk.VerticaBlock
getNumRows() com.vertica.sdk.VerticaBlock
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getString(int idx) com.vertica.sdk.BlockReader
getStringLength(int idx) com.vertica.sdk.BlockReader
getStringLoc(int idx) com.vertica.sdk.BlockReader
getTimestamp(int idx) com.vertica.sdk.BlockReader
getTypeMetaData() com.vertica.sdk.VerticaBlock
getVNumeric(int idx) com.vertica.sdk.BlockReader
getVString(int idx) com.vertica.sdk.BlockReader
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
isBooleanNull(int idx) com.vertica.sdk.BlockReader
isDateNull(int idx) com.vertica.sdk.BlockReader
isDoubleNull(int idx) com.vertica.sdk.BlockReader
isLongNull(int idx) com.vertica.sdk.BlockReader
isStringNull(int idx) com.vertica.sdk.BlockReader
isTimestampInfinite(int idx) com.vertica.sdk.BlockReader
isTimestampInfiniteNeg(int idx) com.vertica.sdk.BlockReader
isTimestampInfinitePos(int idx) com.vertica.sdk.BlockReader
isTimestampNull(int idx) com.vertica.sdk.BlockReader
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
next() (defined in com.vertica.sdk.PartitionReader) com.vertica.sdk.PartitionReader
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
PartitionReader() (defined in com.vertica.sdk.PartitionReader) com.vertica.sdk.PartitionReader
readNextBlock() com.vertica.sdk.PartitionReader pure virtual
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.81 - com.vertica.sdk.PartitionWriter Class Reference

Inheritance diagram for com.vertica.sdk.PartitionWriter:

Collaboration diagram for com.vertica.sdk.PartitionWriter:

Public Member Functions
PartitionWriter (int nargs)
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
void copyFromInput (int dstIdx, PartitionReader input_reader, int srcIdx) throws UdfException
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
TypeCoercion getDefaultTypeCoercion ()
int getNumCols ()
VNumeric getNumericWriter (int idx)
int getNumRows ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
VString getStringWriter (int idx)
SizedColumnTypes getTypeMetaData ()
abstract boolean getWriteableBlock () throws UdfException, DestroyInvocation
boolean next () throws UdfException, DestroyInvocation
void resetBuffers ()
void setBoolean (int idx, boolean r)
void setBooleanNull (int idx)
void setBooleanValue (int idx, Boolean value)
void setDate (int idx, java.sql.Date r)
void setDateNull (int idx)
void setDateValue (int idx, java.sql.Date value)
TypeCoercion setDefaultTypeCoercion (TypeCoercion coerce)
void setDouble (int idx, double r)
void setDoubleNull (int idx)
void setDoubleValue (int idx, Double value)
void setLong (int idx, long r)
void setLongNull (int idx)
void setLongValue (int idx, Long value)
void setNumeric (int idx, BigDecimal bd)
void setNumericNull (int idx)
void setNumericValue (int idx, BigDecimal value)
void setRowFromMap (Map rowData)
void setRowFromMap (Map rowData, TypeCoercion coerce)
void setString (int idx, String r)
void setStringBytes (int idx, ByteBuffer bytes)
void setStringNull (int idx)
void setStringValue (int idx, String value)
void setTimestamp (int idx, java.sql.Timestamp r)
void setTimestampInfiniteNeg (int idx)
void setTimestampInfinitePos (int idx)
void setTimestampNull (int idx)
void setTimestampValue (int idx, java.sql.Timestamp value)
void setValue (int idx, Object value, TypeCoercion coerce)
void setVMap (int idx, Map data)
void setVMap (int idx, Map data, TypeCoercion coerce)
void throwInCorrectUsageError (int idx)
: Throwing UdfException for incorrect setter usage
Public Attributes
int count
int index
int ncols
int nrows
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
long getRowSize (SizedColumnTypes types)
void setRowCount (SizedColumnTypes types)
Static Protected Member Functions
static long blockSizeGivenRowSize (long row_size)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos

Detailed Description

PartitionWriter provides an iterator-based write interface over output data for a single partition. Automatically makes space a block-at-a-time, as needed.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
void com.vertica.sdk.PartitionWriter.copyFromInput(int dstIdx, PartitionReader input_reader, int srcIdx) throws UdfException

Copies a column from the input reader to the output writer. The data types and sizes of the source and destination columns must match exactly.

Parameters

  • dstIdx: The destination column index (in the output writer)
  • input_reader: The input reader from which to copy a column
  • srcIdx: The source column index (in the input reader)
ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

TypeCoercion com.vertica.sdk.PartitionWriter.getDefaultTypeCoercion()

Give the default TypeCoercion instance, creating one if necessary. This may be useful in cases where the calling code would like to change the TypeCoercionPolicy or do TypeCoercion in the same manner as this PartitionWriter.

If a TypeCoercion is created, it is an instance of StandardTypeCoercion.

See Also #setRowFromMap(Map)

Returns the current default TypeCoercion, creating one if necessary.

Referenced by

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

abstract boolean com.vertica.sdk.PartitionWriter.getWriteableBlock() throws UdfException, DestroyInvocation

pure virtual Gets a writeable block of data and positions cursor at the beginning.

Returns true on success; use other methods to manipulate the block

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: Invocation needed to be destroyed

Implemented in com.vertica.sdk.StreamWriter, and com.vertica.sdk.AnalyticPartitionWriter.

void com.vertica.sdk.PartitionWriter.setBooleanValue(int idx, Boolean value)

Set a Boolean value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setDateValue(int idx, java.sql.Date value)

Set a Date value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
TypeCoercion com.vertica.sdk.PartitionWriter.setDefaultTypeCoercion(TypeCoercion coerce)

Set the default type coercion instance.

See Also #setRowFromMap(Map)

Parameters

  • coerce: A TypeCoercion instance.

Returns the former default, which may be null.

void com.vertica.sdk.PartitionWriter.setDoubleValue(int idx, Double value)

Set a Double value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setLongValue(int idx, Long value)

Set a Long value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setNumericValue(int idx, BigDecimal value)

Set a Numeric value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setRowFromMap(Map rowData)

Sets all columns on the current row according to the data provided, using the column names to match the data keys. See setRowFromMap(Map, TypeCoercion) for more details. This is a shortcut for using the default type coercion.

Parameters

  • rowData: The data. Null data is treated as empty.

See Also #setRowFromMap(Map, TypeCoercion)

getDefaultTypeCoercion()

void com.vertica.sdk.PartitionWriter.setRowFromMap(Map rowData, TypeCoercion coerce)

Sets all columns on the current row according to the data provided, using the column names to match the data keys.

For each column, TypeCoercion will be used to convert a value in rowData to the appropriate type for that column. This is done via setValue and may cause a TypeCoercion exception.

To find the corresponding value, the 'first' matching key (according to case-insensitive SQL identifier matching) in the map will be used. 'first' is not well defined, but is consistent.

If no corresponding value is found, the column will be set to null. This never raises an exception, regardless of the target column type. That is, FAIL_SDK_UNSUPPORTED_TYPE is ignored in that case.

In addition, if the target row structure appears to be a flex table, the necessary internal structures will be populated with an encoded vmap via setVMap(int, Map, TypeCoercion).

Parameters

  • rowData: The data. Null data is treated as empty.
  • coerce: The implementation of coercion

See Also #setVMap(int, Map, TypeCoercion)

setValue(int, Object, TypeCoercion)

void com.vertica.sdk.PartitionWriter.setStringBytes(int idx, ByteBuffer bytes)

Set a String value for column at index idx. Accepts null values.

Parameters

  • idx: The column index
  • bytes: A ByteBuffer with bytes between position and limit that are a string encoded according to Vertica's requirements. This buffer must fit within the column's length requirements.

Exceptions

  • IllegalArgumentException: if bytes is too long
void com.vertica.sdk.PartitionWriter.setStringValue(int idx, String value)

Set a String value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setTimestampValue(int idx, java.sql.Timestamp value)

Set a Timestamp value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setValue(int idx, Object value, TypeCoercion coerce)

Set a value for a column using type coercion. Type coercion attempts to generate an appropriate value for the target column type based on the input type.

The following target column types are supported by the SDK for this method. All others will generate a TypeCoercionException due to FAIL_SDK_UNSUPPORTED_TYPE if appropriate.

  • Bools

  • Integers (excluding Numeric)

  • Floats

  • String-like types (char and binary, along with var- and long variants)

  • Timestamp and timestamptz

  • Dates

Parameters

  • idx: The column index
  • value: The value to store in the column. May be null.
  • coerce: The type coercion policy.

Referenced by com.vertica.sdk.PartitionWriter.setRowFromMap().

void com.vertica.sdk.PartitionWriter.setVMap(int idx, Map data)

Encodes a VMap into the given column, which must be of binary type.

Parameters

  • idx: The index of the binary or varbinary column.
  • data: The data. Null data is treated as empty.

See Also #setVMap(int, Map, TypeCoercion)

getDefaultTypeCoercion()

void com.vertica.sdk.PartitionWriter.setVMap(int idx, Map data, TypeCoercion coerce)

Encodes a VMap into the given column, which must be of binary type. Uses standard type coercion to identify aggregate values and to serialize all values.

Parameters

  • idx: The index of the binary or varbinary column.
  • data: The data. Null data is treated as empty.
  • coerce: Ignored but still here for backwards compatibility.

See Also #setVMap(int, Map)

getDefaultTypeCoercion()

2.1.82 - com.vertica.sdk.PartitionWriter Member List

This is the complete list of members for com.vertica.sdk.PartitionWriter, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
blockSizeGivenRowSize(long row_size) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter protectedstatic
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
copyFromInput(int dstIdx, PartitionReader input_reader, int srcIdx) com.vertica.sdk.PartitionWriter
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getDefaultTypeCoercion() com.vertica.sdk.PartitionWriter
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getNumCols() com.vertica.sdk.VerticaBlock
getNumericWriter(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
getNumRows() com.vertica.sdk.VerticaBlock
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getRowSize(SizedColumnTypes types) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter protected
getStringWriter(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
getTypeMetaData() com.vertica.sdk.VerticaBlock
getWriteableBlock() com.vertica.sdk.PartitionWriter pure virtual
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
next() (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
PartitionWriter(int nargs) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
setBoolean(int idx, boolean r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setBooleanNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setBooleanValue(int idx, Boolean value) com.vertica.sdk.PartitionWriter
setDate(int idx, java.sql.Date r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDateNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDateValue(int idx, java.sql.Date value) com.vertica.sdk.PartitionWriter
setDefaultTypeCoercion(TypeCoercion coerce) com.vertica.sdk.PartitionWriter
setDouble(int idx, double r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDoubleNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDoubleValue(int idx, Double value) com.vertica.sdk.PartitionWriter
setLong(int idx, long r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setLongNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setLongValue(int idx, Long value) com.vertica.sdk.PartitionWriter
setNumeric(int idx, BigDecimal bd) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setNumericNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setNumericValue(int idx, BigDecimal value) com.vertica.sdk.PartitionWriter
setRowCount(SizedColumnTypes types) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter protected
setRowFromMap(Map rowData) com.vertica.sdk.PartitionWriter
setRowFromMap(Map rowData, TypeCoercion coerce) com.vertica.sdk.PartitionWriter
setString(int idx, String r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setStringBytes(int idx, ByteBuffer bytes) com.vertica.sdk.PartitionWriter
setStringNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setStringValue(int idx, String value) com.vertica.sdk.PartitionWriter
setTimestamp(int idx, java.sql.Timestamp r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampInfiniteNeg(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampInfinitePos(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampValue(int idx, java.sql.Timestamp value) com.vertica.sdk.PartitionWriter
setValue(int idx, Object value, TypeCoercion coerce) com.vertica.sdk.PartitionWriter
setVMap(int idx, Map data) com.vertica.sdk.PartitionWriter
setVMap(int idx, Map data, TypeCoercion coerce) com.vertica.sdk.PartitionWriter
throwInCorrectUsageError(int idx) com.vertica.sdk.PartitionWriter
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.83 - com.vertica.sdk.PerColumnParamReader Class Reference

Collaboration diagram for com.vertica.sdk.PerColumnParamReader:

Public Member Functions
boolean containsColumn (String columnName)
Collection getColumnNames ()
ParamReader getColumnParamReader (String column)
Public Attributes
Map paramReaderByCol

Detailed Description

A wrapper around a map from column to ParamReader.

Member Function Documentation

boolean com.vertica.sdk.PerColumnParamReader.containsColumn(String columnName)

Parameters

  • columnName: name of column

Returns true if a ParamReader exists for the given column

Collection com.vertica.sdk.PerColumnParamReader.getColumnNames()

Gets the names of all columns with column specific arguments

Returns a vector of column names

ParamReader com.vertica.sdk.PerColumnParamReader.getColumnParamReader(String column)

Gets the parameters of the given column

Parameters

  • column: the name of the column of interest

Returns the parameters of the given column

2.1.84 - com.vertica.sdk.PerColumnParamReader Member List

This is the complete list of members for com.vertica.sdk.PerColumnParamReader, including all inherited members.

containsColumn(String columnName) com.vertica.sdk.PerColumnParamReader
getColumnNames() com.vertica.sdk.PerColumnParamReader
getColumnParamReader(String column) com.vertica.sdk.PerColumnParamReader
paramReaderByCol (defined in com.vertica.sdk.PerColumnParamReader) com.vertica.sdk.PerColumnParamReader
PerColumnParamReader() (defined in com.vertica.sdk.PerColumnParamReader) com.vertica.sdk.PerColumnParamReader

2.1.85 - com.vertica.sdk.PGUDxShared Class Reference

Collaboration diagram for com.vertica.sdk.PGUDxShared:

Static Public Member Functions
static long PRECISIONFROMTYPMOD (long t)
static long SCALEFROMTYPMOD (long t)
static long TYPMODFROMPRECSCALE (long p, long s)
Static Public Attributes
static final int NUMERIC_MAX_PRECISION = 1024
static final int VARHDRSZ = 4

2.1.86 - com.vertica.sdk.PGUDxShared Member List

This is the complete list of members for com.vertica.sdk.PGUDxShared, including all inherited members.

NUMERIC_MAX_PRECISION (defined in com.vertica.sdk.PGUDxShared) com.vertica.sdk.PGUDxShared static
PRECISIONFROMTYPMOD(long t) (defined in com.vertica.sdk.PGUDxShared) com.vertica.sdk.PGUDxShared static
SCALEFROMTYPMOD(long t) (defined in com.vertica.sdk.PGUDxShared) com.vertica.sdk.PGUDxShared static
TYPMODFROMPRECSCALE(long p, long s) (defined in com.vertica.sdk.PGUDxShared) com.vertica.sdk.PGUDxShared static
VARHDRSZ (defined in com.vertica.sdk.PGUDxShared) com.vertica.sdk.PGUDxShared static

2.1.87 - com.vertica.sdk.PlanContext Class Reference

Inheritance diagram for com.vertica.sdk.PlanContext:

Collaboration diagram for com.vertica.sdk.PlanContext:

Public Member Functions
PlanContext (ParamWriter writer, ArrayList clusterNodes)
PlanContext (ParamWriter writer)
ArrayList getClusterNodes ()
ParamReader getReader ()
ParamWriter getWriter ()

Detailed Description

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.

Member Function Documentation

ArrayList com.vertica.sdk.PlanContext.getClusterNodes()

Returns A list of all of the nodes in the current cluster, by node name

ParamReader com.vertica.sdk.PlanContext.getReader()

Returns A read-only instance of the current context

ParamWriter com.vertica.sdk.PlanContext.getWriter()

Returns The current context for writing

2.1.88 - com.vertica.sdk.PlanContext Member List

This is the complete list of members for com.vertica.sdk.PlanContext, including all inherited members.

getClusterNodes() com.vertica.sdk.PlanContext
getReader() com.vertica.sdk.PlanContext
getWriter() com.vertica.sdk.PlanContext
PlanContext(ParamWriter writer, ArrayList clusterNodes) (defined in com.vertica.sdk.PlanContext) com.vertica.sdk.PlanContext
PlanContext(ParamWriter writer) (defined in com.vertica.sdk.PlanContext) com.vertica.sdk.PlanContext

2.1.89 - com.vertica.sdk.Portion Class Reference

Collaboration diagram for com.vertica.sdk.Portion:

Public Member Functions
Portion (long o, long s, boolean t)
boolean isValid ()
Public Attributes
boolean is_first_portion
long offset
long size

Detailed Description

Portion

Describe a source portion

2.1.90 - com.vertica.sdk.Portion Member List

This is the complete list of members for com.vertica.sdk.Portion, including all inherited members.

is_first_portion (defined in com.vertica.sdk.Portion) com.vertica.sdk.Portion
isValid() (defined in com.vertica.sdk.Portion) com.vertica.sdk.Portion
offset (defined in com.vertica.sdk.Portion) com.vertica.sdk.Portion
Portion() (defined in com.vertica.sdk.Portion) com.vertica.sdk.Portion
Portion(long o, long s, boolean t) (defined in com.vertica.sdk.Portion) com.vertica.sdk.Portion
size (defined in com.vertica.sdk.Portion) com.vertica.sdk.Portion

2.1.91 - com.vertica.sdk.RejectedRecord Class Reference

Collaboration diagram for com.vertica.sdk.RejectedRecord:

Public Member Functions
RejectedRecord (String reason, char[] data, int length, String terminator)
RejectedRecord (String reason, char[] data, int length)
RejectedRecord (String reason, char[] data)
RejectedRecord (String reason)
Public Attributes
char[] data
int length
String reason
String terminator

Detailed Description

Information about a rejected record.

2.1.92 - com.vertica.sdk.RejectedRecord Member List

This is the complete list of members for com.vertica.sdk.RejectedRecord, including all inherited members.

data (defined in com.vertica.sdk.RejectedRecord) com.vertica.sdk.RejectedRecord
length (defined in com.vertica.sdk.RejectedRecord) com.vertica.sdk.RejectedRecord
reason (defined in com.vertica.sdk.RejectedRecord) com.vertica.sdk.RejectedRecord
RejectedRecord(String reason, char[] data, int length, String terminator) (defined in com.vertica.sdk.RejectedRecord) com.vertica.sdk.RejectedRecord
RejectedRecord(String reason, char[] data, int length) (defined in com.vertica.sdk.RejectedRecord) com.vertica.sdk.RejectedRecord
RejectedRecord(String reason, char[] data) (defined in com.vertica.sdk.RejectedRecord) com.vertica.sdk.RejectedRecord
RejectedRecord(String reason) (defined in com.vertica.sdk.RejectedRecord) com.vertica.sdk.RejectedRecord
RejectedRecord() (defined in com.vertica.sdk.RejectedRecord) com.vertica.sdk.RejectedRecord
terminator (defined in com.vertica.sdk.RejectedRecord) com.vertica.sdk.RejectedRecord

2.1.93 - com.vertica.sdk.ScalarFunction Class Reference

Inheritance diagram for com.vertica.sdk.ScalarFunction:

Collaboration diagram for com.vertica.sdk.ScalarFunction:

Classes
enum InterfaceType
Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes)
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)
boolean isCanceled ()
abstract void processBlock (ServerInterface srvInterface, BlockReader arg_reader, BlockWriter res_writer) throws UdfException, DestroyInvocation
void setup (ServerInterface srvInterface, SizedColumnTypes argTypes)
Protected Member Functions
void cancel (ServerInterface srvInterface)
InterfaceType getInterfaceType ()

Detailed Description

Interface for User-Defined Scalar Function (UDSF). A UDSF produces a single value from a row of data.

A UDSF can be used anywhere a native function can be used, except CREATE TABLE BY PARTITION and SEGMENTED BY expressions.

A ScalarFunction must have an associated ScalarFunctionFactory.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
void com.vertica.sdk.UDXFunction.destroy(ServerInterface srvInterface, SizedColumnTypes argTypes)

inherited Perform per instance destruction. This function may throw errors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)

Referenced by com.vertica.sdk.UDXFunction.destroy().

void com.vertica.sdk.UDXFunction.destroy(ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)

inherited Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)
  • udSessionParams: a SessionParamWriterMap
boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

abstract void com.vertica.sdk.ScalarFunction.processBlock(ServerInterface srvInterface, BlockReader arg_reader, BlockWriter res_writer) throws UdfException, DestroyInvocation

pure virtual Invoke a user defined function on a set of rows. As the name suggests, a batch of rows are passed in for every invocation to amortize performance.

Notes:

  • This methods may be invoked by different threads at different times, and by a different thread than the constructor.

  • The order in which the function sees rows is not guaranteed.

  • To report error to Vertica, throw a UdfException object

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • arg_reader: input rows
  • res_writer: output location

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
void com.vertica.sdk.UDXFunction.setup(ServerInterface srvInterface, SizedColumnTypes argTypes)

inherited Perform per instance initialization. This function may throw errors.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)

2.1.94 - com.vertica.sdk.ScalarFunction Member List

This is the complete list of members for com.vertica.sdk.ScalarFunction, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
destroy(ServerInterface srvInterface, SizedColumnTypes argTypes) com.vertica.sdk.UDXFunction
destroy(ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams) com.vertica.sdk.UDXFunction
getInterfaceType() (defined in com.vertica.sdk.ScalarFunction) com.vertica.sdk.ScalarFunction protected
isCanceled() com.vertica.sdk.UDXObject
processBlock(ServerInterface srvInterface, BlockReader arg_reader, BlockWriter res_writer) com.vertica.sdk.ScalarFunction pure virtual
setup(ServerInterface srvInterface, SizedColumnTypes argTypes) com.vertica.sdk.UDXFunction
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.95 - com.vertica.sdk.ScalarFunction.InterfaceType Enum Reference

Collaboration diagram for com.vertica.sdk.ScalarFunction.InterfaceType:

Public Attributes
FunctionT
IndexListFunctionT

2.1.96 - com.vertica.sdk.ScalarFunction.InterfaceType Member List

This is the complete list of members for com.vertica.sdk.ScalarFunction.InterfaceType, including all inherited members.

FunctionT (defined in com.vertica.sdk.ScalarFunction.InterfaceType) com.vertica.sdk.ScalarFunction.InterfaceType
IndexListFunctionT (defined in com.vertica.sdk.ScalarFunction.InterfaceType) com.vertica.sdk.ScalarFunction.InterfaceType

2.1.97 - com.vertica.sdk.ScalarFunctionFactory Class Reference

Inheritance diagram for com.vertica.sdk.ScalarFunctionFactory:

Collaboration diagram for com.vertica.sdk.ScalarFunctionFactory:

Classes
enum strictness
enum volatility
Public Member Functions
abstract ScalarFunction createScalarFunction (ServerInterface srvInterface)
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
abstract void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException
UDXType getUDXFactoryType ()
Public Attributes
strictness strict
volatility vol
Protected Attributes
long libOid
String sqlName

Detailed Description

Interface for declaring parameters and return types for, and instantiating, an associated ScalarFunction.

Member Function Documentation

abstract ScalarFunction com.vertica.sdk.ScalarFunctionFactory.createScalarFunction(ServerInterface srvInterface)

pure virtual Note More than one object may be instantiated per query.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Returns a ScalarFunction object which implements the UDx API described by this metadata.

void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

inherited Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Referenced by com.vertica.sdk.UDXFactory.getPerInstanceResources().

void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
abstract void com.vertica.sdk.UDXFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

pure virtual inherited Provides the argument and return types of the UDX

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments
  • returnType: the type(s) of the return

Implemented in com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.

Referenced by com.vertica.sdk.ScalarFunctionFactory.getReturnType().

void com.vertica.sdk.ScalarFunctionFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException

virtual

For scalar functions, this function needs to be overridden only if the return type needs length/precision specification.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: The data type of the return value defined by processBlock()
  • returnType: The size of the data returned by processBlock()

Implements com.vertica.sdk.UDXFactory.

UDXType com.vertica.sdk.ScalarFunctionFactory.getUDXFactoryType()

virtual

Returns the object type internally used by Vertica

Implements com.vertica.sdk.UDXFactory.

Member Data Documentation

volatility com.vertica.sdk.ScalarFunctionFactory.vol

Strictness and Volatility settings that the UDSF programmer can set Defaults are VOLATILE and CALLED_ON_NULL_INPUT

2.1.98 - com.vertica.sdk.ScalarFunctionFactory Member List

This is the complete list of members for com.vertica.sdk.ScalarFunctionFactory, including all inherited members.

createScalarFunction(ServerInterface srvInterface) com.vertica.sdk.ScalarFunctionFactory pure virtual
getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDXFactory
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.UDXFactory pure virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.ScalarFunctionFactory virtual
getUDXFactoryType() com.vertica.sdk.ScalarFunctionFactory virtual
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
ScalarFunctionFactory() (defined in com.vertica.sdk.ScalarFunctionFactory) com.vertica.sdk.ScalarFunctionFactory
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
strict (defined in com.vertica.sdk.ScalarFunctionFactory) com.vertica.sdk.ScalarFunctionFactory
vol com.vertica.sdk.ScalarFunctionFactory

2.1.99 - com.vertica.sdk.ScalarFunctionFactory.strictness Enum Reference

Collaboration diagram for com.vertica.sdk.ScalarFunctionFactory.strictness:

Public Attributes
CALLED_ON_NULL_INPUT
DEFAULT_STRICTNESS
RETURN_NULL_ON_NULL_INPUT
STRICT

Detailed Description

Enum to allow programmatic specification of strictness.

2.1.100 - com.vertica.sdk.ScalarFunctionFactory.strictness Member List

This is the complete list of members for com.vertica.sdk.ScalarFunctionFactory.strictness, including all inherited members.

CALLED_ON_NULL_INPUT (defined in com.vertica.sdk.ScalarFunctionFactory.strictness) com.vertica.sdk.ScalarFunctionFactory.strictness
DEFAULT_STRICTNESS (defined in com.vertica.sdk.ScalarFunctionFactory.strictness) com.vertica.sdk.ScalarFunctionFactory.strictness
RETURN_NULL_ON_NULL_INPUT (defined in com.vertica.sdk.ScalarFunctionFactory.strictness) com.vertica.sdk.ScalarFunctionFactory.strictness
STRICT (defined in com.vertica.sdk.ScalarFunctionFactory.strictness) com.vertica.sdk.ScalarFunctionFactory.strictness

2.1.101 - com.vertica.sdk.ScalarFunctionFactory.volatility Enum Reference

Collaboration diagram for com.vertica.sdk.ScalarFunctionFactory.volatility:

Public Attributes
DEFAULT_VOLATILITY
IMMUTABLE
STABLE
VOLATILE

Detailed Description

Enum to allow programmatic specification of volatility.

2.1.102 - com.vertica.sdk.ScalarFunctionFactory.volatility Member List

This is the complete list of members for com.vertica.sdk.ScalarFunctionFactory.volatility, including all inherited members.

DEFAULT_VOLATILITY (defined in com.vertica.sdk.ScalarFunctionFactory.volatility) com.vertica.sdk.ScalarFunctionFactory.volatility
IMMUTABLE (defined in com.vertica.sdk.ScalarFunctionFactory.volatility) com.vertica.sdk.ScalarFunctionFactory.volatility
STABLE (defined in com.vertica.sdk.ScalarFunctionFactory.volatility) com.vertica.sdk.ScalarFunctionFactory.volatility
VOLATILE (defined in com.vertica.sdk.ScalarFunctionFactory.volatility) com.vertica.sdk.ScalarFunctionFactory.volatility

2.1.103 - com.vertica.sdk.ServerInterface Class Reference

Collaboration diagram for com.vertica.sdk.ServerInterface:

Public Member Functions
String getCurrentNodeName ()
String getDatabaseName ()
HashMap getDependencies ()
long getFunctionOid ()
String getLocale ()
String getNodeName ()
ParamReader getParamReader ()
ParamReader getSessionParamReader ()
Map getSessionStorage ()
ParamReader getUDSessionParamReader (String nsp)
ParamReader getUDSessionParamReader ()
SessionParamReaderMap getUDSessionParamReaderMap ()
String getUserName ()
void log (String format, Object...args)
void setDependencies (HashMap depends)
void setFunctionOid (long oid)
void setParamReader (ParamReader paramReader)
void setSessionParamReader (ParamReader sessionParamReader)
void setUDSessionParameterMap (SessionParamReaderMap udSessionParams)
void setupInformation (String sqlName, ParamReader paramReader, ParamReader sessionParamReader, String locale, String userName, String nodeName, String dbName, FileManager fileManager)
Public Attributes
FileManager fileManager
Protected Member Functions
abstract void vlog (String logEntry)

Detailed Description

Provides UDxs with access to the Vertica server.

Vertica passes a ServerInterface instance to the setup(), destroy(), and main processing functions of each UDx. Key methods for UDx use include log() (to write to the Vertica log), getParamReader(), setParamReader(), getSessionParamReader(), and setSessionParamReader().

Member Function Documentation

String com.vertica.sdk.ServerInterface.getDatabaseName()

Returns the name of the database in which this code is executed.

long com.vertica.sdk.ServerInterface.getFunctionOid()

Returns the function Oid

String com.vertica.sdk.ServerInterface.getLocale()

Returns the locale of the current session.

String com.vertica.sdk.ServerInterface.getNodeName()

Returns the name of the vertica node on which this code is executed.

ParamReader com.vertica.sdk.ServerInterface.getParamReader()

Returns The ParamReader that allows accessing parameter values using their names

ParamReader com.vertica.sdk.ServerInterface.getSessionParamReader()

Returns The SessionParamReader that allows accessing session parameter values using their names

ParamReader com.vertica.sdk.ServerInterface.getUDSessionParamReader(String nsp)

Parameters

  • nsp: the namespace

Returns the UDSessionParamReader for the namespace

ParamReader com.vertica.sdk.ServerInterface.getUDSessionParamReader()

Returns The UDSessionParamReader for the default namespace

SessionParamReaderMap com.vertica.sdk.ServerInterface.getUDSessionParamReaderMap()

Returns the UDSessionParamReaderMap

String com.vertica.sdk.ServerInterface.getUserName()

Returns the username of the current session.

void com.vertica.sdk.ServerInterface.log(String format, Object... args)

Writes a message to a log file stored in the UDxLogs directory of the database's catalog directory. The SQL name of the UDx is added to the log message, along with the string [UserMessage] to mark the entry as a message added by a call to this method.

Parameters

  • format: a printf-style format string specifying the log message format.
  • args: the arguments for the format
void com.vertica.sdk.ServerInterface.setFunctionOid(long oid)

Set the function Oid

Parameters

  • oid: the function oid to set
void com.vertica.sdk.ServerInterface.setParamReader(ParamReader paramReader)

Set the paramReader of this ServerInterface when delayed creation is required Used by the code when delayed creation of the parameters is needed Users should not call this function

Parameters

  • paramReader: the reader to set
void com.vertica.sdk.ServerInterface.setSessionParamReader(ParamReader sessionParamReader)

Set the sessionParamReader of this ServerInterface

Parameters

  • sessionParamReader: the reader to set
void com.vertica.sdk.ServerInterface.setUDSessionParameterMap(SessionParamReaderMap udSessionParams)

Set the UDSessionParamReaderMap

Parameters

  • udSessionParams: parameters to set
abstract void com.vertica.sdk.ServerInterface.vlog(String logEntry)

protected pure virtual Callback for logging, implemented by the server

Parameters

  • logEntry: string to log

Referenced by com.vertica.sdk.ServerInterface.log().

Member Data Documentation

FileManager com.vertica.sdk.ServerInterface.fileManager

File manager of the session context

2.1.104 - com.vertica.sdk.ServerInterface Member List

This is the complete list of members for com.vertica.sdk.ServerInterface, including all inherited members.

fileManager com.vertica.sdk.ServerInterface
getCurrentNodeName() (defined in com.vertica.sdk.ServerInterface) com.vertica.sdk.ServerInterface
getDatabaseName() com.vertica.sdk.ServerInterface
getDependencies() (defined in com.vertica.sdk.ServerInterface) com.vertica.sdk.ServerInterface
getFunctionOid() com.vertica.sdk.ServerInterface
getLocale() com.vertica.sdk.ServerInterface
getNodeName() com.vertica.sdk.ServerInterface
getParamReader() com.vertica.sdk.ServerInterface
getSessionParamReader() com.vertica.sdk.ServerInterface
getSessionStorage() (defined in com.vertica.sdk.ServerInterface) com.vertica.sdk.ServerInterface
getUDSessionParamReader(String nsp) com.vertica.sdk.ServerInterface
getUDSessionParamReader() com.vertica.sdk.ServerInterface
getUDSessionParamReaderMap() com.vertica.sdk.ServerInterface
getUserName() com.vertica.sdk.ServerInterface
log(String format, Object...args) com.vertica.sdk.ServerInterface
setDependencies(HashMap depends) (defined in com.vertica.sdk.ServerInterface) com.vertica.sdk.ServerInterface
setFunctionOid(long oid) com.vertica.sdk.ServerInterface
setParamReader(ParamReader paramReader) com.vertica.sdk.ServerInterface
setSessionParamReader(ParamReader sessionParamReader) com.vertica.sdk.ServerInterface
setUDSessionParameterMap(SessionParamReaderMap udSessionParams) com.vertica.sdk.ServerInterface
setupInformation(String sqlName, ParamReader paramReader, ParamReader sessionParamReader, String locale, String userName, String nodeName, String dbName, FileManager fileManager) (defined in com.vertica.sdk.ServerInterface) com.vertica.sdk.ServerInterface
vlog(String logEntry) com.vertica.sdk.ServerInterface protectedpure virtual

2.1.105 - com.vertica.sdk.SessionParamReaderMap Class Reference

Collaboration diagram for com.vertica.sdk.SessionParamReaderMap:

Public Member Functions
void addUDSessionParamReader (String nsp, ParamReader sessionParamReader)
Boolean containsNamespace (String nsp)
Collection getNamespaces ()
ParamReader getUDSessionParamReader (String nsp)
void setUDSessionParamReaderMap (Map paramReaderMap)
Public Attributes
Map nspToParamReaderMap

Member Function Documentation

void com.vertica.sdk.SessionParamReaderMap.addUDSessionParamReader(String nsp, ParamReader sessionParamReader)

Add a Session ParamReader for a namespace

Parameters

  • nsp: The namespace and the ParamReader
  • sessionParamReader: Reader id
Boolean com.vertica.sdk.SessionParamReaderMap.containsNamespace(String nsp)

Check if a SessionParamReader for the Namespace exists in the map

Parameters

  • nsp: The namespace

Returns true if the SessionParamReader for the Namespace exists false otherwise

Collection com.vertica.sdk.SessionParamReaderMap.getNamespaces()

Gets the names of all namespaces

Returns a vector of column namespaces

ParamReader com.vertica.sdk.SessionParamReaderMap.getUDSessionParamReader(String nsp)

Get a SessionParamReader for a namespace

Parameters

  • nsp: The namespace

Returns The SessionParamReader

void com.vertica.sdk.SessionParamReaderMap.setUDSessionParamReaderMap(Map paramReaderMap)

Set the SessionParamReaderMap

Parameters

  • paramReaderMap: The SessionParamReaderMap

2.1.106 - com.vertica.sdk.SessionParamReaderMap Member List

This is the complete list of members for com.vertica.sdk.SessionParamReaderMap, including all inherited members.

addUDSessionParamReader(String nsp, ParamReader sessionParamReader) com.vertica.sdk.SessionParamReaderMap
containsNamespace(String nsp) com.vertica.sdk.SessionParamReaderMap
getNamespaces() com.vertica.sdk.SessionParamReaderMap
getUDSessionParamReader(String nsp) com.vertica.sdk.SessionParamReaderMap
nspToParamReaderMap (defined in com.vertica.sdk.SessionParamReaderMap) com.vertica.sdk.SessionParamReaderMap
SessionParamReaderMap() (defined in com.vertica.sdk.SessionParamReaderMap) com.vertica.sdk.SessionParamReaderMap
setUDSessionParamReaderMap(Map paramReaderMap) com.vertica.sdk.SessionParamReaderMap

2.1.107 - com.vertica.sdk.SessionParamWriterMap Class Reference

Collaboration diagram for com.vertica.sdk.SessionParamWriterMap:

Public Member Functions
void addUDSessionParamWriter (String nsp, ParamWriter sessionParamWriter)
Boolean containsNamespace (String nsp)
Collection getNamespaces ()
ParamWriter getUDSessionParamWriter (String nsp)
ParamWriter getUDSessionParamWriter ()

Member Function Documentation

void com.vertica.sdk.SessionParamWriterMap.addUDSessionParamWriter(String nsp, ParamWriter sessionParamWriter)

Add a SessionParamWriter for a namespace

Parameters

  • nsp: The namespace
  • sessionParamWriter: The ParamWriter

Referenced by com.vertica.sdk.SessionParamWriterMap.getUDSessionParamWriter().

Boolean com.vertica.sdk.SessionParamWriterMap.containsNamespace(String nsp)

Check if a SessionParamWriter for the Namespace exists in the map

Parameters

  • nsp: The namespace

Returns true if the SessionParamWriter for the Namespace exists false otherwise

Collection com.vertica.sdk.SessionParamWriterMap.getNamespaces()

Gets the names of all namespaces

Returns a vector of column namespaces

ParamWriter com.vertica.sdk.SessionParamWriterMap.getUDSessionParamWriter(String nsp)

Get a SessionParamWriter for a namespace

Parameters

  • nsp: The namespace

Returns The SessionParamWriter

ParamWriter com.vertica.sdk.SessionParamWriterMap.getUDSessionParamWriter()

Get a SessionParamWriter for a namespace library

Returns The SessionParamWriter

2.1.108 - com.vertica.sdk.SessionParamWriterMap Member List

This is the complete list of members for com.vertica.sdk.SessionParamWriterMap, including all inherited members.

addUDSessionParamWriter(String nsp, ParamWriter sessionParamWriter) com.vertica.sdk.SessionParamWriterMap
containsNamespace(String nsp) com.vertica.sdk.SessionParamWriterMap
getNamespaces() com.vertica.sdk.SessionParamWriterMap
getUDSessionParamWriter(String nsp) com.vertica.sdk.SessionParamWriterMap
getUDSessionParamWriter() com.vertica.sdk.SessionParamWriterMap
SessionParamWriterMap() (defined in com.vertica.sdk.SessionParamWriterMap) com.vertica.sdk.SessionParamWriterMap

2.1.109 - com.vertica.sdk.SizedColumnTypes Class Reference

Collaboration diagram for com.vertica.sdk.SizedColumnTypes:

Classes
class PartitionOrderColumnInfo
Represents the partition by and order by column information for each phase in a multi-phase transform function.
Public Member Functions
void addBinary (int len, String fieldName)
Adds a column of type BINARY.
void addBinary (int len)
void addBinaryOrderColumn (int len, String fieldName)
Adds an order column of type BINARY.
void addBinaryPartitionColumn (int len, String fieldName)
Adds a partition column of type BINARY.
void addBool (String fieldName)
Adds a column of type BOOLEAN.
void addBool ()
void addBoolOrderColumn (String fieldName)
Adds an order column of type BOOLEAN.
void addBoolPartitionColumn (String fieldName)
Adds a partition column of type BOOLEAN.
void addChar (int len, String fieldName)
Adds a column of type CHAR.
void addChar (int len)
void addCharOrderColumn (int len, String fieldName)
Adds an order column of type CHAR.
void addCharPartitionColumn (int len, String fieldName)
Adds a partition column of type CHAR.
void addDate (String fieldName)
Adds a column of type DATE.
void addDate ()
void addDateOrderColumn (String fieldName)
Adds an order column of type DATE.
void addDatePartitionColumn (String fieldName)
Adds a partition column of type DATE.
void addFloat (String fieldName)
Adds a column of type FLOAT.
void addFloat ()
void addFloatOrderColumn (String fieldName)
Adds an order column of type FLOAT.
void addFloatPartitionColumn (String fieldName)
Adds a partition column of type FLOAT.
void addInt (String fieldName)
Adds a column of type INTEGER.
void addInt ()
void addIntervalOrderColumn (int precision, int range, String fieldName)
Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND.
void addIntervalPartitionColumn (int precision, int range, String fieldName)
Adds a partition column of type INTERVAL/INTERVAL DAY TO SECOND.
void addIntervalYMOrderColumn (int range, String fieldName)
Adds an order column of type INTERVAL YEAR TO MONTH.
void addIntervalYMPartitionColumn (int range, String fieldName)
Adds a partition column of type INTERVAL YEAR TO MONTH.
void addIntOrderColumn (String fieldName)
Adds an order column of type INTEGER.
void addIntPartitionColumn (String fieldName)
Adds a partition column of type INTEGER.
void addLongVarbinary (int len, String fieldName)
Adds a column of type LONGVARBINARY.
void addLongVarbinary (int len)
void addLongVarbinaryOrderColumn (int len, String fieldName)
Adds an order column of type VARBINARY.
void addLongVarbinaryPartitionColumn (int len, String fieldName)
Adds a partition column of type VARBINARY.
void addLongVarchar (int len, String fieldName)
Adds a column of type LONGVARCHAR.
void addLongVarchar (int len)
void addLongVarcharOrderColumn (int len, String fieldName)
Adds an order column of type VARCHAR.
void addLongVarcharPartitionColumn (int len, String fieldName)
Adds a partition column of type VARCHAR.
void addNumeric (int precision, int scale, String fieldName)
Adds a column of type NUMERIC.
void addNumeric (int precision, int scale)
void addNumericOrderColumn (int precision, int scale, String fieldName)
Adds an order column of type NUMERIC.
void addNumericPartitionColumn (int precision, int scale, String fieldName)
Adds a partition column of type NUMERIC.
void addOrderColumn (BaseDataOID typeOid, int typeMod, String fieldName)
void addOrderColumn (VerticaType dt, String fieldName)
Adds an order column of the specified type. (only relevant to multiphase UDTs.)
void addPartitionColumn (BaseDataOID typeOid, int typeMod, String fieldName)
void addPartitionColumn (VerticaType dt, String fieldName)
Adds a partition column of the specified type (only relevant to multiphase UDTs.)
void addTime (int precision, String fieldName)
Adds a column of type TIME.
void addTime (int precision)
void addTimeOrderColumn (int precision, String fieldName)
Adds an order column of type TIME.
void addTimePartitionColumn (int precision, String fieldName)
Adds a partition column of type TIME.
void addTimestamp (String fieldName)
Adds a column of type TIMESTAMP.
void addTimestamp ()
void addTimestampOrderColumn (int precision, String fieldName)
Adds an order column of type TIMESTAMP.
void addTimestampPartitionColumn (int precision, String fieldName)
Adds a partition column of type TIMESTAMP.
void addTimestampTzOrderColumn (int precision, String fieldName)
Adds an order column of type TIMESTAMP WITH TIMEZONE.
void addTimestampTzPartitionColumn (int precision, String fieldName)
Adds a partition column of type TIMESTAMP WITH TIMEZONE.
void addTimeTz (int precision, String fieldName)
Adds a column of type TIME WITH TIMEZONE.
void addTimeTz (int precision)
void addTimeTzOrderColumn (int precision, String fieldName)
Adds an order column of type TIME WITH TIMEZONE.
void addVarbinary (int len, String fieldName)
Adds a column of type VARBINARY.
void addVarbinary (int len)
void addVarbinaryOrderColumn (int len, String fieldName)
Adds an order column of type VARBINARY.
void addVarbinaryPartitionColumn (int len, String fieldName)
Adds a partition column of type VARBINARY.
void addVarchar (int len, String fieldName)
Adds a column of type VARCHAR.
void addVarchar (int len)
void addVarcharOrderColumn (int len, String fieldName)
Adds an order column of type VARCHAR.
void addVarcharPartitionColumn (int len, String fieldName)
Adds a partition column of type VARCHAR.
void copyValues (SizedColumnTypes sizedColumnTypes)
void getArgumentColumns (ArrayList cols)
Retrieves indexes of argument columns. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).
int getColumnCount ()
Returns the number of columns.
String getColumnName (int idx)
Returns the name of the column at the specified index.
VerticaType getColumnType (int idx)
Returns the type of the column at the specified index.
int getLastOrderColumnIdx ()
Gets the last ORDER BY column index.
int getLastPartitionColumnIdx ()
Gets the last PARTITION BY column index.
void getOrderByColumns (ArrayList cols)
Retrieves indexes of ORDER BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).
void getPartitionByColumns (ArrayList cols)
Retrieves indexes of PARTITION BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).
boolean isOrderByColumn (int idx)
Indicates whether the column at the specified index is an ORDER BY column.
boolean isPartitionByColumn (int idx)
Indicates whether the column at the specified index is a PARTITION BY column.
void setPartitionOrderColumnIdx (int partition_idx, int order_idx)
Sets the PARTITION BY and ORDER BY column indexes.
void setPartitionOrderColumnIdx (SizedColumnTypes other)
Sets the PARTITION BY and ORDER BY column indexes from another SizedColumnTypes object.

Detailed Description

Represents types and information to determine the size of the columns as input/output of a User Defined Function/Transform

This class is used to exchange size and precision information between Vertica and the user defined function/transform function. Vertica provides the user code with size/precision information about the particular data types that it has been called with, and expects the user code to provide size/precision information about what it will return.

Member Function Documentation

void com.vertica.sdk.SizedColumnTypes.addBinary(int len, String fieldName)

Adds a column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBinaryOrderColumn(int len, String fieldName)

Adds an order column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBinaryPartitionColumn(int len, String fieldName)

Adds a partition column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBool(String fieldName)

Adds a column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBoolOrderColumn(String fieldName)

Adds an order column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBoolPartitionColumn(String fieldName)

Adds a partition column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addChar(int len, String fieldName)

Adds a column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addCharOrderColumn(int len, String fieldName)

Adds an order column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addCharPartitionColumn(int len, String fieldName)

Adds a partition column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addDate(String fieldName)

Adds a column of type DATE.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addDateOrderColumn(String fieldName)

Adds an order column of type DATE.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addDatePartitionColumn(String fieldName)

Adds a partition column of type DATE.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addFloat(String fieldName)

Adds a column of type FLOAT.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addFloatOrderColumn(String fieldName)

Adds an order column of type FLOAT.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addFloatPartitionColumn(String fieldName)

Adds a partition column of type FLOAT.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addInt(String fieldName)

Adds a column of type INTEGER.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntervalOrderColumn(int precision, int range, String fieldName)

Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND.

Parameters

  • precision: The precision for the interval.
  • range: The range for the interval.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntervalPartitionColumn(int precision, int range, String fieldName)

Adds a partition column of type INTERVAL/INTERVAL DAY TO SECOND.

Parameters

  • precision: The precision for the interval.
  • range: The range for the interval.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntervalYMOrderColumn(int range, String fieldName)

Adds an order column of type INTERVAL YEAR TO MONTH.

Parameters

  • range: The range for the interval.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntervalYMPartitionColumn(int range, String fieldName)

Adds a partition column of type INTERVAL YEAR TO MONTH.

Parameters

  • range: The range for the interval.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntOrderColumn(String fieldName)

Adds an order column of type INTEGER.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntPartitionColumn(String fieldName)

Adds a partition column of type INTEGER.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarbinary(int len, String fieldName)

Adds a column of type LONGVARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarbinaryOrderColumn(int len, String fieldName)

Adds an order column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarbinaryPartitionColumn(int len, String fieldName)

Adds a partition column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarchar(int len, String fieldName)

Adds a column of type LONGVARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarcharOrderColumn(int len, String fieldName)

Adds an order column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarcharPartitionColumn(int len, String fieldName)

Adds a partition column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addNumeric(int precision, int scale, String fieldName)

Adds a column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addNumericOrderColumn(int precision, int scale, String fieldName)

Adds an order column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addNumericPartitionColumn(int precision, int scale, String fieldName)

Adds a partition column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTime(int precision, String fieldName)

Adds a column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimeOrderColumn(int precision, String fieldName)

Adds an order column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimePartitionColumn(int precision, String fieldName)

Adds a partition column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestamp(String fieldName)

Adds a column of type TIMESTAMP.

Parameters

  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestampOrderColumn(int precision, String fieldName)

Adds an order column of type TIMESTAMP.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestampPartitionColumn(int precision, String fieldName)

Adds a partition column of type TIMESTAMP.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestampTzOrderColumn(int precision, String fieldName)

Adds an order column of type TIMESTAMP WITH TIMEZONE.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestampTzPartitionColumn(int precision, String fieldName)

Adds a partition column of type TIMESTAMP WITH TIMEZONE.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimeTz(int precision, String fieldName)

Adds a column of type TIME WITH TIMEZONE.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimeTzOrderColumn(int precision, String fieldName)

Adds an order column of type TIME WITH TIMEZONE.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarbinary(int len, String fieldName)

Adds a column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarbinaryOrderColumn(int len, String fieldName)

Adds an order column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarbinaryPartitionColumn(int len, String fieldName)

Adds a partition column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarchar(int len, String fieldName)

Adds a column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarcharOrderColumn(int len, String fieldName)

Adds an order column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarcharPartitionColumn(int len, String fieldName)

Adds a partition column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.getArgumentColumns(ArrayList cols)

Retrieves indexes of argument columns. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).

Parameters

  • cols: A vector to store the retrieved column indexes.
String com.vertica.sdk.SizedColumnTypes.getColumnName(int idx)

Returns the name of the column at the specified index.

Parameters

  • idx: The index of the column
VerticaType com.vertica.sdk.SizedColumnTypes.getColumnType(int idx)

Returns the type of the column at the specified index.

Parameters

  • idx: The index of the column

Returns a VerticaType object describing the column's data type.

Referenced by com.vertica.sdk.BlockReader.getVNumeric().

void com.vertica.sdk.SizedColumnTypes.getOrderByColumns(ArrayList cols)

Retrieves indexes of ORDER BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).

Parameters

  • cols: A vector to store the retrieved column indexes.
void com.vertica.sdk.SizedColumnTypes.getPartitionByColumns(ArrayList cols)

Retrieves indexes of PARTITION BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).

Parameters

  • cols: A vector to store the retrieved column indexes.
boolean com.vertica.sdk.SizedColumnTypes.isOrderByColumn(int idx)

Indicates whether the column at the specified index is an ORDER BY column.

Parameters

  • idx: The index of the column
boolean com.vertica.sdk.SizedColumnTypes.isPartitionByColumn(int idx)

Indicates whether the column at the specified index is a PARTITION BY column.

Parameters

  • idx: The index of the column
void com.vertica.sdk.SizedColumnTypes.setPartitionOrderColumnIdx(int partition_idx, int order_idx)

Sets the PARTITION BY and ORDER BY column indexes.

Parameters

  • partition_idx: Index of the last partition-by column
  • order_idx: Index of the last order-by column
void com.vertica.sdk.SizedColumnTypes.setPartitionOrderColumnIdx(SizedColumnTypes other)

Sets the PARTITION BY and ORDER BY column indexes from another SizedColumnTypes object.

Parameters

  • other: The SizedColumnTypes object to set the indexes from

2.1.110 - com.vertica.sdk.SizedColumnTypes Member List

This is the complete list of members for com.vertica.sdk.SizedColumnTypes, including all inherited members.

addBinary(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addBinary(int len) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addBinaryOrderColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addBinaryPartitionColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addBool(String fieldName) com.vertica.sdk.SizedColumnTypes
addBool() (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addBoolOrderColumn(String fieldName) com.vertica.sdk.SizedColumnTypes
addBoolPartitionColumn(String fieldName) com.vertica.sdk.SizedColumnTypes
addChar(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addChar(int len) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addCharOrderColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addCharPartitionColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addDate(String fieldName) com.vertica.sdk.SizedColumnTypes
addDate() (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addDateOrderColumn(String fieldName) com.vertica.sdk.SizedColumnTypes
addDatePartitionColumn(String fieldName) com.vertica.sdk.SizedColumnTypes
addFloat(String fieldName) com.vertica.sdk.SizedColumnTypes
addFloat() (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addFloatOrderColumn(String fieldName) com.vertica.sdk.SizedColumnTypes
addFloatPartitionColumn(String fieldName) com.vertica.sdk.SizedColumnTypes
addInt(String fieldName) com.vertica.sdk.SizedColumnTypes
addInt() (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addIntervalOrderColumn(int precision, int range, String fieldName) com.vertica.sdk.SizedColumnTypes
addIntervalPartitionColumn(int precision, int range, String fieldName) com.vertica.sdk.SizedColumnTypes
addIntervalYMOrderColumn(int range, String fieldName) com.vertica.sdk.SizedColumnTypes
addIntervalYMPartitionColumn(int range, String fieldName) com.vertica.sdk.SizedColumnTypes
addIntOrderColumn(String fieldName) com.vertica.sdk.SizedColumnTypes
addIntPartitionColumn(String fieldName) com.vertica.sdk.SizedColumnTypes
addLongVarbinary(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addLongVarbinary(int len) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addLongVarbinaryOrderColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addLongVarbinaryPartitionColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addLongVarchar(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addLongVarchar(int len) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addLongVarcharOrderColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addLongVarcharPartitionColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addNumeric(int precision, int scale, String fieldName) com.vertica.sdk.SizedColumnTypes
addNumeric(int precision, int scale) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addNumericOrderColumn(int precision, int scale, String fieldName) com.vertica.sdk.SizedColumnTypes
addNumericPartitionColumn(int precision, int scale, String fieldName) com.vertica.sdk.SizedColumnTypes
addOrderColumn(BaseDataOID typeOid, int typeMod, String fieldName) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addOrderColumn(VerticaType dt, String fieldName) com.vertica.sdk.SizedColumnTypes
addPartitionColumn(BaseDataOID typeOid, int typeMod, String fieldName) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addPartitionColumn(VerticaType dt, String fieldName) com.vertica.sdk.SizedColumnTypes
addTime(int precision, String fieldName) com.vertica.sdk.SizedColumnTypes
addTime(int precision) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addTimeOrderColumn(int precision, String fieldName) com.vertica.sdk.SizedColumnTypes
addTimePartitionColumn(int precision, String fieldName) com.vertica.sdk.SizedColumnTypes
addTimestamp(String fieldName) com.vertica.sdk.SizedColumnTypes
addTimestamp() (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addTimestampOrderColumn(int precision, String fieldName) com.vertica.sdk.SizedColumnTypes
addTimestampPartitionColumn(int precision, String fieldName) com.vertica.sdk.SizedColumnTypes
addTimestampTzOrderColumn(int precision, String fieldName) com.vertica.sdk.SizedColumnTypes
addTimestampTzPartitionColumn(int precision, String fieldName) com.vertica.sdk.SizedColumnTypes
addTimeTz(int precision, String fieldName) com.vertica.sdk.SizedColumnTypes
addTimeTz(int precision) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addTimeTzOrderColumn(int precision, String fieldName) com.vertica.sdk.SizedColumnTypes
addVarbinary(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addVarbinary(int len) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addVarbinaryOrderColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addVarbinaryPartitionColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addVarchar(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addVarchar(int len) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
addVarcharOrderColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
addVarcharPartitionColumn(int len, String fieldName) com.vertica.sdk.SizedColumnTypes
copyValues(SizedColumnTypes sizedColumnTypes) (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes
getArgumentColumns(ArrayList cols) com.vertica.sdk.SizedColumnTypes
getColumnCount() com.vertica.sdk.SizedColumnTypes
getColumnName(int idx) com.vertica.sdk.SizedColumnTypes
getColumnType(int idx) com.vertica.sdk.SizedColumnTypes
getLastOrderColumnIdx() com.vertica.sdk.SizedColumnTypes
getLastPartitionColumnIdx() com.vertica.sdk.SizedColumnTypes
getOrderByColumns(ArrayList cols) com.vertica.sdk.SizedColumnTypes
getPartitionByColumns(ArrayList cols) com.vertica.sdk.SizedColumnTypes
isOrderByColumn(int idx) com.vertica.sdk.SizedColumnTypes
isPartitionByColumn(int idx) com.vertica.sdk.SizedColumnTypes
setPartitionOrderColumnIdx(int partition_idx, int order_idx) com.vertica.sdk.SizedColumnTypes
setPartitionOrderColumnIdx(SizedColumnTypes other) com.vertica.sdk.SizedColumnTypes
SizedColumnTypes() (defined in com.vertica.sdk.SizedColumnTypes) com.vertica.sdk.SizedColumnTypes

2.1.111 - com.vertica.sdk.SourceFactory Class Reference

Inheritance diagram for com.vertica.sdk.SourceFactory:

Collaboration diagram for com.vertica.sdk.SourceFactory:

Public Member Functions
int getDesiredThreads (ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)
UDXType getUDXFactoryType ()
boolean isSourceApportionable ()
void plan (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
SourceIterator prepare (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
SourceIterator prepare (ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException
ArrayList prepareUDSources (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
ArrayList prepareUDSources (ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException
Protected Attributes
long libOid
String sqlName

Detailed Description

Produces and initializes UDSources to process input data sources.

Subclassing SourceFactory is the preferred way to implement a factory corresponding to a UDSource. If you need more flexibility, implement both IterativeSourceFactory and SourceIterator. (See the documentation of IterativeSourceFactory.)

Member Function Documentation

int com.vertica.sdk.SourceFactory.getDesiredThreads(ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException

Request the number of threads that the SourceFactory wants to use. This function is called on each node before prepareUDSources().

'planCtxt' contains the same parameters stored by plan() method. It also exposes the maximum number of allowed threads, via 'getMaxAllowedThreads()'. Further computations can be stored in its 'ExecutorParamWriter' object, for use in prepare().

void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

inherited Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDLFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
void com.vertica.sdk.UDLFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

virtualinherited

Provides the argument and return types of the UDL. UDL's take no input tuples; as such, their prototype is empty.

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.UDLFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)

virtualinherited

Not used in this form

Implements com.vertica.sdk.UDXFactory.

UDXType com.vertica.sdk.IterativeSourceFactory.getUDXFactoryType()

virtualinherited

User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Returns the type of UDX Object instance this factory returns.

Implements com.vertica.sdk.UDXFactory.

boolean com.vertica.sdk.IterativeSourceFactory.isSourceApportionable()

inherited Returns if this source factory has the capability to generate source with portions

void com.vertica.sdk.SourceFactory.plan(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on.

plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan(). Also provides functionality for specifying which nodes this query will run on.

Exceptions

  • UdfException: UDF problem
SourceIterator com.vertica.sdk.IterativeSourceFactory.prepare(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

inherited Prepare this SourceFactory to start creating sources. This function will be called on each node, prior to the Load operator starting to execute and prior to any other virtual functions on this class being called.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup.
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan() and getDesiredThreads(). It also provides functionality for determining which nodes this query is running on.

Returns A SourceIterator object for use in the query.

Exceptions

  • UdfException: UDF problem

Referenced by com.vertica.sdk.IterativeSourceFactory.prepare().

SourceIterator com.vertica.sdk.SourceFactory.prepare(ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException

INTERNAL

Referenced by com.vertica.sdk.SourceFactory.getDesiredThreads().

ArrayList com.vertica.sdk.SourceFactory.prepareUDSources(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

Create UDSources. This function will be called on each node, prior to the Load operator starting to execute.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup.
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan() and getDesiredThreads(). It also provides functionality for determining which nodes this query is running on.

Returns An ArrayList of UDSources to use for this query. Sources will be loaded in a pooled manner, several at a time.

Exceptions

  • UdfException: UDF problem

Referenced by

ArrayList com.vertica.sdk.SourceFactory.prepareUDSources(ServerInterface srvInterface, ExecutorPlanContext planCtxt) throws UdfException

Create UDSources. This function will be called on each node, prior to the Load operator starting to execute.

Parameters

  • srvInterface: Interface to server operations and functionality, including (not-per-column) parameter lookup.
  • planCtxt: Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan() and getDesiredThreads(). It provides functionality for determining which nodes this query is running on, as well as the number of threads allowed by the resource pool (via getMaxAllowedThreads()) and, more importantly, the actual load concurrency (via getLoadConcurrency()).

Returns An ArrayList of UDSources to use for this query. Sources will be loaded in a pooled manner, several at a time.

Exceptions

  • UdfException: UDF problem

2.1.112 - com.vertica.sdk.SourceFactory Member List

This is the complete list of members for com.vertica.sdk.SourceFactory, including all inherited members.

getDesiredThreads(ServerInterface srvInterface, ExecutorPlanContext planCtxt) com.vertica.sdk.SourceFactory
getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) (defined in com.vertica.sdk.UDLFactory) com.vertica.sdk.UDLFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDLFactory
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getUDXFactoryType() com.vertica.sdk.IterativeSourceFactory virtual
isSourceApportionable() com.vertica.sdk.IterativeSourceFactory
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
plan(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) com.vertica.sdk.SourceFactory
prepare(ServerInterface srvInterface, ExecutorPlanContext planCtxt) com.vertica.sdk.SourceFactory
com::vertica::sdk::IterativeSourceFactory.prepare(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) com.vertica.sdk.IterativeSourceFactory
prepareUDSources(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) com.vertica.sdk.SourceFactory
prepareUDSources(ServerInterface srvInterface, ExecutorPlanContext planCtxt) com.vertica.sdk.SourceFactory
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected

2.1.113 - com.vertica.sdk.SourceIterator Class Reference

Inheritance diagram for com.vertica.sdk.SourceIterator:

Collaboration diagram for com.vertica.sdk.SourceIterator:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
abstract UnsizedUDSource createNextSource (ServerInterface srvInterface) throws UdfException
void destroy (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
abstract int getNumberOfSources () throws UdfException
Integer getSizeOfSource (int sourceNum) throws UdfException
boolean isCanceled ()
void setup (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
Protected Member Functions
void cancel (ServerInterface srvInterface)

Detailed Description

Constructs a set of Sources to be used by an IterativeSourceFactory.

createNextSource() will be called repeatedly until it returns NULL. Each resulting Source will be read to completion, and the contained data passed to the Filter and Parser.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
abstract UnsizedUDSource com.vertica.sdk.SourceIterator.createNextSource(ServerInterface srvInterface) throws UdfException

pure virtual Create the next UDSource to process.

Should return NULL if no further sources are available for processing.

Note that the previous Source may still be open and in use on a different thread when this function is called.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Returns a new Source instance corresponding to a new input stream

Exceptions

  • UdfException: UDF problem

Implemented in com.vertica.sdk.DefaultSourceIterator.

void com.vertica.sdk.SourceIterator.destroy(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

Tear down this SourceIterator

Should perform clean-up

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • planCtxt: a plan context

Exceptions

  • UdfException: UDF problem
abstract int com.vertica.sdk.SourceIterator.getNumberOfSources() throws UdfException

pure virtual Returns the total number of Sources that this factory will produce

Exceptions

  • UdfException: UDF problem

Implemented in com.vertica.sdk.DefaultSourceIterator.

Integer com.vertica.sdk.SourceIterator.getSizeOfSource(int sourceNum) throws UdfException

Parameters

  • sourceNum: which source to query

Returns the raw-data size of the sourceNum'th source that will be produced by createNextSource(). Should return vint_null if the size is unknown.

This value is used as a hint, and is used by the "load_streams" table to display load progress. If incorrect or not set, "load_streams" may contain incorrect or unhelpful information.

Exceptions

  • UdfException: UDF problem
boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

void com.vertica.sdk.SourceIterator.setup(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

Set up this SourceIterator

Should perform setup that should not take place in the constructor due to the exception-handling semantics of constructors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • planCtxt: a plan context

Exceptions

  • UdfException: UDF problem

2.1.114 - com.vertica.sdk.SourceIterator Member List

This is the complete list of members for com.vertica.sdk.SourceIterator, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
createNextSource(ServerInterface srvInterface) com.vertica.sdk.SourceIterator pure virtual
destroy(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) com.vertica.sdk.SourceIterator
getNumberOfSources() com.vertica.sdk.SourceIterator pure virtual
getSizeOfSource(int sourceNum) com.vertica.sdk.SourceIterator
isCanceled() com.vertica.sdk.UDXObject
setup(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) com.vertica.sdk.SourceIterator
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.115 - com.vertica.sdk.StandardTypeCoercion Class Reference

Inheritance diagram for com.vertica.sdk.StandardTypeCoercion:

Collaboration diagram for com.vertica.sdk.StandardTypeCoercion:

Classes
enum BooleanEvaluation
class SpecialBigDecimal
Public Member Functions
StandardTypeCoercion ()
ByteBuffer asBinaryBytes (Object value, int length, VerticaType type)
Boolean asBoolean (Object value, VerticaType type)
Boolean asBooleanByJava (Object value, VerticaType type)
Boolean asBooleanByNumeric (Object value, VerticaType type)
Boolean asBooleanByPerl (Object value, VerticaType type)
Boolean asBooleanByPython (Object value, VerticaType type)
Boolean asBooleanByVertica (Object value, VerticaType type)
ByteBuffer asCharBytes (Object value, int length, VerticaType type)
java.sql.Date asDate (Object value, VerticaType type)
Double asDouble (Object value, VerticaType type)
Long asLong (Object value, VerticaType type)
java.sql.Timestamp asTimestamp (Object value, VerticaType type)
BooleanEvaluation getBooleanEvaluation ()
DateFormat getDateFormat ()
DateFormat getDateParse ()
DateFormat getDefaultDateFormat ()
DateFormat getDefaultDateParse ()
DateFormat getDefaultTimestampFormat ()
DateFormat getDefaultTimestampParse ()
Iterator getListIterator (Object value)
Iterator > getMapIterator (Object value)
MetaType getMetaType (Object value)
Set getPolicy ()
DateFormat getTimestampFormat ()
DateFormat getTimestampParse ()
java.sql.Date parseDate (String value, VerticaType type)
java.sql.Timestamp parseTimestamp (String value, VerticaType type)
void setBooleanEvaluation (BooleanEvaluation boolEval)
void setDateFormat (DateFormat fmt)
void setDateParse (DateFormat fmt)
void setPolicy (Collection policy)
void setTimestampFormat (DateFormat fmt)
void setTimestampParse (DateFormat fmt)
Protected Member Functions
Collection getDefaultPolicy ()
void invalidInputType (Object value, VerticaType type)
void invalidInputValue (Object value, VerticaType type)
SpecialBigDecimal parseNumber (char[] text)
void unsupportedType (Object value, VerticaType type)
void valueTooLarge (Object value, VerticaType type)

Detailed Description

StandardTypeCoercion implements standard type conversions. It provides some ability to configure how certain values (such as booleans and dates) are Interpreted or formatted.

The default policy favors errors and avoids modifying data. See getDefaultPolicy(). Values may be truncated if the policy includes TRUNCATE_VALUES.

Constructor & Destructor Documentation

com.vertica.sdk.StandardTypeCoercion.StandardTypeCoercion()

Create a default instance of StandardTypeCoercion using the default policy.

See Also

getDefaultPolicy()

Member Function Documentation

ByteBuffer com.vertica.sdk.NullTypeCoercion.asBinaryBytes(Object value, int length, VerticaType type)

inherited Not supported; returns null or raises TypeCoercionException.

Implements com.vertica.sdk.TypeCoercion.

Boolean com.vertica.sdk.StandardTypeCoercion.asBoolean(Object value, VerticaType type)

Generates a Boolean (or null) value out of input values of various types, depending on the boolean evaluation strategy. Uses one of the various 'asBoolean' methods according to the current boolean evaluation strategy.

See Also

setBooleanEvaluation(BooleanEvaluation)

asBooleanByVertica(Object, VerticaType)

asBooleanByPerl(Object, VerticaType)

asBooleanByPython(Object, VerticaType)

asBooleanByJava(Object, VerticaType)

asBooleanByNumeric(Object, VerticaType)

Implements com.vertica.sdk.TypeCoercion.

Boolean com.vertica.sdk.StandardTypeCoercion.asBooleanByJava(Object value, VerticaType type)

Interprets a Boolean value in a similar manner as Java's Boolean#valueOf(String) function, which handles only Strings.

  • null values are null.

  • Boolean values are used as-is.

  • String values are evaluated via Boolean.valueOf(String).

Parameters

  • value: The value being coerced.
  • type: The target Vertica type, which is boolean.

Returns value coerced to Boolean, potentially null.

Referenced by com.vertica.sdk.StandardTypeCoercion.asBoolean().

Boolean com.vertica.sdk.StandardTypeCoercion.asBooleanByNumeric(Object value, VerticaType type)

Interprets a Boolean value in a similar manner as C/C++, where numeric values and booleans aren't strictly separated. Rather than handling only integer numerics, this handles all numerics.

  • null values are null.

  • Boolean values are used as-is.

  • Number values are evaluated based on Number#doubleValue(). 0.0 is false and all other values are true.

  • All other types are invalid input types.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type, which is boolean.

Returns value coerced to Boolean, potentially null.

Referenced by com.vertica.sdk.StandardTypeCoercion.asBoolean().

Boolean com.vertica.sdk.StandardTypeCoercion.asBooleanByPerl(Object value, VerticaType type)

Interprets a Boolean value in a similar manner as Perl does. Unlike Perl which treats undef as false, the null value will give a null Boolean. Otherwise, behavior follows the Perl behavior as closely as possible.

  • null values are null.

  • Boolean values are used as-is.

  • String values are false if empty (length() == 0) or if equal to "0". Strings are true otherwise. Whitespace is NOT ignored.

  • Number values are evaluated based on doubleValue(). 0.0 is false and all other values are True.

  • Collection and Map values are false if empty (size() == 0) and true otherwise.

  • All other types are true. Therefore, this will never result in an invalid input type.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type, which is boolean.

Returns value coerced to Boolean, potentially null.

Referenced by com.vertica.sdk.StandardTypeCoercion.asBoolean().

Boolean com.vertica.sdk.StandardTypeCoercion.asBooleanByPython(Object value, VerticaType type)

Interprets a Boolean value in a similar manner as Python does. Unlike Python which treats None as False, the null value will give a null Boolean. Otherwise, behavior follows the Python language specification. See "5.10 Boolean operations" in the Python 2.x reference on expressions.

  • null values are null.

  • Boolean values are used as-is.

  • String values are false if empty (length() == 0) and true otherwise. Whitespace is NOT ignored.

  • Number values are evaluated based on doubleValue(). 0.0 is false and all other values are True.

  • Collection and Map values are false if empty (size() == 0) and true otherwise.

  • All other types are true. Therefore, this will never result in an invalid input type.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type, which is boolean.

Returns value coerced to Boolean, potentially null.

Referenced by com.vertica.sdk.StandardTypeCoercion.asBoolean().

Boolean com.vertica.sdk.StandardTypeCoercion.asBooleanByVertica(Object value, VerticaType type)

Interprets a Boolean value in a similar manner as Vertica does internally.

  • null values are null.

  • Boolean values are used as-is.

  • The following String values are true, after trimming leading and trailing whitespace and ignoring case: 't', 'true', 'y', 'yes', '1'.

  • The following String values are false, after trimming leading and trailing whitespace and ignoring case: 'f', 'false', 'n', 'no', '0'.

  • All other String values are invalid input values.

  • Number values are evaluated based on doubleValue(). 0.0 is false and 1.0 is true. All other values are invalid input values.

  • All other types are invalid input types.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type, which is boolean.

Returns value coerced to Boolean, potentially null.

Referenced by com.vertica.sdk.StandardTypeCoercion.asBoolean().

ByteBuffer com.vertica.sdk.StandardTypeCoercion.asCharBytes(Object value, int length, VerticaType type)

Generates a ByteBuffer with the string representation of an object. Generally uses the same approach as Vertica's vsql presentation format for analogous types. Unknown types will use Java's String#valueOf(Object).

The value will be truncated to length when necessary if TRUNCATE_VALUES is specified in the policy. Otherwise values that are too long will return in either a null return value or a TypeCoercionException according to the policy (FAIL_INVALID_INPUT_VALUE).

In agreement with how 'char' values are stored in Vertica, trailing spaces will be removed if the type is 'char'.

Specifically, the following describes the textual representation of various types, which then undergoes truncation and trimming as necessary.

  • null values are null.

  • String values are used as-is.

  • Long, Integer, Short, Byte, AtomicLong, AtomicInteger, and BigInteger types are represented in decimal, without ever using scientific notation. Negative values are preceded with a '-'.

  • BigDecimal is also represented in decimal, without ever using scientific notation. BigDecimal#toPlainString() method is used.

  • All other Number types are represented by passing the Number#doubleValue() through Double#toString() which uses scientific notation and represents NaN and Infinity.

  • Boolean values are represented as 'true' or 'false'.

  • java.sql.Date values are formatted with the format given by getDateFormat()

  • java.util.Date values (including java.sql.Timestamp values) are formatted with the format given by getTimestampFormat().

  • String#valueOf(Object) is used for all other values.

See Also

VerticaType::isChar()

Implements com.vertica.sdk.TypeCoercion.

java.sql.Date com.vertica.sdk.StandardTypeCoercion.asDate(Object value, VerticaType type)

Generate a java.sql.Date representation of the provided object.

  • null values are null.

  • java.sql.Date values are used as-is. java.util.Date values are converted to java.sql.Date.

  • String values are handled by parseDate(String, VerticaType).

  • All other types are invalid input types.

See Also

parseDate(String, VerticaType)

Implements com.vertica.sdk.TypeCoercion.

Double com.vertica.sdk.StandardTypeCoercion.asDouble(Object value, VerticaType type)

Generates a Double representation of the provided object.

  • null values are null.

  • Number values use Number#doubleValue().

  • Strings are parsed by the following rules. Violations are invalid input values. Note that the double data type has a limited range of precision and magnitude. Some precision may be lost. Extreme values may be represented as Infinity or -Infinity.

A hexidecimal integer value starting with '0x' or '0X' with optional leading '-' or '+'.

  • 'Infinity' (case insensitive) with optional leading '-' or '+'.

  • 'NaN' (case insensitive) with optional leading '-' or '+'.

  • A decimal number with or without scientific notation, with optional leading '-' or '+'

  • All other types are invalid input types.

Implements com.vertica.sdk.TypeCoercion.

Long com.vertica.sdk.StandardTypeCoercion.asLong(Object value, VerticaType type)

Generates a Long representation of the provided object.

  • null values are null.

  • Number values use Number#doubleValue(). This usually implies truncation of any fractional part of the value, regardless of the truncation policy.

  • Strings are parsed by the following rules. Violations are invalid input values. Note that the long data type has a limited range of magnitude. Values outside of this range are invalid input values. Values with fractional parts are truncated.

A hexidecimal integer value starting with '0x' or '0X' with optional leading '-' or '+'.

  • A decimal number with or without scientific notation, with optional leading '-' or '+'

  • All other types are invalid input types.

Implements com.vertica.sdk.TypeCoercion.

java.sql.Timestamp com.vertica.sdk.StandardTypeCoercion.asTimestamp(Object value, VerticaType type)

Generate a java.sql.Timestamp representation of the provided object.

  • null values are null.

  • java.sql.Timestamp values are used as-is. java.util.Date values are converted to java.sql.Timestamp via getTime().

  • String values are handled by parseTimestamp(String, VerticaType).

  • All other types are invalid input types.

See Also

parseTimestamp(String, VerticaType)

Implements com.vertica.sdk.TypeCoercion.

BooleanEvaluation com.vertica.sdk.StandardTypeCoercion.getBooleanEvaluation()

Get the boolean evaluation strategy. The default is VERTICA.

Returns The current boolean evaluation strategy.

DateFormat com.vertica.sdk.StandardTypeCoercion.getDateFormat()

Get the DateFormat used for formatting date types. This is used during asCharBytes for appropriately typed objects.

Returns The format in use.

See Also

asCharBytes(Object, int, VerticaType)

DateFormat com.vertica.sdk.StandardTypeCoercion.getDateParse()

Retrieve the current DateFormat used for parsing java.sql.Date values in parseDate(String, VerticaType). Does not return null.

Returns The format in use.

See Also

getDefaultDateParse()

parseDate(String, VerticaType)

DateFormat com.vertica.sdk.StandardTypeCoercion.getDefaultDateFormat()

Get the default DateFormat used for formatting date types to Strings. The format is 'yyyy-MM-dd' in the JVM default timezone. This is used during asCharBytes for appropriately typed objects.

Returns The default format used by new instances.

See Also

asCharBytes(Object, int, VerticaType)

Referenced by com.vertica.sdk.StandardTypeCoercion.setDateFormat().

DateFormat com.vertica.sdk.StandardTypeCoercion.getDefaultDateParse()

Get the default DateFormat used for parsing date types from Strings. The format is 'yyyy-MM-dd' in the JVM default timezone and is not lenient.

For more flexibility, override parseDate(String, VerticaType) or install a different date format.

See Also

parseDate(String, VerticaType)

setDateParse(DateFormat)

Returns The default format used by new instances.

Referenced by com.vertica.sdk.StandardTypeCoercion.setDateParse().

Collection com.vertica.sdk.NoopTypeCoercion.getDefaultPolicy()

protected inherited Provides the default policy installed by the constructor.

For NoopTypeCoercion, the default policy favors errors and avoids modifying data:

  • FAIL_SDK_UNSUPPORTED_TYPE

  • FAIL_UNSUPPORTED_TYPE

  • FAIL_INVALID_INPUT_TYPE

  • FAIL_INVALID_INPUT_VALUE

DateFormat com.vertica.sdk.StandardTypeCoercion.getDefaultTimestampFormat()

Get the default DateFormat used for formatting timestamp types to Strings. The format is 'yyyy-MM-dd HH:mm:ss.SSS' in the JVM default timezone. This is used during asCharBytes for appropriately typed objects.

Returns The default format used by new instances.

See Also

asCharBytes(Object, int, VerticaType)

Referenced by com.vertica.sdk.StandardTypeCoercion.setTimestampFormat().

DateFormat com.vertica.sdk.StandardTypeCoercion.getDefaultTimestampParse()

Get the default DateFormat used for parsing timestamp types from Strings. The format is 'yyyy-MM-dd HH:mm:ss.SSS' in the JVM default timezone and is not lenient.

For more flexibility, override parseTimestamp(String, VerticaType) or install a different date format.

See Also

parseTimestamp(String, VerticaType)

setTimestampParse(DateFormat)

Returns The default format used by new instances.

Referenced by com.vertica.sdk.StandardTypeCoercion.setTimestampParse().

Iterator com.vertica.sdk.NoopTypeCoercion.getListIterator(Object value)

inherited Provides an Iterator over Objects for a given Iterable input.

Parameters

  • value: Something implementing Iterable

Implements com.vertica.sdk.TypeCoercion.

Iterator > com.vertica.sdk.NoopTypeCoercion.getMapIterator(Object value)

inherited Provides an Iterator over map entries for a given Map.

Internal maps are assumed to have String keys. A ClassCastException will eventually result if there are internal maps with keys that are not Strings.

Parameters

  • value: Something implementing Map

Implements com.vertica.sdk.TypeCoercion.

MetaType com.vertica.sdk.NoopTypeCoercion.getMetaType(Object value)

inherited Detects Java standard Map and Iterable types.

Internal maps are assumed to have String keys. A ClassCastException will result if there are internal maps with keys that are not Strings.

Implements com.vertica.sdk.TypeCoercion.

Set com.vertica.sdk.NullTypeCoercion.getPolicy()

inherited Returns an unmodifiable version of the policy.

Returns The policy collection.

See Also

setPolicy

Implements com.vertica.sdk.TypeCoercion.

Referenced by

DateFormat com.vertica.sdk.StandardTypeCoercion.getTimestampFormat()

Get the current DateFormat used for formatting timestamp types. This is used during asCharBytes for appropriately typed objects.

Returns The format in use.

See Also

asCharBytes(Object, int, VerticaType)

DateFormat com.vertica.sdk.StandardTypeCoercion.getTimestampParse()

Retrieve the current DateFormat used for parsing java.sql.Timestamp values in parseTimestamp(String, VerticaType). Does not return null.

Returns The format in use.

See Also

getDefaultTimestampParse()

parseTimestamp(String, VerticaType)

void com.vertica.sdk.NoopTypeCoercion.invalidInputType(Object value, VerticaType type)

protected inherited Throws a TypeCoercionException if the policy includes FAIL_INVALID_INPUT_TYPE. Otherwise does nothing.

Parameters

  • value: The value being coerced.
  • type: The target type.

See Also

getPolicy() #setPolicy(Collection)

Referenced by

void com.vertica.sdk.StandardTypeCoercion.invalidInputValue(Object value, VerticaType type)

protected

Throws a TypeCoercionException if the policy includes FAIL_INVALID_INPUT_VALUE. Otherwise does nothing.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type.

See Also

getPolicy() #setPolicy(Collection)

Referenced by

java.sql.Date com.vertica.sdk.StandardTypeCoercion.parseDate(String value, VerticaType type)

Parse a date from a String using the current date parsing format.

Note that java.sql.Date specifies that values should be normalized by setting all non-day units to 0. This is not necessary or expected of return values from parseDate.

Parameters

  • value: The String value being coerced, which is not null.
  • type: The target Vertica type, which is a date type.

Returns The input value as a date, or null.

See Also

setDateParse(DateFormat)

getDefaultDateParse()

Referenced by com.vertica.sdk.StandardTypeCoercion.asDate().

SpecialBigDecimal com.vertica.sdk.StandardTypeCoercion.parseNumber(char[] text)

protected

Parses a textual representation of a number into a SpecialBigDecimal. Input text is trimmed of whitespace, then evaluated as a perfect fit to:

  • A hexidecimal integer value starting with '0x' or '0X' with optional leading '-' or '+'.

  • 'Infinity' (case insensitive) with optional leading '-' or '+'.

  • 'NaN' (case insensitive) with optional leading '-' or '+'.

  • A decimal number with or without scientific notation, with optional leading '-' or '+'.

Parameters

  • text: A string as a character array.

Returns A SpecialBigDecimal representing the value of the text, whether that is a BigDecimal value or a special non-real value.

Referenced by

java.sql.Timestamp com.vertica.sdk.StandardTypeCoercion.parseTimestamp(String value, VerticaType type)

Parse a timestamp from a String using the current timestamp parsing format. Because DateFormat#parse(String, ParsePosition) returns a java.sql.Date, the precision of this operation is only milliseconds, which is less than Vertica's possible precision of microseconds.

Note that timestamptz (aka 'timestamp with time zone') and timestamp values are parsed in the same manner, regardless of the current session's timezone.

Parameters

  • value: The String value being coerced, which is not null.
  • type: The target Vertica type, which is either timestamp or timestamptz.

Returns A timestamp value, or null.

See Also

setTimestampParse(DateFormat)

getDefaultTimestampParse()

Referenced by com.vertica.sdk.StandardTypeCoercion.asTimestamp().

void com.vertica.sdk.StandardTypeCoercion.setBooleanEvaluation(BooleanEvaluation boolEval)

Set the boolean evaluation strategy. The default is VERTICA.

Parameters

  • boolEval: A boolean evaluation strategy

See Also

asBooleanByVertica(Object, VerticaType)

asBooleanByPerl(Object, VerticaType)

asBooleanByPython(Object, VerticaType)

asBooleanByJava(Object, VerticaType)

asBooleanByNumeric(Object, VerticaType)

void com.vertica.sdk.StandardTypeCoercion.setDateFormat(DateFormat fmt)

Set the DateFormat used for formatting date types. This is used during asCharBytes for appropriately typed objects. Only the format method will be used; other methods do not need to be implemented.

Parameters

  • fmt: The format to use.

See Also

asCharBytes(Object, int, VerticaType)

void com.vertica.sdk.StandardTypeCoercion.setDateParse(DateFormat fmt)

Set the DateFormat used for parsing java.sql.Date values in parseDate. If null, the default date parse format is used.

Note Non-Lenient DateFormats are strongly encouraged. Lenient date formats can cause surprising results in some scenarios.

Parameters

  • fmt: The format to use.

See Also

getDefaultDateParse()

parseDate(String, VerticaType)

void com.vertica.sdk.NullTypeCoercion.setPolicy(Collection policy)

inherited Sets the policies for this TypeCoercion instance. Policies generally dictate which scenarios generate exceptions and allow for different error handling choices without implementing a new TypeCoercion class.

Parameters

  • policy: The policy collection

See Also

TypeCoercionPolicy

getPolicy()

Implements com.vertica.sdk.TypeCoercion.

Referenced by com.vertica.sdk.NullTypeCoercion.NullTypeCoercion().

void com.vertica.sdk.StandardTypeCoercion.setTimestampFormat(DateFormat fmt)

Set the DateFormat used for formatting timestamp types. This is used during asCharBytes for appropriately typed objects. Only the format method will be used; other methods do not need to be implemented.

Parameters

  • fmt: The format to use.

See Also

asCharBytes(Object, int, VerticaType)

void com.vertica.sdk.StandardTypeCoercion.setTimestampParse(DateFormat fmt)

Set the DateFormat used for parsing java.sql.Timestamp values in parseTimestamp. If null, the default timestamp parse format is used.

Note Non-Lenient DateFormats are strongly encouraged. Lenient date formats can cause surprising results in some scenarios.

Parameters

  • fmt: The format to use.

See Also

getDefaultTimestampParse()

parseTimestamp(String, VerticaType)

void com.vertica.sdk.NullTypeCoercion.unsupportedType(Object value, VerticaType type)

protected inherited Throws a TypeCoercionException if the policy includes TypeCoercionPolicy#FAIL_UNSUPPORTED_TYPE. Otherwise does nothing.

Parameters

  • value: The value provided which could not be coerced.
  • type: The target Vertica type.

See Also

getPolicy() #setPolicy(Collection)

Referenced by

void com.vertica.sdk.NoopTypeCoercion.valueTooLarge(Object value, VerticaType type)

protected inherited Throws a TypeCoercionException with a TRUNCATE_VALUES cause if the policy includes FAIL_INVALID_INPUT_VALUE. Otherwise does nothing.

This should only be called if the policy does not request truncation via TRUNCATE_VALUES.

Parameters

  • value: The value being coerced.
  • type: The target type.

See Also

getPolicy() #setPolicy(Collection)

Referenced by

2.1.116 - com.vertica.sdk.StandardTypeCoercion Member List

This is the complete list of members for com.vertica.sdk.StandardTypeCoercion, including all inherited members.

asBinaryBytes(Object value, int length, VerticaType type) com.vertica.sdk.NullTypeCoercion
asBoolean(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asBooleanByJava(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asBooleanByNumeric(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asBooleanByPerl(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asBooleanByPython(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asBooleanByVertica(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asCharBytes(Object value, int length, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asDate(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asDouble(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asLong(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
asTimestamp(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
getBooleanEvaluation() com.vertica.sdk.StandardTypeCoercion
getDateFormat() com.vertica.sdk.StandardTypeCoercion
getDateParse() com.vertica.sdk.StandardTypeCoercion
getDefaultDateFormat() com.vertica.sdk.StandardTypeCoercion
getDefaultDateParse() com.vertica.sdk.StandardTypeCoercion
getDefaultPolicy() com.vertica.sdk.NoopTypeCoercion protected
getDefaultTimestampFormat() com.vertica.sdk.StandardTypeCoercion
getDefaultTimestampParse() com.vertica.sdk.StandardTypeCoercion
getListIterator(Object value) com.vertica.sdk.NoopTypeCoercion
getMapIterator(Object value) com.vertica.sdk.NoopTypeCoercion
getMetaType(Object value) com.vertica.sdk.NoopTypeCoercion
getPolicy() com.vertica.sdk.NullTypeCoercion
getTimestampFormat() com.vertica.sdk.StandardTypeCoercion
getTimestampParse() com.vertica.sdk.StandardTypeCoercion
invalidInputType(Object value, VerticaType type) com.vertica.sdk.NoopTypeCoercion protected
invalidInputValue(Object value, VerticaType type) com.vertica.sdk.StandardTypeCoercion protected
NullTypeCoercion() com.vertica.sdk.NullTypeCoercion
parseDate(String value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
parseNumber(char[] text) com.vertica.sdk.StandardTypeCoercion protected
parseTimestamp(String value, VerticaType type) com.vertica.sdk.StandardTypeCoercion
setBooleanEvaluation(BooleanEvaluation boolEval) com.vertica.sdk.StandardTypeCoercion
setDateFormat(DateFormat fmt) com.vertica.sdk.StandardTypeCoercion
setDateParse(DateFormat fmt) com.vertica.sdk.StandardTypeCoercion
setPolicy(Collection policy) com.vertica.sdk.NullTypeCoercion
setTimestampFormat(DateFormat fmt) com.vertica.sdk.StandardTypeCoercion
setTimestampParse(DateFormat fmt) com.vertica.sdk.StandardTypeCoercion
StandardTypeCoercion() com.vertica.sdk.StandardTypeCoercion
unsupportedType(Object value, VerticaType type) com.vertica.sdk.NullTypeCoercion protected
valueTooLarge(Object value, VerticaType type) com.vertica.sdk.NoopTypeCoercion protected

2.1.117 - com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation Enum Reference

Collaboration diagram for com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation:

Public Attributes
JAVA
PERL
PYTHON
VERTICA

Detailed Description

Choice of algorithm for handling coercion to Vertica's boolean type.

Member Data Documentation

com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation.JAVA

use asBooleanByJava.

com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation.PERL

use asBooleanByPerl.

com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation.PYTHON

use asBooleanByPython.

com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation.VERTICA

use asBooleanByJava.

Referenced by com.vertica.sdk.StandardTypeCoercion.StandardTypeCoercion().

2.1.118 - com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation Member List

This is the complete list of members for com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation, including all inherited members.

JAVA com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation
NUMERIC enum value com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation
PERL com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation
PYTHON com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation
VERTICA com.vertica.sdk.StandardTypeCoercion.BooleanEvaluation

2.1.119 - com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal Class Reference

Collaboration diagram for com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal:

Public Member Functions
SpecialBigDecimal (BigDecimal val)
Public Attributes
final BigDecimal bigDecimal
final boolean isSpecial
final Double special
Static Public Attributes
static final SpecialBigDecimal NAN
static final SpecialBigDecimal NEGATIVE_INFINITY
static final SpecialBigDecimal POSITIVE_INFINITY

Detailed Description

Wraps a BigDecimal value such that NaN, +Infinity, and -Infinity can also be represented. This class does not have comparison or equality functionality. It's intended usage is only as a vehicle for the results of parseNumber.

When handling the result of StandardTypeCoercion#parseNumber(char[]), first check whether or not the result SpecialBigDecimal#isSpecial. If the result is special, then the value is either NaN, Infinity, or -Infinity. The value can be found in SpecialBigDecimal#special. Otherwise, the value can be found in SpecialBigDecimal#bigDecimal.

Constructor & Destructor Documentation

com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal.SpecialBigDecimal(BigDecimal val)

Create a finite and real SpecialBigDecimal based on a BigDecimal value.

Parameters

  • val: The internal value.

Member Data Documentation

final SpecialBigDecimal com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal.NAN

static

Initial value:

=
new SpecialBigDecimal(Double.NaN)

Singleton NaN special value.

Referenced by com.vertica.sdk.StandardTypeCoercion.parseNumber().

final SpecialBigDecimal com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal.NEGATIVE_INFINITY

static

Initial value:

=
new SpecialBigDecimal(Double.NEGATIVE_INFINITY)

Singleton -Infinity special value.

Referenced by com.vertica.sdk.StandardTypeCoercion.parseNumber().

final SpecialBigDecimal com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal.POSITIVE_INFINITY

static

Initial value:

=
new SpecialBigDecimal(Double.POSITIVE_INFINITY)

Singleton Infinity special value.

Referenced by com.vertica.sdk.StandardTypeCoercion.parseNumber().

2.1.120 - com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal Member List

This is the complete list of members for com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal, including all inherited members.

bigDecimal (defined in com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal) com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal
isSpecial (defined in com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal) com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal
NAN com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal static
NEGATIVE_INFINITY com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal static
POSITIVE_INFINITY com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal static
special (defined in com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal) com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal
SpecialBigDecimal(BigDecimal val) com.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal

2.1.121 - com.vertica.sdk.State Class Reference

Collaboration diagram for com.vertica.sdk.State:

Classes
enum InputState
enum StreamState

2.1.122 - com.vertica.sdk.State.InputState Enum Reference

Collaboration diagram for com.vertica.sdk.State.InputState:

Public Member Functions
int getCode ()
Public Attributes
END_OF_CHUNK =(2)
END_OF_FILE =(1)
OK =(0)

Detailed Description

InputState is used by input streams; namely, UDFilter and UDParser.

Member Function Documentation

int com.vertica.sdk.State.InputState.getCode()

Each Input State has a unique code, but that code is an internal implementation detail not intended to be used by UDX implementations.

Returns code

Member Data Documentation

com.vertica.sdk.State.InputState.END_OF_CHUNK =(2)

Reached the end of an input chunk. Applies only to a parser and only when fed by a Chunker, it means the current data block ends on a record boundary. In this state a parser should consume all data in the block before returning from process.

Returning a StreamState of INPUT_NEEDED at this point is invalid, as there is no more input available for this parser.

com.vertica.sdk.State.InputState.END_OF_FILE =(1)

Reached the end of the input stream. No further data is available. Returning a StreamState of INPUT_NEEDED at this point is invalid, as there is no more input.

com.vertica.sdk.State.InputState.OK =(0)

Currently at the start of or in the middle of a stream.

2.1.123 - com.vertica.sdk.State.InputState Member List

This is the complete list of members for com.vertica.sdk.State.InputState, including all inherited members.

END_OF_CHUNK com.vertica.sdk.State.InputState
END_OF_FILE com.vertica.sdk.State.InputState
getCode() com.vertica.sdk.State.InputState
OK com.vertica.sdk.State.InputState

2.1.124 - com.vertica.sdk.State.StreamState Enum Reference

Collaboration diagram for com.vertica.sdk.State.StreamState:

Public Member Functions
int getCode ()
Public Attributes
DONE =(2)
INPUT_NEEDED =(0)
KEEP_GOING =(4)
OUTPUT_NEEDED =(1)
REJECT =(3)

Detailed Description

StreamState indicates the state of a stream after process() has handled some input and some output data. See the UDSource, UDFilter, and UDParser classes for how these streams are used.

Member Data Documentation

com.vertica.sdk.State.StreamState.DONE =(2)

The stream has completed; it will not be writing any more output nor consuming any more input.

Referenced by com.vertica.sdk.ContinuousUDParser.process().

com.vertica.sdk.State.StreamState.INPUT_NEEDED =(0)

Indicates that a stream is unable to continue without being given more input. It may not have consumed all of its available input yet. It does not need to have consumed every byte of input. Not valid for output-only streams, ie., UDSources.

Referenced by com.vertica.sdk.ContinuousUDParser.process().

com.vertica.sdk.State.StreamState.KEEP_GOING =(4)

Not commonly used; the stream has neither filled all of its output buffer nor consumed all of its input buffer, but would like to yield to the server. Typically it has neither consumed data nor produced data. This state should be used instead of a "wait" loop; a stream that is waiting for some external operation to complete should periodically return KEEP_GOING rather than simply blocking forever.

Referenced by com.vertica.sdk.ContinuousUDParser.process().

com.vertica.sdk.State.StreamState.OUTPUT_NEEDED =(1)

Indicates that a stream is unable to write more output without being given a new or larger output buffer. Basically that it has "filled" the buffer as much as it is reasonably able to (which may be every byte full, some bytes full, even completely empty – in which case Vertica assumes that the UDL needs a larger buffer). Not valid for input-only streams, ie., UDParsers.

com.vertica.sdk.State.StreamState.REJECT =(3)

Only valid for UDParsers, indicates that the Parser has encountered an invalid entry that it cannot process. Parsers may reject exactly one row at a time.

See Also

UDParser::getRejectedRecord()

Referenced by com.vertica.sdk.ContinuousUDParser.process().

2.1.125 - com.vertica.sdk.State.StreamState Member List

This is the complete list of members for com.vertica.sdk.State.StreamState, including all inherited members.

DONE com.vertica.sdk.State.StreamState
getCode() (defined in com.vertica.sdk.State.StreamState) com.vertica.sdk.State.StreamState
INPUT_NEEDED com.vertica.sdk.State.StreamState
KEEP_GOING com.vertica.sdk.State.StreamState
OUTPUT_NEEDED com.vertica.sdk.State.StreamState
REJECT com.vertica.sdk.State.StreamState

2.1.126 - com.vertica.sdk.StreamWriter Class Reference

Inheritance diagram for com.vertica.sdk.StreamWriter:

Collaboration diagram for com.vertica.sdk.StreamWriter:

Public Member Functions
StreamWriter (int nargs)
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
void copyFromInput (int dstIdx, PartitionReader input_reader, int srcIdx) throws UdfException
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
TypeCoercion getDefaultTypeCoercion ()
int getNumCols ()
VNumeric getNumericWriter (int idx)
int getNumRows ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
VString getStringWriter (int idx)
long getTotalRowCount ()
SizedColumnTypes getTypeMetaData ()
abstract boolean getWriteableBlock () throws UdfException, DestroyInvocation
boolean next () throws UdfException, DestroyInvocation
void resetBuffers ()
void setBoolean (int idx, boolean r)
void setBooleanNull (int idx)
void setBooleanValue (int idx, Boolean value)
void setDate (int idx, java.sql.Date r)
void setDateNull (int idx)
void setDateValue (int idx, java.sql.Date value)
TypeCoercion setDefaultTypeCoercion (TypeCoercion coerce)
void setDouble (int idx, double r)
void setDoubleNull (int idx)
void setDoubleValue (int idx, Double value)
void setLong (int idx, long r)
void setLongNull (int idx)
void setLongValue (int idx, Long value)
void setNumeric (int idx, BigDecimal bd)
void setNumericNull (int idx)
void setNumericValue (int idx, BigDecimal value)
void setRowFromMap (Map rowData)
void setRowFromMap (Map rowData, TypeCoercion coerce)
void setString (int idx, String r)
void setStringBytes (int idx, ByteBuffer bytes)
void setStringNull (int idx)
void setStringValue (int idx, String value)
void setTimestamp (int idx, java.sql.Timestamp r)
void setTimestampInfiniteNeg (int idx)
void setTimestampInfinitePos (int idx)
void setTimestampNull (int idx)
void setTimestampValue (int idx, java.sql.Timestamp value)
void setValue (int idx, Object value, TypeCoercion coerce)
void setVMap (int idx, Map data)
void setVMap (int idx, Map data, TypeCoercion coerce)
void throwInCorrectUsageError (int idx)
: Throwing UdfException for incorrect setter usage
Public Attributes
int count
int index
int ncols
int nrows
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
long getRowSize (SizedColumnTypes types)
void setRowCount (SizedColumnTypes types)
Static Protected Member Functions
static long blockSizeGivenRowSize (long row_size)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
long cumulative_rows
ArrayList currentPos

Detailed Description

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.

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

inherited Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
void com.vertica.sdk.PartitionWriter.copyFromInput(int dstIdx, PartitionReader input_reader, int srcIdx) throws UdfException

inherited Copies a column from the input reader to the output writer. The data types and sizes of the source and destination columns must match exactly.

Parameters

  • dstIdx: The destination column index (in the output writer)
  • input_reader: The input reader from which to copy a column
  • srcIdx: The source column index (in the input reader)
ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

inherited Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

inherited Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

TypeCoercion com.vertica.sdk.PartitionWriter.getDefaultTypeCoercion()

inherited Give the default TypeCoercion instance, creating one if necessary. This may be useful in cases where the calling code would like to change the TypeCoercionPolicy or do TypeCoercion in the same manner as this PartitionWriter.

If a TypeCoercion is created, it is an instance of StandardTypeCoercion.

See Also #setRowFromMap(Map)

Returns the current default TypeCoercion, creating one if necessary.

Referenced by

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected inherited Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

abstract boolean com.vertica.sdk.StreamWriter.getWriteableBlock() throws UdfException, DestroyInvocation

pure virtual Gets a writeable block of data and positions cursor at the beginning.

Implements com.vertica.sdk.PartitionWriter.

void com.vertica.sdk.PartitionWriter.setBooleanValue(int idx, Boolean value)

inherited Set a Boolean value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setDateValue(int idx, java.sql.Date value)

inherited Set a Date value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
TypeCoercion com.vertica.sdk.PartitionWriter.setDefaultTypeCoercion(TypeCoercion coerce)

inherited Set the default type coercion instance.

See Also #setRowFromMap(Map)

Parameters

  • coerce: A TypeCoercion instance.

Returns the former default, which may be null.

void com.vertica.sdk.PartitionWriter.setDoubleValue(int idx, Double value)

inherited Set a Double value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setLongValue(int idx, Long value)

inherited Set a Long value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setNumericValue(int idx, BigDecimal value)

inherited Set a Numeric value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setRowFromMap(Map rowData)

inherited Sets all columns on the current row according to the data provided, using the column names to match the data keys. See setRowFromMap(Map, TypeCoercion) for more details. This is a shortcut for using the default type coercion.

Parameters

  • rowData: The data. Null data is treated as empty.

See Also #setRowFromMap(Map, TypeCoercion)

getDefaultTypeCoercion()

void com.vertica.sdk.PartitionWriter.setRowFromMap(Map rowData, TypeCoercion coerce)

inherited Sets all columns on the current row according to the data provided, using the column names to match the data keys.

For each column, TypeCoercion will be used to convert a value in rowData to the appropriate type for that column. This is done via setValue and may cause a TypeCoercion exception.

To find the corresponding value, the 'first' matching key (according to case-insensitive SQL identifier matching) in the map will be used. 'first' is not well defined, but is consistent.

If no corresponding value is found, the column will be set to null. This never raises an exception, regardless of the target column type. That is, FAIL_SDK_UNSUPPORTED_TYPE is ignored in that case.

In addition, if the target row structure appears to be a flex table, the necessary internal structures will be populated with an encoded vmap via setVMap(int, Map, TypeCoercion).

Parameters

  • rowData: The data. Null data is treated as empty.
  • coerce: The implementation of coercion

See Also #setVMap(int, Map, TypeCoercion)

setValue(int, Object, TypeCoercion)

void com.vertica.sdk.PartitionWriter.setStringBytes(int idx, ByteBuffer bytes)

inherited Set a String value for column at index idx. Accepts null values.

Parameters

  • idx: The column index
  • bytes: A ByteBuffer with bytes between position and limit that are a string encoded according to Vertica's requirements. This buffer must fit within the column's length requirements.

Exceptions

  • IllegalArgumentException: if bytes is too long
void com.vertica.sdk.PartitionWriter.setStringValue(int idx, String value)

inherited Set a String value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setTimestampValue(int idx, java.sql.Timestamp value)

inherited Set a Timestamp value for column at index idx. Accepts null values.

Parameters

  • idx: column number
  • value: value to set it to
void com.vertica.sdk.PartitionWriter.setValue(int idx, Object value, TypeCoercion coerce)

inherited Set a value for a column using type coercion. Type coercion attempts to generate an appropriate value for the target column type based on the input type.

The following target column types are supported by the SDK for this method. All others will generate a TypeCoercionException due to FAIL_SDK_UNSUPPORTED_TYPE if appropriate.

  • Bools

  • Integers (excluding Numeric)

  • Floats

  • String-like types (char and binary, along with var- and long variants)

  • Timestamp and timestamptz

  • Dates

Parameters

  • idx: The column index
  • value: The value to store in the column. May be null.
  • coerce: The type coercion policy.

Referenced by com.vertica.sdk.PartitionWriter.setRowFromMap().

void com.vertica.sdk.PartitionWriter.setVMap(int idx, Map data)

inherited Encodes a VMap into the given column, which must be of binary type.

Parameters

  • idx: The index of the binary or varbinary column.
  • data: The data. Null data is treated as empty.

See Also #setVMap(int, Map, TypeCoercion)

getDefaultTypeCoercion()

void com.vertica.sdk.PartitionWriter.setVMap(int idx, Map data, TypeCoercion coerce)

inherited Encodes a VMap into the given column, which must be of binary type. Uses standard type coercion to identify aggregate values and to serialize all values.

Parameters

  • idx: The index of the binary or varbinary column.
  • data: The data. Null data is treated as empty.
  • coerce: Ignored but still here for backwards compatibility.

See Also #setVMap(int, Map)

getDefaultTypeCoercion()

2.1.127 - com.vertica.sdk.StreamWriter Member List

This is the complete list of members for com.vertica.sdk.StreamWriter, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
blockSizeGivenRowSize(long row_size) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter protectedstatic
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
copyFromInput(int dstIdx, PartitionReader input_reader, int srcIdx) com.vertica.sdk.PartitionWriter
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
cumulative_rows (defined in com.vertica.sdk.StreamWriter) com.vertica.sdk.StreamWriter protected
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getDefaultTypeCoercion() com.vertica.sdk.PartitionWriter
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getNumCols() com.vertica.sdk.VerticaBlock
getNumericWriter(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
getNumRows() com.vertica.sdk.VerticaBlock
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getRowSize(SizedColumnTypes types) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter protected
getStringWriter(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
getTotalRowCount() (defined in com.vertica.sdk.StreamWriter) com.vertica.sdk.StreamWriter
getTypeMetaData() com.vertica.sdk.VerticaBlock
getWriteableBlock() com.vertica.sdk.StreamWriter pure virtual
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
next() (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
PartitionWriter(int nargs) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
setBoolean(int idx, boolean r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setBooleanNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setBooleanValue(int idx, Boolean value) com.vertica.sdk.PartitionWriter
setDate(int idx, java.sql.Date r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDateNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDateValue(int idx, java.sql.Date value) com.vertica.sdk.PartitionWriter
setDefaultTypeCoercion(TypeCoercion coerce) com.vertica.sdk.PartitionWriter
setDouble(int idx, double r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDoubleNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setDoubleValue(int idx, Double value) com.vertica.sdk.PartitionWriter
setLong(int idx, long r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setLongNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setLongValue(int idx, Long value) com.vertica.sdk.PartitionWriter
setNumeric(int idx, BigDecimal bd) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setNumericNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setNumericValue(int idx, BigDecimal value) com.vertica.sdk.PartitionWriter
setRowCount(SizedColumnTypes types) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter protected
setRowFromMap(Map rowData) com.vertica.sdk.PartitionWriter
setRowFromMap(Map rowData, TypeCoercion coerce) com.vertica.sdk.PartitionWriter
setString(int idx, String r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setStringBytes(int idx, ByteBuffer bytes) com.vertica.sdk.PartitionWriter
setStringNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setStringValue(int idx, String value) com.vertica.sdk.PartitionWriter
setTimestamp(int idx, java.sql.Timestamp r) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampInfiniteNeg(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampInfinitePos(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampNull(int idx) (defined in com.vertica.sdk.PartitionWriter) com.vertica.sdk.PartitionWriter
setTimestampValue(int idx, java.sql.Timestamp value) com.vertica.sdk.PartitionWriter
setValue(int idx, Object value, TypeCoercion coerce) com.vertica.sdk.PartitionWriter
setVMap(int idx, Map data) com.vertica.sdk.PartitionWriter
setVMap(int idx, Map data, TypeCoercion coerce) com.vertica.sdk.PartitionWriter
StreamWriter(int nargs) (defined in com.vertica.sdk.StreamWriter) com.vertica.sdk.StreamWriter
throwInCorrectUsageError(int idx) com.vertica.sdk.PartitionWriter
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.128 - com.vertica.sdk.StringUtils Class Reference

Collaboration diagram for com.vertica.sdk.StringUtils:

Static Public Member Functions
static ByteBuffer duplicateBB (ByteBuffer buffer)
static Charset getCharset ()
static ByteBuffer getStringBytes (String value, int length, boolean removeTrailingSpaces)
static ByteBuffer getStringBytes (String value, int length, boolean removeTrailingSpaces, boolean truncate)
static String newString (ByteBuffer buffer)
static String newString (ByteBuffer buffer, Charset charset)
static void removeTruncatedUtf8CharBytes (ByteBuffer string)
static ByteBuffer sliceBB (ByteBuffer buffer)

Detailed Description

A collection of string-related functions which assist in reading, generating, and handling Vertica string-like types. String-like types include:

  • char

  • varchar

  • long varchar

  • binary

  • varbinary

  • long varbinary

Member Function Documentation

static ByteBuffer com.vertica.sdk.StringUtils.duplicateBB(ByteBuffer buffer)

static

A safer version of ByteBuffer#duplicate() that works around weird Java behavior. ByteBuffer#duplicate() does not apply the byte ordering of the source buffer to the duplicate buffer. This helper handles this. Otherwise it is identical.

Parameters

  • buffer: A non-null ByteBuffer.

Returns a duplicate of the given buffer, sharing the same storage.

See Also

Java bug 4715166

Referenced by com.vertica.sdk.vmap.v1.Encoder.encode().

static Charset com.vertica.sdk.StringUtils.getCharset()

static

Get the Charset used by Vertica. Required for any strings stored within or retrieved from Vertica.

Returns The character set.

Referenced by

static ByteBuffer com.vertica.sdk.StringUtils.getStringBytes(String value, int length, boolean removeTrailingSpaces)

static

Correctly extract the bytes from a Java String in Vertica's character set. Does not perform truncation. Shorthand for:

getStringBytes(value, length, removeTrailingSpaces, false);

See Also

getCharset()

Parameters

  • value: A non-null String (may be empty)
  • length: The maximum byte length of the destination, or -1 for no maximum.
  • removeTrailingSpaces: If true, trailing ASCII spaces will be excluded from the resulting byte sequence. This is proper behavior for Vertica's 'char' type.

Returns a ByteBuffer with position and limit designating the start and end of the correct byte representation of the string. If truncation is not permitted and the value is too long, null will be returned.

static ByteBuffer com.vertica.sdk.StringUtils.getStringBytes(String value, int length, boolean removeTrailingSpaces, boolean truncate)

static

Correctly extract the bytes from a Java String in Vertica's character set. This ensures that the value fits within the designated byte length OR is properly truncated.

If truncation falls within a multi-byte character, additional bytes will be removed in order to ensure the contents are a valid string encoding. This can cause truncation to result in byte buffer that is shorter than length.

When applicable, trailing spaces are removed from the input string immediately as well as after truncation. Therefore, values that exceed the maximum length due to trailing spaces will not require truncation. Also, values that are truncated (if applicable) will have any remaining trailing spaces removed.

See Also

getCharset()

Parameters

  • value: A non-null String (may be empty)
  • length: The maximum byte length of the destination, or -1 for no maximum.
  • removeTrailingSpaces: If true, trailing ASCII spaces will be excluded from the resulting byte sequence. This is proper behavior for Vertica's 'char' type.
  • truncate: If true, truncate values that are too long. If false, return null for values that are too long.

Returns a ByteBuffer with position and limit designating the start and end of the correct byte representation of the string. If truncation is not permitted and the value is too long, null will be returned.

static String com.vertica.sdk.StringUtils.newString(ByteBuffer buffer)

static

Decode a String from the ByteBuffer using Vertica's charset. This is written to avoid unnecessary copies of the byte data. The buffer is not modified.

Parameters

  • buffer: The buffer with String bytes between its position and limit. The position and limit of the buffer is left unmodified. May not be null.

See Also

getCharset()

Returns a non-null String

static String com.vertica.sdk.StringUtils.newString(ByteBuffer buffer, Charset charset)

static

Decode a String from the ByteBuffer using the specified charset. The implementation avoids unnecessary copies of the byte data.

Parameters

  • buffer: The buffer with String bytes between its position and limit. The position and limit of the buffer is left unmodified. May not be null.
  • charset: The Charset to use when creating the new string from the source bytes.

Returns a non-null String

static void com.vertica.sdk.StringUtils.removeTruncatedUtf8CharBytes(ByteBuffer string)

static

Removes bytes at the end of a string encoded in Vertica's character set that are incomplete multi-byte characters. This scenario usually occurs due to truncation according to byte length which falls in the middle of a multi-byte character. This further truncation ensures the final string is valid in Vertica's encoding.

Parameters

  • string: A ByteBuffer representing a string in Vertica's encoding. The limit will be moved towards the position in order to drop partial multi-byte characters.

Referenced by com.vertica.sdk.StringUtils.getStringBytes().

static ByteBuffer com.vertica.sdk.StringUtils.sliceBB(ByteBuffer buffer)

static

A safer version of ByteBuffer#slice() that works around weird Java behavior. ByteBuffer#slice() does not apply the byte ordering of the source buffer to the slice buffer. This helper handles this. Otherwise it is identical.

Parameters

  • buffer: A non-null ByteBuffer.

Returns a view into the given buffer, sharing the same storage.

See Also

Java bug 4715166

2.1.129 - com.vertica.sdk.StringUtils Member List

This is the complete list of members for com.vertica.sdk.StringUtils, including all inherited members.

duplicateBB(ByteBuffer buffer) com.vertica.sdk.StringUtils static
getCharset() com.vertica.sdk.StringUtils static
getStringBytes(String value, int length, boolean removeTrailingSpaces) com.vertica.sdk.StringUtils static
getStringBytes(String value, int length, boolean removeTrailingSpaces, boolean truncate) com.vertica.sdk.StringUtils static
newString(ByteBuffer buffer) com.vertica.sdk.StringUtils static
newString(ByteBuffer buffer, Charset charset) com.vertica.sdk.StringUtils static
removeTruncatedUtf8CharBytes(ByteBuffer string) com.vertica.sdk.StringUtils static
sliceBB(ByteBuffer buffer) com.vertica.sdk.StringUtils static

2.1.130 - com.vertica.sdk.TimestampUDxShared Class Reference

Collaboration diagram for com.vertica.sdk.TimestampUDxShared:

Classes
enum DTtype
Static Public Member Functions
static String describeIntervalTypeMod (int typemod)
static int INTERVAL_MASK (int b)
static int INTERVAL_PRECISION (int t)
static int INTERVAL_RANGE (int t)
static int TIMESTAMP_MASK (int b)
Static Public Attributes
static final int INTERVAL_DAY2SECOND
static final int INTERVAL_PRECISION_MASK = 0xFFFF
static final int INTERVAL_RANGE_MASK = INTERVAL_YEAR2MONTH | INTERVAL_DAY2SECOND
static final int INTERVAL_YEAR2MONTH = INTERVAL_MASK(DTtype.YEAR.getDTtype()) | INTERVAL_MASK(DTtype.MONTH.getDTtype())
static final int MAX_SECONDS_PRECISION = 6

Member Data Documentation

final int com.vertica.sdk.TimestampUDxShared.INTERVAL_DAY2SECOND

static

Initial value:

= INTERVAL_MASK(DTtype.DAY.getDTtype()) | INTERVAL_MASK(DTtype.HOUR.getDTtype()
| INTERVAL_MASK(DTtype.MINUTE.getDTtype()) | INTERVAL_MASK(DTtype.SECOND.getDTtype()))

2.1.131 - com.vertica.sdk.TimestampUDxShared Member List

This is the complete list of members for com.vertica.sdk.TimestampUDxShared, including all inherited members.

describeIntervalTypeMod(int typemod) (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static
INTERVAL_DAY2SECOND (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static
INTERVAL_MASK(int b) (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static
INTERVAL_PRECISION(int t) (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static
INTERVAL_PRECISION_MASK (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static
INTERVAL_RANGE(int t) (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static
INTERVAL_RANGE_MASK (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static
INTERVAL_YEAR2MONTH (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static
MAX_SECONDS_PRECISION (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static
TIMESTAMP_MASK(int b) (defined in com.vertica.sdk.TimestampUDxShared) com.vertica.sdk.TimestampUDxShared static

2.1.132 - com.vertica.sdk.TimestampUDxShared.DTtype Enum Reference

Collaboration diagram for com.vertica.sdk.TimestampUDxShared.DTtype:

Public Member Functions
int getDTtype ()
Public Attributes
ADBC =(16)
AGO =(17)
AMPM =(9)
DAY =(3)
DOW =(14)
DOY =(13)
DTZ =(6)
DTZMOD =(7)
HOUR =(10)
IGNORE_DTF =(8)
ISODATE =(20)
ISOTIME =(21)
MINUTE =(11)
MONTH =(1)
NEG_INTERVAL =(4)
RESERV =(0)
SECOND =(12)
TZ =(5)
UNITS =(15)
UNKNOWN_FIELD =(31)
YEAR =(2)

2.1.133 - com.vertica.sdk.TimestampUDxShared.DTtype Member List

This is the complete list of members for com.vertica.sdk.TimestampUDxShared.DTtype, including all inherited members.

ADBC (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
AGO (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
AMPM (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
DAY (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
DOW (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
DOY (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
DTZ (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
DTZMOD (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
getDTtype() (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
HOUR (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
IGNORE_DTF (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
ISODATE (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
ISOTIME (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
MINUTE (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
MONTH (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
NEG_INTERVAL (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
RESERV (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
SECOND (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
TZ (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
UNITS (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
UNKNOWN_FIELD (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype
YEAR (defined in com.vertica.sdk.TimestampUDxShared.DTtype) com.vertica.sdk.TimestampUDxShared.DTtype

2.1.134 - com.vertica.sdk.TransformFunction Class Reference

Inheritance diagram for com.vertica.sdk.TransformFunction:

Collaboration diagram for com.vertica.sdk.TransformFunction:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes)
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)
boolean isCanceled ()
abstract void processPartition (ServerInterface srvInterface, PartitionReader input_reader, PartitionWriter input_writer) throws UdfException, DestroyInvocation
void setup (ServerInterface srvInterface, SizedColumnTypes argTypes)
Protected Member Functions
void cancel (ServerInterface srvInterface)

Detailed Description

Interface for User-Defined Transform Function (UDTF). A UDTF operates on a table segment and returns zero or more rows of data.

UDTFs can only be used in the SELECT list of a query. UDTFs are cancelable.

A TransformFunction must have an associated TransformFunctionFactory.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
void com.vertica.sdk.UDXFunction.destroy(ServerInterface srvInterface, SizedColumnTypes argTypes)

inherited Perform per instance destruction. This function may throw errors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)

Referenced by com.vertica.sdk.UDXFunction.destroy().

void com.vertica.sdk.UDXFunction.destroy(ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)

inherited Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)
  • udSessionParams: a SessionParamWriterMap
boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

abstract void com.vertica.sdk.TransformFunction.processPartition(ServerInterface srvInterface, PartitionReader input_reader, PartitionWriter input_writer) throws UdfException, DestroyInvocation

pure virtual Invoke a user defined transform on a set of rows. As the name suggests, a batch of rows are passed in for every invocation to amortize performance.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • input_reader: input rows
  • input_writer: output location

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: vertica canceling – do not catch or handle
void com.vertica.sdk.UDXFunction.setup(ServerInterface srvInterface, SizedColumnTypes argTypes)

inherited Perform per instance initialization. This function may throw errors.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)

2.1.135 - com.vertica.sdk.TransformFunction Member List

This is the complete list of members for com.vertica.sdk.TransformFunction, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
destroy(ServerInterface srvInterface, SizedColumnTypes argTypes) com.vertica.sdk.UDXFunction
destroy(ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams) com.vertica.sdk.UDXFunction
isCanceled() com.vertica.sdk.UDXObject
processPartition(ServerInterface srvInterface, PartitionReader input_reader, PartitionWriter input_writer) com.vertica.sdk.TransformFunction pure virtual
setup(ServerInterface srvInterface, SizedColumnTypes argTypes) com.vertica.sdk.UDXFunction
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.136 - com.vertica.sdk.TransformFunctionFactory Class Reference

Inheritance diagram for com.vertica.sdk.TransformFunctionFactory:

Collaboration diagram for com.vertica.sdk.TransformFunctionFactory:

Public Member Functions
abstract TransformFunction createTransformFunction (ServerInterface srvInterface)
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
abstract void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
abstract void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException
UDXType getUDXFactoryType ()
Protected Attributes
long libOid
String sqlName

Detailed Description

Interface for declaring parameters and return types for, and instantiating, an associated TransformFunction.

Member Function Documentation

abstract TransformFunction com.vertica.sdk.TransformFunctionFactory.createTransformFunction(ServerInterface srvInterface)

pure virtual Called when Vertica needs a new TransformFunction object to process a UDTF function call.

Note More than one object may be instantiated per query.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Returns an TransformFunction object which implements the UDx API described by this metadata.

void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

inherited Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Referenced by com.vertica.sdk.UDXFactory.getPerInstanceResources().

void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

inherited Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
abstract void com.vertica.sdk.UDXFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

pure virtual inherited Provides the argument and return types of the UDX

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments
  • returnType: the type(s) of the return

Implemented in com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.

Referenced by com.vertica.sdk.ScalarFunctionFactory.getReturnType().

abstract void com.vertica.sdk.UDXFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException

pure virtual inherited Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Implemented in com.vertica.sdk.ScalarFunctionFactory, com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.

UDXType com.vertica.sdk.TransformFunctionFactory.getUDXFactoryType()

virtual

Returns the object type internally used by Vertica

Implements com.vertica.sdk.UDXFactory.

2.1.137 - com.vertica.sdk.TransformFunctionFactory Member List

This is the complete list of members for com.vertica.sdk.TransformFunctionFactory, including all inherited members.

createTransformFunction(ServerInterface srvInterface) com.vertica.sdk.TransformFunctionFactory pure virtual
getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDXFactory
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.UDXFactory pure virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.UDXFactory pure virtual
getUDXFactoryType() com.vertica.sdk.TransformFunctionFactory virtual
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected

2.1.138 - com.vertica.sdk.TransformFunctionPhase Class Reference

Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function.

Collaboration diagram for com.vertica.sdk.TransformFunctionPhase:

Public Member Functions
abstract TransformFunction createTransformFunction (ServerInterface srvInterface)
abstract void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnTypes)
boolean isPrepass ()
void setPrepass ()

Detailed Description

Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function.

Note that even though this class shares some methods with TransformFunctionFactory, it is explicitly not a subclass (because it is incorrect to implement a getPrototype() method for this class).

Member Function Documentation

abstract TransformFunction com.vertica.sdk.TransformFunctionPhase.createTransformFunction(ServerInterface srvInterface)

pure virtual Called when Vertica needs a new TransformFunction object to process this phase of a multi-phase UDT.

Note More than one object may be instantiated per query.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Returns a TransformFunction object which implements the UDx API described by this metadata.

abstract void com.vertica.sdk.TransformFunctionPhase.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnTypes)

pure virtual Function to tell Vertica what the return types (and length/precision if necessary) and partition-by, order-by of this phase are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time/Timestamp types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: Provides the data types of arguments that this phase was called with, along with partition and order information. This may be used to modify the return types accordingly.
  • returnTypes: User code must fill in the names and data types returned by this phase, along with the partition-by and order-by column information (if any).

2.1.139 - com.vertica.sdk.TransformFunctionPhase Member List

This is the complete list of members for com.vertica.sdk.TransformFunctionPhase, including all inherited members.

createTransformFunction(ServerInterface srvInterface) com.vertica.sdk.TransformFunctionPhase pure virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnTypes) com.vertica.sdk.TransformFunctionPhase pure virtual
isPrepass() (defined in com.vertica.sdk.TransformFunctionPhase) com.vertica.sdk.TransformFunctionPhase
setPrepass() (defined in com.vertica.sdk.TransformFunctionPhase) com.vertica.sdk.TransformFunctionPhase
TransformFunctionPhase() (defined in com.vertica.sdk.TransformFunctionPhase) com.vertica.sdk.TransformFunctionPhase

2.1.140 - com.vertica.sdk.TypeCoercion Interface Reference

Inheritance diagram for com.vertica.sdk.TypeCoercion:

Collaboration diagram for com.vertica.sdk.TypeCoercion:

Classes
enum MetaType
Public Member Functions
ByteBuffer asBinaryBytes (Object value, int length, VerticaType type)
Boolean asBoolean (Object value, VerticaType type)
ByteBuffer asCharBytes (Object value, int length, VerticaType type)
java.sql.Date asDate (Object value, VerticaType type)
Double asDouble (Object value, VerticaType type)
Long asLong (Object value, VerticaType type)
java.sql.Timestamp asTimestamp (Object value, VerticaType type)
Iterator getListIterator (Object value)
Iterator > getMapIterator (Object value)
MetaType getMetaType (Object value)
Set getPolicy ()
void setPolicy (Collection policy)

Detailed Description

An interface which allows for intelligent casting from arbitrary Java Objects to appropriate types for consumption by Vertica. Several default implementations are provided, including:

Member Function Documentation

ByteBuffer com.vertica.sdk.TypeCoercion.asBinaryBytes(Object value, int length, VerticaType type)

Coerce a value to bytes. May return null, which is different than an empty array.

Note that the 'binary' type should be padded out to the full length.

Parameters

  • value: The value being coerced.
  • length: The length of the string-like type.
  • type: The target Vertica type, which is a string-like type.

Returns a ByteBuffer with no more than 'length' bytes between its position and limit.

Implemented in com.vertica.sdk.NullTypeCoercion.

Boolean com.vertica.sdk.TypeCoercion.asBoolean(Object value, VerticaType type)

Coerce a value to a Boolean. May return null.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type, which is boolean.

Returns An appropriate Boolean value, or null.

Implemented in com.vertica.sdk.StandardTypeCoercion, com.vertica.sdk.NoopTypeCoercion, and com.vertica.sdk.NullTypeCoercion.

ByteBuffer com.vertica.sdk.TypeCoercion.asCharBytes(Object value, int length, VerticaType type)

Coerce a value to vertica-encoded string bytes. May return null, which is different than the empty string.

Note that the 'char' type should have trailing ASCII spaces removed. To implement this behavior, inspect the type parameter with VerticaType#isChar().

Parameters

  • value: The value to convert, which may be null.
  • length: The maximum length (in bytes) of the result.
  • type: The target Vertica type, which is some string-like type.

See Also

StringUtils::getStringBytes(String, int, boolean)

StringUtils::getStringBytes(String, int, boolean, boolean)

StringUtils::getCharset()

VerticaType::isChar()

Returns A ByteBuffer with no more than 'length' bytes between its position and limit.

Implemented in com.vertica.sdk.StandardTypeCoercion, com.vertica.sdk.NoopTypeCoercion, and com.vertica.sdk.NullTypeCoercion.

java.sql.Date com.vertica.sdk.TypeCoercion.asDate(Object value, VerticaType type)

Coerce a value to a Date. May return null.

Note that the java.sql.Date specification requires that the millisecond values wrapped by a java.sql.Date instance must be 'normalized' by setting the hours, minutes, seconds, and milliseconds to zero in the particular time zone with which the instance is associated.

However, that is not required by the Vertica SDK. This 'normalization' will take place later by internal components of the SDK.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type.

Returns An appropriate Timestamp value, or null.

Implemented in com.vertica.sdk.StandardTypeCoercion, com.vertica.sdk.NoopTypeCoercion, and com.vertica.sdk.NullTypeCoercion.

Double com.vertica.sdk.TypeCoercion.asDouble(Object value, VerticaType type)

Coerce a value to a Double. May return null.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type.

Returns An appropriate Double value, or null.

Implemented in com.vertica.sdk.StandardTypeCoercion, com.vertica.sdk.NoopTypeCoercion, and com.vertica.sdk.NullTypeCoercion.

Long com.vertica.sdk.TypeCoercion.asLong(Object value, VerticaType type)

Coerce a value to a Long. May return null.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type.

Returns An appropriate Long value, or null.

Implemented in com.vertica.sdk.StandardTypeCoercion, com.vertica.sdk.NoopTypeCoercion, and com.vertica.sdk.NullTypeCoercion.

java.sql.Timestamp com.vertica.sdk.TypeCoercion.asTimestamp(Object value, VerticaType type)

Coerce a value to a Timestamp. May return null. This is used for timestamp and timestamptz Vertica types.

The timestamp is assumed to represent a moment in the UTC timezone, which is how Vertica stores all timestamp and timestamptz values internally. Implementations should handle any translations related to timezones.

Vertica has microsecond precision for timestamp values. Any further precision on the returned value is ignored.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type.

Returns An appropriate Timestamp value, or null.

Implemented in com.vertica.sdk.StandardTypeCoercion, com.vertica.sdk.NoopTypeCoercion, and com.vertica.sdk.NullTypeCoercion.

Iterator com.vertica.sdk.TypeCoercion.getListIterator(Object value)

Get an iterator of values from some list-like aggregate value. This is only invoked for values which getMetaType(Object) has returned MetaType#LIST.

Parameters

  • value: A value that was previously identified as list-like type.

Returns An iterator over Objects. Not null.

Implemented in com.vertica.sdk.NoopTypeCoercion, and com.vertica.sdk.NullTypeCoercion.

Iterator > com.vertica.sdk.TypeCoercion.getMapIterator(Object value)

Get an iterator of values from some map-like aggregate value. This is only invoked for values which getMetaType(Object) has returned MetaType#MAP.

The elements must have only String keys. Otherwise a ClassCastException will be raised at a later time.

Parameters

  • value: A value that was previously identified as map-like type.

Returns An iterator over Map.Entry<String,Object>. Not null.

Implemented in com.vertica.sdk.NoopTypeCoercion, and com.vertica.sdk.NullTypeCoercion.

MetaType com.vertica.sdk.TypeCoercion.getMetaType(Object value)

Determine what genre of type the given value is. This is used when handling aggregate data structures which may include nesting of other aggregate or non-aggregate types.

The response indicates if the given value is a scalar, list, or map type. Alternatively, a response of SKIP indicates that the value should be ignored, as if it did not exist.

Parameters

  • value: The value of interest, which may be null.

Returns The type of the value.

See Also

MetaType

Implemented in com.vertica.sdk.NoopTypeCoercion, and com.vertica.sdk.NullTypeCoercion.

Set com.vertica.sdk.TypeCoercion.getPolicy()

Returns an unmodifiable version of the policy.

Returns The policy collection.

See Also

setPolicy

Implemented in com.vertica.sdk.NullTypeCoercion.

void com.vertica.sdk.TypeCoercion.setPolicy(Collection policy)

Sets the policies for this TypeCoercion instance. Policies generally dictate which scenarios generate exceptions and allow for different error handling choices without implementing a new TypeCoercion class.

Parameters

  • policy: The policy collection

See Also

TypeCoercionPolicy

getPolicy()

Implemented in com.vertica.sdk.NullTypeCoercion.

2.1.141 - com.vertica.sdk.TypeCoercion Member List

This is the complete list of members for com.vertica.sdk.TypeCoercion, including all inherited members.

asBinaryBytes(Object value, int length, VerticaType type) com.vertica.sdk.TypeCoercion
asBoolean(Object value, VerticaType type) com.vertica.sdk.TypeCoercion
asCharBytes(Object value, int length, VerticaType type) com.vertica.sdk.TypeCoercion
asDate(Object value, VerticaType type) com.vertica.sdk.TypeCoercion
asDouble(Object value, VerticaType type) com.vertica.sdk.TypeCoercion
asLong(Object value, VerticaType type) com.vertica.sdk.TypeCoercion
asTimestamp(Object value, VerticaType type) com.vertica.sdk.TypeCoercion
getListIterator(Object value) com.vertica.sdk.TypeCoercion
getMapIterator(Object value) com.vertica.sdk.TypeCoercion
getMetaType(Object value) com.vertica.sdk.TypeCoercion
getPolicy() com.vertica.sdk.TypeCoercion
setPolicy(Collection policy) com.vertica.sdk.TypeCoercion

2.1.142 - com.vertica.sdk.TypeCoercion.MetaType Enum Reference

Collaboration diagram for com.vertica.sdk.TypeCoercion.MetaType:

Public Attributes
LIST
SCALAR
SKIP

Detailed Description

The possible meta-types of any given value.

See Also

TypeCoercion::getMetaType(Object)

Member Data Documentation

com.vertica.sdk.TypeCoercion.MetaType.LIST

This value is a list of values.

Referenced by com.vertica.sdk.NoopTypeCoercion.getMetaType().

com.vertica.sdk.TypeCoercion.MetaType.SCALAR

This value is a scalar value.

Referenced by

com.vertica.sdk.TypeCoercion.MetaType.SKIP

Ignore the value, as if it did not exist.

2.1.143 - com.vertica.sdk.TypeCoercion.MetaType Member List

This is the complete list of members for com.vertica.sdk.TypeCoercion.MetaType, including all inherited members.

LIST com.vertica.sdk.TypeCoercion.MetaType
MAP enum value com.vertica.sdk.TypeCoercion.MetaType
SCALAR com.vertica.sdk.TypeCoercion.MetaType
SKIP com.vertica.sdk.TypeCoercion.MetaType

2.1.144 - com.vertica.sdk.TypeCoercionException Class Reference

Inheritance diagram for com.vertica.sdk.TypeCoercionException:

Collaboration diagram for com.vertica.sdk.TypeCoercionException:

Public Member Functions
TypeCoercionException ()
TypeCoercionException (Object value, VerticaType type, TypeCoercionPolicy policyViolated)
TypeCoercionPolicy getPolicy ()
VerticaType getType ()
Object getValue ()

Detailed Description

Indicates that a given object value could not be coerced to a particular VerticaType.

Constructor & Destructor Documentation

com.vertica.sdk.TypeCoercionException.TypeCoercionException()

A new empty exception.

com.vertica.sdk.TypeCoercionException.TypeCoercionException(Object value, VerticaType type, TypeCoercionPolicy policyViolated)

A TypeCoercion exception generated by attempting to coerce value to type, but failed due to policyViolated.

Parameters

  • value: The value being coerced.
  • type: The target Vertica type.
  • policyViolated: The policy that caused the error.

Member Function Documentation

TypeCoercionPolicy com.vertica.sdk.TypeCoercionException.getPolicy()

Get the policy which was violated

Returns The policy that caused the exception.

VerticaType com.vertica.sdk.TypeCoercionException.getType()

Get the VerticaType

Returns The target Vertica type.

Object com.vertica.sdk.TypeCoercionException.getValue()

Get the value that caused the exception.

Returns The value being coerced.

2.1.145 - com.vertica.sdk.TypeCoercionException Member List

This is the complete list of members for com.vertica.sdk.TypeCoercionException, including all inherited members.

getPolicy() com.vertica.sdk.TypeCoercionException
getType() com.vertica.sdk.TypeCoercionException
getValue() com.vertica.sdk.TypeCoercionException
TypeCoercionException() com.vertica.sdk.TypeCoercionException
TypeCoercionException(Object value, VerticaType type, TypeCoercionPolicy policyViolated) com.vertica.sdk.TypeCoercionException

2.1.146 - com.vertica.sdk.TypeCoercionPolicy Enum Reference

Collaboration diagram for com.vertica.sdk.TypeCoercionPolicy:

Public Member Functions
TypeCoercionPolicy (String errorReason)
String getErrorReason ()
Public Attributes
FAIL_INVALID_INPUT_TYPE
FAIL_INVALID_INPUT_VALUE
FAIL_SDK_UNSUPPORTED_TYPE
FAIL_UNSUPPORTED_TYPE
TRUNCATE_VALUES

Detailed Description

A collection of optional policy choices for TypeCoercion instances. These represent common choices that can be enabled or disabled for a given TypeCoercion instance.

Member Data Documentation

com.vertica.sdk.TypeCoercionPolicy.FAIL_INVALID_INPUT_TYPE

Initial value:

=(
"The input type cannot be coerced to the target type")

Consider invalid input types as failures.

Referenced by com.vertica.sdk.NoopTypeCoercion.getDefaultPolicy().

com.vertica.sdk.TypeCoercionPolicy.FAIL_INVALID_INPUT_VALUE

Initial value:

=(
"The input value cannot be coerced to the target type")

Consider invalid input values (of valid input type) as failures.

Referenced by com.vertica.sdk.NoopTypeCoercion.getDefaultPolicy().

com.vertica.sdk.TypeCoercionPolicy.FAIL_SDK_UNSUPPORTED_TYPE

Initial value:

=(
"The target type is unsupported by the Vertica Java SDK")

Consider target types that are unsupported by the Vertica Java SDK as failures.

Referenced by com.vertica.sdk.NoopTypeCoercion.getDefaultPolicy().

com.vertica.sdk.TypeCoercionPolicy.FAIL_UNSUPPORTED_TYPE

Initial value:

=(
"Unsupported target type")

Consider types that are unsupported by TypeCoercion as failures. See FAIL_SDK_UNSUPPORTED_TYPE for types not supported by the Vertica SDK.

Referenced by com.vertica.sdk.NoopTypeCoercion.getDefaultPolicy().

com.vertica.sdk.TypeCoercionPolicy.TRUNCATE_VALUES

Initial value:

=(
"The input value is too large for the target type")

Values that are too large for the target type should be truncated. Otherwise, they are treated as invalid input values and handled according to FAIL_INVALID_INPUT_VALUE.

2.1.147 - com.vertica.sdk.TypeCoercionPolicy Member List

This is the complete list of members for com.vertica.sdk.TypeCoercionPolicy, including all inherited members.

FAIL_INVALID_INPUT_TYPE com.vertica.sdk.TypeCoercionPolicy
FAIL_INVALID_INPUT_VALUE com.vertica.sdk.TypeCoercionPolicy
FAIL_SDK_UNSUPPORTED_TYPE com.vertica.sdk.TypeCoercionPolicy
FAIL_UNSUPPORTED_TYPE com.vertica.sdk.TypeCoercionPolicy
getErrorReason() (defined in com.vertica.sdk.TypeCoercionPolicy) com.vertica.sdk.TypeCoercionPolicy
TRUNCATE_VALUES com.vertica.sdk.TypeCoercionPolicy
TypeCoercionPolicy(String errorReason) (defined in com.vertica.sdk.TypeCoercionPolicy) com.vertica.sdk.TypeCoercionPolicy

2.1.148 - com.vertica.sdk.UdfException Class Reference

Inheritance diagram for com.vertica.sdk.UdfException:

Collaboration diagram for com.vertica.sdk.UdfException:

Public Member Functions
UdfException (int errorcode, Throwable causedBy)
UdfException (int errorcode, String message, Throwable causedBy)
UdfException (int errorcode, String message)
Public Attributes
int errorcode

Detailed Description

Contains error information, UDx code can throw object of this class to Vertica to indicate an error

Constructor & Destructor Documentation

com.vertica.sdk.UdfException.UdfException(int errorcode, Throwable causedBy)

Constructor

Parameters

  • errorcode: a numeric id that UDx can use to indicate the error.
  • causedBy: an uncaught Throwable that caused the UDF to fail
com.vertica.sdk.UdfException.UdfException(int errorcode, String message, Throwable causedBy)

Constructor

Parameters

  • errorcode: a numeric id that UDx can use to indicate the error.
  • message: a human readable error message
  • causedBy: an uncaught Throwable that caused the UDF to fail
com.vertica.sdk.UdfException.UdfException(int errorcode, String message)

Constructor

Parameters

  • errorcode: a numeric id that UDx can use to indicate the error.
  • message: a human readable error message.

2.1.149 - com.vertica.sdk.UdfException Member List

This is the complete list of members for com.vertica.sdk.UdfException, including all inherited members.

errorcode (defined in com.vertica.sdk.UdfException) com.vertica.sdk.UdfException
UdfException(int errorcode, Throwable causedBy) com.vertica.sdk.UdfException
UdfException(int errorcode, String message, Throwable causedBy) com.vertica.sdk.UdfException
UdfException(int errorcode, String message) com.vertica.sdk.UdfException

2.1.150 - com.vertica.sdk.UDFilter Class Reference

Inheritance diagram for com.vertica.sdk.UDFilter:

Collaboration diagram for com.vertica.sdk.UDFilter:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
void destroy (ServerInterface srvInterface) throws UdfException
void destroy (ServerInterface srvInterface, SessionParamWriterMap udSessionParams) throws UdfException
boolean isCanceled ()
abstract StreamState process (ServerInterface srvInterface, DataBuffer input, InputState input_state, DataBuffer output) throws UdfException
void setup (ServerInterface srvInterface) throws UdfException
Protected Member Functions
void cancel (ServerInterface srvInterface)

Detailed Description

Reads input data from a UDSource or another UDFilter and transforms it.

For example, a UDFilter might unzip a file, convert UTF-16 to UTF-8, or remove personally identifying information such as social security numbers. UDFilters can be chained, for example unzipping, converting encodings, and then stripping personal information. The first UDFilter in a chain receives its input from a UDSource, and the output of the last one in the chain is sent to a UDParser.

UDFilter is part of the load pipeline. The load pipeline consists of up to one UDSource, any number of UDFilters, and up to one UDParser.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
void com.vertica.sdk.UDFilter.destroy(ServerInterface srvInterface) throws UdfException

UDFilter::destroy()

Will be invoked during query execution, after the last time that process() is called on this UDFilter instance for a particular input file.

May write UD Session Parameters for namespaces public and library May optionally be overridden to perform tear-down/destruction.

See UDFilter::setup() for a note about the restartability of UDFilters.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Exceptions

  • UdfException: UDF problem
boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

abstract StreamState com.vertica.sdk.UDFilter.process(ServerInterface srvInterface, DataBuffer input, InputState input_state, DataBuffer output) throws UdfException

pure virtual UDFilter::process()

Will be invoked repeatedly during query execution, until it returns DONE or until the query is canceled by the user.

On each invocation, process() is handed some input data and a buffer to write output data into. It is expected to read and process some amount of the input data, write some amount of output data, and return a value that informs Vertica what needs to happen next.

process() must set input.offset to the number of bytes that were successfully read from the input buffer, and that will not need to be re-consumed by a subsequent invocation of process(). This may not be larger than input.size. (input.size is the size of the buffer.) If it is set to 0, this indicates that process() cannot process any part of an input buffer of this size, and requires more data per invocation. (For example, a block-based decompression algorithm might return 0 if the input buffer does not contain a complete block.)

Note that input may contain null bytes, if the source file contains null bytes. Note also that input is NOT automatically null-terminated.

If input_state == END_OF_FILE, then the last byte in input is the last byte in the input stream. Returning INPUT_NEEDED will not result in any new input appearing. process() should return DONE in this case as soon as this operator has finished producing all output that it is going to produce.

process() must set output.offset to the number of bytes that were written to the output buffer. This may not be larger than output.size. If it is set to 0, this indicates that process() requires a larger output buffer.

Note that, unless OUTPUT_NEEDED is returned, output will be UNMODIFIED the next time process() is called. This means that pointers into the buffer will continue to be valid. It also means that output.offset may be set. So, in general, process() code should assume that buffers start at output.buf[output.offset]. The same goes for input and INPUT_NEEDED. Note also that, as a performance optimization, upstream operators may start processing emitted data (data between output.buf[0] and output.buf[output.offset]) before OUTPUT_NEEDED is returned. For this reason, output.offset must be strictly increasing.

process() must not block indefinitely. If it cannot proceed for an extended period of time, it should return KEEP_GOING. It will be called again shortly. Failure to do this will, among other things, prevent the query from being canceled by the user.

Note that it is UNSAFE to maintain pointers or references to any of these arguments (or any other argument passed by reference into any other function in this API) beyond the scope of the function call in question. For example, do not store a reference to the server interface or the input block on an instance variable. Vertica may free and replace these objects.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • input: DataBuffer for input
  • input_state: InputState
  • output: DataBuffer for output

Returns OUTPUT_NEEDED if this UDFilter has more data to produce; INPUT_NEEDED if it needs more data to continue working; DONE if has no more data to produce.

Exceptions

  • UdfException: UDF problem
void com.vertica.sdk.UDFilter.setup(ServerInterface srvInterface) throws UdfException

UDFilter::setup()

Will be invoked during query execution, prior to the first time that process() is called on this UDFilter instance for a particular input file.

May optionally be overridden to perform setup/initialzation.

Note that UDFilters MUST BE RESTARTABLE! If loading large numbers of files, a given UDFilter may be re-used for multiple files. Vertica follows the worker-pool design pattern: At the start of COPY execution, several Parsers and several Filters are instantiated per node, by calling the corresponding prepare() method multiple times. Each Filter/Parser pair is then internally assigned to an initial Source (UDSource or internal). At that point, setup() is called; then process() is called until it is finished; then destroy() is called. If there are still sources in the pool waiting to be processed, then the UDFilter/UDSource pair will be given a second Source; setup() will be called a second time, then process() until it is finished, then destroy(). This repeats until all sources have been read.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Exceptions

  • UdfException: UDF problem

2.1.151 - com.vertica.sdk.UDFilter Member List

This is the complete list of members for com.vertica.sdk.UDFilter, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
destroy(ServerInterface srvInterface) com.vertica.sdk.UDFilter
destroy(ServerInterface srvInterface, SessionParamWriterMap udSessionParams) (defined in com.vertica.sdk.UDFilter) com.vertica.sdk.UDFilter
isCanceled() com.vertica.sdk.UDXObject
process(ServerInterface srvInterface, DataBuffer input, InputState input_state, DataBuffer output) com.vertica.sdk.UDFilter pure virtual
setup(ServerInterface srvInterface) com.vertica.sdk.UDFilter
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.152 - com.vertica.sdk.UDLFactory Class Reference

Inheritance diagram for com.vertica.sdk.UDLFactory:

Collaboration diagram for com.vertica.sdk.UDLFactory:

Public Member Functions
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)
abstract UDXType getUDXFactoryType ()
Protected Attributes
long libOid
String sqlName

Member Function Documentation

void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

inherited Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDLFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
void com.vertica.sdk.UDLFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

virtual

Provides the argument and return types of the UDL. UDL's take no input tuples; as such, their prototype is empty.

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.UDLFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)

virtual

Not used in this form

Implements com.vertica.sdk.UDXFactory.

abstract UDXType com.vertica.sdk.UDXFactory.getUDXFactoryType()

pure virtual inherited User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Returns the type of UDX Object instance this factory returns.

Implemented in com.vertica.sdk.ScalarFunctionFactory, com.vertica.sdk.IterativeSourceFactory, com.vertica.sdk.TransformFunctionFactory, com.vertica.sdk.AnalyticFunctionFactory, com.vertica.sdk.FilterFactory, com.vertica.sdk.MultiPhaseTransformFunctionFactory, and com.vertica.sdk.ParserFactory.

2.1.153 - com.vertica.sdk.UDLFactory Member List

This is the complete list of members for com.vertica.sdk.UDLFactory, including all inherited members.

getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) (defined in com.vertica.sdk.UDLFactory) com.vertica.sdk.UDLFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDLFactory
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.UDLFactory virtual
getUDXFactoryType() com.vertica.sdk.UDXFactory pure virtual
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected

2.1.154 - com.vertica.sdk.UDParser Class Reference

Inheritance diagram for com.vertica.sdk.UDParser:

Collaboration diagram for com.vertica.sdk.UDParser:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
void destroy (ServerInterface srvInterface, SizedColumnTypes returnType) throws UdfException
void destroy (ServerInterface srvInterface, SizedColumnTypes returnType, SessionParamWriterMap udSessionParams) throws UdfException
int getRecordsAcceptedInBatch ()
RejectedRecord getRejectedRecord () throws UdfException
boolean getSeenEOB ()
StreamWriter getStreamWriter ()
void increRecordsAcceptedInBatch ()
boolean isCanceled ()
abstract StreamState process (ServerInterface srvInterface, DataBuffer input, InputState input_state) throws UdfException, DestroyInvocation
void setRecordsAcceptedInBatch (int i)
void setSeenEOB (Boolean b)
void setStreamWriter (StreamWriter writer)
void setup (ServerInterface srvInterface, SizedColumnTypes returnType) throws UdfException
Protected Member Functions
void cancel (ServerInterface srvInterface)
Protected Attributes
int recordsAcceptedInBatch
boolean seen_eob
StreamWriter writer

Detailed Description

Parses an input stream into Vertica tuples (rows to be inserted into a table).

A UDParser can be used with up to one UDSource and any number of UDfilters.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
void com.vertica.sdk.UDParser.destroy(ServerInterface srvInterface, SizedColumnTypes returnType) throws UdfException

UDParser::destroy()

Will be invoked during query execution, after the last time that process() is called on this UDParser instance for a particular input file.

May write UD Session Parameters for namespaces public and library

May optionally be overridden to perform tear-down/destruction.

See UDParser::setup() for a note about the restartability of UDParsers.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • returnType: the type of the return

Exceptions

  • UdfException: UDF problem
RejectedRecord com.vertica.sdk.UDParser.getRejectedRecord() throws UdfException

Returns information about the rejected record

Returns a rejected record

Exceptions

  • UdfException: UDF problem
boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

abstract StreamState com.vertica.sdk.UDParser.process(ServerInterface srvInterface, DataBuffer input, InputState input_state) throws UdfException, DestroyInvocation

pure virtual UDParser::prepareToCooperate()

Notification to this parser that it should prepare to share parsing input with another. This can only happen when a parser has an associated chunker. Default implementation does nothing. UDParser::isReadyToCooperate()

Called after UDParser::prepareToCooperate(), returns false if this parser is not yet ready to cooperate. Once this method returns true the parser can begin to cooperate. Default implementation returns true, override if some preparation is required before the parser can cooperate (e.g. a certain # of rows must be skipped). UDParser::process()

Will be invoked repeatedly during query execution, until it returns DONE or until the query is canceled by the user.

On each invocation, process() will be given an input buffer. It should read data from that buffer, converting it to fields and tuples and writing those tuples via writer. Once it has consumed as much as it reasonably can (for example, once it has consumed the last complete row in the input buffer), it should return INPUT_NEEDED to indicate that more data is needed, or DONE to indicate that it has completed parsing this input stream and will not be reading more bytes from it.

If input_state == END_OF_FILE, then the last byte in input is the last byte in the input stream. Returning INPUT_NEEDED will not result in any new input appearing. process() should return DONE in this case as soon as this operator has finished producing all output that it is going to produce.

Note that input may contain null bytes, if the source file contains null bytes. Note also that input is NOT automatically null-terminated.

process() must not block indefinitely. If it cannot proceed for an extended period of time, it should return KEEP_GOING. It will be called again shortly. Failure to do this will, among other things, prevent the query from being canceled by the user.

Note that, unless INPUT_NEEDED is returned, input will be UNMODIFIED the next time process() is called. This means that pointers into the buffer will continue to be valid. It also means that input.offset may be set. So, in general, process() code should assume that buffers start at input.buf[input.offset].

Row Rejection

process() can "reject" a row, causing it to be logged by Vertica's rejected-rows mechanism. Rejected rows should not be emitted as tuples. A rejected row must start at the first byte of input (meaning all previous input must have been consumed by a previous call to process()). To reject a row, set input.offset to the size of the row, and return REJECT.

Returns INPUT_NEEDED if this UDParser has more data to produce; DONE if has no more data to produce; REJECT to reject a row

Note that it is UNSAFE to maintain pointers or references to any of these arguments (or any other argument passed by reference into any other function in this API) beyond the scope of the function call in question. For example, do not store a reference to the server interface or the input block on an instance variable. Vertica may free and replace these objects.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • input: input data buffer
  • input_state: input state

Exceptions

  • UdfException: UDF problem
  • DestroyInvocation: Invocation needed to be destroyed

Implemented in com.vertica.sdk.ContinuousUDParser.

void com.vertica.sdk.UDParser.setup(ServerInterface srvInterface, SizedColumnTypes returnType) throws UdfException

UDParser::setup()

Will be invoked during query execution, prior to the first time that process() is called on this UDParser instance for a particular input source.

May optionally be overridden to perform setup/initialization.

Note that UDParsers MUST BE RESTARTABLE! If loading large numbers of files, a given UDParsers may be re-used for multiple files. Vertica follows the worker-pool design pattern: At the start of COPY execution, several Parsers and several Filters are instantiated per node, by calling the corresponding prepare() method multiple times. Each Filter/Parser pair is then internally assigned to an initial Source (UDSource or internal). At that point, setup() is called; then process() is called until it is finished; then destroy() is called. If there are still sources in the pool waiting to be processed, then the UDFilter/UDSource pair will be given a second Source; setup() will be called a second time, then process() until it is finished, then destroy(). This repeats until all sources have been read.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • returnType: type of the return value

Exceptions

  • UdfException: UDF problem

Member Data Documentation

StreamWriter com.vertica.sdk.UDParser.writer

protected

Writer to write parsed tuples to. Has the same API as PartitionWriter, from the UDT framework.

2.1.155 - com.vertica.sdk.UDParser Member List

This is the complete list of members for com.vertica.sdk.UDParser, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
destroy(ServerInterface srvInterface, SizedColumnTypes returnType) com.vertica.sdk.UDParser
destroy(ServerInterface srvInterface, SizedColumnTypes returnType, SessionParamWriterMap udSessionParams) (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
getRecordsAcceptedInBatch() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
getRejectedRecord() com.vertica.sdk.UDParser
getSeenEOB() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
getStreamWriter() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
increRecordsAcceptedInBatch() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
isCanceled() com.vertica.sdk.UDXObject
process(ServerInterface srvInterface, DataBuffer input, InputState input_state) com.vertica.sdk.UDParser pure virtual
recordsAcceptedInBatch (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser protected
seen_eob (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser protected
setRecordsAcceptedInBatch(int i) (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
setSeenEOB(Boolean b) (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
setStreamWriter(StreamWriter writer) (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
setup(ServerInterface srvInterface, SizedColumnTypes returnType) com.vertica.sdk.UDParser
UDParser() (defined in com.vertica.sdk.UDParser) com.vertica.sdk.UDParser
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject
writer com.vertica.sdk.UDParser protected

2.1.156 - com.vertica.sdk.UDSource Class Reference

Inheritance diagram for com.vertica.sdk.UDSource:

Collaboration diagram for com.vertica.sdk.UDSource:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
void destroy (ServerInterface srvInterface) throws UdfException
void destroy (ServerInterface srvInterface, SessionParamWriterMap udSessionParams) throws UdfException
Portion getPortion ()
Integer getSize ()
String getUri ()
boolean isCanceled ()
abstract StreamState process (ServerInterface srvInterface, DataBuffer output) throws UdfException
void setup (ServerInterface srvInterface) throws UdfException
Protected Member Functions
void cancel (ServerInterface srvInterface)

Detailed Description

Acquires data from an external source (such as a file or URL) and produces that data in a streaming manner.

The output of a UDSource can be sent through one or more UDFilters followed by one UDParser.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
void com.vertica.sdk.UDSource.destroy(ServerInterface srvInterface) throws UdfException

UDSource::destroy()

Will be invoked during query execution, after the last time that process() is called on this UDSource instance.

May write UD Session Parameters for namespaces public and library

May optionally be overridden to perform tear-down/destruction.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Exceptions

  • UdfException: UDF problem
Portion com.vertica.sdk.UDSource.getPortion()

UDSource::getPortion()

Returns Portion information associated with this source, if available

Integer com.vertica.sdk.UDSource.getSize()

UDSource::getSize()

Returns the estimated number of bytes that process() will return.

This value is treated as advisory only. It is used to indicate the file size in the LOAD_STREAMS table.

IMPORTANT: getSize() can be called at any time, even before setup() is called! (Though not before or during the constructor.)

In the case of Sources whose factories can potentially produce many UDSource instances, getSize() should avoid acquiring resources that last for the life of the object. Doing otherwise can defeat Vertica's attempts to limit the maximum number of Sources that are consuming system resources at any given time. For example, if it opens a file handle and leaves that file handle open for use by process(), and if a large number of UDSources are loaded in a single statement, the query may exceed the operating system limit on file handles and crash, even though Vertica only operates on a small number of files at once. This doesn't apply to singleton Sources, Sources whose factory will only ever produce one UDSource instance.

Returns the size

String com.vertica.sdk.UnsizedUDSource.getUri()

inherited UnsizedUDSource::getUri()

This function will be invoked during execution to fill in monitoring information.

Returns the URI of the current source of data.

boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

abstract StreamState com.vertica.sdk.UDSource.process(ServerInterface srvInterface, DataBuffer output) throws UdfException

pure virtual UDSource::process()

Will be invoked repeatedly during query execution, until it returns DONE or until the query is canceled by the user.

On each invocation, process() should acquire more data and write that data to the buffer specified by output.

process() must set output.offset to the number of bytes that were written to the output buffer. It is common, though not necessary, for this to be the same as output.size. output.offset is initially uninitialized. If it is set to 0, this indicates that the output buffer is too small for process() to be able to write a unit of input to it.

Note that, unless OUTPUT_NEEDED is returned, output will be UNMODIFIED the next time process() is called. This means that pointers into the buffer will continue to be valid. It also means that output.offset may be set. So, in general, process() code should assume that buffers start at output.buf[output.offset]. Note also that, as a performance optimization, upstream operators may start processing emitted data (data between output.buf[0] and output.buf[output.offset]) before OUTPUT_NEEDED is returned. For this reason, output.offset must be strictly increasing.

process() must not block indefinitely. If it cannot proceed for an extended period of time, it should return KEEP_GOING. It will be called again shortly. Failure to do this will, among other things, prevent the query from being canceled by the user.

Note that it is UNSAFE to maintain pointers or references to any of these arguments (or any other argument passed by reference into any other function in this API) beyond the scope of the function call in question. For example, do not store a reference to the server interface or the input block on an instance variable. Vertica may free and replace these objects.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Returns OUTPUT_NEEDED if this UDSource has more data to produce; DONE if has no more data to produce.

Exceptions

  • UdfException: UDF problem

Implements com.vertica.sdk.UnsizedUDSource.

void com.vertica.sdk.UDSource.setup(ServerInterface srvInterface) throws UdfException

UDSource::setup()

Will be invoked during query execution, prior to the first time that process() is called on this UDSource instance.

May optionally be overridden to perform setup/initialization.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Exceptions

  • UdfException: UDF problem

2.1.157 - com.vertica.sdk.UDSource Member List

This is the complete list of members for com.vertica.sdk.UDSource, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
destroy(ServerInterface srvInterface) com.vertica.sdk.UDSource
destroy(ServerInterface srvInterface, SessionParamWriterMap udSessionParams) (defined in com.vertica.sdk.UDSource) com.vertica.sdk.UDSource
getPortion() com.vertica.sdk.UDSource
getSize() com.vertica.sdk.UDSource
getUri() com.vertica.sdk.UnsizedUDSource
isCanceled() com.vertica.sdk.UDXObject
process(ServerInterface srvInterface, DataBuffer output) com.vertica.sdk.UDSource pure virtual
setup(ServerInterface srvInterface) com.vertica.sdk.UDSource
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.158 - com.vertica.sdk.UDXFactory Class Reference

Inheritance diagram for com.vertica.sdk.UDXFactory:

Collaboration diagram for com.vertica.sdk.UDXFactory:

Classes
enum UDXType
Public Member Functions
void getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)
void getPerInstanceResources (ServerInterface srvInterface, VResources res)
void getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)
abstract void getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)
abstract void getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException
abstract UDXType getUDXFactoryType ()
Protected Attributes
long libOid
String sqlName

Detailed Description

Parent class for UDx factories; not intended for direct use by applications.

Member Function Documentation

void com.vertica.sdk.UDXFactory.getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes)

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • parameterTypes: SizedColumnTypes describing the parameters
void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res)

Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX

Referenced by com.vertica.sdk.UDXFactory.getPerInstanceResources().

void com.vertica.sdk.UDXFactory.getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

Set the resource required for each instance of the UDX Object subclass

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • res: a VResources object used to tell Vertica what resources are needed by the UDX
  • argTypes: Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.
abstract void com.vertica.sdk.UDXFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

pure virtual Provides the argument and return types of the UDX

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments
  • returnType: the type(s) of the return

Implemented in com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.

Referenced by com.vertica.sdk.ScalarFunctionFactory.getReturnType().

abstract void com.vertica.sdk.UDXFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException

pure virtual Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
  • returnType: User code must fill in the names and data types returned by the UDT.

Implemented in com.vertica.sdk.ScalarFunctionFactory, com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.

abstract UDXType com.vertica.sdk.UDXFactory.getUDXFactoryType()

pure virtual User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Returns the type of UDX Object instance this factory returns.

Implemented in com.vertica.sdk.ScalarFunctionFactory, com.vertica.sdk.IterativeSourceFactory, com.vertica.sdk.TransformFunctionFactory, com.vertica.sdk.AnalyticFunctionFactory, com.vertica.sdk.FilterFactory, com.vertica.sdk.MultiPhaseTransformFunctionFactory, and com.vertica.sdk.ParserFactory.

2.1.159 - com.vertica.sdk.UDXFactory Member List

This is the complete list of members for com.vertica.sdk.UDXFactory, including all inherited members.

getParameterType(ServerInterface srvInterface, SizedColumnTypes parameterTypes) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res) com.vertica.sdk.UDXFactory
getPerInstanceResources(ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes) com.vertica.sdk.UDXFactory
getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType) com.vertica.sdk.UDXFactory pure virtual
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) com.vertica.sdk.UDXFactory pure virtual
getUDXFactoryType() com.vertica.sdk.UDXFactory pure virtual
libOid (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected
sqlName (defined in com.vertica.sdk.UDXFactory) com.vertica.sdk.UDXFactory protected

2.1.160 - com.vertica.sdk.UDXFactory.UDXType Enum Reference

Collaboration diagram for com.vertica.sdk.UDXFactory.UDXType:

Public Member Functions
int getCode ()
Public Attributes
AGGREGATE =(5)
ANALYTIC =(3)
LOAD_FILTER =(7)
LOAD_PARSER =(8)
LOAD_SOURCE =(6)
MULTI_TRANSFORM =(4)
SCALAR =(1)
TRANSFORM =(2)

Detailed Description

The type of UDX instance this factory produces

2.1.161 - com.vertica.sdk.UDXFactory.UDXType Member List

This is the complete list of members for com.vertica.sdk.UDXFactory.UDXType, including all inherited members.

AGGREGATE (defined in com.vertica.sdk.UDXFactory.UDXType) com.vertica.sdk.UDXFactory.UDXType
ANALYTIC (defined in com.vertica.sdk.UDXFactory.UDXType) com.vertica.sdk.UDXFactory.UDXType
getCode() (defined in com.vertica.sdk.UDXFactory.UDXType) com.vertica.sdk.UDXFactory.UDXType
LOAD_FILTER (defined in com.vertica.sdk.UDXFactory.UDXType) com.vertica.sdk.UDXFactory.UDXType
LOAD_PARSER (defined in com.vertica.sdk.UDXFactory.UDXType) com.vertica.sdk.UDXFactory.UDXType
LOAD_SOURCE (defined in com.vertica.sdk.UDXFactory.UDXType) com.vertica.sdk.UDXFactory.UDXType
MULTI_TRANSFORM (defined in com.vertica.sdk.UDXFactory.UDXType) com.vertica.sdk.UDXFactory.UDXType
SCALAR (defined in com.vertica.sdk.UDXFactory.UDXType) com.vertica.sdk.UDXFactory.UDXType
TRANSFORM (defined in com.vertica.sdk.UDXFactory.UDXType) com.vertica.sdk.UDXFactory.UDXType

2.1.162 - com.vertica.sdk.UDXFunction Class Reference

Inheritance diagram for com.vertica.sdk.UDXFunction:

Collaboration diagram for com.vertica.sdk.UDXFunction:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes)
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)
boolean isCanceled ()
void setup (ServerInterface srvInterface, SizedColumnTypes argTypes)
Protected Member Functions
void cancel (ServerInterface srvInterface)

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
void com.vertica.sdk.UDXFunction.destroy(ServerInterface srvInterface, SizedColumnTypes argTypes)

Perform per instance destruction. This function may throw errors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)

Referenced by com.vertica.sdk.UDXFunction.destroy().

void com.vertica.sdk.UDXFunction.destroy(ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)

Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)
  • udSessionParams: a SessionParamWriterMap
boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

void com.vertica.sdk.UDXFunction.setup(ServerInterface srvInterface, SizedColumnTypes argTypes)

Perform per instance initialization. This function may throw errors.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
  • argTypes: the types of the arguments (as SizedColumnTypes)

2.1.163 - com.vertica.sdk.UDXFunction Member List

This is the complete list of members for com.vertica.sdk.UDXFunction, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
destroy(ServerInterface srvInterface, SizedColumnTypes argTypes) com.vertica.sdk.UDXFunction
destroy(ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams) com.vertica.sdk.UDXFunction
isCanceled() com.vertica.sdk.UDXObject
setup(ServerInterface srvInterface, SizedColumnTypes argTypes) com.vertica.sdk.UDXFunction
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.164 - com.vertica.sdk.UDXLibrary Class Reference

Collaboration diagram for com.vertica.sdk.UDXLibrary:

Public Member Functions
String getAuthor ()
String getDescription ()
String getLibraryBuildTag ()
String getLibrarySDKVersion ()
String getLibraryVersion ()
String getLicensesRequired ()
String getSignature ()
String getSourceUrl ()

Detailed Description

MetaData interface for Vertica User Defined extension libraries

2.1.165 - com.vertica.sdk.UDXLibrary Member List

This is the complete list of members for com.vertica.sdk.UDXLibrary, including all inherited members.

getAuthor() (defined in com.vertica.sdk.UDXLibrary) com.vertica.sdk.UDXLibrary
getDescription() (defined in com.vertica.sdk.UDXLibrary) com.vertica.sdk.UDXLibrary
getLibraryBuildTag() (defined in com.vertica.sdk.UDXLibrary) com.vertica.sdk.UDXLibrary
getLibrarySDKVersion() (defined in com.vertica.sdk.UDXLibrary) com.vertica.sdk.UDXLibrary
getLibraryVersion() (defined in com.vertica.sdk.UDXLibrary) com.vertica.sdk.UDXLibrary
getLicensesRequired() (defined in com.vertica.sdk.UDXLibrary) com.vertica.sdk.UDXLibrary
getSignature() (defined in com.vertica.sdk.UDXLibrary) com.vertica.sdk.UDXLibrary
getSourceUrl() (defined in com.vertica.sdk.UDXLibrary) com.vertica.sdk.UDXLibrary

2.1.166 - com.vertica.sdk.UDXObject Class Reference

Inheritance diagram for com.vertica.sdk.UDXObject:

Collaboration diagram for com.vertica.sdk.UDXObject:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
boolean isCanceled ()
Protected Member Functions
void cancel (ServerInterface srvInterface)

Detailed Description

Base class for Vertica User-Defined extensions (the function classes themselves). Not intended for direct use by applications.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected

Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
boolean com.vertica.sdk.UDXObject.isCanceled()

Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

2.1.167 - com.vertica.sdk.UDXObject Member List

This is the complete list of members for com.vertica.sdk.UDXObject, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
isCanceled() com.vertica.sdk.UDXObject
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.168 - com.vertica.sdk.UnsizedUDSource Class Reference

Inheritance diagram for com.vertica.sdk.UnsizedUDSource:

Collaboration diagram for com.vertica.sdk.UnsizedUDSource:

Public Member Functions
final void cancelUDX (ServerInterface srvInterface)
void destroy (ServerInterface srvInterface) throws UdfException
void destroy (ServerInterface srvInterface, SessionParamWriterMap udSessionParams) throws UdfException
String getUri ()
boolean isCanceled ()
abstract StreamState process (ServerInterface srvInterface, DataBuffer output) throws UdfException
void setup (ServerInterface srvInterface) throws UdfException
Protected Member Functions
void cancel (ServerInterface srvInterface)

Detailed Description

UnsizedUDSource

Base class for UDSource. Used 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.

Not intended or optimized for typical applications.

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel(ServerInterface srvInterface)

protected inherited Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.

  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.

  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX(ServerInterface srvInterface)

inherited Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

  • srvInterface: a ServerInterface object used to communicate with Vertica
String com.vertica.sdk.UnsizedUDSource.getUri()

UnsizedUDSource::getUri()

This function will be invoked during execution to fill in monitoring information.

Returns the URI of the current source of data.

boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

2.1.169 - com.vertica.sdk.UnsizedUDSource Member List

This is the complete list of members for com.vertica.sdk.UnsizedUDSource, including all inherited members.

cancel(ServerInterface srvInterface) com.vertica.sdk.UDXObject protected
cancelUDX(ServerInterface srvInterface) com.vertica.sdk.UDXObject
destroy(ServerInterface srvInterface) (defined in com.vertica.sdk.UnsizedUDSource) com.vertica.sdk.UnsizedUDSource
destroy(ServerInterface srvInterface, SessionParamWriterMap udSessionParams) (defined in com.vertica.sdk.UnsizedUDSource) com.vertica.sdk.UnsizedUDSource
getUri() com.vertica.sdk.UnsizedUDSource
isCanceled() com.vertica.sdk.UDXObject
process(ServerInterface srvInterface, DataBuffer output) (defined in com.vertica.sdk.UnsizedUDSource) com.vertica.sdk.UnsizedUDSource pure virtual
setup(ServerInterface srvInterface) (defined in com.vertica.sdk.UnsizedUDSource) com.vertica.sdk.UnsizedUDSource
UDXObject() (defined in com.vertica.sdk.UDXObject) com.vertica.sdk.UDXObject

2.1.170 - com.vertica.sdk.VerticaBlock Class Reference

Inheritance diagram for com.vertica.sdk.VerticaBlock:

Collaboration diagram for com.vertica.sdk.VerticaBlock:

Public Member Functions
VerticaBlock (int _ncols, int _rowcount)
void addCol (ByteBuffer arg, int colstride, VerticaType dt, String colName)
void addCol (ByteBuffer arg, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)
void addCol (ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)
boolean checkStringUserBlockInfo (int idx)
boolean checkTimeUserBlockInfo (int idx)
ByteBuffer getColDataAreaRef (int idx)
ByteBuffer getColRef (int idx)
int getNumCols ()
int getNumRows ()
BaseDataOID getProcessBlockUserInfoVectorAt (int i)
SizedColumnTypes getTypeMetaData ()
void resetBuffers ()
Public Attributes
int count
int index
int ncols
int nrows
SizedColumnTypes typeMetaData
Protected Member Functions
void clear ()
ByteBuffer getInlineColBuffer (int idx)
Protected Attributes
ArrayList coldataareas
ArrayList cols
ArrayList colstrides
ArrayList currentPos

Detailed Description

Represents an in-memory block of tuples

Member Function Documentation

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName)

Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column

Referenced by com.vertica.sdk.VerticaBlock.addCol().

void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, int colstride, VerticaType dt)

Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt)

Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
void com.vertica.sdk.VerticaBlock.addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName)

Add the location for reading a particular argument.

Parameters

  • arg: The base location to find data.
  • da: The location to find out of band string data.
  • colstride: The stride between data instances.
  • dt: The type of input.
  • colName: Name of the column
ByteBuffer com.vertica.sdk.VerticaBlock.getColDataAreaRef(int idx)

Get the ByteBuffer that stores out of line string data (Data Area) for the idx'th argument

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer

Referenced by com.vertica.sdk.BlockReader.getVString().

ByteBuffer com.vertica.sdk.VerticaBlock.getColRef(int idx)

Example

ByteBuffer a = arg_reader.getColPtr(0);

Parameters

  • idx: The column number to retrieve from the input row.

Returns a ByteBuffer to the idx'th argument, containing data for the column

Referenced by

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

protected

Give a ByteBuffer for the given column (inline storage only). Returns a buffer with position and limit bounding the data area for a single element of that column, given the current position in the column.

Parameters

  • idx: The column number to retrieve from the input row.

Returns the ByteBuffer for the column

Referenced by

int com.vertica.sdk.VerticaBlock.getNumCols()

Returns the number of arguments held by this reader.

int com.vertica.sdk.VerticaBlock.getNumRows()

Returns the number of rows held by this block.

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

Returns information about the types and numbers of arguments

Referenced by

2.1.171 - com.vertica.sdk.VerticaBlock Member List

This is the complete list of members for com.vertica.sdk.VerticaBlock, including all inherited members.

addCol(ByteBuffer arg, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt) com.vertica.sdk.VerticaBlock
addCol(ByteBuffer arg, ByteBuffer da, int colstride, VerticaType dt, String colName) com.vertica.sdk.VerticaBlock
checkStringUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
checkTimeUserBlockInfo(int idx) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
clear() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
coldataareas (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
cols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
colstrides (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
count (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
currentPos (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock protected
getColDataAreaRef(int idx) com.vertica.sdk.VerticaBlock
getColRef(int idx) com.vertica.sdk.VerticaBlock
getInlineColBuffer(int idx) com.vertica.sdk.VerticaBlock protected
getNumCols() com.vertica.sdk.VerticaBlock
getNumRows() com.vertica.sdk.VerticaBlock
getProcessBlockUserInfoVectorAt(int i) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
getTypeMetaData() com.vertica.sdk.VerticaBlock
index (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
ncols (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
nrows (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
resetBuffers() (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
typeMetaData (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock
VerticaBlock(int _ncols, int _rowcount) (defined in com.vertica.sdk.VerticaBlock) com.vertica.sdk.VerticaBlock

2.1.172 - com.vertica.sdk.VerticaType Class Reference

Collaboration diagram for com.vertica.sdk.VerticaType:

Public Member Functions
int getIntervalPrecision ()
For INTERVAL data types, returns the precision.
int getIntervalRange ()
For INTERVAL data types, returns the range.
int getMaxSize ()
int getNumericFractional ()
int getNumericIntegral ()
int getNumericLength ()
For NUMERIC data types, returns the number of bytes required to store an element. Calling this with a non-numeric data type can cause a crash.
int getNumericPrecision ()
int getNumericScale ()
int getNumericWordCount ()
String getPrettyPrintStr ()
int getStringLength ()
For VARCHAR/CHAR/VARBINARY/BINARY data types, returns the length of the string.
int getTimestampPrecision ()
For TIMESTAMP data types, returns the precision.
boolean isBinary ()
boolean isBool ()
boolean isChar ()
boolean isDate ()
boolean isFloat ()
boolean isInt ()
boolean isLongVarbinary ()
boolean isLongVarchar ()
boolean isNumeric ()
boolean isStringType ()
Return true for VARCHAR/CHAR/VARBINARY/BINARY data types.
boolean isTimestamp ()
boolean isVarbinary ()
boolean isVarchar ()
void setIntervalPrecision (int precision)
For INTERVAL data types, sets the precision.
void setIntervalRange (int range)
For INTERVAL data types, sets the range.
void setNumericPrecision (int precision)
For NUMERIC data types, sets the precision.
void setNumericScale (int scale)
For NUMERIC data types, sets the scale.
void setTimestampPrecision (int precision)
For TIMESTAMP data types, sets the precision.
String toString ()

Detailed Description

Represents types of data that are passed into and returned back from user's code

Member Function Documentation

int com.vertica.sdk.VerticaType.getMaxSize()

Returns The maximum size, in bytes, of a data element of this type.

boolean com.vertica.sdk.VerticaType.isBinary()

Returns true if this type is BINARY, false otherwise.

boolean com.vertica.sdk.VerticaType.isBool()

Returns true if this type is BOOLEAN, false otherwise.

boolean com.vertica.sdk.VerticaType.isChar()

Returns true if this type is CHAR, false otherwise.

Referenced by com.vertica.sdk.NoopTypeCoercion.asCharBytes().

boolean com.vertica.sdk.VerticaType.isDate()

Returns true if this type is DATE, false otherwise.

boolean com.vertica.sdk.VerticaType.isFloat()

Returns true if this type is FLOAT, false otherwise.

boolean com.vertica.sdk.VerticaType.isInt()

Returns true if this type is INTEGER, false otherwise.

boolean com.vertica.sdk.VerticaType.isLongVarbinary()

Returns true if this type is LONGVARBINARY, false otherwise.

boolean com.vertica.sdk.VerticaType.isLongVarchar()

Returns true if this type is LONGVARCHAR, false otherwise.

boolean com.vertica.sdk.VerticaType.isNumeric()

Returns true if this type is NUMERIC, false otherwise.

boolean com.vertica.sdk.VerticaType.isTimestamp()

Returns true if this type is TIMESTAMP, false otherwise.

boolean com.vertica.sdk.VerticaType.isVarbinary()

Returns true if this type is VARBINARY, false otherwise.

boolean com.vertica.sdk.VerticaType.isVarchar()

Returns true if this type is VARCHAR, false otherwise.

2.1.173 - com.vertica.sdk.VerticaType Member List

This is the complete list of members for com.vertica.sdk.VerticaType, including all inherited members.

getIntervalPrecision() com.vertica.sdk.VerticaType
getIntervalRange() com.vertica.sdk.VerticaType
getMaxSize() com.vertica.sdk.VerticaType
getNumericFractional() (defined in com.vertica.sdk.VerticaType) com.vertica.sdk.VerticaType
getNumericIntegral() (defined in com.vertica.sdk.VerticaType) com.vertica.sdk.VerticaType
getNumericLength() com.vertica.sdk.VerticaType
getNumericPrecision() (defined in com.vertica.sdk.VerticaType) com.vertica.sdk.VerticaType
getNumericScale() (defined in com.vertica.sdk.VerticaType) com.vertica.sdk.VerticaType
getNumericWordCount() (defined in com.vertica.sdk.VerticaType) com.vertica.sdk.VerticaType
getPrettyPrintStr() (defined in com.vertica.sdk.VerticaType) com.vertica.sdk.VerticaType
getStringLength() com.vertica.sdk.VerticaType
getTimestampPrecision() com.vertica.sdk.VerticaType
isBinary() com.vertica.sdk.VerticaType
isBool() com.vertica.sdk.VerticaType
isChar() com.vertica.sdk.VerticaType
isDate() com.vertica.sdk.VerticaType
isFloat() com.vertica.sdk.VerticaType
isInt() com.vertica.sdk.VerticaType
isLongVarbinary() com.vertica.sdk.VerticaType
isLongVarchar() com.vertica.sdk.VerticaType
isNumeric() com.vertica.sdk.VerticaType
isStringType() com.vertica.sdk.VerticaType
isTimestamp() com.vertica.sdk.VerticaType
isVarbinary() com.vertica.sdk.VerticaType
isVarchar() com.vertica.sdk.VerticaType
setIntervalPrecision(int precision) com.vertica.sdk.VerticaType
setIntervalRange(int range) com.vertica.sdk.VerticaType
setNumericPrecision(int precision) com.vertica.sdk.VerticaType
setNumericScale(int scale) com.vertica.sdk.VerticaType
setTimestampPrecision(int precision) com.vertica.sdk.VerticaType
toString() (defined in com.vertica.sdk.VerticaType) com.vertica.sdk.VerticaType

2.1.174 - com.vertica.sdk.vmap.InvalidMapKeyException Class Reference

Inheritance diagram for com.vertica.sdk.vmap.InvalidMapKeyException:

Collaboration diagram for com.vertica.sdk.vmap.InvalidMapKeyException:

Public Member Functions
InvalidMapKeyException (String msg, String key)
String getKey ()

Detailed Description

An Exception that is thrown when an invalid key is found when attempting to encode a vmap, Vertica's aggregate type that powers Flex tables.

Constructor & Destructor Documentation

com.vertica.sdk.vmap.InvalidMapKeyException.InvalidMapKeyException(String msg, String key)

Create an exception caused by an invalid key, with associated message (reason).

Parameters

  • msg: The reason for the exception, or more details on its cause.
  • key: The key that is invalid.

Member Function Documentation

String com.vertica.sdk.vmap.InvalidMapKeyException.getKey()

Get the key value that caused the exception (i.e. is invalid).

Returns The invalid key

2.1.175 - com.vertica.sdk.vmap.InvalidMapKeyException Member List

This is the complete list of members for com.vertica.sdk.vmap.InvalidMapKeyException, including all inherited members.

getKey() com.vertica.sdk.vmap.InvalidMapKeyException
InvalidMapKeyException(String msg, String key) com.vertica.sdk.vmap.InvalidMapKeyException
VMapEncodingException(String why) (defined in com.vertica.sdk.vmap.VMapEncodingException) com.vertica.sdk.vmap.VMapEncodingException
VMapEncodingException(String why, Throwable causedBy) (defined in com.vertica.sdk.vmap.VMapEncodingException) com.vertica.sdk.vmap.VMapEncodingException

2.1.176 - com.vertica.sdk.vmap.v1.Encoder Class Reference

Inheritance diagram for com.vertica.sdk.vmap.v1.Encoder:

Collaboration diagram for com.vertica.sdk.vmap.v1.Encoder:

Classes
class MatchingKeySelector
Public Member Functions
Encoder (TypeCoercion coercion)
int byteSize ()
void consume (Map data)
void consume (Iterator> data)
void consume (Iterator> data, int sizeEstimate)
ByteBuffer encode ()
void encode (ByteBuffer buffer)
String keyForIdent (String ident)

Detailed Description

An encoder able to generate a VMap, Vertica's aggregate data type.

To use, call consume followed by encode().

Constructor & Destructor Documentation

com.vertica.sdk.vmap.v1.Encoder.Encoder(TypeCoercion coercion)

Create an Encoder instance.

Parameters

  • coercion: A TypeCoercion instance used to provide guidance on serializing input data before encoding it into a VMap.

Member Function Documentation

int com.vertica.sdk.vmap.v1.Encoder.byteSize()

Returns the output length of the encoded VMap. Available only after consume.

Returns The byte size of the output vmap.

Referenced by com.vertica.sdk.vmap.v1.Encoder.encode().

void com.vertica.sdk.vmap.v1.Encoder.consume(Map data)

Execute the consume phase of encoding.

Parameters

  • data: A map of data specified with String keys.

Referenced by com.vertica.sdk.vmap.v1.Encoder.consume().

void com.vertica.sdk.vmap.v1.Encoder.consume(Iterator> data)

Execute the consume phase of encoding with a default guess at the number of data elements.

Parameters

  • data: An iterator over a map-like object which has all String keys.
void com.vertica.sdk.vmap.v1.Encoder.consume(Iterator> data, int sizeEstimate)

Execute the consume phase of encoding.

Parameters

  • data: An iterator over a map-like object which has all String keys.
  • sizeEstimate: A guess at the number of elements found in data. Iterators do not provide a means of querying size.
ByteBuffer com.vertica.sdk.vmap.v1.Encoder.encode()

Get the encoded VMap as a new ByteBuffer.

Returns A ByteBuffer with the VMap representation from 0 to limit.

void com.vertica.sdk.vmap.v1.Encoder.encode(ByteBuffer buffer)

Write the VMap into a ByteBuffer and return the number of bytes written. The buffer's position will be advanced to the end of the VMap.

Parameters

  • buffer: The target buffer, which must have at least byteSize() remaining, or a BufferOverflowException will result.
String com.vertica.sdk.vmap.v1.Encoder.keyForIdent(String ident)

Returns the key name of the first key that matches ident according to identifier comparison. Requires that data already be consumed.

See Also #consume(Map)

Implements com.vertica.sdk.vmap.v1.KeySelector.

2.1.177 - com.vertica.sdk.vmap.v1.Encoder Member List

This is the complete list of members for com.vertica.sdk.vmap.v1.Encoder, including all inherited members.

byteSize() com.vertica.sdk.vmap.v1.Encoder
consume(Map data) com.vertica.sdk.vmap.v1.Encoder
consume(Iterator> data) com.vertica.sdk.vmap.v1.Encoder
consume(Iterator> data, int sizeEstimate) com.vertica.sdk.vmap.v1.Encoder
encode() com.vertica.sdk.vmap.v1.Encoder
encode(ByteBuffer buffer) com.vertica.sdk.vmap.v1.Encoder
Encoder(TypeCoercion coercion) com.vertica.sdk.vmap.v1.Encoder
keyForIdent(String ident) com.vertica.sdk.vmap.v1.Encoder

2.1.178 - com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector Class Reference

Inheritance diagram for com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector:

Collaboration diagram for com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector:

Public Member Functions
MatchingKeySelector ()
void consume (Map data)
String keyForIdent (String ident)

Detailed Description

A class that mimics the exact behavior of Encoder#keyForIdent(String) without having to pay the full performance cost of Encoder#consume(Map).

Constructor & Destructor Documentation

com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector.MatchingKeySelector()

Create a MatchingKeySelector instance.

Member Function Documentation

void com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector.consume(Map data)

Consumes a map of data, looking only at the keys. This is necessary before calling keyForIdent(String).

Parameters

  • data: A map of data specified with String keys.
String com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector.keyForIdent(String ident)

Returns the key name of the first key that matches ident according to identifier comparison. Requires that data already be consumed.

See Also #consume(Map)

Implements com.vertica.sdk.vmap.v1.KeySelector.

2.1.179 - com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector Member List

This is the complete list of members for com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector, including all inherited members.

consume(Map data) com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector
keyForIdent(String ident) com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector
MatchingKeySelector() com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector

2.1.180 - com.vertica.sdk.vmap.v1.KeySelector Interface Reference

Inheritance diagram for com.vertica.sdk.vmap.v1.KeySelector:

Collaboration diagram for com.vertica.sdk.vmap.v1.KeySelector:

Public Member Functions
String keyForIdent (String ident)

Detailed Description

An interface that provides deterministic resolution of identifiers to source data keys. See PartitionWriter#setRowFromMap(Map, com.vertica.sdk.TypeCoercion).

Member Function Documentation

String com.vertica.sdk.vmap.v1.KeySelector.keyForIdent(String ident)

Returns the key name of the first key that matches ident according to identifier comparison.

Parameters

  • ident: A SQL identifier or "key", similar to a column name.

Returns A key from within the data that matches the ident, or null if not found.

Implemented in com.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector, and com.vertica.sdk.vmap.v1.Encoder.

2.1.181 - com.vertica.sdk.vmap.v1.KeySelector Member List

This is the complete list of members for com.vertica.sdk.vmap.v1.KeySelector, including all inherited members.

keyForIdent(String ident) com.vertica.sdk.vmap.v1.KeySelector

2.1.182 - com.vertica.sdk.vmap.VMapEncodingException Class Reference

Inheritance diagram for com.vertica.sdk.vmap.VMapEncodingException:

Collaboration diagram for com.vertica.sdk.vmap.VMapEncodingException:

Public Member Functions
VMapEncodingException (String why)
VMapEncodingException (String why, Throwable causedBy)

Detailed Description

A catch-all exception that is thrown whenever there is a problem encoding a vmap, Vertica's aggregate type that powers Flex tables.

An Exception that is thrown when an invalid key is found when attempting to encode or decode a vmap, Vertica's aggregate type that powers Flex tables.

2.1.183 - com.vertica.sdk.vmap.VMapEncodingException Member List

This is the complete list of members for com.vertica.sdk.vmap.VMapEncodingException, including all inherited members.

VMapEncodingException(String why) (defined in com.vertica.sdk.vmap.VMapEncodingException) com.vertica.sdk.vmap.VMapEncodingException
VMapEncodingException(String why, Throwable causedBy) (defined in com.vertica.sdk.vmap.VMapEncodingException) com.vertica.sdk.vmap.VMapEncodingException

2.1.184 - com.vertica.sdk.VNumeric Class Reference

Collaboration diagram for com.vertica.sdk.VNumeric:

Public Member Functions
VNumeric (ByteBuffer buff, int data_offset, int max_data_len, int typmod)
VNumeric (BigDecimal words, int precision, int scale)
VNumeric (BigDecimal words, int t)
void accumulate (VNumeric from)
void add (VNumeric a, VNumeric b)
int compare (VNumeric from)
int compareUnsigned (VNumeric from)
void copy (VNumeric from)
void div (VNumeric a, VNumeric b)
boolean equal (VNumeric from)
int getScale ()
void incr ()
void invertSign ()
boolean isNeg ()
boolean isNull ()
boolean isZero ()
void mul (VNumeric a, VNumeric b)
void setNull ()
void setZero ()
void shiftLeft (int bitsToShift)
void shiftRight (int bitsToShift)
void sub (VNumeric a, VNumeric b)
void toString (ByteBuffer outBuf, int olen)
String toString ()

Detailed Description

Representation of NUMERIC, fixed point data types in Vertica.

2.1.185 - com.vertica.sdk.VNumeric Member List

This is the complete list of members for com.vertica.sdk.VNumeric, including all inherited members.

accumulate(VNumeric from) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
add(VNumeric a, VNumeric b) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
compare(VNumeric from) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
compareUnsigned(VNumeric from) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
copy(VNumeric from) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
div(VNumeric a, VNumeric b) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
equal(VNumeric from) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
getScale() (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
incr() (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
invertSign() (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
isNeg() (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
isNull() (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
isZero() (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
mul(VNumeric a, VNumeric b) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
setNull() (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
setZero() (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
shiftLeft(int bitsToShift) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
shiftRight(int bitsToShift) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
sub(VNumeric a, VNumeric b) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
toString(ByteBuffer outBuf, int olen) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
toString() (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
VNumeric(ByteBuffer buff, int data_offset, int max_data_len, int typmod) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
VNumeric(BigDecimal words, int precision, int scale) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric
VNumeric(BigDecimal words, int t) (defined in com.vertica.sdk.VNumeric) com.vertica.sdk.VNumeric

2.1.186 - com.vertica.sdk.VResources Class Reference

Collaboration diagram for com.vertica.sdk.VResources:

Public Attributes
int nFileHandles
long scratchMemory

Detailed Description

Representation of the resources user code can ask Vertica for

Member Data Documentation

int com.vertica.sdk.VResources.nFileHandles

Number of file handles / sockets required

long com.vertica.sdk.VResources.scratchMemory

Amount of RAM in bytes used by User defined function

2.1.187 - com.vertica.sdk.VResources Member List

This is the complete list of members for com.vertica.sdk.VResources, including all inherited members.

nFileHandles com.vertica.sdk.VResources
scratchMemory com.vertica.sdk.VResources
VResources() (defined in com.vertica.sdk.VResources) com.vertica.sdk.VResources

2.1.188 - com.vertica.sdk.VString Class Reference

Collaboration diagram for com.vertica.sdk.VString:

Public Member Functions
VString (ByteBuffer buf, int offset, int totalMaxLen)
VString (ByteBuffer hbuf, ByteBuffer dbuf, int hoffset, int doffset, int maxDataLen)
void copy (byte[] from)
void copy (String from)
void copy (VString from)
ByteBuffer data ()
boolean isNull ()
int length ()
void setNull ()
String str ()
String toString ()

Detailed Description

Representation of a String in Vertica. All character data is internally encoded as UTF-8 characters and is not NULL terminated.

Constructor & Destructor Documentation

com.vertica.sdk.VString.VString(ByteBuffer buf, int offset, int totalMaxLen)

Contruct a VString object

Parameters

  • buf: the ByteBuffer providing the space to back the VString
  • offset: offset of the beginning of VString into the ByteBuffer
  • totalMaxLen: the maximum length of the string structure including the header
com.vertica.sdk.VString.VString(ByteBuffer hbuf, ByteBuffer dbuf, int hoffset, int doffset, int maxDataLen)

Construct an out of line VString object

Parameters

  • hbuf: the ByteBuffer with the VString header
  • dbuf: the ByteBuffer with the actual data
  • hoffset: of the beginning of VString header in hbuf
  • doffset: offset of the actual string data
  • maxDataLen: maximum length of the string structure not including the header

Member Function Documentation

void com.vertica.sdk.VString.copy(byte[] from)

Copy character data from byte array to the VString's internal buffer.

Parameters

  • from: array of bytes input data
void com.vertica.sdk.VString.copy(String from)

Copy character data from String

Parameters

  • from: Java String object as character input data
void com.vertica.sdk.VString.copy(VString from)

Copy data from another VString.

Parameters

  • from: The source VString
ByteBuffer com.vertica.sdk.VString.data()

Provides a read-only ByteBuffer to this VString's internal character data.

Note The returned string is not null terminated

Returns the read only character data for this string in a ByteBuffer

boolean com.vertica.sdk.VString.isNull()

Indicates if this VString contains the SQL NULL value

Returns true if this string contains the SQL NULL value, false otherwise

Referenced by com.vertica.sdk.VString.str().

int com.vertica.sdk.VString.length()

Returns the length of this VString

Returns the length of the string, in bytes. Does not include any extra space for null characters.

Referenced by

void com.vertica.sdk.VString.setNull()

Sets this VString to the SQL NULL value.

String com.vertica.sdk.VString.str()

Provides a copy of this VString's data as a Java String

Returns a Java String copy of the data in this VString

2.1.189 - com.vertica.sdk.VString Member List

This is the complete list of members for com.vertica.sdk.VString, including all inherited members.

copy(byte[] from) com.vertica.sdk.VString
copy(String from) com.vertica.sdk.VString
copy(VString from) com.vertica.sdk.VString
data() com.vertica.sdk.VString
isNull() com.vertica.sdk.VString
length() com.vertica.sdk.VString
setNull() com.vertica.sdk.VString
str() com.vertica.sdk.VString
toString() (defined in com.vertica.sdk.VString) com.vertica.sdk.VString
VString(ByteBuffer buf, int offset, int totalMaxLen) com.vertica.sdk.VString
VString(ByteBuffer hbuf, ByteBuffer dbuf, int hoffset, int doffset, int maxDataLen) com.vertica.sdk.VString

2.1.190 - functions

Here is a list of all documented class members with links to the class documentation for each member:

- a -

2.1.191 - functions 0x62

Here is a list of all documented class members with links to the class documentation for each member:

- b -

2.1.192 - functions 0x63

Here is a list of all documented class members with links to the class documentation for each member:

- c -

2.1.193 - functions 0x64

Here is a list of all documented class members with links to the class documentation for each member:

- d -

2.1.194 - functions 0x65

Here is a list of all documented class members with links to the class documentation for each member:

- e -

2.1.195 - functions 0x66

Here is a list of all documented class members with links to the class documentation for each member:

- f -

2.1.196 - functions 0x67

Here is a list of all documented class members with links to the class documentation for each member:

- g -

2.1.197 - functions 0x69

Here is a list of all documented class members with links to the class documentation for each member:

- i -

2.1.198 - functions 0x6a

Here is a list of all documented class members with links to the class documentation for each member:

- j -

2.1.199 - functions 0x6b

Here is a list of all documented class members with links to the class documentation for each member:

- k -

2.1.200 - functions 0x6c

Here is a list of all documented class members with links to the class documentation for each member:

- l -

2.1.201 - functions 0x6d

Here is a list of all documented class members with links to the class documentation for each member:

- m -

2.1.202 - functions 0x6e

Here is a list of all documented class members with links to the class documentation for each member:

- n -

2.1.203 - functions 0x6f

Here is a list of all documented class members with links to the class documentation for each member:

- o -

2.1.204 - functions 0x70

Here is a list of all documented class members with links to the class documentation for each member:

- p -

2.1.205 - functions 0x72

Here is a list of all documented class members with links to the class documentation for each member:

- r -

2.1.206 - functions 0x73

Here is a list of all documented class members with links to the class documentation for each member:

- s -

2.1.207 - functions 0x74

Here is a list of all documented class members with links to the class documentation for each member:

- t -

2.1.208 - functions 0x75

Here is a list of all documented class members with links to the class documentation for each member:

- u -

2.1.209 - functions 0x76

Here is a list of all documented class members with links to the class documentation for each member:

- v -

2.1.210 - functions 0x77

Here is a list of all documented class members with links to the class documentation for each member:

- w -

2.1.211 - functions eval

2.1.212 - functions func

- a -

2.1.213 - functions func 0x62

- b -

2.1.214 - functions func 0x63

- c -

2.1.215 - functions func 0x64

- d -

2.1.216 - functions func 0x65

- e -

2.1.217 - functions func 0x66

- f -

2.1.218 - functions func 0x67

- g -

2.1.219 - functions func 0x69

- i -

2.1.220 - functions func 0x6a

- j -

2.1.221 - functions func 0x6b

- k -

2.1.222 - functions func 0x6c

- l -

2.1.223 - functions func 0x6d

- m -

2.1.224 - functions func 0x6e

- n -

2.1.225 - functions func 0x6f

- o -

2.1.226 - functions func 0x70

- p -

2.1.227 - functions func 0x72

- r -

2.1.228 - functions func 0x73

- s -

2.1.229 - functions func 0x74

- t -

2.1.230 - functions func 0x75

- u -

2.1.231 - functions func 0x76

- v -

2.1.232 - functions func 0x77

- w -

2.1.233 - functions vars

2.2 - com Directory Reference

Directories
directory vertica

2.3 - Graph Legend

This page explains how to interpret the graphs that are generated by doxygen.

Consider the following example:

/*! Invisible class because of truncation */
class Invisible { };

/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };

/* Class not documented with doxygen comments */
class Undocumented { };

/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };

/*! A template class */
template class Templ { };

/*! Class that is inherited using protected inheritance */
class ProtectedBase { };

/*! Class that is inherited using private inheritance */
class PrivateBase { };

/*! Class that is used by the Inherited class */
class Used { };

/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
protected ProtectedBase,
private PrivateBase,
public Undocumented,
public Templ
{
private:
Used *m_usedClass;
};

This will result in the following graph:

image

The boxes in the above graph have the following meaning:

  • A filled gray box represents the struct or class for which the graph is generated.

  • A box with a black border denotes a documented struct or class.

  • A box with a grey border denotes an undocumented struct or class.

  • A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.

The arrows have the following meaning:

  • A dark blue arrow is used to visualize a public inheritance relation between two classes.

  • A dark green arrow is used for protected inheritance.

  • A dark red arrow is used for private inheritance.

  • A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible.

  • A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labeled with the template parameters of the instance.

2.4 - Packages

Here are the packages with brief descriptions (if available):

[detail level 123]

com
vertica
sdk

2.4.1 - Package com.vertica.sdk

Classes
class AnalyticFunction
class AnalyticFunctionFactory
class AnalyticPartitionReader
class AnalyticPartitionWriter
enum BaseDataOID
class Basics
class BlockReader
class BlockWriter
class BuildInfo
class ColumnTypes
class ContinuousReader
class ContinuousRejecter
class ContinuousStreamer
class ContinuousUDParser
class ContinuousUDParserLocks
class DataBuffer
class DefaultSourceIterator
class DestroyInvocation
class DFSConstants
class DFSFile
class DFSFileReader
enum DFSFileStatus
class DFSFileWriter
class ExecutorParamWriter
class ExecutorPlanContext
class FileManager
class FilterFactory
class IdentComparator
class IterativeSourceFactory
class MultiPhaseTransformFunctionFactory
class NodeSpecifyingPlanContext
class NoopTypeCoercion
class NullTypeCoercion
class ParamReader
class ParamWriter
class ParserFactory
class PartitionReader
class PartitionWriter
class PerColumnParamReader
class PGUDxShared
class PlanContext
class Portion
class RejectedRecord
class ScalarFunction
class ScalarFunctionFactory
class ServerInterface
class SessionParamReaderMap
class SessionParamWriterMap
class SizedColumnTypes
class SourceFactory
class SourceIterator
class StandardTypeCoercion
class State
class StreamWriter
class StringUtils
class TimestampUDxShared
class TransformFunction
class TransformFunctionFactory
class TransformFunctionPhase
Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function.
interface TypeCoercion
class TypeCoercionException
enum TypeCoercionPolicy
class UdfException
class UDFilter
class UDLFactory
class UDParser
class UDSource
class UDXFactory
class UDXFunction
class UDXLibrary
class UDXObject
class UnsizedUDSource
class VerticaBlock
class VerticaType
class VNumeric
class VResources
class VString

Detailed Description

AnalyticPartitionReader provides an iterator-based read interface over all the partition_by keys, order_by keys, and function arguments in a partition.

AnalyticPartitionWriter provides an iterator-based write interface over all input data in a single partition. It automatically makes space as needed.

2.5 - sdk Directory Reference

Directories
directory vmap
Files
file AnalyticFunction.java
file AnalyticFunctionFactory.java
file AnalyticPartitionReader.java
file AnalyticPartitionWriter.java
file BaseDataOID.java
file Basics.java
file BlockReader.java
file BlockWriter.java
file BuildInfo.java
file ColumnTypes.java
file ContinuousReader.java
file ContinuousRejecter.java
file ContinuousStreamer.java
file ContinuousUDParser.java
file ContinuousUDParserLocks.java
file DataBuffer.java
file DefaultSourceIterator.java
file DestroyInvocation.java
file DFSConstants.java
file DFSFile.java
file DFSFileReader.java
file DFSFileStatus.java
file DFSFileWriter.java
file ExecutorParamWriter.java
file ExecutorPlanContext.java
file FileManager.java
file FilterFactory.java
file IdentComparator.java
file IterativeSourceFactory.java
file MultiPhaseTransformFunctionFactory.java
file NodeSpecifyingPlanContext.java
file NoopTypeCoercion.java
file NullTypeCoercion.java
file ParamReader.java
file ParamWriter.java
file ParserFactory.java
file PartitionReader.java
file PartitionWriter.java
file PerColumnParamReader.java
file PGUDxShared.java
file PlanContext.java
file Portion.java
file RejectedRecord.java
file ScalarFunction.java
file ScalarFunctionFactory.java
file ServerInterface.java
file SessionParamReaderMap.java
file SessionParamWriterMap.java
file SizedColumnTypes.java
file SourceFactory.java
file SourceIterator.java
file StandardTypeCoercion.java
file State.java
file StreamWriter.java
file StringUtils.java
file TimestampUDxShared.java
file TransformFunction.java
file TransformFunctionFactory.java
file TransformFunctionPhase.java
file TypeCoercion.java
file TypeCoercionException.java
file TypeCoercionPolicy.java
file UdfException.java
file UDFilter.java
file UDLFactory.java
file UDParser.java
file UDSource.java
file UDXFactory.java
file UDXFunction.java
file UDXLibrary.java
file UDXObject.java
file UnsizedUDSource.java
file VerticaBlock.java
file VerticaBuildInfo.java
file VerticaType.java
file VNumeric.java
file VResources.java
file VString.java

2.6 - v1 Directory Reference

Files
file ByteMapTuple.java
file Encoder.java
file IdentMapTupleComparator.java
file KeyComparator.java
file KeySelector.java
file ListIterator.java
file MapTuple.java
file NestedMapTuple.java
file NullMapTuple.java

2.7 - vertica Directory Reference

Directories
directory sdk

2.8 - vmap Directory Reference

Directories
directory v1
Files
file InvalidMapKeyException.java
file VMapEncodingException.java

3 - R SDK

Welcome to the Vertica R SDK API Documentation.

Welcome to the Vertica R SDK API Documentation. This documentation covers all of the functions that make up the R SDK. Using this API, you can create User Defined Extensions (UDxs) that integrate your own features into the Vertica Analytics Platform.

To learn how UDxs work and how to develop, compile, and deploy them, see Developing user-defined extensions (UDxs).

3.1 - Main function

The first function called when Vertica runs an R user-defined extension (UDx).

The first function called when Vertica runs an R user-defined extension (UDx). It must return a data frame and is defined by the name parameter of the factory function.

Example

FunctionName <- function(input_data_frame, parameters_data_frame) {
  # Each column from Vertica is turned into a column in the input data frame.
  # This is a brief example of multiplying two columns of the input data frame.
  output_data_frame <- data.frame(input_data_frame[, 1] * input_data_frame[, 2])
  # The function must return a data frame.
  return(output_data_frame)
}

Arguments

input_data_frame The data read by the Vertica user-defined extension (UDx). This input must be a data frame.
parameters_data_frame

The parameters passed to the Vertica user-defined extension (UDx).

This input must be a data frame. If you are passing parameters from your Vertica UDx, defined with USING PARAMETERS, then you must included this in your R UDx. If you are not passing parameters to your R UDx, then this can be omitted from your R UDx.

Description

The main function takes as input one data frame as the first argument, and if your UDx accepts parameters, a parameter data frame as the second argument. The main function must return a data frame. The factory function converts the intype argument into a data frame for the main function. For example, intype=c("float","float") is converted by the factory function into a two-dimensional matrix.

The function can call other functions defined in your R UDx library file.

3.2 - Factory function

The factory function consists of an R list which specifies the parameters of your R user-defined extension (UDx).

The factory function consists of an R list which specifies the parameters of your R user-defined extension (UDx).

Example

FunctionNameFactory <- function() {
  list(name                  = MainFunctionName,
       udxtype               = c("scalar"),
       intype                = c("float","int", ...),
       outtype               = c("float", ...),
       outtypecallback       = MyReturnTypeFunc,
       parametertypecallback = MyParamReturnFunc,
       volatility            = c("volatile"),
       strictness            = c("called_on_null_input") )
}

Arguments

name The name of the R function in this UDx that is called when the function is invoked by Vertica, and which returns the value(s) back to Vertica.
udxtype

The type of UDx, one of the following:

  • scalar

  • transform

intype Data types of arguments accepted by the function. UDxs support up to 9800 arguments.
outtype Data types of the arguments returned by the function.
outtypecallback (Optional) The callback function to call before sending the data back to Vertica, which defines the types and precision that the main function returns.
parametertypecallback

The callback function to send parameter types and names to Vertica.

This parameter is required if your UDx is called from Vertica with USING PARAMETERS.

volatility

(Optional) Indicates whether the function returns the same output given the same input, one of the following:

  • VOLATILE (default)

  • IMMUTABLE

  • STABLE

For details, see Setting null input and volatility behavior for R functions.

strictness

(Optional) Indicates whether the function always returns NULL when any input argument is NULL, one of the following:

  • CALLED_ON_NULL_INPUT (default)

  • RETURN_NULL_ON_NULL_INPUT

  • STRICT

For details, see Setting null input and volatility behavior for R functions.

Description

User-defined functions in R (R UDx) require a factory function for each main R function that you want to call from within Vertica. The factory function encapsulates all the information required by Vertica to load the R UDx.

3.3 - Outtypecallback function

Function to define the column names, output data types, length/precision, and scale of the data being returned to Vertica.

Function to define the column names, output data types, length/precision, and scale of the data being returned to Vertica.

Example

SalesTaxReturnTypes <- function(arguments.data.frame, parameters.data.frame) {
  output.return.type <- data.frame(datatype = rep(NA, 2),
                                   length   = rep(NA, 2),
                                   scale    = rep(NA, 2),
                                   name     = rep(NA, 2))
  output.return.type$datatype <- c("float", "float")
  output.return.type$name <- c("Sales Tax Rate", "Item Cost with Tax")
  return(output.return.type)
}

Arguments

*arguments.data.frame Data frame that contains the arguments passed to the UDx from Vertica. This data frame is created and used internally by the UDx process.
*parameters.data.frame Data frame that contains the parameters defined in the UDx from Vertica. This data frame is created and used internally by the UDx process.
datatype Output data type.
length (Optional) Dimension of the output.
scale (Optional) Proportional dimensions of the output.
name Column name of the output.

Description

When creating the outtypecallback function, define one row for each value returned. Use the same order as in the outtype defined in the factory function. If any columns are left blank or the outtypecallback function is omitted, then Vertica uses default values.

3.4 - Parametertypecallback function

Function to define the output data type(s), length/precision, and scale of the parameters sent to the main function.

Function to define the output data type(s), length/precision, and scale of the parameters sent to the main function.

Example

FunctionNameParameterTypes <- function() {
  parameters <- list(datatype = c("int", "varchar"),
                     length   = c("NA", "100"),
                     scale    = c("NA", "NA"),
                     name     = c("k", "algorithm"))
  return(parameters)
}

Arguments

datatype The data type of the parameter.
length (Optional) The dimension of the parameter.
scale The proportional dimensions of the parameter.
name The name of the parameter.

Description

When creating the parametertypecallback function, you define one row for each parameter being sent to the function. You must specify a parametertypecallback function if your UDx uses parameters.

The parametertypecallback does not accept any input arguments.

4 - Python SDK

Welcome to the Vertica Python SDK Documentation. This documentation covers all of the classes that make up the Python SDK API. Using this API, you can create User Defined Extensions (UDxs) that integrate your own features into the Vertica Analytics Platform.

See Developing User-Defined Extensions.

The Vertica Python SDK requires Python 3.

Python UDx SDK Documentation

4.1 - BlockReader

class vertica_sdk.BlockReader

Interface for reading a list of in-memory tuples.

All rows have the same column types.

getArray(self, idx)

Returns a list containing this reader’s array data. Nested complex types are also expanded in the result: rows into OrderedDicts, and arrays into lists.

getArrayHelper(self, idx)

getArrayReader(self, idx)

Returns a vertica_sdk.ArrayReader object used to access this reader’s array data.

getBinary(self, idx)

Returns a bytes object.

getBool(self, idx)

Returns a int (SQL null means this has more than two values).

getDate(self, idx)

Returns a datetime.date.

getFloat(self, idx)

Returns a float.

getInt(self, idx)

Returns an int.

getInterval(self, idx)

Returns a datetime.timedelta.

The return value can be a negative interval. Use abs(val) to see the absolute value.

getIntervalYM(self, idx)

Returns an int that represents an interval in months.

The return value can be a negative interval.

getNumCols(self)

Returns the number of columns held by this reader.

getNumRows(self)

Returns the number of rows held by this reader.

getNumeric(self, idx)

Returns a decimal.Decimal.

getRow(self, idx)

Returns a collections.OrderedDict containing this reader’s row data. Nested complex types are also expanded in the result: rows into OrderedDicts, and arrays into lists.

getRowReader(self, idx)

Returns a vertica_sdk.RowReader object used to access the row fields of this reader.

getString(self, idx)

Returns a str (unicode code point values).

getTime(self, idx)

Returns a datetime.time.

getTimeTz(self, idx)

Returns a datetime.time with datetime.tzinfo set to constant offset.

getTimestamp(self, idx)

Returns a datetime.datetime.

getTimestampTz(self, idx)

Returns a datetime.datetime.

TimestampTz objects contain no timezone information in the Vertica SDK. All times are UTC.

getTypeMetaData(self)

Returns a vertica_sdk.SizedColumnTypes object describing the column types of this reader.

getTypeMetadata(self)

Returns a vertica_sdk.SizedColumnTypes object describing the column types of this reader.

hasData(self)

Returns True if this reader has rows remaining after the current one, or False otherwise.

isNull(self, col)

Returns True if the value in the indicated zero-indexed column of the current row is NULL, and False otherwise.

next(self)

Advances the block reader to the next row of input. Returns True if more input rows are available, and False otherwise.

4.2 - BlockWriter

class vertica_sdk.BlockWriter

Interface for writing a list of in-memory tuples.

All rows have the same column types.

copyColumn(self, srcblock, srccol)

Copy a column from the current row of srcblock into the current row of this block.

Returns None.

getArrayWriter(self)

Returns a vertica_sdk.ArrayWriter object used to store array data.

getNumCols(self)

Returns the number of columns held by this writer.

getNumRows(self)

Returns the number of rows held by this writer.

getRowWriter(self)

Returns a vertica_sdk.RowWriter objects used to store row data.

getTypeMetadata(self)

Returns a vertica_sdk.SizedColumnTypes object describing the column types of this writer.

next(self)

Advances the block writer to the next row of output.

Returns None.

setArray(self, value)

Stores a list object as array data.

Returns None.

setBinary(self, value)

Stores a binary value for the current row. Raises a RuntimeError when this block data type does not match.

Returns None.

setBool(self, value)

Stores a bool value for the current row. Raises a RuntimeError when this block data type does not match.

Returns None.

setDate(self, value)

Stores a datetime.datetime or datetime.date. Raises a RuntimeError when this block data type does not match.

Returns None.

setFloat(self, value)

Stores a float value for the current row. Raises a RuntimeError when this block data type does not match.

Returns None.

setHook(self)

setInt(self, value)

Stores an int value for the current row. Raises a RuntimeError when this block data type does not match.

Returns None.

setInterval(self, value)

Stores a datetime.timedelta. Raises a RuntimeError when this block data type does not match.

Returns None.

setIntervalYM(self, value)

Stores an int number of months. Raises a RuntimeError when this block data type does not match.

Returns None.

setNull(self)

Sets the output for the current row to NULL.

Returns None.

setNumeric(self, value)

Stores a decimal.Decimal. Values will be rounded to the scale of the output type. Raises a RuntimeError when this block data type does not match.

Returns None.

setRow(self, value)

Stores row data. Supported input value formats are:

  • tuple, where each entry corresponds to a field in its corresponding field order
  • dict or collections.OrderedDict, where each key-value pair maps field name to field value

Returns None.

setString(self, value)

Stores a string value for the current row. Raises a RuntimeError when this block data type does not match.

Returns None.

setTime(self, value)

Stores a datetime.time. Raises a RuntimeError when this block data type does not match.

Returns None.

setTimeTz(self, value)

Stores a datetime.time with datetime.tzinfo. Raises a RuntimeError when this block data type does not match.

Returns None.

setTimestamp(self, value)

Stores a datetime.datetime with appropriate time-zone awareness. Raises a RuntimeError when this block data type does not match.

Returns None.

setTimestampTz(self, value)

Stores a datetime.datetime with appropriate time-zone awareness. Raises a RuntimeError when this block data type does not match.

Returns None.

4.3 - ColumnTypes

class vertica_sdk.ColumnTypes

Stores type metadata for a collection of columns.

addAny(self)

Specifies that a variable number of columns can be accepted.

Returns None.

addArrayType(self, elementPrototype)

Adds an array type to the list of columns, with the same element type as the provided vertica_sdk.ColumnTypes. Requires that the element type contain exactly one column.

Returns None.

addBinary(self)

Adds a binary column to the list of columns.

Returns None.

addBool(self)

Adds a bool column to the list of columns.

Returns None.

addChar(self)

Adds a char column to the list of columns.

Returns None.

addDate(self)

Adds a date column to the list of columns.

Returns None.

addFloat(self)

Adds a float column to the list of columns.

Returns None.

addInt(self)

Adds an int column to the list of columns.

Returns None.

addInterval(self)

Adds a interval column to the list of columns.

Returns None.

addIntervalYM(self)

Adds a year-to-month interval column to the list of columns.

Returns None.

addLongVarbinary(self)

Adds a long varbinary column to the list of columns.

Returns None.

addLongVarchar(self)

Adds a long varchar column to the list of columns.

Returns None.

addNumeric(self)

Adds a numeric column to the list of columns.

Returns None.

addRowType(self, fieldsPrototpye)

Adds a row type to the list of columns, with the same fields as the provided vertica_sdk.ColumnTypes.

Returns None.

addTime(self)

Adds a time column to the list of columns.

Returns None.

addTimeTz(self)

Adds a timetz column to the list of columns.

Returns None.

addTimestamp(self)

Adds a timestamp column to the list of columns.

Returns None.

addTimestampTz(self)

Adds a timestamptz column to the list of columns.

Returns None.

addVarbinary(self)

Adds a varbinary column to the list of columns.

Returns None.

addVarchar(self)

Adds a varchar column to the list of columns.

Returns None.

getColumnCount(self)

Returns the number of columns.

getColumnType(self, idx)

Returns the OID of the type of the indicated column.

static makeAny()

Returns a vertica_sdk.ColumnTypes that accepts a variable number of column types.

static makeArrayType(elementPrototype)

Returns a vertica_sdk.ColumnTypes with one array column, with its element type specified by the provided vertica_sdk.ColumnTypes argument.

static makeBinary()

Returns a vertica_sdk.ColumnTypes with one binary column.

static makeBool()

Returns a vertica_sdk.ColumnTypes with one bool column.

static makeChar()

Returns a vertica_sdk.ColumnTypes with one char column.

static makeDate()

Returns a vertica_sdk.ColumnTypes with one date column.

static makeEmpty()

Returns an emtpy vertica_sdk.ColumnTypes.

static makeFloat()

Returns a vertica_sdk.ColumnTypes with one float column.

static makeInt()

Returns a vertica_sdk.ColumnTypes with one int column.

static makeInterval()

Returns a vertica_sdk.ColumnTypes with one interval column.

static makeIntervalYM()

Returns a vertica_sdk.ColumnTypes with one year-to-month interval column.

static makeLongVarbinary()

Returns a vertica_sdk.ColumnTypes with one long varbinary column.

static makeLongVarchar()

Returns a vertica_sdk.ColumnTypes with one long varchar column.

static makeNumeric()

Returns a vertica_sdk.ColumnTypes with one numeric column.

static makeRowType(fieldsPrototype)

Returns a vertica_sdk.ColumnTypes with one row column, with field types specified by the provided vertica_sdk.ColumnTypes argument.

static makeTime()

Returns a vertica_sdk.ColumnTypes with one time column.

static makeTimeTz()

Returns a vertica_sdk.ColumnTypes with one timetz column.

static makeTimestamp()

Returns a vertica_sdk.ColumnTypes with one timestamp column.

static makeTimestampTz()

Returns a vertica_sdk.ColumnTypes with one timestamptz column.

static makeVarbinary()

Returns a vertica_sdk.ColumnTypes with one varbinary column.

static makeVarchar()

Returns a vertica_sdk.ColumnTypes with one varchar column.

4.4 - FilterFactory

class vertica_sdk.FilterFactory

Produces vertica_sdk.UDFilter objects, which transform one raw data stream into another.

vertica_sdk.FilterFactory implementations should be stateless. Modifications to instance, class, or global variables might not be persisted.

classmethod getUDXFactoryType(cls)

Returns vertica_sdk.UDXType.LOAD_FILTER.

classmethod plan(self, serverInterface, planContext)

Execute any logic required at query plan time.

This method is run once per query on the initiator node. If it raises an exception, the query will not proceed.

serverInterface is a vertica_sdk.ServerInterface object which provides access to server functionality, including session and statement parameters.

planContext is vertica_sdk.PlanContext object, for storing and retrieving data which will be serialized and distributed to all nodes which run the query plan.

classmethod prepare(self, serverInterface, planContext)

Create a vertica_sdk.UDFilter object for execution. This method is run once per load thread on each node, prior to the start of execution.

serverInterface is a vertica_sdk.ServerInterface object which provides access to server functionality, including session and statement parameters. It contains the same parameters as the ServerInterface argument to plan() in the same query.

planContext is a vertica_sdk.PlanContext object which contains any data which was stored during a call to plan().

4.5 - Index

A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W

A

addAny() (vertica_sdk.ColumnTypes method) addArrayType() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addBinary() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addBinaryOrderColumn() (vertica_sdk.SizedColumnTypes method) addBinaryPartitionColumn() (vertica_sdk.SizedColumnTypes method) addBool() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addBoolOrderColumn() (vertica_sdk.SizedColumnTypes method) addBoolPartitionColumn() (vertica_sdk.SizedColumnTypes method) addChar() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addCharOrderColumn() (vertica_sdk.SizedColumnTypes method) addCharPartitionColumn() (vertica_sdk.SizedColumnTypes method) addColumn() (vertica_sdk.SizedColumnTypes method) addDate() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addDateOrderColumn() (vertica_sdk.SizedColumnTypes method) addDatePartitionColumn() (vertica_sdk.SizedColumnTypes method) addFloat() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addFloatOrderColumn() (vertica_sdk.SizedColumnTypes method) addFloatPartitionColumn() (vertica_sdk.SizedColumnTypes method) addInt() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addInterval() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addIntervalOrderColumn() (vertica_sdk.SizedColumnTypes method) addIntervalPartitionColumn() (vertica_sdk.SizedColumnTypes method) addIntervalYM() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addIntervalYMOrderColumn() (vertica_sdk.SizedColumnTypes method) addIntervalYMPartitionColumn() (vertica_sdk.SizedColumnTypes method) addIntOrderColumn() (vertica_sdk.SizedColumnTypes method) addIntPartitionColumn() (vertica_sdk.SizedColumnTypes method) addLongVarbinary() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addLongVarbinaryOrderColumn() (vertica_sdk.SizedColumnTypes method) addLongVarbinaryPartitionColumn() (vertica_sdk.SizedColumnTypes method) addLongVarchar() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addLongVarcharOrderColumn() (vertica_sdk.SizedColumnTypes method) addLongVarcharPartitionColumn() (vertica_sdk.SizedColumnTypes method) addNumeric() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addNumericOrderColumn() (vertica_sdk.SizedColumnTypes method) addNumericPartitionColumn() (vertica_sdk.SizedColumnTypes method) addOrderColumn() (vertica_sdk.SizedColumnTypes method) addPartitionColumn() (vertica_sdk.SizedColumnTypes method) addRowType() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addTime() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addTimeOrderColumn() (vertica_sdk.SizedColumnTypes method) addTimePartitionColumn() (vertica_sdk.SizedColumnTypes method) addTimestamp() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addTimestampOrderColumn() (vertica_sdk.SizedColumnTypes method) addTimestampPartitionColumn() (vertica_sdk.SizedColumnTypes method) addTimestampTz() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addTimestampTzOrderColumn() (vertica_sdk.SizedColumnTypes method) addTimestampTzPartitionColumn() (vertica_sdk.SizedColumnTypes method) addTimeTz() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addTimeTzOrderColumn() (vertica_sdk.SizedColumnTypes method) addTimeTzPartitionColumn() (vertica_sdk.SizedColumnTypes method) addUuid() (vertica_sdk.SizedColumnTypes method) addUuidOrderColumn() (vertica_sdk.SizedColumnTypes method) addVarbinary() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addVarbinaryOrderColumn() (vertica_sdk.SizedColumnTypes method) addVarbinaryPartitionColumn() (vertica_sdk.SizedColumnTypes method) addVarchar() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) addVarcharOrderColumn() (vertica_sdk.SizedColumnTypes method) addVarcharPartitionColumn() (vertica_sdk.SizedColumnTypes method) advance() (vertica_sdk.InputBuffer method) AGGREGATE (vertica_sdk.UDXType attribute) ANALYTIC (vertica_sdk.UDXType attribute)

B

BlockReader (class in vertica_sdk) BlockWriter (class in vertica_sdk)

C

canApportionParser() (vertica_sdk.ParserFactory class method) CHUNK_ALIGNED (vertica_sdk.StreamState attribute) ColumnTypes (class in vertica_sdk) containsColumns() (vertica_sdk.PerColumnParamReader method) containsNamespace() (vertica_sdk.SessionParamWriterMap method) containsParameter() (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) copyColumn() (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionWriter method) copyRow() (vertica_sdk.PartitionWriter method) copyTypesFrom() (vertica_sdk.SizedColumnTypes method) createScalarFunction() (vertica_sdk.ScalarFunctionFactory class method) createTransformFunction() (vertica_sdk.TransformFunctionFactory class method) (vertica_sdk.TransformFunctionPhase class method)

D

destroy (vertica_sdk.ScalarFunction attribute) (vertica_sdk.UDFilter attribute) (vertica_sdk.UDParser attribute) (vertica_sdk.UDXObject attribute) DONE (vertica_sdk.StreamState attribute)

E

END_OF_FILE (vertica_sdk.InputState attribute)

F

FILESYSTEM (vertica_sdk.UDXType attribute) FilterFactory (class in vertica_sdk) findUnsetColumn() (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method)

G

getArgumentColumns() (vertica_sdk.SizedColumnTypes method) getArray() (vertica_sdk.BlockReader method) (vertica_sdk.PartitionReader method) getArrayBound() (vertica_sdk.VerticaType method) getArrayHelper() (vertica_sdk.BlockReader method) (vertica_sdk.PartitionReader method) getArrayReader() (vertica_sdk.BlockReader method) (vertica_sdk.PartitionReader method) getArrayWriter() (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) getBinary() (vertica_sdk.BlockReader method) (vertica_sdk.PartitionReader method) getBool() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getClusterNodes() (vertica_sdk.PlanContext method) getColumnCount() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) getColumnName() (vertica_sdk.SizedColumnTypes method) getColumnNames() (vertica_sdk.PerColumnParamReader method) getColumnParamReader() (vertica_sdk.PerColumnParamReader method) getColumnType() (vertica_sdk.ColumnTypes method) (vertica_sdk.SizedColumnTypes method) getData (vertica_sdk.RejectedRecord attribute) getDatabaseName() (vertica_sdk.ServerInterface method) getDate() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getElementType() (vertica_sdk.VerticaType method) getFieldName() (vertica_sdk.VerticaType method) getFieldType() (vertica_sdk.VerticaType method) getFloat() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getInt() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getInterval() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getIntervalPrecision() (vertica_sdk.VerticaType method) getIntervalRange() (vertica_sdk.VerticaType method) getIntervalYM() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getLastOrderColumnIdx() (vertica_sdk.SizedColumnTypes method) getLastPartitionColumnIdx() (vertica_sdk.SizedColumnTypes method) getLocale() (vertica_sdk.ServerInterface method) getMaxSize() (vertica_sdk.VerticaType method) getNamespaces() (vertica_sdk.SessionParamWriterMap method) getNodeName() (vertica_sdk.ServerInterface method) getNumCols() (vertica_sdk.BlockReader method) (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionReader method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) getNumeric() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getNumericFractional() (vertica_sdk.VerticaType method) getNumericIntegral() (vertica_sdk.VerticaType method) getNumericPrecision() (vertica_sdk.VerticaType method) getNumericScale() (vertica_sdk.VerticaType method) getNumericWordCount() (vertica_sdk.VerticaType method) getNumFields() (vertica_sdk.VerticaType method) getNumRows() (vertica_sdk.BlockReader method) (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionReader method) getOffset() (vertica_sdk.InputBuffer method) getOrderByColumns() (vertica_sdk.SizedColumnTypes method) getParameterType (vertica_sdk.UDXFactory attribute) getParamNames() (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) getParamReader() (vertica_sdk.ServerInterface method) getParserReturnType() (vertica_sdk.ParserFactory class method) getPartitionByColumns() (vertica_sdk.SizedColumnTypes method) getPerInstanceResources (vertica_sdk.UDXFactory attribute) getPhases() (vertica_sdk.MultiPhaseTransformFunctionFactory class method) getPrettyPrintStr() (vertica_sdk.VerticaType method) getPrototype (vertica_sdk.MultiPhaseTransformFunctionFactory attribute) (vertica_sdk.UDXFactory attribute) getReader() (vertica_sdk.PlanContext method) getReason (vertica_sdk.RejectedRecord attribute) getReturnType (vertica_sdk.MultiPhaseTransformFunctionFactory attribute) (vertica_sdk.TransformFunctionPhase attribute) (vertica_sdk.UDXFactory attribute) getRow() (vertica_sdk.BlockReader method) (vertica_sdk.PartitionReader method) getRowReader() (vertica_sdk.BlockReader method) (vertica_sdk.PartitionReader method) getRowWriter() (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) getSize() (vertica_sdk.InputBuffer method) getString() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getStringLength() (vertica_sdk.VerticaType method) getTerminator (vertica_sdk.RejectedRecord attribute) getTime() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getTimePrecision() (vertica_sdk.VerticaType method) getTimestamp() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getTimestampPrecision() (vertica_sdk.VerticaType method) getTimestampTz() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getTimeTz() (vertica_sdk.BlockReader method) (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionReader method) getTotalRowCount() (vertica_sdk.StreamWriter method) getTypeMetaData() (vertica_sdk.BlockReader method) getTypeMetadata() (vertica_sdk.BlockReader method) (vertica_sdk.BlockWriter method) getTypeMetaData() (vertica_sdk.PartitionReader method) getTypeMetadata() (vertica_sdk.PartitionReader method) getTypeMetaData() (vertica_sdk.PartitionWriter method) getTypeMetadata() (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) getTypeMod() (vertica_sdk.VerticaType method) getTypeOid() (vertica_sdk.VerticaType method) getTypeStr() (vertica_sdk.VerticaType method) getUDSessionParamReader() (vertica_sdk.ServerInterface method) getUDSessionParamWriter() (vertica_sdk.SessionParamWriterMap method) getUDXFactoryType() (vertica_sdk.FilterFactory class method) (vertica_sdk.MultiPhaseTransformFunctionFactory class method) (vertica_sdk.ParserFactory class method) (vertica_sdk.ScalarFunctionFactory class method) (vertica_sdk.TransformFunctionFactory class method) (vertica_sdk.UDXFactory class method) getUserName() (vertica_sdk.ServerInterface method) getWriter() (vertica_sdk.PlanContext method)

H

hasData() (vertica_sdk.BlockReader method) (vertica_sdk.PartitionReader method) hasMoreData() (vertica_sdk.PartitionReader method)

I

INPUT_NEEDED (vertica_sdk.StreamState attribute) InputBuffer (class in vertica_sdk) InputState (class in vertica_sdk) INVALID_UDX (vertica_sdk.UDXType attribute) isArrayType() (vertica_sdk.VerticaType method) isBinary() (vertica_sdk.VerticaType method) isBool() (vertica_sdk.VerticaType method) isChar() (vertica_sdk.VerticaType method) isComplexArrayType() (vertica_sdk.VerticaType method) isComplexRowType() (vertica_sdk.VerticaType method) isDate() (vertica_sdk.VerticaType method) isEmpty() (vertica_sdk.ParamReader method) (vertica_sdk.ParamWriter method) isFloat() (vertica_sdk.VerticaType method) isInt() (vertica_sdk.VerticaType method) isInterval() (vertica_sdk.VerticaType method) isIntervalYM() (vertica_sdk.VerticaType method) isLongVarbinary() (vertica_sdk.VerticaType method) isLongVarchar() (vertica_sdk.VerticaType method) isNull() (vertica_sdk.BlockReader method) (vertica_sdk.PartitionReader method) isNumeric() (vertica_sdk.VerticaType method) isOrderByColumn() (vertica_sdk.SizedColumnTypes method) isPartitionByColumn() (vertica_sdk.SizedColumnTypes method) isPrepass (vertica_sdk.TransformFunctionPhase attribute) isStringType() (vertica_sdk.VerticaType method) isTime() (vertica_sdk.VerticaType method) isTimestamp() (vertica_sdk.VerticaType method) isTimestampTz() (vertica_sdk.VerticaType method) isTimeTz() (vertica_sdk.VerticaType method) isUUID() (vertica_sdk.VerticaType method) isVarbinary() (vertica_sdk.VerticaType method) isVarchar() (vertica_sdk.VerticaType method)

K

KEEP_GOING (vertica_sdk.StreamState attribute) KEYMANAGER (vertica_sdk.UDXType attribute)

L

LOAD_FILTER (vertica_sdk.UDXType attribute) LOAD_PARSER (vertica_sdk.UDXType attribute) LOAD_SOURCE (vertica_sdk.UDXType attribute) log() (vertica_sdk.ServerInterface method)

M

makeAny() (vertica_sdk.ColumnTypes static method) makeArrayType() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeBinary() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeBool() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeChar() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeDate() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeEmpty() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeFloat() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeInt() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeInterval() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeIntervalYM() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeLongVarbinary() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeLongVarchar() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeNumeric() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeRowType() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeTime() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeTimestamp() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeTimestampTz() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeTimeTz() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeUuid() (vertica_sdk.SizedColumnTypes static method) makeVarbinary() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) makeVarchar() (vertica_sdk.ColumnTypes static method) (vertica_sdk.SizedColumnTypes static method) MULTI_TRANSFORM (vertica_sdk.UDXType attribute) MultiPhaseTransformFunctionFactory (class in vertica_sdk)

N

next() (vertica_sdk.BlockReader method) (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionReader method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method)

O

OK (vertica_sdk.InputState attribute) OUTPUT_NEEDED (vertica_sdk.StreamState attribute) OutputBuffer (class in vertica_sdk)

P

ParamReader (class in vertica_sdk) ParamWriter (class in vertica_sdk) ParserFactory (class in vertica_sdk) PartitionReader (class in vertica_sdk) PartitionWriter (class in vertica_sdk) peek() (vertica_sdk.InputBuffer method) PerColumnParamReader (class in vertica_sdk) plan() (vertica_sdk.FilterFactory class method) (vertica_sdk.ParserFactory class method) PlanContext (class in vertica_sdk) prepare() (vertica_sdk.FilterFactory class method) (vertica_sdk.ParserFactory class method) process (vertica_sdk.UDFilter attribute) (vertica_sdk.UDParser attribute) processBlock (vertica_sdk.ScalarFunction attribute) processPartition (vertica_sdk.TransformFunction attribute)

R

read() (vertica_sdk.InputBuffer method) REJECT() (vertica_sdk.StreamState method) RejectedRecord (class in vertica_sdk) reportError() (vertica_sdk.ServerInterface method) reportInfo() (vertica_sdk.ServerInterface method) reportNotice() (vertica_sdk.ServerInterface method) reportWarning() (vertica_sdk.ServerInterface method) reset() (vertica_sdk.SizedColumnTypes method)

S

SCALAR (vertica_sdk.UDXType attribute) ScalarFunction (class in vertica_sdk) ScalarFunctionFactory (class in vertica_sdk) ServerInterface (class in vertica_sdk) SessionParamWriterMap (class in vertica_sdk) setArray() (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setBinary() (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setBool() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setDate() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setEncoding() (vertica_sdk.InputBuffer method) (vertica_sdk.OutputBuffer method) setFloat() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setHook() (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setInt() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setInterval() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setIntervalYM() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setNull() (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setNumeric() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setPartitionOrderColumnIdx() (vertica_sdk.SizedColumnTypes method) setPrepass (vertica_sdk.TransformFunctionPhase attribute) setRow() (vertica_sdk.BlockWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setString() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setTime() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setTimestamp() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setTimestampTz() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setTimeTz() (vertica_sdk.BlockWriter method) (vertica_sdk.ParamWriter method) (vertica_sdk.PartitionWriter method) (vertica_sdk.StreamWriter method) setup (vertica_sdk.ScalarFunction attribute) (vertica_sdk.UDFilter attribute) (vertica_sdk.UDParser attribute) (vertica_sdk.UDXObject attribute) SizedColumnTypes (class in vertica_sdk) StreamState (class in vertica_sdk) StreamWriter (class in vertica_sdk) strictness (vertica_sdk.ScalarFunctionFactory attribute)

T

TRANSFORM (vertica_sdk.UDXType attribute) TransformFunction (class in vertica_sdk) TransformFunctionFactory (class in vertica_sdk) TransformFunctionPhase (class in vertica_sdk) TYPE (vertica_sdk.UDXType attribute)

U

UDFilter (class in vertica_sdk) UDParser (class in vertica_sdk) UDXFactory (class in vertica_sdk) UDXObject (class in vertica_sdk) UDXType (class in vertica_sdk)

V

VerticaType (class in vertica_sdk) volatility (vertica_sdk.ScalarFunctionFactory attribute)

W

write() (vertica_sdk.OutputBuffer method)

4.6 - InputBuffer

class vertica_sdk.InputBuffer(inputstate)

Interface for reading a raw data stream. Objects of this type wrap an in-memory buffer provided by Vertica.

Methods for retrieving data can return either raw data or decoded data. Only one encoding may be specified for the stream. To specify an encoding for the data stream, call setEncoding() before calling any other method of this object.

advance(self, length=None)

Advance the buffer offset by the indicated number of characters. See peek().

Returns the new offset.

getOffset(self)

Return the current position from which data will be read.

getSize(self)

Return the number of characters in the buffer.

peek(self, length=None)

Copy data from the underlying buffer into Python. If no encoding has been specified (via setEncoding()) this returns a bytes object containing raw data. Otherwise, this returns data decoded into an object corresponding to the specified encoding (for example, 'utf-8' would return a string).

If length is None, returns all available data. If length is not None then the length of the returned object is at most what is requested.

This method does not advance the buffer offset.

read(self, length=None)

See peek(). This method does the same thing as peek(), but it also advances the buffer offset by the number of characters consumed.

setEncoding(self, encoding)

Set the encoding of the data contained in the underlying buffer.

4.7 - InputState

class vertica_sdk.InputState

State of the current window in a raw input stream.

Vertica supplies this state as an argument to UDX methods which process a vertica_sdk.InputBuffer.

OK The input is at the start or in the middle of the stream.

END_OF_FILE The input is the end of the stream. No further data is available.

4.8 - MultiPhaseTransformFunctionFactory

class vertica_sdk.MultiPhaseTransformFunctionFactory

Interface for declaring parameters and return types for a multi-phase function; as well as declaring and instantiating its associated vertica_sdk.TransformFunction phases.

classmethod getPhases(cls, server_interface)

Called when Vertica needs a new TransformFunctionPhase pipeline to process a multi-phase UDTF function call.

Vertica invokes the phases in order; collectively they behave like a TransformFunction. More than one object may be instantiated per query.

Note This function can be called several times per query.

getPrototype

Report, via the vertica_sdk.ColumnTypes argument return_types, the return types of this UDX.

Returns None.

getReturnType

Report, via the vertica_sdk.SizedColumnTypes argument return_types, the concrete return types of this UDX.

Returns None.

classmethod getUDXFactoryType(cls)

Returns vertica_sdk.UDXType.MULTI_TRANSFORM.

4.9 - OutputBuffer

class vertica_sdk.OutputBuffer

Interface for writing a raw data stream.

setEncoding(self, encoding)

Specify the encoding of the data written to the underlying buffer.

write(self, data)

Transfer bytes from the data object into Vertica. If encoding is None, the data object will be implicitly converted to bytes. Otherwise, the specified encoding will be used to convert the data to bytes.

The buffer offset will be advanced the number of bytes written.

Returns an object which is a slice of the input data object, corresponding to any data which did not fit in the buffer.

4.10 - ParamReader

class vertica_sdk.ParamReader

Provides read access to a set of named parameters. Type-specific methods can be used to retrieve values.

containsParameter(self, fieldName)

Returns True if there is a value for fieldName and False otherwise.

getBool(self, fieldName)

Returns a boolean value corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getDate(self, fieldName)

Returns a datetime.date corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getFloat(self, fieldName)

Returns a float corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getInt(self, fieldName)

Returns an int corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getInterval(self, fieldName)

Returns a datetime.timedelta corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getIntervalYM(self, fieldName)

Returns a int corresponding to the key fieldName whose value represents an interval in months.

Raises an error if there is no parameter fieldName.

getNumeric(self, fieldName)

Returns a decimal.Decimal corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getParamNames(self)

Returns a list containing the names of all of the parameters.

getString(self, fieldName)

Returns a str corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getTime(self, fieldName)

Returns a datetime.time corresponding to they key fieldName. The timezone is fixed to UTC.

Raises an error if there is no parameter fieldName.

getTimeTz(self, fieldName)

Returns a datetime.time corresponding to they key fieldName. The timezone is a constant offset from UTC.

Raises an error if there is no parameter fieldName.

getTimestamp(self, fieldName)

Returns a datetime.datetime corresponding to they key fieldName.

Raises an error if there is no parameter fieldName.

getTimestampTz(self, fieldName)

Returns a datetime.datetime corresponding to they key fieldName.

Raises an error if there is no parameter fieldName.

isEmpty(self)

Returns True if there are no parameters and False otherwise.

4.11 - ParamWriter

class vertica_sdk.ParamWriter

Provides write access to a set of named parameters. Type-specific methods can be used to retrieve or set values.

containsParameter(self, fieldName)

Returns True if there is a value for fieldName and False otherwise.

getBool(self, fieldName)

Returns a boolean value corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getDate(self, fieldName)

Returns a datetime.date corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getFloat(self, fieldName)

Returns a float corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getInt(self, fieldName)

Returns an int corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getInterval(self, fieldName)

Returns a datetime.timedelta corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getIntervalYM(self, fieldName)

Returns a int corresponding to the key fieldName whose value represents an interval in months.

Raises an error if there is no parameter fieldName.

getNumeric(self, fieldName)

Returns a decimal.Decimal corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getParamNames(self)

Returns a list containing the names of all of the parameters.

getString(self, fieldName)

Returns a str corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getTime(self, fieldName)

Returns a datetime.time corresponding to the key fieldName. The timezone is fixed to UTC.

Raises an error if there is no parameter fieldName.

getTimeTz(self, fieldName)

Returns a datetime.time corresponding to then key fieldName. The timezone is a constant offset from UTC.

Raises an error if there is no parameter fieldName.

getTimestamp(self, fieldName)

Returns a datetime.datetime corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

getTimestampTz(self, fieldName)

Returns a datetime.datetime corresponding to the key fieldName.

Raises an error if there is no parameter fieldName.

isEmpty(self)

Returns True if there are no parameters and False otherwise.

setBool(self, fieldName, value)

Write a boolean value for the parameter fieldName.

Returns None.

setDate(self, fieldName, value)

Write a datetime.datetime or datetime.date value for the parameter fieldName.

Returns None.

setFloat(self, fieldName, value)

Write a float value for the parameter fieldName.

Returns None.

setInt(self, fieldName, value)

Write an int value for the parameter fieldName.

Returns None.

setInterval(self, fieldName, value, precision, range)

Write a datetime.timedelta value for the parameter fieldName.

Returns None.

setIntervalYM(self, fieldName, value, range)

Write an int number of months as an IntervalYM for the parameter fieldName.

range is an int for the maximum range of the IntervalYM type.

Returns None.

setNumeric(self, fieldName, value, precision, scale)

Write a decimal.Decimal value for the parameter fieldName.

precision and scale are the precision and scale of the Numeric type, respectively.

Returns None.

setString(self, fieldName, value)

Write a str value for the parameter fieldName.

Returns None.

setTime(self, fieldName, value, precision)

Write a datetime.time value for the parameter fieldName.

precision is the precision of the Time type.

Returns None.

setTimeTz(self, fieldName, value, precision)

Write a datetime.time value (with tzinfo) for the parameter fieldName.

precision is the precision of the Time type.

Returns None.

setTimestamp(self, fieldName, value, precision)

Write a datetime.datetime object with appropriate time-zone awareness for the parameter fieldName.

Returns None.

setTimestampTz(self, fieldName, value, precision)

Write a datetime.datetime object with appropriate time-zone awareness for the parameter fieldName.

Returns None.

4.12 - ParserFactory

class vertica_sdk.ParserFactory

Produces vertica_sdk.UDParser objects, which transform a raw data stream into Vertica tuples.

vertica_sdk.ParserFactory implementations should be stateless. Modifications to instance, class, or global variables might not be persisted.

classmethod canApportionParser(cls)

Return True if parsers produced by this factory can handle input states vertica_sdk.InputState.START_OF_PORTION and vertica_sdk.InputState.END_OF_PORTION. Return False otherwise.

classmethod getParserReturnType(self, serverInterface, perColumnParamReader, planContext, argTypes, returnTypes)

Set the concrete return types for a query with the provided parameters. This method will be called after plan() in a single query, and may be called multiple times.

argTypes is a vertica_sdk.SizedColumnTypes object indicating the column types of the target table. Implementations of this method should validate that these are supported types.

Parser return types should be added to returnTypes, a vertica_sdk.SizedColumnTypes object.

serverInterface is a vertica_sdk.ServerInterface object which provides access to server functionality, including session and statement parameters.

perColumnParamReader is a vertica_sdk.PerColumnParamReader object, which provides access to column-specific parameters passed to the query.

planContext is a vertica_sdk.PlanContext object which contains any data which was stored during a call to plan().

The default implementation sets the return types to be the same as the arg types.

Returns None.

classmethod getUDXFactoryType(cls)

Returns vertica_sdk.UDXType.LOAD_PARSER.

classmethod plan(self, serverInterface, perColumnParamReader, planContext)

Execute any logic required at query plan time.

This method is run once per query on the initiator node. If it raises an exception, the query will not proceed.

serverInterface is a vertica_sdk.ServerInterface object which provides access to server functionality, including session and statement parameters.

perColumnParamReader is a vertica_sdk.PerColumnParamReader object, which provides access to column-specific parameters passed to the query.

planContext is vertica_sdk.PlanContext object, for storing and retrieving data which will be serialized and distributed to all nodes which run the query plan.

classmethod prepare(self, serverInterface, perColumnParamReader, planContext, returnType)

Create a vertica_sdk.UDParser object for execution. This method is run once per load thread on each node, prior to the start of execution.

serverInterface is a vertica_sdk.ServerInterface object which provides access to server functionality, including session and statement parameters. It contains the same parameters as the ServerInterface argument to plan() in the same query.

perColumnParamReader is a vertica_sdk.PerColumnParamReader object, which provides access to column-specific parameters passed to the query. It contains the smae parameters as the ServerInterface argument to plan() in the same query.

planContext is a vertica_sdk.PlanContext object which contains any data which was stored during a call to plan().

4.13 - PartitionReader

class vertica_sdk.PartitionReader

Iterator-based read interface over all input data in a single partition. Automatically fetches data from Vertica as needed.

getArray(self, idx)

Returns a list containing this reader’s array data. Nested complex types are also expanded in the result: rows into OrderedDicts, and arrays into lists.

getArrayHelper(self, idx)

getArrayReader(self, idx)

Returns a vertica_sdk.ArrayReader object used to access this reader’s array data.

getBinary(self, idx)

Returns a bytes object.

getBool(self, idx)

Returns a int (SQL null means this has more than two values).

getDate(self, idx)

Returns a datetime.date.

getFloat(self, idx)

Returns a float.

getInt(self, idx)

Returns an int.

getInterval(self, idx)

Returns a datetime.timedelta.

The return value can be a negative interval. Use abs(val) to see the absolute value.

getIntervalYM(self, idx)

Returns an int that represents an interval in months.

The return value can be a negative interval.

getNumCols(self)

Returns the number of columns held by this reader.

getNumRows(self)

Returns the number of rows held by this reader.

getNumeric(self, idx)

Returns a decimal.Decimal.

getRow(self, idx)

Returns a collections.OrderedDict containing this reader’s row data. Nested complex types are also expanded in the result: rows into OrderedDicts, and arrays into lists.

getRowReader(self, idx)

Returns a vertica_sdk.RowReader object used to access the row fields of this reader.

getString(self, idx)

Returns a str (unicode code point values).

getTime(self, idx)

Returns a datetime.time.

getTimeTz(self, idx)

Returns a datetime.time with datetime.tzinfo set to constant offset.

getTimestamp(self, idx)

Returns a datetime.datetime.

getTimestampTz(self, idx)

Returns a datetime.datetime.

TimestampTz objects contain no timezone information in the Vertica SDK. All times are UTC.

getTypeMetaData(self)

Returns a vertica_sdk.SizedColumnTypes object describing the column types of this reader.

getTypeMetadata(self)

Returns a vertica_sdk.SizedColumnTypes object describing the column types of this reader.

hasData(self)

Returns True if this reader has rows remaining after the current one, or False otherwise.

hasMoreData(self)

Returns True if there are more rows avaiable to read, and False otherwise.

isNull(self, col)

Returns True if the value in the indicated zero-indexed column of the current row is NULL, and False otherwise.

next(self)

Advance to the next row. If more input is needed, it will be transparently allocated.

Returns True if there is more input available, and False otherwise.

4.14 - PartitionWriter

class vertica_sdk.PartitionWriter

Iterator-based write interface for producing output from a single partition. Automatically makes space a block at a time, as needed.

copyColumn(self, dstcol, srcblock, srccol)

Copy a column from the current row of srcblock into the current row of this block.

Returns None.

copyRow(self, srcblock)

Copy a row from the current row of srcblock into the current row of this block.

Returns None.

findUnsetColumn(self)

getArrayWriter(self, col)

Returns a vertica_sdk.ArrayWriter object used to write array data to the indicated zero-indexed column of the current row.

getNumCols(self)

Returns the number of columns held by this writer.

getRowWriter(self, col)

Returns a vertica_sdk.RowWriter objects used to write row data to the indicated zero-indexed field of this row.

getTypeMetaData(self)

Returns a vertica_sdk.SizedColumnTypes object describing the column types of this writer.

getTypeMetadata(self)

next(self)

Advance to the next row. If space is needed, it will be transparently allocated.

Returns True if there is space available to write more rows. Returns False otherwise.

setArray(self, col, value)

Write a list object into the the indicated zero-indexed column of the current row.

Returns None.

setBinary(self, col, value)

Write a bytes object into the indicated zero-indexed column of the current row.

Returns None.

setBool(self, col, value)

Write a boolean value into the indicated zero-indexed column of the current row.

Returns None.

setDate(self, col, value)

Write a datetime.datetime or datetime.date object into the indicated zero-indexed column of the current row.

Returns None.

setFloat(self, col, value)

Write a float value into the indicated zero-indexed column of the current row.

Returns None.

setHook(self, col)

setInt(self, col, value)

Write an int value into the indicated zero-indexed column of the current row.

Returns None.

setInterval(self, col, value)

Write a datetime.timedelta object into the indicated zero-indexed column of the current row.

Returns None.

setIntervalYM(self, col, value)

Write a datetime.timedelta object into the indicated zero-indexed column of the current row.

Returns None.

setNull(self, col)

Set the indicated zero-indexed column of the current row to NULL.

Returns None.

setNumeric(self, col, value)

Write a decimal.Decimal object into the indicated zero-indexed column of the current row.

Returns None.

setRow(self, col, value)

Write row data into the indicated zero-indexed column of the current row. Supported input value formats are:

  • tuple, where each entry corresponds to a field in its corresponding field order
  • dict or collections.OrderedDict, where each key-value pair maps field name to field value

Returns None.

setString(self, col, value)

Write a str object into the indicated zero-indexed column of the current row.

Returns None.

setTime(self, col, value)

Write a datetime.time object (with datetime.tzinfo) into the indicated zero-indexed column of the current row.

Returns None.

setTimeTz(self, col, value)

Write a datetime.time object into the indicated zero-indexed column of the current row.

Returns None.

setTimestamp(self, col, value)

Write a datetime.datetime object with appropriate time-zone awareness into the indicated zero-indexed column of the current row.

Returns None.

setTimestampTz(self, col, value)

Alias for setTimestamp().

4.15 - PerColumnParamReader

class vertica_sdk.PerColumnParamReader

Provides vertica_sdk.ParamReader objects for column-specific parameters provided in a COPY statement.

containsColumns(self, columnName)

Returns True if any parameters have been provided for the column columnName and False otherwise.

getColumnNames(self)

Returns a list of all columns with parameters.

getColumnParamReader(self, columnName)

Returns a vertica_sdk.ParamReader object containing parameters for the column columnName.

4.16 - PlanContext

class vertica_sdk.PlanContext

Stores query plan state for sharing values between different methods of a vertica_sdk.UDXFactory possibly on different nodes.

getClusterNodes(self)

Returns a list containing the name of each node in the cluster.

getReader(self)

Returns a vertica_sdk.ParamReader view for stored parameters.

getWriter(self)

Returns a vertica_sdk.ParamWriter for modifying the parameter context.

4.17 - RejectedRecord

class vertica_sdk.RejectedRecord

Contains information about a record rejected by a user-defined Parser.

getData

Returns the rejected record data.

getReason

Returns the reason the record was rejected.

getTerminator

Returns a terminator for the rejected record data.

4.18 - ScalarFunction

class vertica_sdk.ScalarFunction

Interface for a user-defined scalar function. A scalar function produces a single value for each row of input data.

destroy

Perform per instance destruction.

processBlock

Invoke the scalar function on a batch of rows contained in arg_reader, a vertica_sdk.BlockReader object.

Output is written to res_writer, a vertica_sdk.BlockWriter object.

setup

Perform per instance initialization.

4.19 - ScalarFunctionFactory

class vertica_sdk.ScalarFunctionFactory

classmethod createScalarFunction(cls, server_interface)

Create and return an instance of the associated vertica_sdk.ScalarFunction class for query execution.

Parameters for this function can be read from the server_interface argument (a vertica_sdk.ServerInterface object).

This may be called more than once per query.

classmethod getUDXFactoryType(cls)

Returns vertica_sdk.UDXType.SCALAR.

strictness = 0

volatility = 0

4.20 - Search

Please activate JavaScript to enable the search functionality.

From here you can search these documents. Enter your search words into the box below and click "search". Note that the search function will automatically search for all of the words. Pages containing fewer words won't appear in the result list.

4.21 - ServerInterface

class vertica_sdk.ServerInterface

getDatabaseName(self)

Returns the name of the database in which this code is executed.

getLocale(self)

Returns the locale of the current session.

getNodeName(self)

Returns the name of the vertica node on which this code is executed.

getParamReader(self)

Allows the ability to access parameter values using their names.

Returns a vertica_sdk.ParamReader containing named parameters for a UDX.

getUDSessionParamReader(self, nsp)

Returns a vertica_sdk.ParamReader for a user-defined session parameter namespace.

getUserName(self)

Returns the username of the current session.

log(self, message)

Logs a message.

Returns None.

reportError(self, code, text, hint=u'', detail=u'')

reportInfo(self, code, text, hint=u'', detail=u'')

reportNotice(self, code, text, hint=u'', detail=u'')

reportWarning(self, code, text, hint=u'', detail=u'')

4.22 - SessionParamWriterMap

class vertica_sdk.SessionParamWriterMap

Interface for writing user-defined session parameters.

containsNamespace(self, nsp)

Returns True if there is a namespace nsp and False otherwise.

getNamespaces(self)

Returns a list of all parameter namespaces.

getUDSessionParamWriter(self, nsp)

Returns a vertica_sdk.ParamWriter object corresponding to the namespace nsp.

4.23 - SizedColumnTypes

class vertica_sdk.SizedColumnTypes

Stores type metadata for a collection of columns.

Includes type mod information, such as string length and numeric percision information.

addArrayType(self, element, maxElems, fieldName=u'')

Adds an ARRAY-typed column with its element typed according to the ‘element’ argument.

Returns None.

addBinary(self, size, field_name=u'')

Adds a binary column to the list of columns.

Returns None.

addBinaryOrderColumn(self, size, field_name=u'')

Adds an order column of type BINARY

Returns None.

addBinaryPartitionColumn(self, size, field_name=u'')

Adds a partition column of type BINARY

Returns None.

addBool(self, field_name=u'')

Adds a bool column to the list of columns.

Returns None.

addBoolOrderColumn(self, field_name=u'')

Adds an order column of type BOOLEAN

Returns None.

addBoolPartitionColumn(self, field_name=u'')

Adds a partition column of type BOOLEAN

Returns None.

addChar(self, size, field_name=u'')

Adds a char column to the list of columns.

Returns None.

addCharOrderColumn(self, size, field_name=u'')

Adds an order column of type CHAR

Returns None.

addCharPartitionColumn(self, size, field_name=u'')

Adds a partition column of type CHAR

Returns None.

addColumn(self, vertica_type, field_name=u'')

Adds a column with the given vertica_sdk.VerticaType and name to the list of columns.

Returns None.

addDate(self, field_name=u'')

Adds a date column to the list of columns.

Returns None.

addDateOrderColumn(self, field_name=u'')

Adds an order column of type DATE

Returns None.

addDatePartitionColumn(self, field_name=u'')

Adds a partition column of type DATE

Returns None.

addFloat(self, field_name=u'')

Adds a float column to the list of columns.

Returns None.

addFloatOrderColumn(self, field_name=u'')

Adds an order column of type FLOAT

Returns None.

addFloatPartitionColumn(self, field_name=u'')

Adds a partition column of type FLOAT

Returns None.

addInt(self, field_name=u'')

Adds an int column to the list of columns.

Returns None.

addIntOrderColumn(self, field_name=u'')

Adds an order column of type INTEGER

Returns None.

addIntPartitionColumn(self, field_name=u'')

Adds a partition column of type INTEGER

Returns None.

addInterval(self, field_name=u'')

Adds a interval column to the list of columns.

Returns None.

addIntervalOrderColumn(self, field_name=u'')

Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND

Returns None.

addIntervalPartitionColumn(self, field_name=u'')

Adds a partition column of type INTERVAL/INTERVAL DAY TO SECOND

Returns None.

addIntervalYM(self, field_name=u'')

Adds a year-to-month interval column to the list of columns.

Returns None.

addIntervalYMOrderColumn(self, field_name=u'')

Adds an order column of type INTERVAL YEAR TO MONTH

Returns None.

addIntervalYMPartitionColumn(self, field_name=u'')

Adds a partition column of type INTERVAL YEAR TO MONTH

Returns None.

addLongVarbinary(self, size, field_name=u'')

Adds a long varbinary column to the list of columns.

Returns None.

addLongVarbinaryOrderColumn(self, size, field_name=u'')

Adds an order column of type LONG VARBINARY

Returns None.

addLongVarbinaryPartitionColumn(self, size, field_name=u'')

Adds a partition column of type LONG VARBINARY

Returns None.

addLongVarchar(self, size, field_name=u'')

Adds a long varchar column to the list of columns.

Returns None.

addLongVarcharOrderColumn(self, size, field_name=u'')

Adds an order column of type LONG VARCHAR

Returns None.

addLongVarcharPartitionColumn(self, size, field_name=u'')

Adds a partition column of type LONG VARCHAR

Returns None.

addNumeric(self, precision, scale, field_name=u'')

Adds a numeric column to the list of columns.

Returns None.

addNumericOrderColumn(self, precision, scale, field_name=u'')

Adds an order column of type NUMERIC

Returns None.

addNumericPartitionColumn(self, precision, scale, field_name=u'')

Adds a partition column of type NUMERIC

Returns None.

addOrderColumn(self, vertica_type, field_name=u'')

Adds an order column with the given vertica_sdk.VerticaType and name to the list of columns. (only relevant to multiphase UDTs.)

Returns None.

addPartitionColumn(self, vertica_type, field_name=u'')

Adds a partition column with the given vertica_sdk.VerticaType and name to the list of columns. (only relevant to multiphase UDTs.)

Returns None.

addRowType(self, fields, fieldName=u'')

Adds a ROW-typed column with its fields typed according to the ‘fields’ argument.

Returns None.

addTime(self, field_name=u'')

Adds a time column to the list of columns.

Returns None.

addTimeOrderColumn(self, field_name=u'')

Adds an order column of type TIME

Returns None.

addTimePartitionColumn(self, field_name=u'')

Adds a partition column of type TIME

Returns None.

addTimeTz(self, field_name=u'')

Adds a timetz column to the list of columns.

Returns None.

addTimeTzOrderColumn(self, field_name=u'')

Adds an order column of type TIME WITH TIMEZONE

Returns None.

addTimeTzPartitionColumn(self, field_name=u'')

Adds a partition column of type TIME WITH TIMEZONE

Returns None.

addTimestamp(self, field_name=u'')

Adds a timestamp column to the list of columns.

Returns None.

addTimestampOrderColumn(self, field_name=u'')

Adds an order column of type TIMESTAMP

Returns None.

addTimestampPartitionColumn(self, field_name=u'')

Adds a partition column of type TIMESTAMP

Returns None.

addTimestampTz(self, field_name=u'')

Adds a timestamptz column to the list of columns.

Returns None.

addTimestampTzOrderColumn(self, field_name=u'')

Adds an order column of type TIMESTAMP WITH TIMEZONE

Returns None.

addTimestampTzPartitionColumn(self, field_name=u'')

Adds a partition column of type TIMESTAMP WITH TIMEZONE

Returns None.

addUuid(self, field_name=u'')

Adds a column of type UUID

Returns None.

addUuidOrderColumn(self, field_name=u'')

Adds an order column of type UUID

Returns None.

addVarbinary(self, size, field_name=u'')

Adds a varbinary column to the list of columns.

Returns None.

addVarbinaryOrderColumn(self, size, field_name=u'')

Adds an order column of type VARBINARY

Returns None.

addVarbinaryPartitionColumn(self, size, field_name=u'')

Adds a partition column of type VARBINARY

Returns None.

addVarchar(self, size, field_name=u'')

Adds a varchar column to the list of columns.

Returns None.

addVarcharOrderColumn(self, size, field_name=u'')

Adds an order column of type VARCHAR

Returns None.

addVarcharPartitionColumn(self, size, field_name=u'')

Adds a partition column of type VARCHAR

Returns None.

copyTypesFrom(self, other)

Appends the types from the provided vertica_sdk.SizedColumnTypes onto the current one.

Returns None.

getArgumentColumns(self)

Returns indexes of argument columns. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(idx) and getColumnName(idx).

getColumnCount(self)

Returns the number of columns.

getColumnName(self, idx)

Returns the name of the indicated column.

getColumnType(self, idx)

Returns a vertica_sdk.VerticaType object describing the SQL type of the indicated column.

getLastOrderColumnIdx(self)

Gets the last ORDER BY column index For example, it returns 5 in case of OVER(PARTITION BY a, b, c ORDER BY d, e, f).

getLastPartitionColumnIdx(self)

Gets the last PARTITION BY column index For example, it returns 2 in case of OVER(PARTITION BY a, b, c ORDER BY d, e, f).

getOrderByColumns(self)

Returns indexes of ORDER BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(idx) and getColumnName(idx).

getPartitionByColumns(self)

Returns indexes of PARTITION BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(idx) and getColumnName(idx).

isOrderByColumn(self, idx)

Returns a boolean indicating whether the column at the specified index is an ORDER BY column.

isPartitionByColumn(self, idx)

Returns a boolean indicating whether the column at the specified index is a PARTITION BY column.

static makeArrayType(element, maxElems, fieldName=u'')

static makeBinary(size, field_name=u'')

static makeBool(field_name=u'')

static makeChar(size, field_name=u'')

static makeDate(field_name=u'')

static makeEmpty()

static makeFloat(field_name=u'')

static makeInt(field_name=u'')

static makeInterval(field_name=u'')

static makeIntervalYM(field_name=u'')

static makeLongVarbinary(size, field_name=u'')

static makeLongVarchar(size, field_name=u'')

static makeNumeric(precision, scale, field_name=u'')

static makeRowType(fields, fieldName=u'')

static makeTime(field_name=u'')

static makeTimeTz(field_name=u'')

static makeTimestamp(field_name=u'')

static makeTimestampTz(field_name=u'')

static makeUuid(field_name=u'')

static makeVarbinary(size, field_name=u'')

static makeVarchar(size, field_name=u'')

reset(self)

INTERNAL

setPartitionOrderColumnIdx(self, partition_idx, order_idx)

Sets the PARTITION BY and ORDER BY column indexes.

Returns None.

4.24 - StreamState

class vertica_sdk.StreamState

State of stream processing.

UDX methods which process a vertica_sdk.InputBuffer return this state to Vertica to indicate how stream processing should proceed.

INPUT_NEEDED More input data is required to continue processing the stream.

OUTPUT_NEEDED More output space is needed to continue processing the stream.

DONE Stream processing has completed.

REJECT(rejected_record)

Data from the stream is invalid. rejected_record should be a vertica_sdk.RejectedRecord object.

KEEP_GOING Stream processing must block before consuming any more input or producing any more output.

CHUNK_ALIGNED A block boundary has been identified.

4.25 - StreamWriter

class vertica_sdk.StreamWriter

Iterator-based write interface for producing a stream of output tuples. Automatically makes space a block at a time, as needed.

findUnsetColumn(self)

getArrayWriter(self, col)

Returns a vertica_sdk.ArrayWriter object used to write array data to the indicated zero-indexed column of the current row.

getNumCols(self)

Returns the number of columns held by this writer.

getRowWriter(self, col)

Returns a vertica_sdk.RowWriter objects used to write row data to the indicated zero-indexed field of this row.

getTotalRowCount(self)

Returns the total number of rows written.

getTypeMetadata(self)

Returns a vertica_sdk.SizedColumnTypes object describing the column types of this writer.

next(self)

Advance to the next row. If space is needed, it will be transparently allocated.

Returns True if there is space available to write more rows. Returns False otherwise.

setArray(self, col, value)

Write a list object into the the indicated zero-indexed column of the current row.

Returns None.

setBinary(self, idx, value)

Write a bytes object into the indicated zero-indexed column of the current row.

Returns None.

setBool(self, idx, value)

Write a boolean value into the indicated zero-indexed column of the current row.

Returns None.

setDate(self, idx, value)

Write a datetime.datetime or datetime.date object into the indicated zero-indexed column of the current row.

Returns None.

setFloat(self, idx, value)

Write a float value into the indicated zero-indexed column of the current row.

Returns None.

setHook(self, col)

setInt(self, idx, value)

Write an int value into the indicated zero-indexed column of the current row.

Returns None.

setInterval(self, idx, value)

Write a datetime.timedelta object into the indicated zero-indexed column of the current row.

Returns None.

setIntervalYM(self, idx, value)

Write a datetime.timedelta object into the indicated zero-indexed column of the current row.

Returns None.

setNull(self, idx)

Set the indicated zero-indexed column of the current row to NULL.

Returns None.

setNumeric(self, idx, value)

Write a decimal.Decimal object into the indicated zero-indexed column of the current row.

Returns None.

setRow(self, col, value)

Write row data into the indicated zero-indexed column of the current row. Supported input value formats are:

  • tuple, where each entry corresponds to a field in its corresponding field order
  • dict or collections.OrderedDict, where each key-value pair maps field name to field value

Returns None.

setString(self, idx, value)

Write a str into the indicated zero-indexed column of the current row.

Returns None.

setTime(self, idx, value)

Write a datetime.time object (with tzinfo) into the indicated zero-indexed column of the current row.

Returns None.

setTimeTz(self, idx, value)

Write a datetime.time object into the indicated zero-indexed column of the current row.

Returns None.

setTimestamp(self, idx, value)

Write a datetime.datetime object with appropriate time-zone awareness into the indicated zero-indexed column of the current row.

Returns None.

setTimestampTz(self, idx, value)

Alias for setTimestamp().

4.26 - TransformFunction

class vertica_sdk.TransformFunction

Interface for a user-defined transform function. A transform function operates on a table segment and returns zero or more rows of data.

processPartition

Invoke the transform function on a set of rows contained in partition_reader, a vertica_sdk.PartitionReader object. Each call processes an entire partition of rows.

Output is written to partition_writer, a vertica_sdk.PartitionWriter object.

4.27 - TransformFunctionFactory

class vertica_sdk.TransformFunctionFactory

Interface for declaring parameters and return types for, and instantiating, an associated vertica_sdk.TransformFunction.

classmethod createTransformFunction(cls, server_interface)

Create and return an instance of the associated vertica_sdk.TransformFunction class for query execution.

Parameters for this function can be read from the server_interface argument (a vertica_sdk.ServerInterface object).

This method is called after query local planning, just before execution begins. It may be called more than once per query.

classmethod getUDXFactoryType(cls)

Returns vertica_sdk.UDXType.TRANSFORM.

4.28 - TransformFunctionPhase

class vertica_sdk.TransformFunctionPhase

Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function.

classmethod createTransformFunction(cls, server_interface)

Create and return an instance of the associated vertica_sdk.TransformFunction class for execution of this phase.

Parameters for this function can be read from the server_interface argument (a vertica_sdk.ServerInterface object).

getReturnType

Report, via the vertica_sdk.SizedColumnTypes argument return_types, the concrete return types of this UDX.

Returns None.

isPrepass

Returns the prepass status of this phase

setPrepass

Indicates that this phase is a pre-pass and runs on local data (i.e., runs before any data movement)

Note Only the first phase of a multi-phase transform function can be marked as prepass. When it is not marked as prepass and the OVER clause contains no PARTITION BY, the input data is moved to initiator before running the first phase.

4.29 - UDFilter

class vertica_sdk.UDFilter

Transforms a stream of raw input data.

destroy

Performs any per-stream deinitialization.

Session parameters can be persisted using udSessionParams, a vertica_sdk.SessionParamWriterMap object.

Returns None.

process

Read data from input (a vertica_sdk.InputBuffer object) and write data to output (a vertica_sdk.OutputBuffer object).

Returns a vertica_sdk.StreamState to indicate the state of stream processing.

setup

Performs any per-stream initialization.

Returns None.

4.30 - UDParser

class vertica_sdk.UDParser

Transforms a stream of raw input data into tuples.

destroy

Performs any per-stream deinitialization.

Session parameters can be persisted using udSessionParams, a vertica_sdk.SessionParamWriterMap object.

Returns None.

process

Read data from input (a vertica_sdk.InputBuffer object) and write tuples to stream_writer (a vertica_sdk.StreamWriter object).

Returns a vertica_sdk.StreamState to indicate the state of stream processing.

setup

Performs any per-stream initialization.

Returns None.

4.31 - UDXFactory

class vertica_sdk.UDXFactory

getParameterType

Report, via the vertica_sdk.SizedColumnTypes object parameterTypes, the names and types of parameters used by this UDX.

Returns None.

getPerInstanceResources

Request resources for each instance of the UDX class produced by this factory.

Returns a vertica_sdk.VResources object representing that request.

getPrototype

Report, via the vertica_sdk.ColumnTypes argument return_types, the return types of this UDX.

Returns None.

getReturnType

Report, via the vertica_sdk.SizedColumnTypes argument return_types, the concrete return types of this UDX.

Returns None.

classmethod getUDXFactoryType(cls)

Returns a string representing the type of this UDX.

4.32 - UDXObject

class vertica_sdk.UDXObject

Base class of all UDX types.

destroy

Perform per instance destruction.

setup

Perform per instance initialization.

4.33 - UDXType

The type of UDx instance a factory produces.

class vertica_sdk.UDXType

Namespace for holding type constants.

AGGREGATE = 'AGGREGATE'

ANALYTIC = 'ANALYTIC'

FILESYSTEM = 'FILESYSTEM'

INVALID_UDX = 'INVALID_UDX'

KEYMANAGER = 'KEYMANAGER'

LOAD_FILTER = 'LOAD_FILTER'

LOAD_PARSER = 'LOAD_PARSER'

LOAD_SOURCE = 'LOAD_SOURCE'

MULTI_TRANSFORM = 'MULTI_TRANSFORM'

SCALAR = 'SCALAR'

TRANSFORM = 'TRANSFORM'

TYPE = 'TYPE'

4.34 - VerticaType

class vertica_sdk.VerticaType

Stores column type metadata.

getArrayBound(self)

getElementType(self)

Returns the element type for this array type. Throws an exception on non-arrays.

getFieldName(self, idx)

Returns the name of the field at position idx for this row type. Throws an exception for non-rows.

getFieldType(self, idx)

Returns the field type at position idx for this row type. Throws an exception for non-rows.

getIntervalPrecision(self)

Returns the precision of this INTERVAL type.

No type checking is applied. Results for non-interval types are unspecified.

getIntervalRange(self)

Returns the range of this INTERVAL type as an int.

No type checking is applied. Results for non-interval types are unspecified.

getMaxSize(self)

Returns the maximum size, in bytes, of a data element of this type.

getNumFields(self)

Returns the number of fields in this ROW type. Throws an exception for non-rows.

getNumericFractional(self)

Returns the number of fractional digits (i.e. digits right of the decimal point) of this NUMERIC type.

No type checking is applied. Results for non-numeric types are unspecified.

getNumericIntegral(self)

Returns the number of integral digits (i.e. digits left of the decimal point) of this NUMERIC type.

No type checking is applied. Results for non-numeric types are unspecified.

getNumericPrecision(self)

Returns the precision of this NUMERIC type.

No type checking is applied. Results for non-numeric types are unspecified.

getNumericScale(self)

Returns the scale of this NUMERIC type.

No type checking is applied. Results for non-numeric types are unspecified.

getNumericWordCount(self)

Returns the number of words needed in memory to represent a value of this NUMERIC type.

No type checking is applied. Results for non-numeric types are unspecified.

getPrettyPrintStr(self)

Returns a human-readable string representing this type (including typemod).

getStringLength(self, check_type=True)

Returns the maximum length of an element of this string data type.

Raises an error if the type is not a string type.

getTimePrecision(self)

Returns the precision of this TIME type.

No type checking is applied. Results for non-time types are unspecified.

getTimestampPrecision(self)

Returns the precision of this TIMESTAMP type.

No type checking is applied. Results for non-timestamp types are unspecified.

getTypeMod(self)

Returns the typemod of this type.

getTypeOid(self)

Returns the OID of this type.

getTypeStr(self)

Returns a string representing the base data type that this type represents.

isArrayType(self)

Returns True if this is any array type (1D or complex), False otherwise.

isBinary(self)

Returns True if this type is BINARY and False otherwise.

isBool(self)

Returns True if this type is BOOLEAN and False otherwise.

isChar(self)

Returns True if this type is CHAR and False otherwise.

isComplexArrayType(self)

Returns True if this is a complex array type, False otherwise.

isComplexRowType(self)

Returns True if this is a complex row type, False otherwise.

isDate(self)

Returns True if this type is DATE and False otherwise.

isFloat(self)

Returns True if this type is FLOAT and False otherwise.

isInt(self)

Returns True if this type is INTEGER and False otherwise.

isInterval(self)

Returns True if this type is INTERVAL and False otherwise.

isIntervalYM(self)

Returns True if this type is INTERVAL YEAR TO MONTH and False otherwise.

isLongVarbinary(self)

Returns True if this type is LONG VARBINARY and False otherwise.

isLongVarchar(self)

Returns True if this type is LONG VARCHAR and False otherwise.

isNumeric(self)

Returns True if this type is NUMERIC and False otherwise.

isStringType(self)

Returns True if this is any string type, e.g. CHAR, VARCHAR, BINARY, VARBINARY.

isTime(self)

Returns True if this type is TIME and False otherwise.

isTimeTz(self)

Returns True if this type is TIME WITH TIMEZONE (TIMETZ) and False otherwise.

isTimestamp(self)

Returns True if this type is TIMESTAMP and False otherwise.

isTimestampTz(self)

Returns True if this type is TIMESTAMP WITH TIMEZONE (TIMESTAMPTZ) and False otherwise.

isUUID(self)

Returns True if this type is UUID and False otherwise.

isVarbinary(self)

Returns True if this type is VARBINARY and False otherwise.

isVarchar(self)

Returns True if this type is VARCHAR and False otherwise.

5 - JDBC API

The Vertica JDBC API is a Java client interface for connecting applications to Vertica and working with database data. Use the reference pages below when developing applications that use the Vertica JDBC driver.

For instructions on configuring and using the JDBC client, see Accessing Vertica with JDBC.

The reference is organized into packages and classes. Package pages group related API types, while class pages document constructors, methods, fields, and interfaces.

Classes

Browse all classes in the JDBC API:

Packages

Browse classes organized by package:

5.1 - Class Hierarchy

  • java.lang.Object

com.vertica.jdbc.common.BaseConnectionFactory

com.vertica.jdbc.common.AbstractDataSource (implements javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)

com.vertica.jdbc.hybrid.HybridAbstractDataSource

com.vertica.jdbc.DataSource (implements javax.sql.DataSource)

  • com.vertica.jdbc.common.AbstractDriver (implements java.sql.Driver)

com.vertica.jdbc.hybrid.HybridAbstractDriver

com.vertica.jdbc.Driver

  • com.vertica.dsi.dataengine.utilities.DSIMonthSpan (implements java.lang.Cloneable)

com.vertica.jdbc.VerticaYearMonthInterval (implements java.lang.Cloneable)

  • com.vertica.dsi.dataengine.utilities.DSITimeSpan (implements java.lang.Cloneable)

com.vertica.jdbc.VerticaDayTimeInterval (implements java.lang.Cloneable)

Interface Hierarchy

  • java.lang.AutoCloseable

java.sql.Connection (also extends java.sql.Wrapper)

com.vertica.jdbc.VerticaConnection

com.vertica.jdbc.kv.VerticaRoutableConnection

  • java.sql.Statement (also extends java.sql.Wrapper)

java.sql.PreparedStatement

com.vertica.jdbc.VerticaPreparedStatement

java.sql.Connection (also extends java.lang.AutoCloseable)

com.vertica.jdbc.VerticaConnection

com.vertica.jdbc.kv.VerticaRoutableConnection

  • java.sql.Statement (also extends java.lang.AutoCloseable)

java.sql.PreparedStatement

com.vertica.jdbc.VerticaPreparedStatement

Enum Hierarchy

  • java.lang.Object

java.lang.Enum (implements java.lang.Comparable, java.io.Serializable)

com.vertica.jdbc.kv.VGet.SortOrder

5.2 - Classes

5.3 - com.vertica.jdbc

  • Interface Description
    VerticaConnection This interface defines the public Vertica Analytic Database extensions to java.sql.Connection.
    VerticaDatabaseErrorInfo Exposes additional information about errors that occur on the database server.
    VerticaPreparedStatement This interface defines the public Vertica Analytic Database extensions to java.sql.Statement.
    VerticaStatement This interface defines the public Vertica Analytic Database extensions to java.sql.Statement.
  • Class Description
    DataSource
    Driver
    VerticaCopyStream A bulk loading utility that sends COPY FROM LOCAL STDIN data from a JDBC client to the Vertica database.
    VerticaDayTimeInterval The JDBC representation of the Vertica INTERVAL DAY TO SECOND type.
    VerticaTypes This class defines Vertica identifiers for data types Vertica supports but which are not represented in java.sql.types.
    VerticaYearMonthInterval The JDBC representation of the Vertica INTERVAL YEAR TO MONTH type.

5.4 - com.vertica.jdbc Class Hierarchy

Class Hierarchy

  • java.lang.Object

com.vertica.jdbc.common.BaseConnectionFactory

com.vertica.jdbc.common.AbstractDataSource (implements javax.sql.ConnectionPoolDataSource, javax.sql.DataSource)

com.vertica.jdbc.hybrid.HybridAbstractDataSource

com.vertica.jdbc.DataSource (implements javax.sql.DataSource)

  • com.vertica.jdbc.common.AbstractDriver (implements java.sql.Driver)

com.vertica.jdbc.hybrid.HybridAbstractDriver

com.vertica.jdbc.Driver

  • com.vertica.dsi.dataengine.utilities.DSIMonthSpan (implements java.lang.Cloneable)

com.vertica.jdbc.VerticaYearMonthInterval (implements java.lang.Cloneable)

  • com.vertica.dsi.dataengine.utilities.DSITimeSpan (implements java.lang.Cloneable)

com.vertica.jdbc.VerticaDayTimeInterval (implements java.lang.Cloneable)

Interface Hierarchy

  • java.lang.AutoCloseable

java.sql.Connection (also extends java.sql.Wrapper)

com.vertica.jdbc.VerticaConnection

  • java.sql.Statement (also extends java.sql.Wrapper)

java.sql.PreparedStatement

com.vertica.jdbc.VerticaPreparedStatement

java.sql.Connection (also extends java.lang.AutoCloseable)

com.vertica.jdbc.VerticaConnection

  • java.sql.Statement (also extends java.lang.AutoCloseable)

java.sql.PreparedStatement

com.vertica.jdbc.VerticaPreparedStatement

5.5 - com.vertica.jdbc.kv

  • Interface Description
    VerticaRoutableConnection Deprecated This feature is likely to stop working in a future release and to be removed as a result.
    VerticaRoutableExecutor Deprecated This feature is likely to stop working in a future release and to be removed as a result.
    VGet Deprecated This feature is likely to stop working in a future release and to be removed as a result.
  • Class Description
    VHash Deprecated This feature is likely to stop working in a future release and to be removed as a result.
  • Enum Description
    VGet.SortOrder Describes the ordering of result data.

5.6 - com.vertica.jdbc.kv Class Hierarchy

Class Hierarchy

  • java.lang.Object

com.vertica.jdbc.kv.VHash

Interface Hierarchy

  • java.lang.AutoCloseable

java.sql.Connection (also extends java.sql.Wrapper)

com.vertica.jdbc.VerticaConnection

com.vertica.jdbc.kv.VerticaRoutableConnection

java.sql.Connection (also extends java.lang.AutoCloseable)

com.vertica.jdbc.VerticaConnection

com.vertica.jdbc.kv.VerticaRoutableConnection

Enum Hierarchy

  • java.lang.Object

java.lang.Enum (implements java.lang.Comparable, java.io.Serializable)

com.vertica.jdbc.kv.VGet.SortOrder

5.7 - DataSource

  • java.lang.Object

  • com.vertica.jdbc.common.BaseConnectionFactory

  • com.vertica.jdbc.common.AbstractDataSource

  • com.vertica.jdbc.hybrid.HybridAbstractDataSource

  • com.vertica.jdbc.DataSource

  • All Implemented Interfaces: java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource

public class DataSource
extends com.vertica.jdbc.hybrid.HybridAbstractDataSource
implements javax.sql.DataSource

Field Summary

Fields inherited from class com.vertica.jdbc.common.BaseConnectionFactory

CONNECTION_LOCALE_KEY, s_Messages, URL_SEPARATOR

Constructor Summary

Constructor and Description
DataSource()

Method Summary

Modifier and Type Method and Description
boolean areBatchInsertsDirect() Get if batch inserts are direct for the data source.
java.lang.String getBackupServerNode() Get list of backup server nodes.
boolean getBinaryTransfer() Get whether or not connection uses binary transfer
java.lang.String getConnSettings() Returns the session initialization sql that will run when a connection is established.
java.lang.String getDatabase() Get the database for the data source.
boolean getDisableCopyLocal() Gets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled.
boolean getEnableRoutableQueries() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
boolean getFailOnMultiNodePlans() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
java.lang.String getHost() Get the host for the data source.
java.lang.String getHostNameVerifier() Get if TLS Mode for the data source.
java.lang.String getJAASConfigName() Gets the name of the JAAS configuration entry that will the driver will use when performing GSS authentication.
java.lang.String getKerberosHostName() Gets the host name portion of the kerberos service principal that identifies the Vertica server.
java.lang.String getKerberosServiceName() Gets the service name portion of the kerberos service principal that identifies the Vertica server.
java.lang.String getKeyStorePassword() Gets the password for the keystore file.
java.lang.String getKeyStorePath() Gets the path to the keystore file, or "" if not specified.
java.lang.String getLocale() Get the locale for the data source.
java.lang.String getLogDirectory() Gets the directory used to store log files
int getLoginNetworkTimeout() Get the LoginNetworkTimeout for the data source.
int getLoginNodeTimeout() Get the LoginNodeTimeout for the data source.
int getLoginTimeout() Get the login timeout for the data source.
com.vertica.support.LogLevel getLogLevel() Gets current level of logging
java.lang.String getLogNameSpace() Gets package that logging is restricted to
boolean getMarsEnabled()
int getMaxPooledConnections() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
int getMaxPooledConnectionsPerNode() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
int getMaxPooledConnectionUses() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
int getMetadataCacheLifetime() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
int getNetworkTimeout() Gets the current network timeout value.
int getNodeDownWaitTime() Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
java.lang.String getOAuthAccessToken() Gets the access token used for OAuth authentication.
java.lang.String getOAuthClientId() Gets the client ID used for OAuth authentication.
java.lang.String getOAuthClientSecret() Gets the client secret used for OAuth authentication.
java.lang.String getOAuthDiscoveryUrl() Gets the discovery url used to fetch the OAuth token endpoint.
java.lang.String getOAuthRefreshToken() Gets the refresh token used for OAuth authentication.
java.lang.String getOAuthScope() Gets the scope of the access request used for OAuth token refresh.
java.lang.String getOAuthTokenUrl() Gets the token url used for OAuth authentication.
java.util.logging.Logger getParentLogger() Get parent Logger of all the Loggers used by this data source.
short getPort() Get the port for the data source.
int getPortInt() Get the port for the data source as an inteter.
java.lang.String getPreferredAddressFamily() Gets the preferred address family type to be used when resolving hostnames.
long getResultBufferSize() Get the maximum size of the client side ResultSet cache for the data source.
java.lang.String getSearchPath() Get the schema search path for this data source.
java.lang.String getSessionLabel() Get the session label for the data source.
java.lang.String getSessionTimezone() Get the session timezone for the data source.
java.lang.String getSocketFactoryName() Get the custom socket factory name for the data source.
java.lang.String getSSLSocketFactoryName() Get the custom SSL socket factory name for the data source.
boolean getStreamingBatchInsert() Gets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used.
java.lang.String getTLSMode() Get TLS Mode for the data source.
int getTransactionIsolation() Get the transaction isolation for the data source.
java.lang.String getTrustStorePassword() Gets the password for the truststore file.
java.lang.String getTrustStorePath() Gets the path to the truststore file, or "" if not specified.
java.lang.String getUser() Get current user
boolean isAutoCommitOnByDefault() Get if autocommit is enabled by default for the data source.
boolean isReadOnly() Get if the data source is read only.
boolean isSslEnabled() Deprecated. getTLSMode method provide finer information.
boolean isWrapperFor(java.lang.Class iface)
void setAutoCommitOnByDefault(boolean isAutoCommit) Set if autocommit is enabled by default for the data source.
void setBackupServerNode(java.lang.String backupServerNode) Sets the list of backup server nodes for this data source.
void setBatchInsertsDirect(boolean isDirect) Deprecated. This method has been deprecated. WOS and moveout operations are no longer supported. All connections use direct batch insert.
void setBinaryTransfer(boolean enabled) Sets the flag that indicates whether or not to use binary transfer
void setConnectionLoadBalance(boolean useConnectionLoadBalance) Sets the flag that indicates whether or not to use native load balancing.
void setConnSettings(java.lang.String sql) ConnSettings are sql statements that the driver will execute when a connection is made.
void setDatabase(java.lang.String database) Set the database for the data source.
void setDisableCopyLocal(boolean disabled) Sets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled.
void setEnableRoutableQueries(boolean enabled) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
void setFailOnMultiNodePlans(boolean enabled) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
void setHost(java.lang.String host) Set the host for the data source.
void setHostNameVerifier(java.lang.String hvn) Set user defined HostnameVerifier.
void setJAASConfigName(java.lang.String name) Sets the name of the JAAS configuration entry that will be used when performing GSS-Kerberos authentication.
void setKerberosHostName(java.lang.String name) Sets the host name portion of the kerberos service principal that identifies the Vertica server.
void setKerberosServiceName(java.lang.String name) Sets the service name portion of the kerberos service principal that identifies the Vertica server.
void setKeyStorePassword(java.lang.String paramString) Sets the password protecting the keystore file.
void setKeyStorePath(java.lang.String paramString) Sets the path to a keystore file (typically in .jks format) to be used for TLS connections.
void setLocale(java.lang.String locale) Set the locale for the data source.
void setLogDirectory(java.lang.String paramString) Sets the directory used to store log files.
void setLoginNetworkTimeout(int timeout) Set the loginNetworkTimeout for the data source.
void setLoginNodeTimeout(int timeout) Set the loginNodeTimeout for the data source.
void setLoginTimeout(int loginTimeout) Set the login timeout for the data source.
void setLogLevel(java.lang.String paramString) Sets the log level Valid values: OFF (no logging) INFO WARNING TRACE ERROR DEBUG (most verbose) An invalid value will set log level to OFF
void setLogNameSpace(java.lang.String value) Sets the package that logging is restricted to.
void setMarsEnabled(boolean value)
void setMaxPooledConnections(int max) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
void setMaxPooledConnectionsPerNode(int max) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
void setMaxPooledConnectionUses(int uses) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
void setMetadataCacheLifetime(int lifetime) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
void setNetworkTimeout(int milliseconds) Sets the network timeout.
void setNodeDownWaitTime(int waitTime) Deprecated. This feature is likely to stop working in a future release and to be removed as a result.
void setOAuthAccessToken(java.lang.String accessToken) Sets the access token used for OAuth authentication.
void setOAuthClientId(java.lang.String clientId) Sets the client ID used for OAuth authentication.
void setOAuthClientSecret(java.lang.String clientSecret) Sets the client secret used for OAuth authentication.
void setOAuthDiscoveryUrl(java.lang.String discoveryUrl) Sets the discovery url used to fetch the OAuth token endpoint.
void setOAuthRefreshToken(java.lang.String refreshToken) Sets the refresh token used for OAuth authentication.
void setOAuthScope(java.lang.String scope) Sets the scope of the access request used for OAuth token refresh.
void setOAuthTokenUrl(java.lang.String tokenUrl) Sets the token url used for OAuth authentication.
void setPort(int port) Set the port for the data source as an integer.
void setPort(short port) Set the port for the data source.
void setPreferredAddressFamily(java.lang.String value) Sets the address family type to prefer when the driver resolves hostnames.
void setReadOnly(boolean readOnly) Set if the data source is read only.
void setResultBufferSize(long size) Set the maximum amount of data to cache in bytes when streaming ResultSet data.
void setSearchPath(java.lang.String searchPath) Sets the schema search path for this data source.
void setSessionLabel(java.lang.String label) Set the session label for the data source.
void setSessionTimezone(java.lang.String tz)
void setSocketFactoryName(java.lang.String socketFactoryName) Set the custom socket factory name for the data source.
void setSslEnabled(boolean isSslEnabled) Deprecated. setTLSMode provides finer grained control over the TLS connection process
void setSSLSocketFactoryName(java.lang.String sslSocketFactoryName) Set the custom SSL socket factory name for the data source.
void setStreamingBatchInsert(boolean enabled) Sets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used.
void setThreePartNaming(boolean useThreePartNaming) Set three part naming for the data source.
void setTLSMode(java.lang.String mode) Set TLS Mode for data source.
void setTrustStorePassword(java.lang.String paramString) Sets the password protecting the truststore file.
void setTrustStorePath(java.lang.String paramString) Sets the path to a truststore file (typically in .jks format) to be used for TLS connections.
void setUser(java.lang.String user) Sets the current user
T unwrap(java.lang.Class iface)
boolean useConnectionLoadBalance() Get whether or not connection load balancing is in use.
boolean useThreePartNaming() Get if three-part naming is used for the data source.

Methods inherited from class com.vertica.jdbc.common.AbstractDataSource

getConnection, getConnection, getCustomProperty, getLogWriter, getPassword, getPooledConnection, getPooledConnection, getUserID, initialize, removeCustomProperty, setCustomProperty, setLogWriter, setPassword, setURL, setUserID

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.sql.DataSource

getConnection, getConnection

Methods inherited from interface javax.sql.CommonDataSource

getLogWriter, setLogWriter

Constructor Detail

DataSource

public DataSource()

Method Detail

areBatchInsertsDirect

public boolean areBatchInsertsDirect()

Get if batch inserts are direct for the data source. Returns true if batch inserts go directly into the ROS for the data source.

getDatabase

public java.lang.String getDatabase()

Get the database for the data source. Returns The database for the data source.

getHost

public java.lang.String getHost()

Get the host for the data source. Returns The host for the data source.

getLocale

public java.lang.String getLocale()

Get the locale for the data source. Returns The locale for the data source.

getSessionTimezone

public java.lang.String getSessionTimezone()

Get the session timezone for the data source. Returns A string representing the timezone

getLoginTimeout

public int getLoginTimeout()

Get the login timeout for the data source.

Specified by getLoginTimeout in interface javax.sql.CommonDataSource Overrides getLoginTimeout in class com.vertica.jdbc.common.AbstractDataSource Returns The login timeout for the data source.

getLoginNetworkTimeout

public int getLoginNetworkTimeout()

Get the LoginNetworkTimeout for the data source. Returns The LoginNetworkTimeout for the data source.

getLoginNodeTimeout

public int getLoginNodeTimeout()

Get the LoginNodeTimeout for the data source. Returns The LoginNodeTimeout for the data source.

getSocketFactoryName

public java.lang.String getSocketFactoryName()

Get the custom socket factory name for the data source. Returns The custom socket factory name for the data source.

getSSLSocketFactoryName

public java.lang.String getSSLSocketFactoryName()

Get the custom SSL socket factory name for the data source. Returns The custom socket factory name for the data source.

getResultBufferSize

public long getResultBufferSize()

Get the maximum size of the client side ResultSet cache for the data source. Returns The maximum size of the client side ResultSet cache for the data source.

getPort

public short getPort()

Get the port for the data source. Returns The port for the data source.

getPortInt

public int getPortInt()

Get the port for the data source as an inteter. Returns The port for the data source.

isReadOnly

public boolean isReadOnly()

Get if the data source is read only. Returns true if the data source is read only.

getSearchPath

public java.lang.String getSearchPath()

Get the schema search path for this data source. Returns A comma separated list of schemas.

getSessionLabel

public java.lang.String getSessionLabel()

Get the session label for the data source. Returns The session label for the data source.

getTransactionIsolation

public int getTransactionIsolation()

Get the transaction isolation for the data source. Returns The transaction isolation for the data source.

isAutoCommitOnByDefault

public boolean isAutoCommitOnByDefault()

Get if autocommit is enabled by default for the data source. Returns true if autocommit is enabled by default for the data source.

isSslEnabled

public boolean isSslEnabled()

Deprecated. getTLSMode method provide finer information. Get if SSL is enabled for the data source. Returns true if SSL is enabled (>= Require in TLSMode) for the data source.

getTLSMode

public java.lang.String getTLSMode()

Get TLS Mode for the data source. Returns Currently support Disable, Require, Verify-ca and Verify-full.

getHostNameVerifier

public java.lang.String getHostNameVerifier()

Get if TLS Mode for the data source. Returns Hostname verifer in use, default value is com.vertica.security.VerticaHostnameVerifier.

useConnectionLoadBalance

public boolean useConnectionLoadBalance()

Get whether or not connection load balancing is in use. Returns true if connection load balancing is enabled for the data source.

getBackupServerNode

public java.lang.String getBackupServerNode()

Get list of backup server nodes. Returns Comma-separated list of backup server nodes for this data source.

getUser

public java.lang.String getUser()

Get current user Returns the current user

getParentLogger

public java.util.logging.Logger getParentLogger()
throws java.sql.SQLFeatureNotSupportedException

Get parent Logger of all the Loggers used by this data source.

Specified by getParentLogger in interface javax.sql.CommonDataSource Returns the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source Throws: java.sql.SQLFeatureNotSupportedException

setAutoCommitOnByDefault

public void setAutoCommitOnByDefault(boolean isAutoCommit)

Set if autocommit is enabled by default for the data source. Parameters:isAutoCommit - true if autocommit is enabled by default for the data source.

setBatchInsertsDirect

@Deprecated
public void setBatchInsertsDirect(boolean isDirect)

Deprecated. This method has been deprecated. WOS and moveout operations are no longer supported. All connections use direct batch insert. Set if batch inserts should go directly to the ROS for the data source. Parameters:isDirect - ignored

setDatabase

public void setDatabase(java.lang.String database)

Set the database for the data source. Parameters:database - The database for the data source.

setHost

public void setHost(java.lang.String host)

Set the host for the data source. Parameters:host - The host for the data source.

setLocale

public void setLocale(java.lang.String locale)

Set the locale for the data source. Parameters:locale - The locale for the data source.

setSessionTimezone

public void setSessionTimezone(java.lang.String tz)

setLoginTimeout

public void setLoginTimeout(int loginTimeout)

Set the login timeout for the data source.

Specified by setLoginTimeout in interface javax.sql.CommonDataSource Overrides setLoginTimeout in class com.vertica.jdbc.common.AbstractDataSource Parameters:loginTimeout - The login timeout for the data source.

setLoginNetworkTimeout

public void setLoginNetworkTimeout(int timeout)

Set the loginNetworkTimeout for the data source. Parameters:timeout - The loginNetworkTimeout for the data source.

setLoginNodeTimeout

public void setLoginNodeTimeout(int timeout)

Set the loginNodeTimeout for the data source. Parameters:timeout - The loginNodeTimeout for the data source.

setSSLSocketFactoryName

public void setSSLSocketFactoryName(java.lang.String sslSocketFactoryName)

Set the custom SSL socket factory name for the data source. If set, this must be the name of a class that extends javax.net.ssl.SSLSocketFactory with a zero-argument constructor that is available on the class path.

Typically the SSLSocketFactory will act as a wrapper for a raw socket, performing SSL/TLS encryption prior to forwarding the bytes to the underlying socket.

If also using a cusom socket factory (via setSocketFactoryName(String socketFactoryName)), then that factory will create the raw socket and this factory will be passed that raw socket for I/O. Parameters:sslSocketFactoryName - The custom SSL socket factory name for the data source.

setSocketFactoryName

public void setSocketFactoryName(java.lang.String socketFactoryName)

Set the custom socket factory name for the data source. If set, this must be the name of a class that extends javax.net.SocketFactory with a zero-argument constructor that is available on the class path. Parameters:socketFactoryName - The custom socket factory name for the data source.

setResultBufferSize

public void setResultBufferSize(long size)

Set the maximum amount of data to cache in bytes when streaming ResultSet data. Parameters:size - A number of bytes.

setPort

public void setPort(int port)

Set the port for the data source as an integer. Parameters:port - The port for the data source.

setPort

public void setPort(short port)

Set the port for the data source. Parameters:port - The port for the data source.

setReadOnly

public void setReadOnly(boolean readOnly)

Set if the data source is read only. Parameters:readOnly - true if the data source is read only.

setSessionLabel

public void setSessionLabel(java.lang.String label)

Set the session label for the data source. Parameters:label - The session label for the data source.

setSslEnabled

public void setSslEnabled(boolean isSslEnabled)

Deprecated. setTLSMode provides finer grained control over the TLS connection process Set if SSL is enabled for the data source. Parameters:isSslEnabled - true if SSL is enabled for the data source.

setTLSMode

public void setTLSMode(java.lang.String mode)

Set TLS Mode for data source. value >= Require will enable TLS/SSL. Parameters:mode - Currently support Disable, Require, Verify-ca and Verify-full.

setHostNameVerifier

public void setHostNameVerifier(java.lang.String hvn)

Set user defined HostnameVerifier. Only call this function when default hostnameverifier cannot fulfill the requirements. Parameters:hvn - String value of the customized hostnameverifier class location.

setThreePartNaming

public void setThreePartNaming(boolean useThreePartNaming)

Set three part naming for the data source. When enabled, metadata ResultSets containing a catalog column will report the database name as the catalog, rather than NULL. Parameters:useThreePartNaming - true if three-part naming is enabled for the data source.

setSearchPath

public void setSearchPath(java.lang.String searchPath)

Sets the schema search path for this data source. Parameters:searchPath - A comma separated list of schema names.

setBackupServerNode

public void setBackupServerNode(java.lang.String backupServerNode)

Sets the list of backup server nodes for this data source. Parameters:backupServerNode - A comma separated list of vertica servers (host:port[,host:port...])

setUser

public void setUser(java.lang.String user)

Sets the current user Parameters:user - current user

setConnectionLoadBalance

public void setConnectionLoadBalance(boolean useConnectionLoadBalance)

Sets the flag that indicates whether or not to use native load balancing. Parameters:useConnectionLoadBalance - true if native load balancing is enabled for the data source.

useThreePartNaming

public boolean useThreePartNaming()

Get if three-part naming is used for the data source. When enabled, metadata ResultSets containing a catalog column will report the database name as the catalog, rather than NULL. Returns true if three-part naming is enabled for the data source.

getJAASConfigName

public java.lang.String getJAASConfigName()

Gets the name of the JAAS configuration entry that will the driver will use when performing GSS authentication. Returns A JAAS configuration name

setJAASConfigName

public void setJAASConfigName(java.lang.String name)

Sets the name of the JAAS configuration entry that will be used when performing GSS-Kerberos authentication.

The driver relies on JAAS to acquire a kerberos ticket-granting-ticket when the database server requests that the client uses GSS authentication. The JAAS configuration identified by this name can be used to customize this process. Parameters:name - The name of a configuration entry in a JAAS configuration file.

getKerberosServiceName

public java.lang.String getKerberosServiceName()

Gets the service name portion of the kerberos service principal that identifies the Vertica server. Returns The Vertica server's kerberos service name.

setKerberosServiceName

public void setKerberosServiceName(java.lang.String name)

Sets the service name portion of the kerberos service principal that identifies the Vertica server.

When the Vertica server requests that the client uses GSS authentication, the client uses this name to request a kerberos service ticket. The value of this property should match the database's KerberosServiceName config parameter. Parameters:name - The Vertica server's kerberos service name.

getKerberosHostName

public java.lang.String getKerberosHostName()

Gets the host name portion of the kerberos service principal that identifies the Vertica server. Returns The Vertica server's kerberos host name.

setKerberosHostName

public void setKerberosHostName(java.lang.String name)

Sets the host name portion of the kerberos service principal that identifies the Vertica server.

When the Vertica server requests that the client uses GSS authentication, the client uses this name to request a kerberos service ticket. The value of this property should match the database's KerberosHostName config parameter. Parameters:name - The Vertica server's kerberos host name.

getOAuthAccessToken

public java.lang.String getOAuthAccessToken()

Gets the access token used for OAuth authentication. Returns The client's access token.

setOAuthAccessToken

public void setOAuthAccessToken(java.lang.String accessToken)

Sets the access token used for OAuth authentication. Parameters:accessToken - The client's access token.

getOAuthRefreshToken

public java.lang.String getOAuthRefreshToken()

Gets the refresh token used for OAuth authentication. Returns The client's refresh token.

setOAuthRefreshToken

public void setOAuthRefreshToken(java.lang.String refreshToken)

Sets the refresh token used for OAuth authentication. Parameters:refreshToken - The client's refresh token.

getOAuthTokenUrl

public java.lang.String getOAuthTokenUrl()

Gets the token url used for OAuth authentication. Returns The client's token url.

setOAuthTokenUrl

public void setOAuthTokenUrl(java.lang.String tokenUrl)

Sets the token url used for OAuth authentication. Parameters:tokenUrl - The client's token url.

getOAuthClientId

public java.lang.String getOAuthClientId()

Gets the client ID used for OAuth authentication. Returns The client's ID.

setOAuthClientId

public void setOAuthClientId(java.lang.String clientId)

Sets the client ID used for OAuth authentication. Parameters:clientId - The client's ID.

getOAuthClientSecret

public java.lang.String getOAuthClientSecret()

Gets the client secret used for OAuth authentication. Returns The client's secret.

setOAuthClientSecret

public void setOAuthClientSecret(java.lang.String clientSecret)

Sets the client secret used for OAuth authentication. Parameters:clientSecret - The client's secret.

getOAuthDiscoveryUrl

public java.lang.String getOAuthDiscoveryUrl()

Gets the discovery url used to fetch the OAuth token endpoint. Returns The client's discovery url.

setOAuthDiscoveryUrl

public void setOAuthDiscoveryUrl(java.lang.String discoveryUrl)

Sets the discovery url used to fetch the OAuth token endpoint. Parameters:discoveryUrl - The client's discovery url.

getOAuthScope

public java.lang.String getOAuthScope()

Gets the scope of the access request used for OAuth token refresh. Returns The scope of the access request used for OAuth token refresh.

setOAuthScope

public void setOAuthScope(java.lang.String scope)

Sets the scope of the access request used for OAuth token refresh. Parameters:scope - The scope of the access request used for OAuth token refresh.

getStreamingBatchInsert

public boolean getStreamingBatchInsert()

Gets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used. Returns true if batches are stored in memory, false if they are sent to the server immediately

setStreamingBatchInsert

public void setStreamingBatchInsert(boolean enabled)

Sets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used. Parameters:enabled - True to store batches in memory, false to send them to the server immediately

getDisableCopyLocal

public boolean getDisableCopyLocal()

Gets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled. Returns true if file-based COPY LOCAL operations are disabled

setDisableCopyLocal

public void setDisableCopyLocal(boolean disabled)

Sets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled. Parameters:disabled - True to disable file-based COPY LOCAL operations

getBinaryTransfer

public boolean getBinaryTransfer()

Get whether or not connection uses binary transfer Returns true if binary transfer is enabled

setBinaryTransfer

public void setBinaryTransfer(boolean enabled)

Sets the flag that indicates whether or not to use binary transfer Parameters:enabled - True if binary transfer should be enabled

setConnSettings

public void setConnSettings(java.lang.String sql)

ConnSettings are sql statements that the driver will execute when a connection is made. This is typically used to initialize session variables automatically with each connection. Parameters:sql - Semicolon-delimited sql statements that run when a connection is established.

getConnSettings

public java.lang.String getConnSettings()

Returns the session initialization sql that will run when a connection is established. If no ConnSettings was specified, "" is returned. Returns Semicolon-delimited sql thats that run when a connection is established.

getEnableRoutableQueries

@Deprecated
public boolean getEnableRoutableQueries()

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Get if VerticaRoutableConnections are returned by the data source. Returns true if VerticaRoutableConnections are returned.

setEnableRoutableQueries

@Deprecated
public void setEnableRoutableQueries(boolean enabled)

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Set if VerticaRoutableConnections are returned by the data source. Parameters:enabled - true to enable VerticaRoutableConnections

getFailOnMultiNodePlans

@Deprecated
public boolean getFailOnMultiNodePlans()

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Get if non-local plans are allowed in VGet operations.

Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Returns true if non-local plans are allowed.

setFailOnMultiNodePlans

@Deprecated
public void setFailOnMultiNodePlans(boolean enabled)

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Get if non-local plans are allowed in VGet operations. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Parameters:enabled - true to allow non-local plans, false to disable.

setMaxPooledConnectionUses

@Deprecated
public void setMaxPooledConnectionUses(int uses)

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Set the maximum number times to use a pooled connection before closing it. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Parameters:uses - The maximum number of times to use a pooled connection.

getMaxPooledConnectionUses

@Deprecated
public int getMaxPooledConnectionUses()

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the maximum number times to use a pooled connection before closing it. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Returns The maximum number of times to use a pooled connection.

setMaxPooledConnections

@Deprecated
public void setMaxPooledConnections(int max)

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Set the maximum number of pooled connections. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Parameters:max - The maximum number of pooled connections allowed open at a time.

getMaxPooledConnections

@Deprecated
public int getMaxPooledConnections()

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the maximum number of pooled connections. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Returns The maximum number pooled connections allowed open at a time.

setMaxPooledConnectionsPerNode

@Deprecated
public void setMaxPooledConnectionsPerNode(int max)

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Set the maximum number of pooled connections per node. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Parameters:max - The maximum number of pooled connections to a single node allowed open at a time.

getMaxPooledConnectionsPerNode

@Deprecated
public int getMaxPooledConnectionsPerNode()

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the maximum number of pooled connections per node. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Returns The maximum number pooled connections to a single node allowed at a time.

getMetadataCacheLifetime

@Deprecated
public int getMetadataCacheLifetime()

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the number of seconds to reuse table and projection metadata during VGet operations. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Returns Amount of time in seconds to keep metadata cached.

setMetadataCacheLifetime

@Deprecated
public void setMetadataCacheLifetime(int lifetime)

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Sets the number of seconds to reuse table and projection metadata during VGet operations. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Parameters:lifetime - Amount of time in seconds to keep metadata cached.

getNodeDownWaitTime

@Deprecated
public int getNodeDownWaitTime()

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Gets the number of seconds to wait before attempting a new connection to a node after detecting a connection failure. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Returns Amount of time in seconds to wait before attempting another connection to a node.

setNodeDownWaitTime

@Deprecated
public void setNodeDownWaitTime(int waitTime)

Deprecated. This feature is likely to stop working in a future release and to be removed as a result. Sets the number of seconds to wait before attempting a new connection to a node after detecting a connection failure. Only has an effect on VerticaRoutableConnections, i.e. when getEnableRoutableQueries() returns true. Parameters:waitTime - Amount of time in seconds to wait before attempting another connection to a node.

setPreferredAddressFamily

public void setPreferredAddressFamily(java.lang.String value)

Sets the address family type to prefer when the driver resolves hostnames.

When set to to "ipv6" the driver will attempt to use IPv6 type AAAA DNS records before IPv4 type A DNS records. When set to "ipv4", the driver will use IPv4 type A DNS records first.

When set to "none" (the default), the driver will take no preference, and instead use the records in the order returned by the JRE. Parameters:value - The preferred address family to use. One of "ipv6", "ipv4" or "none"

getPreferredAddressFamily

public java.lang.String getPreferredAddressFamily()

Gets the preferred address family type to be used when resolving hostnames. Returns The preferred address family type for the data source.

setMarsEnabled

public void setMarsEnabled(boolean value)

getMarsEnabled

public boolean getMarsEnabled()

getLogNameSpace

public java.lang.String getLogNameSpace()

Gets package that logging is restricted to Returns Namespace for logging

setNetworkTimeout

public void setNetworkTimeout(int milliseconds)

Sets the network timeout. Valid values:

≥= 0

Parameters:

milliseconds - The network timeout value for the current connection in milliseconds

getNetworkTimeout

public int getNetworkTimeout()

Gets the current network timeout value. Returns Network timeout value in milliseconds

setLogNameSpace

public void setLogNameSpace(java.lang.String value)

Sets the package that logging is restricted to. Valid values:

com.vertica (all messages generated by the JDBC driver)

  • com.vertica.jdbc (all messages generated by the top-level JDBC API)

  • com.vertica.jdbc.core (connection and statement settings)

  • com.vertica.jdbc.io (client/server protocol messages)

  • com.vertica.jdbc.util (miscellaneous utilities)

  • com.vertica.jdbc.dataengine (query execution and result set iteration).

Parameters:

value - Namespace for logging

setLogLevel

public void setLogLevel(java.lang.String paramString)

Sets the log level Valid values:

OFF (no logging)

  • INFO

  • WARNING

  • TRACE

  • ERROR

  • DEBUG (most verbose)

An invalid value will set log level to OFF

Overrides setLogLevel in class com.vertica.jdbc.common.AbstractDataSource

Parameters:

paramString - String indicating the log level. Can also be numbers 1 to 6

getLogLevel

public com.vertica.support.LogLevel getLogLevel()

Gets current level of logging

Overrides getLogLevel in class com.vertica.jdbc.common.AbstractDataSource Returns The level of logging

setLogDirectory

public void setLogDirectory(java.lang.String paramString)

Sets the directory used to store log files. The directory will be created if it does not exist.

Overrides setLogDirectory in class com.vertica.jdbc.common.AbstractDataSource Parameters:paramString - String indicating the directory to log to

getLogDirectory

public java.lang.String getLogDirectory()

Gets the directory used to store log files

Overrides getLogDirectory in class com.vertica.jdbc.common.AbstractDataSource Returns The log directory

setKeyStorePath

public void setKeyStorePath(java.lang.String paramString)

Sets the path to a keystore file (typically in .jks format) to be used for TLS connections. If not specified, the JVM-global keystore is used. Parameters:paramString - String with a path to a keystore file

getKeyStorePath

public java.lang.String getKeyStorePath()

Gets the path to the keystore file, or "" if not specified. Returns The path to the keystore file

setTrustStorePath

public void setTrustStorePath(java.lang.String paramString)

Sets the path to a truststore file (typically in .jks format) to be used for TLS connections. If not specified, the JVM-global truststore is used. Parameters:paramString - String with a path to a truststore file

getTrustStorePath

public java.lang.String getTrustStorePath()

Gets the path to the truststore file, or "" if not specified. Returns The path to the truststore file

setTrustStorePassword

public void setTrustStorePassword(java.lang.String paramString)

Sets the password protecting the truststore file. Only used if a custom truststore path is specified. Parameters:paramString - The password to the truststore file

getTrustStorePassword

public java.lang.String getTrustStorePassword()

Gets the password for the truststore file. Returns The password for the truststore file.

setKeyStorePassword

public void setKeyStorePassword(java.lang.String paramString)

Sets the password protecting the keystore file. Only used if a custom keystore path is specified. If both the keystore and the keys within the keystore are password protected, they must use the same password specified here. Parameters:paramString - The password to the keystore file

getKeyStorePassword

public java.lang.String getKeyStorePassword()

Gets the password for the keystore file. Returns The password for the keystore file.

unwrap

public  T unwrap(java.lang.Class iface)
throws java.sql.SQLException

Specified by unwrap in interface java.sql.Wrapper Overrides unwrap in class com.vertica.jdbc.common.AbstractDataSource Throws: java.sql.SQLException

isWrapperFor

public boolean isWrapperFor(java.lang.Class iface)
throws java.sql.SQLException

Specified by isWrapperFor in interface java.sql.Wrapper Overrides isWrapperFor in class com.vertica.jdbc.common.AbstractDataSource Throws: java.sql.SQLException

5.8 - Deprecated List

  • Interface and Description
    com.vertica.jdbc.kv.VerticaRoutableConnection This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.kv.VerticaRoutableExecutor This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.kv.VGet This feature is likely to stop working in a future release and to be removed as a result.
  • Class and Description
    com.vertica.jdbc.kv.VHash This feature is likely to stop working in a future release and to be removed as a result.
  • Field and Description
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_DAY superseded by VerticaTypes.INTERVAL_DAY
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_DAY_TO_HOUR superseded by VerticaTypes.INTERVAL_DAY_TO_HOUR
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_DAY_TO_MINUTE superseded by VerticaTypes.INTERVAL_DAY_TO_MINUTE
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_DAY_TO_SECOND superseded by VerticaTypes.INTERVAL_DAY_TO_SECOND
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_HOUR superseded by VerticaTypes.INTERVAL_HOUR
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_HOUR_TO_MINUTE superseded by VerticaTypes.INTERVAL_HOUR_TO_MINUTE
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_HOUR_TO_SECOND superseded by VerticaTypes.INTERVAL_HOUR_TO_SECOND
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_MINUTE superseded by VerticaTypes.INTERVAL_MINUTE
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_MINUTE_TO_SECOND superseded by VerticaTypes.INTERVAL_MINUTE_TO_SECOND
    com.vertica.jdbc.VerticaYearMonthInterval.INTERVAL_MONTH superseded by VerticaTypes.INTERVAL_MONTH
    com.vertica.jdbc.VerticaDayTimeInterval.INTERVAL_SECOND superseded by VerticaTypes.INTERVAL_SECOND
    com.vertica.jdbc.VerticaYearMonthInterval.INTERVAL_YEAR superseded by VerticaTypes.INTERVAL_YEAR
    com.vertica.jdbc.VerticaYearMonthInterval.INTERVAL_YEAR_TO_MONTH superseded by VerticaTypes.INTERVAL_YEAR_TO_MONTH
  • Method and Description
    com.vertica.jdbc.DataSource.getEnableRoutableQueries() This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.getFailOnMultiNodePlans() This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.getMaxPooledConnections() This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.getMaxPooledConnectionsPerNode() This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.getMaxPooledConnectionUses() This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.getMetadataCacheLifetime() This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.getNodeDownWaitTime() This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.isSslEnabled() getTLSMode method provide finer information.
    com.vertica.jdbc.DataSource.setBatchInsertsDirect(boolean) This method has been deprecated. WOS and moveout operations are no longer supported. All connections use direct batch insert.
    com.vertica.jdbc.DataSource.setEnableRoutableQueries(boolean) This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.setFailOnMultiNodePlans(boolean) This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.setMaxPooledConnections(int) This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.setMaxPooledConnectionsPerNode(int) This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.setMaxPooledConnectionUses(int) This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.setMetadataCacheLifetime(int) This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.setNodeDownWaitTime(int) This feature is likely to stop working in a future release and to be removed as a result.
    com.vertica.jdbc.DataSource.setSslEnabled(boolean) setTLSMode provides finer grained control over the TLS connection process

5.9 - Driver

  • java.lang.Object

  • com.vertica.jdbc.common.BaseConnectionFactory

  • com.vertica.jdbc.common.AbstractDriver

  • com.vertica.jdbc.hybrid.HybridAbstractDriver

  • com.vertica.jdbc.Driver

  • All Implemented Interfaces: java.sql.Driver

public class Driver
extends com.vertica.jdbc.hybrid.HybridAbstractDriver

Field Summary

Modifier and Type Field and Description
static java.lang.String SUBPROTOCOL_NAME The subprotocol is the portion of the connection string that comes after "jdbc:" but before the "://".

Fields inherited from class com.vertica.jdbc.common.AbstractDriver

URL_PROTOCOL

Fields inherited from class com.vertica.jdbc.common.BaseConnectionFactory

CONNECTION_LOCALE_KEY, s_Messages, URL_SEPARATOR

Constructor Summary

Constructor and Description
Driver()

Method Summary

Modifier and Type Method and Description
java.util.logging.Logger getParentLogger() Get parent Logger of all the Loggers used by this data source.

Methods inherited from class com.vertica.jdbc.hybrid.HybridAbstractDriver

initializeDriver

Methods inherited from class com.vertica.jdbc.common.AbstractDriver

acceptsURL, connect, getErrorMessageComponentName, getMajorVersion, getMinorVersion, getPropertyInfo, initialize, jdbcCompliant, setErrorMessageComponentName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBPROTOCOL_NAME

public static final java.lang.String SUBPROTOCOL_NAME

The subprotocol is the portion of the connection string that comes after "jdbc:" but before the "://". See Also:Constant Field Values

Constructor Detail

Driver

public Driver()

Method Detail

getParentLogger

public java.util.logging.Logger getParentLogger()
throws java.sql.SQLFeatureNotSupportedException

Get parent Logger of all the Loggers used by this data source. Returns the Logger farthest from the root Logger that is still an ancestor of all of the Loggers used by this data source Throws: java.sql.SQLFeatureNotSupportedException

5.10 - Index

A B C D E F G H I P R S T U V 

A

addBoolean(boolean) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of boolean value to the chain.

addBooleanNull() - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of boolean null value to the chain.

addBytes(byte[]) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of binary value to the chain.

addDate(Date, Calendar) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of Date value to the chain.

addDate(Date, Calendar) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of Date value to the chain.

addDouble(double) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of double value to the chain.

addDoubleNull() - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of double null value to the chain.

addLong(long) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of long value to the chain.

addNull() - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

Adds hash of null value to the chain.

addNumeric(BigDecimal, int) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of numeric value to the chain

addOutputColumn(String) - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Adds an output column to the ResultSet returned by VGet.execute().

addOutputExpression(String) - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Adds the result of a free-form SQL expression to the ResultSet returned by VGet.execute().

addPredicate(String, Object) - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Adds or updates a column equality predicate.

addPredicateExpression(String) - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Adds a free-form SQL predicate to filter results.

addSortColumn(String, VGet.SortOrder) - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Adds the specified column to the sort order of the result.

addStream(InputStream) - Method in class com.vertica.jdbc.VerticaCopyStream

Adds a stream to the list of streams to send in the copy statement.

addString(String) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of String value to the chain.

addTime(Time, Calendar) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of Time value to the chain.

addTime(Date, Calendar) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of Time value to the chain.

addTimestamp(long) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of Timestamp value expressed as milliseconds since Jan 1, 1970 UTC to the chain.

addTimestamp(Timestamp, Calendar) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of Timestamp value to the chain.

addTimestamp(Date, Calendar) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of Timestamp value to the chain.

addUUID(UUID) - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of UUID value to the chain.

addUUIDNull() - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

adds hash of null UUID to the chain.

areBatchInsertsDirect() - Method in class com.vertica.jdbc.DataSource

Get if batch inserts are direct for the data source.

B

beginConsistentRead() - Method in interface com.vertica.jdbc.kv.VerticaRoutableConnection

Deprecated.

All subsequent VGet accesses will read from a consistent snapshot acquired at the time this method call is made.

C

clearMetadataCache() - Method in interface com.vertica.jdbc.kv.VerticaRoutableConnection

Deprecated.

Clears the cached projection metadata used by all VGets constructed by this connection.

clearOutputs() - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Clears out all outputs added with VGet.addOutputColumn(String) and VGet.addOutputExpression(String).

clearPredicates() - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Clears out all predicates added with VGet.addPredicate(String, Object) and VGet.addPredicateExpression(String).

clearSortColumns() - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Clears out all columns added to the sort by VGet.addSortColumn(String, SortOrder)

clone() - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Returns a deep copy of this VerticaDayTimeInterval.

clone() - Method in class com.vertica.jdbc.VerticaYearMonthInterval

Returns a deep copy of this VerticaYearMonthInterval.

close() - Method in interface com.vertica.jdbc.kv.VerticaRoutableExecutor

Deprecated.

Release resource used by this VerticaRoutableExecutor - close the result set(s)

close() - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Releases resources used by this VGet.

com.vertica.jdbc - package com.vertica.jdbc

 

com.vertica.jdbc.kv - package com.vertica.jdbc.kv

 

createRoutableExecutor(String, String) - Method in interface com.vertica.jdbc.kv.VerticaRoutableConnection

Deprecated.

Create a KV query executor for a table/projection.

D

DataSource - Class in com.vertica.jdbc

 

DataSource() - Constructor for class com.vertica.jdbc.DataSource

 

Driver - Class in com.vertica.jdbc

 

Driver() - Constructor for class com.vertica.jdbc.Driver

 

E

endConsistentRead() - Method in interface com.vertica.jdbc.kv.VerticaRoutableConnection

Deprecated.

Stops using snapshot acquired by the last call to VerticaRoutableConnection.beginConsistentRead().

equals(Object) - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Returns true if obj is a VerticaDayTimeInterval and it represents the same span of time as this interval, regardless of which units are set.

equals(Object) - Method in class com.vertica.jdbc.VerticaYearMonthInterval

Returns true if obj is a VerticaYearMonthInterval and it represents the same span of time as this interval, regardless of which units are set.

execute(String, Map) - Method in interface com.vertica.jdbc.kv.VerticaRoutableExecutor

Deprecated.

Execute a query using these segmentation key values arguments.

execute(String, String, Object) - Method in interface com.vertica.jdbc.kv.VerticaRoutableExecutor

Deprecated.

Execute a query using a single column name/value pair as the routing information.

execute() - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Fetches the desired results.

execute() - Method in class com.vertica.jdbc.VerticaCopyStream

 

F

finish() - Method in class com.vertica.jdbc.VerticaCopyStream

Finishes the copy statement.

G

getBackupServerNode() - Method in class com.vertica.jdbc.DataSource

Get list of backup server nodes.

getBinaryTransfer() - Method in class com.vertica.jdbc.DataSource

Get whether or not connection uses binary transfer

getConnSettings() - Method in class com.vertica.jdbc.DataSource

Returns the session initialization sql that will run when a connection is established.

getDatabase() - Method in class com.vertica.jdbc.DataSource

Get the database for the data source.

getDetail() - Method in interface com.vertica.jdbc.VerticaDatabaseErrorInfo

 

getDisableCopyLocal() - Method in class com.vertica.jdbc.DataSource

Gets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled.

getEnableRoutableQueries() - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

getErrorCode() - Method in interface com.vertica.jdbc.VerticaDatabaseErrorInfo

 

getErrorLevel() - Method in interface com.vertica.jdbc.VerticaDatabaseErrorInfo

Returns the severity classification for the error.

getFailOnMultiNodePlans() - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

getHash() - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

returns the current hash value

getHint() - Method in interface com.vertica.jdbc.VerticaDatabaseErrorInfo

 

getHost() - Method in class com.vertica.jdbc.DataSource

Get the host for the data source.

getHostNameVerifier() - Method in class com.vertica.jdbc.DataSource

Get if TLS Mode for the data source.

getIntervalType() - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Gets the ODBC SQL type identifier for this interval.

getIntervalType() - Method in class com.vertica.jdbc.VerticaYearMonthInterval

Gets the ODBC SQL type identifier for this interval.

getJAASConfigName() - Method in class com.vertica.jdbc.DataSource

Gets the name of the JAAS configuration entry that will the driver will use when performing GSS authentication.

getKerberosHostName() - Method in class com.vertica.jdbc.DataSource

Gets the host name portion of the kerberos service principal that identifies the Vertica server.

getKerberosServiceName() - Method in class com.vertica.jdbc.DataSource

Gets the service name portion of the kerberos service principal that identifies the Vertica server.

getKeyStorePassword() - Method in class com.vertica.jdbc.DataSource

Gets the password for the keystore file.

getKeyStorePath() - Method in class com.vertica.jdbc.DataSource

Gets the path to the keystore file, or "" if not specified.

getLastDatabaseError() - Method in interface com.vertica.jdbc.VerticaConnection

Returns information about the most recent database error that occurred on this connection.

getLocale() - Method in class com.vertica.jdbc.DataSource

Get the locale for the data source.

getLogDirectory() - Method in class com.vertica.jdbc.DataSource

Gets the directory used to store log files

getLoginNetworkTimeout() - Method in class com.vertica.jdbc.DataSource

Get the LoginNetworkTimeout for the data source.

getLoginNodeTimeout() - Method in class com.vertica.jdbc.DataSource

Get the LoginNodeTimeout for the data source.

getLoginTimeout() - Method in class com.vertica.jdbc.DataSource

Get the login timeout for the data source.

getLogLevel() - Method in class com.vertica.jdbc.DataSource

Gets current level of logging

getLogNameSpace() - Method in class com.vertica.jdbc.DataSource

Gets package that logging is restricted to

getMarsEnabled() - Method in class com.vertica.jdbc.DataSource

 

getMaxPooledConnections() - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

getMaxPooledConnectionsPerNode() - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

getMaxPooledConnectionUses() - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

getMessage() - Method in interface com.vertica.jdbc.VerticaDatabaseErrorInfo

 

getMetadataCacheLifetime() - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

getNetworkTimeout() - Method in class com.vertica.jdbc.DataSource

Gets the current network timeout value.

getNodeDownWaitTime() - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

getNodeFor(Connection, String, String, long) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

Returns the name of the node that will be responsible for the provided value in the hash space for a given projection.

getNodeFor(String, long) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

Given a projection's get_projection_segments() output, this method will return the node that is responsible for the provided hashValue.

getOAuthAccessToken() - Method in class com.vertica.jdbc.DataSource

Gets the access token used for OAuth authentication.

getOAuthClientId() - Method in class com.vertica.jdbc.DataSource

Gets the client ID used for OAuth authentication.

getOAuthClientSecret() - Method in class com.vertica.jdbc.DataSource

Gets the client secret used for OAuth authentication.

getOAuthDiscoveryUrl() - Method in class com.vertica.jdbc.DataSource

Gets the discovery url used to fetch the OAuth token endpoint.

getOAuthRefreshToken() - Method in class com.vertica.jdbc.DataSource

Gets the refresh token used for OAuth authentication.

getOAuthScope() - Method in class com.vertica.jdbc.DataSource

Gets the scope of the access request used for OAuth token refresh.

getOAuthTokenUrl() - Method in class com.vertica.jdbc.DataSource

Gets the token url used for OAuth authentication.

getParentLogger() - Method in class com.vertica.jdbc.DataSource

Get parent Logger of all the Loggers used by this data source.

getParentLogger() - Method in class com.vertica.jdbc.Driver

Get parent Logger of all the Loggers used by this data source.

getPort() - Method in class com.vertica.jdbc.DataSource

Get the port for the data source.

getPortInt() - Method in class com.vertica.jdbc.DataSource

Get the port for the data source as an inteter.

getPosition() - Method in interface com.vertica.jdbc.VerticaDatabaseErrorInfo

 

getPrecision() - Method in class com.vertica.jdbc.VerticaDayTimeInterval

 

getPreferredAddressFamily() - Method in class com.vertica.jdbc.DataSource

Gets the preferred address family type to be used when resolving hostnames.

getProperty(String) - Method in interface com.vertica.jdbc.VerticaConnection

Returns the value of a Vertica specific property on this connection.

getRejects() - Method in class com.vertica.jdbc.VerticaCopyStream

Returns a list of row numbers corresponding to the rows in the input streams that were rejected by the server.

getResultBufferSize() - Method in class com.vertica.jdbc.DataSource

Get the maximum size of the client side ResultSet cache for the data source.

getRowCount() - Method in class com.vertica.jdbc.VerticaCopyStream

Gets the final row count for the entire copy operation.

getSearchPath() - Method in class com.vertica.jdbc.DataSource

Get the schema search path for this data source.

getSessionLabel() - Method in class com.vertica.jdbc.DataSource

Get the session label for the data source.

getSessionTimezone() - Method in class com.vertica.jdbc.DataSource

Get the session timezone for the data source.

getSocketFactoryName() - Method in class com.vertica.jdbc.DataSource

Get the custom socket factory name for the data source.

getSQLState() - Method in interface com.vertica.jdbc.VerticaDatabaseErrorInfo

 

getSSLSocketFactoryName() - Method in class com.vertica.jdbc.DataSource

Get the custom SSL socket factory name for the data source.

getStreamingBatchInsert() - Method in class com.vertica.jdbc.DataSource

Gets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used.

getTLSMode() - Method in class com.vertica.jdbc.DataSource

Get TLS Mode for the data source.

getTransactionIsolation() - Method in class com.vertica.jdbc.DataSource

Get the transaction isolation for the data source.

getTrustStorePassword() - Method in class com.vertica.jdbc.DataSource

Gets the password for the truststore file.

getTrustStorePath() - Method in class com.vertica.jdbc.DataSource

Gets the path to the truststore file, or "" if not specified.

getUser() - Method in class com.vertica.jdbc.DataSource

Get current user

getWarnings() - Method in interface com.vertica.jdbc.kv.VerticaRoutableExecutor

Deprecated.

Get SQLWarning after an VGet.execute() call.

getWarnings() - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Retrieves the first warning reported by calls on this VGet.

H

hashBoolean(boolean) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of boolean value

hashBooleanNull() - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of boolean null value

hashBytes(byte[]) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of a binary value

hashBytesNull() - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of a binary null value

hashBytesNull(long) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of a binary null value

hashCode() - Method in class com.vertica.jdbc.VerticaDayTimeInterval

The hash code of an interval is computed first by converting the value of this interval to a number of nanoseconds.

hashCode() - Method in class com.vertica.jdbc.VerticaYearMonthInterval

The hash code of an interval is calculated first by converting this interval to a number of months.

hashDate(Date) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of java.util.Date value

hashDate(Date) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of java.sql.Date value

hashDouble(double) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of double value

hashDoubleNull() - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of double null value

hashLong(long) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of long value

hashNull(long) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of null value.

hashNull() - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

Compute hash of null value

hashNumeric(BigDecimal, int) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of a numeric value

hashString(String) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of String value

hashStringNull() - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of String null value

hashTime(Time) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of Time value

hashTimestamp(long) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of Timestamp value expressed in milliseconds since Jan 1, 1970.

hashTimestamp(Timestamp) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of java.sql.Timestamp value

hashUUID(UUID, long) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute hash of UUID value.

hashUUIDNull(long) - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute a hash of a null UUID value.

hashUUIDNull() - Static method in class com.vertica.jdbc.kv.VHash

Deprecated.

compute a hash of a null UUID value.

I

INTERVAL_DAY - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_DAY

INTERVAL_DAY - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL DAY interval.

INTERVAL_DAY_TO_HOUR - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_DAY_TO_HOUR

INTERVAL_DAY_TO_HOUR - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL DAY TO HOUR interval.

INTERVAL_DAY_TO_MINUTE - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_DAY_TO_MINUTE

INTERVAL_DAY_TO_MINUTE - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL DAY TO MINUTE interval.

INTERVAL_DAY_TO_SECOND - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_DAY_TO_SECOND

INTERVAL_DAY_TO_SECOND - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL DAY TO SECOND interval.

INTERVAL_HOUR - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_HOUR

INTERVAL_HOUR - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL HOUR interval.

INTERVAL_HOUR_TO_MINUTE - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_HOUR_TO_MINUTE

INTERVAL_HOUR_TO_MINUTE - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL HOUR TO MINUTE interval.

INTERVAL_HOUR_TO_SECOND - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_HOUR_TO_SECOND

INTERVAL_HOUR_TO_SECOND - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL HOUR TO SECOND interval.

INTERVAL_MINUTE - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_MINUTE

INTERVAL_MINUTE - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL MINUTE interval.

INTERVAL_MINUTE_TO_SECOND - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_MINUTE_TO_SECOND

INTERVAL_MINUTE_TO_SECOND - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL MINUTE TO SECOND interval.

INTERVAL_MONTH - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL MONTH interval.

INTERVAL_MONTH - Static variable in class com.vertica.jdbc.VerticaYearMonthInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_MONTH

INTERVAL_SECOND - Static variable in class com.vertica.jdbc.VerticaDayTimeInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_SECOND

INTERVAL_SECOND - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL SECOND interval.

INTERVAL_YEAR - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL YEAR interval.

INTERVAL_YEAR - Static variable in class com.vertica.jdbc.VerticaYearMonthInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_YEAR

INTERVAL_YEAR_TO_MONTH - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for an INTERVAL YEAR TO MONTH interval.

INTERVAL_YEAR_TO_MONTH - Static variable in class com.vertica.jdbc.VerticaYearMonthInterval

Deprecated.

superseded by VerticaTypes.INTERVAL_YEAR_TO_MONTH

isAutoCommitOnByDefault() - Method in class com.vertica.jdbc.DataSource

Get if autocommit is enabled by default for the data source.

isDayTimeInterval(int) - Static method in class com.vertica.jdbc.VerticaDayTimeInterval

A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 10 day/time intervals that this class is capable of representing.

isReadOnly() - Method in class com.vertica.jdbc.DataSource

Get if the data source is read only.

isSslEnabled() - Method in class com.vertica.jdbc.DataSource

Deprecated.

getTLSMode method provide finer information.

isWrapperFor(Class) - Method in class com.vertica.jdbc.DataSource

 

isYearMonthInterval(int) - Static method in class com.vertica.jdbc.VerticaYearMonthInterval

A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 3 year/month intervals that this class is capable of representing.

P

prepareGet(String, String) - Method in interface com.vertica.jdbc.kv.VerticaRoutableConnection

Deprecated.

Creates a VGet for the given table or projection.

R

reset() - Method in class com.vertica.jdbc.kv.VHash

Deprecated.

resets hash value for next chain.

S

setAutoCommitOnByDefault(boolean) - Method in class com.vertica.jdbc.DataSource

Set if autocommit is enabled by default for the data source.

setBackupServerNode(String) - Method in class com.vertica.jdbc.DataSource

Sets the list of backup server nodes for this data source.

setBatchInsertsDirect(boolean) - Method in class com.vertica.jdbc.DataSource

Deprecated.

This method has been deprecated. WOS and moveout operations are no longer supported. All connections use direct batch insert.

setBinaryTransfer(boolean) - Method in class com.vertica.jdbc.DataSource

Sets the flag that indicates whether or not to use binary transfer

setConnectionLoadBalance(boolean) - Method in class com.vertica.jdbc.DataSource

Sets the flag that indicates whether or not to use native load balancing.

setConnSettings(String) - Method in class com.vertica.jdbc.DataSource

ConnSettings are sql statements that the driver will execute when a connection is made.

setDatabase(String) - Method in class com.vertica.jdbc.DataSource

Set the database for the data source.

setDay(int) - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Sets the days component of this interval.

setDisableCopyLocal(boolean) - Method in class com.vertica.jdbc.DataSource

Sets the value of the connection setting that determines whether file-based COPY LOCAL operations are disabled.

setEnableRoutableQueries(boolean) - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

setFailOnMultiNodePlans(boolean) - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

setFraction(int, int) - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Sets the fraction component of this interval.

setHost(String) - Method in class com.vertica.jdbc.DataSource

Set the host for the data source.

setHostNameVerifier(String) - Method in class com.vertica.jdbc.DataSource

Set user defined HostnameVerifier.

setHour(int) - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Sets the hours component of this interval.

setIsNegative(boolean) - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Sets the sign of this interval.

setJAASConfigName(String) - Method in class com.vertica.jdbc.DataSource

Sets the name of the JAAS configuration entry that will be used when performing GSS-Kerberos authentication.

setKerberosHostName(String) - Method in class com.vertica.jdbc.DataSource

Sets the host name portion of the kerberos service principal that identifies the Vertica server.

setKerberosServiceName(String) - Method in class com.vertica.jdbc.DataSource

Sets the service name portion of the kerberos service principal that identifies the Vertica server.

setKeyStorePassword(String) - Method in class com.vertica.jdbc.DataSource

Sets the password protecting the keystore file.

setKeyStorePath(String) - Method in class com.vertica.jdbc.DataSource

Sets the path to a keystore file (typically in .jks format) to be used for TLS connections.

setLimit(int) - Method in interface com.vertica.jdbc.kv.VGet

Deprecated.

Imposes a limit on the number of rows returned by VGet.execute().

setLocale(String) - Method in class com.vertica.jdbc.DataSource

Set the locale for the data source.

setLogDirectory(String) - Method in class com.vertica.jdbc.DataSource

Sets the directory used to store log files.

setLoginNetworkTimeout(int) - Method in class com.vertica.jdbc.DataSource

Set the loginNetworkTimeout for the data source.

setLoginNodeTimeout(int) - Method in class com.vertica.jdbc.DataSource

Set the loginNodeTimeout for the data source.

setLoginTimeout(int) - Method in class com.vertica.jdbc.DataSource

Set the login timeout for the data source.

setLogLevel(String) - Method in class com.vertica.jdbc.DataSource

Sets the log level Valid values:

OFF (no logging) INFO WARNING TRACE ERROR DEBUG (most verbose)

An invalid value will set log level to OFF

setLogNameSpace(String) - Method in class com.vertica.jdbc.DataSource

Sets the package that logging is restricted to.

setMarsEnabled(boolean) - Method in class com.vertica.jdbc.DataSource

 

setMaxPooledConnections(int) - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

setMaxPooledConnectionsPerNode(int) - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

setMaxPooledConnectionUses(int) - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

setMetadataCacheLifetime(int) - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

setMinute(int) - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Sets the minutes component of this interval.

setMonth(int) - Method in class com.vertica.jdbc.VerticaYearMonthInterval

Sets the months component of this interval.

setNetworkTimeout(int) - Method in class com.vertica.jdbc.DataSource

Sets the network timeout.

setNodeDownWaitTime(int) - Method in class com.vertica.jdbc.DataSource

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

setOAuthAccessToken(String) - Method in class com.vertica.jdbc.DataSource

Sets the access token used for OAuth authentication.

setOAuthClientId(String) - Method in class com.vertica.jdbc.DataSource

Sets the client ID used for OAuth authentication.

setOAuthClientSecret(String) - Method in class com.vertica.jdbc.DataSource

Sets the client secret used for OAuth authentication.

setOAuthDiscoveryUrl(String) - Method in class com.vertica.jdbc.DataSource

Sets the discovery url used to fetch the OAuth token endpoint.

setOAuthRefreshToken(String) - Method in class com.vertica.jdbc.DataSource

Sets the refresh token used for OAuth authentication.

setOAuthScope(String) - Method in class com.vertica.jdbc.DataSource

Sets the scope of the access request used for OAuth token refresh.

setOAuthTokenUrl(String) - Method in class com.vertica.jdbc.DataSource

Sets the token url used for OAuth authentication.

setPort(int) - Method in class com.vertica.jdbc.DataSource

Set the port for the data source as an integer.

setPort(short) - Method in class com.vertica.jdbc.DataSource

Set the port for the data source.

setPreferredAddressFamily(String) - Method in class com.vertica.jdbc.DataSource

Sets the address family type to prefer when the driver resolves hostnames.

setProperty(String, Object) - Method in interface com.vertica.jdbc.VerticaConnection

Sets a Vertica specific property on this connection.

setReadOnly(boolean) - Method in class com.vertica.jdbc.DataSource

Set if the data source is read only.

setResultBufferSize(long) - Method in class com.vertica.jdbc.DataSource

Set the maximum amount of data to cache in bytes when streaming ResultSet data.

setSearchPath(String) - Method in class com.vertica.jdbc.DataSource

Sets the schema search path for this data source.

setSecond(int) - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Sets the seconds component of this interval.

setSessionLabel(String) - Method in class com.vertica.jdbc.DataSource

Set the session label for the data source.

setSessionTimezone(String) - Method in class com.vertica.jdbc.DataSource

 

setSocketFactoryName(String) - Method in class com.vertica.jdbc.DataSource

Set the custom socket factory name for the data source.

setSslEnabled(boolean) - Method in class com.vertica.jdbc.DataSource

Deprecated.

setTLSMode provides finer grained control over the TLS connection process

setSSLSocketFactoryName(String) - Method in class com.vertica.jdbc.DataSource

Set the custom SSL socket factory name for the data source.

setStreamingBatchInsert(boolean) - Method in class com.vertica.jdbc.DataSource

Sets the value of the connection setting that determines whether the streaming or non-streaming batch insert model is used.

setThreePartNaming(boolean) - Method in class com.vertica.jdbc.DataSource

Set three part naming for the data source.

setTLSMode(String) - Method in class com.vertica.jdbc.DataSource

Set TLS Mode for data source.

setTrustStorePassword(String) - Method in class com.vertica.jdbc.DataSource

Sets the password protecting the truststore file.

setTrustStorePath(String) - Method in class com.vertica.jdbc.DataSource

Sets the path to a truststore file (typically in .jks format) to be used for TLS connections.

setUser(String) - Method in class com.vertica.jdbc.DataSource

Sets the current user

setYear(int) - Method in class com.vertica.jdbc.VerticaYearMonthInterval

Sets the years component of this interval.

start() - Method in class com.vertica.jdbc.VerticaCopyStream

Starts the copy operation, optionally sending over any InputStream data that has been added to this VerticaCopyStream thus far (via VerticaCopyStream.execute()).

SUBPROTOCOL_NAME - Static variable in class com.vertica.jdbc.Driver

The subprotocol is the portion of the connection string that comes after "jdbc:" but before the "://".

supportsConsistentRead() - Method in interface com.vertica.jdbc.kv.VerticaRoutableConnection

Deprecated.

Checks to see if the VerticaRoutableConnection.beginConsistentRead() and VerticaRoutableConnection.endConsistentRead() methods are supported.

T

toString() - Method in class com.vertica.jdbc.VerticaDayTimeInterval

Returns a string representation of this interval.

toString() - Method in class com.vertica.jdbc.VerticaYearMonthInterval

Returns a string representation of this interval.

U

unwrap(Class) - Method in class com.vertica.jdbc.DataSource

 

useConnectionLoadBalance() - Method in class com.vertica.jdbc.DataSource

Get whether or not connection load balancing is in use.

useThreePartNaming() - Method in class com.vertica.jdbc.DataSource

Get if three-part naming is used for the data source.

UUID - Static variable in class com.vertica.jdbc.VerticaTypes

The ODBC SQL type identifier for a UUID.

V

valueOf(String) - Static method in enum com.vertica.jdbc.kv.VGet.SortOrder

Deprecated.

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.vertica.jdbc.kv.VGet.SortOrder

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.

VerticaConnection - Interface in com.vertica.jdbc

This interface defines the public Vertica Analytic Database extensions to java.sql.Connection.

VerticaCopyStream - Class in com.vertica.jdbc

A bulk loading utility that sends COPY FROM LOCAL STDIN data from a JDBC client to the Vertica database.

VerticaCopyStream(VerticaConnection, String) - Constructor for class com.vertica.jdbc.VerticaCopyStream

Creates a new VerticaCopyStream to execute the specified statement.

VerticaCopyStream(VerticaConnection, String, InputStream) - Constructor for class com.vertica.jdbc.VerticaCopyStream

Creates a new VerticaCopyStream to execute the specified statement.

VerticaCopyStream(VerticaConnection, String, List) - Constructor for class com.vertica.jdbc.VerticaCopyStream

Creates a new VerticaCopyStream to execute the specified statement.

VerticaDatabaseErrorInfo - Interface in com.vertica.jdbc

Exposes additional information about errors that occur on the database server.

VerticaDayTimeInterval - Class in com.vertica.jdbc

The JDBC representation of the Vertica INTERVAL DAY TO SECOND type.

VerticaDayTimeInterval(int, int, int, int, int, int, boolean) - Constructor for class com.vertica.jdbc.VerticaDayTimeInterval

 

VerticaDayTimeInterval(int, int, int, int, int, int, int, boolean) - Constructor for class com.vertica.jdbc.VerticaDayTimeInterval

Constructs a new VerticaDayTimeInterval.

VerticaPreparedStatement - Interface in com.vertica.jdbc

This interface defines the public Vertica Analytic Database extensions to java.sql.Statement.

VerticaRoutableConnection - Interface in com.vertica.jdbc.kv

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

VerticaRoutableExecutor - Interface in com.vertica.jdbc.kv

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

VerticaStatement - Interface in com.vertica.jdbc

This interface defines the public Vertica Analytic Database extensions to java.sql.Statement.

VerticaTypes - Class in com.vertica.jdbc

This class defines Vertica identifiers for data types Vertica supports but which are not represented in java.sql.types.

VerticaTypes() - Constructor for class com.vertica.jdbc.VerticaTypes

 

VerticaYearMonthInterval - Class in com.vertica.jdbc

The JDBC representation of the Vertica INTERVAL YEAR TO MONTH type.

VerticaYearMonthInterval(int, int, boolean) - Constructor for class com.vertica.jdbc.VerticaYearMonthInterval

Constructs a new VerticaYearMonthInterval.

VerticaYearMonthInterval(int, int, int, boolean) - Constructor for class com.vertica.jdbc.VerticaYearMonthInterval

Constructs a new VerticaYearMonthInterval.

VGet - Interface in com.vertica.jdbc.kv

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

VGet.SortOrder - Enum in com.vertica.jdbc.kv

Deprecated.

Describes the ordering of result data.

VHash - Class in com.vertica.jdbc.kv

Deprecated.

This feature is likely to stop working in a future release and to be removed as a result.

VHash() - Constructor for class com.vertica.jdbc.kv.VHash

Deprecated.

Creates an instance suitable for computing a hash of a chain of values, for use when a projection is segmented by multiple columns.

A B C D E F G H I P R S T U V

5.11 - Packages

5.12 - VerticaConnection

  • All Superinterfaces: java.lang.AutoCloseable, java.sql.Connection, java.sql.Wrapper

All Known Subinterfaces: VerticaRoutableConnection

public interface VerticaConnection
extends java.sql.Connection

This interface defines the public Vertica Analytic Database extensions to java.sql.Connection. All Connections constructed by the Vertica JDBC driver implement VerticaStatement.

Field Summary

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

Modifier and Type Method and Description
VerticaDatabaseErrorInfo getLastDatabaseError() Returns information about the most recent database error that occurred on this connection.
java.lang.Object getProperty(java.lang.String name) Returns the value of a Vertica specific property on this connection.
void setProperty(java.lang.String name, java.lang.Object value) Sets a Vertica specific property on this connection.

Methods inherited from interface java.sql.Connection

abort, clearWarnings, close, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Detail

setProperty

void setProperty(java.lang.String name,
java.lang.Object value)
throws java.sql.SQLException

Sets a Vertica specific property on this connection. Normally a connection's properties are determined by the connection string when the connection is created. This method allows some properties to be changed after the Connection has been created.

Any Statement or PreparedStatement created by this connection will inherit the property values set here. Parameters:name - The name of a connection property.value - The value of the connection property. Throws: java.sql.SQLException - If name is not a valid property name or value is not a valid property value.

getProperty

java.lang.Object getProperty(java.lang.String name)
throws java.sql.SQLException

Returns the value of a Vertica specific property on this connection. Parameters:name - The name of the property to look up. Returns The value of the property, or null if the property has no value. Throws: java.sql.SQLException - If the property lookup fails because of an invalid name.

getLastDatabaseError

VerticaDatabaseErrorInfo getLastDatabaseError()

Returns information about the most recent database error that occurred on this connection.

The information returned by this method may also be accessed via the v_monitor.error_messages system table.

After a SQLException is thrown as a result of a server-side error, this method will return context information about that error.

If the most recent operation did not throw a SQLException, or if the SQLException thrown was the result of a purely client-side error, then null is returned.

The error information is discarded at the start of any operation that requires communication with the database server. Returns database error info instance

5.13 - VerticaCopyStream

  • java.lang.Object

  • com.vertica.jdbc.VerticaCopyStream

public class VerticaCopyStream
extends java.lang.Object

A bulk loading utility that sends COPY FROM LOCAL STDIN data from a JDBC client to the Vertica database. To bulk load data, provide any InputStream(s) and a COPY FROM LOCAL STDIN statement that describes the stream's format and a destination table.

The start() method begins a copy statement. If any streams have already been provided, they are sent at this point. The execute() method can optionally continue the execution. It sends any streams that have been added via addStream(InputStream) since the last start() or execute() operation, Finally, to end the copy statement, and get the total number of rows added during the entire copy operation, call the finish() method.

Though the start(), execute() and finish() methods are designed to work on a single copy statement open over multiple method calls, there are cases when the driver must split what is logically a single operation into multiple distinct commands.

This utility honors the connection's autocommit setting, meaning that upon returning from the start(), execute() or finish() methods, the driver will have committed the transaction when autocommit is enabled. It is not illegal to add data streams to a VerticaCopyStream across transactions, but this will result in degraded performance, as separate ROS containers will be created on the server for each transaction's copy operation. For best performance, disable autocommit when using this utility.

Similarly, because the driver can only allow one statement to run on a connection at a time, interleaving other statement executions between calls to start(), execute() or finish() will force the open copy statement to end, so that the other statement may execute. In this case, a new copy operation will begin upon the next call to execute() or finish(). This will create multiple ROS containers and degrade performance. Furthermore, if the copy statement does not have the NO COMMIT option, then each interleaved statement will in effect end the transaction, even when autocommit is turned off.

To track the progress of the load, the getRejects() method returns a list of' row numbers that the server rejected. Each call to start(), execute() or finish() will send over any stream(s) added via addStream(InputStream) that have not yet been sent to the server. The rejections from the streams(s) sent during the last start(), execute() or finish() operation will be available via getRejects(). This list is cleared with each new call to start(), execute() or finish().

This class also implements Exceptions and Rejections files where, if specified in the Copy statement, the rejected rows will be written to the file designated as REJECTED DATA and the reason for rejection will be written to the designated EXCEPTIONS file. If these are specified, the driver will return an empty list with any calls to getRejects(). The rejection files will contain more detailed rejection information and can be checked instead.

Constructor Summary

Constructor and Description
VerticaCopyStream(VerticaConnection conn, java.lang.String copyStatement) Creates a new VerticaCopyStream to execute the specified statement.
VerticaCopyStream(VerticaConnection conn, java.lang.String copyStatement, java.io.InputStream source) Creates a new VerticaCopyStream to execute the specified statement.
VerticaCopyStream(VerticaConnection conn, java.lang.String copyStatement, java.util.List sources) Creates a new VerticaCopyStream to execute the specified statement.

Method Summary

Modifier and Type Method and Description
void addStream(java.io.InputStream input) Adds a stream to the list of streams to send in the copy statement.
void execute()
long finish() Finishes the copy statement.
java.util.List getRejects() Returns a list of row numbers corresponding to the rows in the input streams that were rejected by the server.
long getRowCount() Gets the final row count for the entire copy operation.
void start() Starts the copy operation, optionally sending over any InputStream data that has been added to this VerticaCopyStream thus far (via execute()).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VerticaCopyStream

public VerticaCopyStream(VerticaConnection conn,
java.lang.String copyStatement)
throws java.sql.SQLException

Creates a new VerticaCopyStream to execute the specified statement. Parameters:conn - The connection to run the copy statement on.copyStatement - A COPY FROM STDIN statement to execute. Throws: java.sql.SQLException - If creation of new copy stream fails.

VerticaCopyStream

public VerticaCopyStream(VerticaConnection conn,
java.lang.String copyStatement,
java.io.InputStream source)
throws java.sql.SQLException

Creates a new VerticaCopyStream to execute the specified statement. Parameters:conn - The connection to run the copy statement on.copyStatement - A COPY FROM STDIN statement to execute.source - A data stream in the format expected by the copy statement. Throws: java.sql.SQLException - If creation of new copy stream fails.

VerticaCopyStream

public VerticaCopyStream(VerticaConnection conn,
java.lang.String copyStatement,
java.util.List sources)
throws java.sql.SQLException

Creates a new VerticaCopyStream to execute the specified statement. Parameters:conn - The connection to run the copy statement on.copyStatement - A COPY FROM STDIN statement to execute.sources - A list of data streams, each in the format expected by the copy statement. The streams will be copied sequentially into the database. Throws: java.sql.SQLException - If creation of new copy stream fails.

Method Detail

start

public void start()
throws java.sql.SQLException

Starts the copy operation, optionally sending over any InputStream data that has been added to this VerticaCopyStream thus far (via execute()). The statement is left open so that more data streams can be added. Throws: java.sql.SQLException - If start operation fails.

execute

public void execute()
throws java.sql.SQLException

Throws: java.sql.SQLException - If this COPY operation has not yet been started, or a database error occurs.

addStream

public void addStream(java.io.InputStream input)
throws java.sql.SQLException

Adds a stream to the list of streams to send in the copy statement. The data will be sent to the database on the next call to start(), execute() or finish(). Parameters:input - The stream to add. Throws: java.sql.SQLException - If addStream operation fails.

finish

public long finish()
throws java.sql.SQLException

Finishes the copy statement. If streams have been added but not yet executed, they will be executed. Returns The total number of rows that were added to the table during this COPY operation. Throws: java.sql.SQLException - If finish operation fails.

getRejects

public java.util.List getRejects()

Returns a list of row numbers corresponding to the rows in the input streams that were rejected by the server. This should be checked after each call to start(), execute() or finish() to see which rows were rejected. When a new execution starts, the previous list of rejected rows is discarded.

This list will be empty if EXCEPTIONS or REJECTED DATA files are specified Returns A list of row numbers that were rejected by the server during the last execution.

getRowCount

public long getRowCount()

Gets the final row count for the entire copy operation. This will be remain zero until finish() has been called. Returns The total number of rows successfully copied to the database.

5.14 - VerticaDatabaseErrorInfo

public interface VerticaDatabaseErrorInfo

Exposes additional information about errors that occur on the database server.

When a server-side error occurs, the database may provide the the client with additional context and troubleshooting information about the error. The information available depends on the type of error that occurred.

For example, when a SQL Syntax error occurs, the database may indicate a position within the SQL query text where the syntax was invalid, and a suggestion for altering the query text to make the query succeed.

The information provided by this interface is also queryable in the database via the v_monitor.error_messages system table.

This interface provides accessors to retrieve that information after an error has occurred. If the type of information was not available or relevant for the given error, the method should return null.

Method Summary

Modifier and Type Method and Description
java.lang.String getDetail()
int getErrorCode()
java.lang.String getErrorLevel() Returns the severity classification for the error.
java.lang.String getHint()
java.lang.String getMessage()
int getPosition()
java.lang.String getSQLState()

Method Detail

getMessage

java.lang.String getMessage()

Returns A description of the error.

getDetail

java.lang.String getDetail()

Returns Additional information about the error (optional). Null if not applicable.

getHint

java.lang.String getHint()

Returns A suggestion for how to resolve the error (optional). Null if not applicable.

getSQLState

java.lang.String getSQLState()

Returns The SQLState code for this error.

getErrorCode

int getErrorCode()

Returns A unique error code for this error.

getPosition

int getPosition()

Returns The position within the SQL command that caused the error. The first character is at position 1. Returns 0 if not applicable to the error.

getErrorLevel

java.lang.String getErrorLevel()

Returns the severity classification for the error. Possible values are: "NOTICE": The command completed but also yielded some diagnostic information. "WARNING": The command completed but also yielded some warning information. "ERROR": The error caused the command the fail. "ROLLBACK": The error caused the current transaction to roll back. "FATAL": The error caused the database server to end the client's session. "PANIC": The error caused the database server to shut down. Returns The severity of the error.

5.15 - VerticaDayTimeInterval

  • java.lang.Object

  • com.vertica.dsi.dataengine.utilities.DSITimeSpan

  • com.vertica.jdbc.VerticaDayTimeInterval

  • All Implemented Interfaces: java.lang.Cloneable

public class VerticaDayTimeInterval
extends com.vertica.dsi.dataengine.utilities.DSITimeSpan
implements java.lang.Cloneable

The JDBC representation of the Vertica INTERVAL DAY TO SECOND type. It represents a span of time measured in days, hours, minutes, seconds and nanoseconds.

The JDBC specification does not define first class support for interval data types. There are no java.sql.Types type identifiers for intervals, there is no built in setter on the PreparedStatement interface and no built in getter on the ResultSet interface.

Instead, the Vertica JDBC driver follows the ODBC standard when it can. Each of the 10 day/time interval ranges is identified by the ODBC standard SQL type identifier. Those identifiers are recreated as integer fields in this class, analogous to those defined for the other data types by java.sql.Types.

To insert a day/time interval into the database, create an instance of this class and pass it to PreparedStatement.setObject, optionally passing one of the ODBC SQL types defined by this class as the target type parameter.

To retrieve a VericaDayTimeInterval from the database, select an INTERVAL DAY TO SECOND column, call ResultSet.getObject and cast the result to a VerticaDayTimeInterval

Field Summary

Modifier and Type Field and Description
static int INTERVAL_DAY Deprecated. superseded by VerticaTypes.INTERVAL_DAY
static int INTERVAL_DAY_TO_HOUR Deprecated. superseded by VerticaTypes.INTERVAL_DAY_TO_HOUR
static int INTERVAL_DAY_TO_MINUTE Deprecated. superseded by VerticaTypes.INTERVAL_DAY_TO_MINUTE
static int INTERVAL_DAY_TO_SECOND Deprecated. superseded by VerticaTypes.INTERVAL_DAY_TO_SECOND
static int INTERVAL_HOUR Deprecated. superseded by VerticaTypes.INTERVAL_HOUR
static int INTERVAL_HOUR_TO_MINUTE Deprecated. superseded by VerticaTypes.INTERVAL_HOUR_TO_MINUTE
static int INTERVAL_HOUR_TO_SECOND Deprecated. superseded by VerticaTypes.INTERVAL_HOUR_TO_SECOND
static int INTERVAL_MINUTE Deprecated. superseded by VerticaTypes.INTERVAL_MINUTE
static int INTERVAL_MINUTE_TO_SECOND Deprecated. superseded by VerticaTypes.INTERVAL_MINUTE_TO_SECOND
static int INTERVAL_SECOND Deprecated. superseded by VerticaTypes.INTERVAL_SECOND

Constructor Summary

Constructor and Description
VerticaDayTimeInterval(int day, int hour, int minute, int second, int fraction, int fracPrecision, boolean isNegative)
VerticaDayTimeInterval(int type, int day, int hour, int minute, int second, int fraction, int fracPrecision, boolean isNegative) Constructs a new VerticaDayTimeInterval.

Method Summary

Modifier and Type Method and Description
VerticaDayTimeInterval clone() Returns a deep copy of this VerticaDayTimeInterval.
boolean equals(java.lang.Object obj) Returns true if obj is a VerticaDayTimeInterval and it represents the same span of time as this interval, regardless of which units are set.
int getIntervalType() Gets the ODBC SQL type identifier for this interval.
int getPrecision()
int hashCode() The hash code of an interval is computed first by converting the value of this interval to a number of nanoseconds.
static boolean isDayTimeInterval(int type) A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 10 day/time intervals that this class is capable of representing.
void setDay(int day) Sets the days component of this interval.
void setFraction(int fraction, int precision) Sets the fraction component of this interval.
void setHour(int hour) Sets the hours component of this interval.
void setIsNegative(boolean isNegative) Sets the sign of this interval.
void setMinute(int minute) Sets the minutes component of this interval.
void setSecond(int second) Sets the seconds component of this interval.
java.lang.String toString() Returns a string representation of this interval.

Methods inherited from class com.vertica.dsi.dataengine.utilities.DSITimeSpan

getDay, getFraction, getHour, getMinute, getSecond, isNegative, setFraction

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

INTERVAL_DAY

public static final int INTERVAL_DAY

Deprecated. superseded by VerticaTypes.INTERVAL_DAY The ODBC SQL type identifier for an INTERVAL DAY interval. See Also:Constant Field Values

INTERVAL_DAY_TO_HOUR

public static final int INTERVAL_DAY_TO_HOUR

Deprecated. superseded by VerticaTypes.INTERVAL_DAY_TO_HOUR The ODBC SQL type identifier for an INTERVAL DAY TO HOUR interval. See Also:Constant Field Values

INTERVAL_DAY_TO_MINUTE

public static final int INTERVAL_DAY_TO_MINUTE

Deprecated. superseded by VerticaTypes.INTERVAL_DAY_TO_MINUTE The ODBC SQL type identifier for an INTERVAL DAY TO MINUTE interval. See Also:Constant Field Values

INTERVAL_DAY_TO_SECOND

public static final int INTERVAL_DAY_TO_SECOND

Deprecated. superseded by VerticaTypes.INTERVAL_DAY_TO_SECOND The ODBC SQL type identifier for an INTERVAL DAY TO SECOND interval. See Also:Constant Field Values

INTERVAL_HOUR

public static final int INTERVAL_HOUR

Deprecated. superseded by VerticaTypes.INTERVAL_HOUR The ODBC SQL type identifier for an INTERVAL HOUR interval. See Also:Constant Field Values

INTERVAL_HOUR_TO_MINUTE

public static final int INTERVAL_HOUR_TO_MINUTE

Deprecated. superseded by VerticaTypes.INTERVAL_HOUR_TO_MINUTE The ODBC SQL type identifier for an INTERVAL HOUR TO MINUTE interval. See Also:Constant Field Values

INTERVAL_HOUR_TO_SECOND

public static final int INTERVAL_HOUR_TO_SECOND

Deprecated. superseded by VerticaTypes.INTERVAL_HOUR_TO_SECOND The ODBC SQL type identifier for an INTERVAL HOUR TO SECOND interval. See Also:Constant Field Values

INTERVAL_MINUTE

public static final int INTERVAL_MINUTE

Deprecated. superseded by VerticaTypes.INTERVAL_MINUTE The ODBC SQL type identifier for an INTERVAL MINUTE interval. See Also:Constant Field Values

INTERVAL_MINUTE_TO_SECOND

public static final int INTERVAL_MINUTE_TO_SECOND

Deprecated. superseded by VerticaTypes.INTERVAL_MINUTE_TO_SECOND The ODBC SQL type identifier for an INTERVAL MINUTE TO SECOND interval. See Also:Constant Field Values

INTERVAL_SECOND

public static final int INTERVAL_SECOND

Deprecated. superseded by VerticaTypes.INTERVAL_SECOND The ODBC SQL type identifier for an INTERVAL SECOND interval. See Also:Constant Field Values

Constructor Detail

VerticaDayTimeInterval

public VerticaDayTimeInterval(int day,
int hour,
int minute,
int second,
int fraction,
int fracPrecision,
boolean isNegative)

VerticaDayTimeInterval

public VerticaDayTimeInterval(int type,
int day,
int hour,
int minute,
int second,
int fraction,
int fracPrecision,
boolean isNegative)

Constructs a new VerticaDayTimeInterval. Parameters:type - The ODBC SQL type identifier for this interval.day - The number of days in this interval. Must be no less than zero.hour - The number of hours in this interval. Must be no less than zero.minute - The number of minutes in this interval. Must be no less than zero.second - The number of seconds in this interval. Must be no less than zero.fraction - The fractional seconds in this interval. Must be no less than zero.fracPrecision - The precision of the fractional seconds, 6 or less (database can't store more).isNegative - True if this interval is negative, false if positive. Throws: java.lang.IllegalArgumentException - If any of the parameters are negative, or if type is not one of the ODBC SQL type identifiers defined by this class.

Method Detail

getPrecision

public int getPrecision()

setDay

public void setDay(int day)

Sets the days component of this interval. If this interval has no day component, it will be converted to the closest unit representable by the type. Any fraction on the converted value is rounded down.

Overrides setDay in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:day - A positive number of days. Throws: java.lang.IllegalArgumentException - If day is negative, or if using this many days would cause the interval to overflow.

setHour

public void setHour(int hour)

Sets the hours component of this interval. If this interval has no hour component, it will be converted to the closest unit representable by the type. Any fraction on the converted value is rounded down.

Overrides setHour in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:hour - A positive number of hours. Throws: java.lang.IllegalArgumentException - If hour is negative, or if using this many hours would cause the interval to overflow.

setMinute

public void setMinute(int minute)

Sets the minutes component of this interval. If this interval has no minute component, it will be converted to the closest unit representable by the type. Any fraction on the converted value is rounded down.

Overrides setMinute in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:minute - A positive number of minutes. Throws: java.lang.IllegalArgumentException - If minute is negative, or if using this many minutes would cause the interval to overflow.

setSecond

public void setSecond(int second)

Sets the seconds component of this interval. If this interval has no minute component, it will be converted to the closest unit representable by the type. Any fraction on the converted value is rounded down.

Overrides setSecond in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:second - A positive number of seconds. Throws: java.lang.IllegalArgumentException - If second is negative, or if using this many seconds would cause the interval to overflow.

setFraction

public void setFraction(int fraction,
int precision)

Sets the fraction component of this interval. If this interval has no fraction component, it will be converted to the closest unit representable by the type. Parameters:fraction - A positive number of microseconds.precision - The precision to use for this interval. Throws: java.lang.IllegalArgumentException - If fraction is negative, or if using this many microseconds would cause the interval to overflow.

setIsNegative

public void setIsNegative(boolean isNegative)

Sets the sign of this interval.

Overrides setIsNegative in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:isNegative - true if this interval is negative, false otherwise.

hashCode

public int hashCode()

The hash code of an interval is computed first by converting the value of this interval to a number of nanoseconds. Since the hash code must fit in an integer, It is possible that this calculation will overflow. Regardless of whether or not there was overflow, this number is then multiplied by -1 if this interval negative.

Overrides hashCode in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Returns A hash code for this interval.

equals

public boolean equals(java.lang.Object obj)

Returns true if obj is a VerticaDayTimeInterval and it represents the same span of time as this interval, regardless of which units are set.

Overrides equals in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Parameters:obj - An object to compare. Returns true if obj has the same sign, day, hour, minute, second and fraction as this interval.

clone

public VerticaDayTimeInterval clone()

Returns a deep copy of this VerticaDayTimeInterval. Equivalent to calling new VerticaDayTimeInterval(getIntervalType(), getDay(), getHour(), getMinute(), getSecond(), getFraction(), isNegative())

Overrides clone in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Returns A copy of this interval.

toString

public java.lang.String toString()

Returns a string representation of this interval. The format of this string is the same format that is recognized by the driver and database. Fields outside this interval's range (as defined by the ODBC type identifier) are not included in the String.

Overrides toString in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Returns The string representation of this interval.

getIntervalType

public int getIntervalType()

Gets the ODBC SQL type identifier for this interval. An interval's range can be determined by comparing the return value of this method with the INTERVAL_* constants defined in this class.

Overrides getIntervalType in class com.vertica.dsi.dataengine.utilities.DSITimeSpan Returns The ODBC SQL type identifier for this interval.

isDayTimeInterval

public static boolean isDayTimeInterval(int type)

A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 10 day/time intervals that this class is capable of representing.

The SQL_DATETIME_SUB column of the ResultSet returned by DatabaseMetaData.getColumns() will contain an ODBC interval subtype when the column is an interval. When this happens, the object returned by the driver when selecting that column will be a VerticaDayTimeInterval when the subtype is one of the 10 interval subtypes defined in this class. This helper method checks the provided type to see if it matches one of those 10 types. Parameters:type - An ODBC interval subtype identifier. Returns true if type corresponds to one of the 10 day/time interval types representable by a VerticaDayTimeInterval.

5.16 - VerticaPreparedStatement

  • All Superinterfaces: java.lang.AutoCloseable, java.sql.PreparedStatement, java.sql.Statement, java.sql.Wrapper
public interface VerticaPreparedStatement
extends java.sql.PreparedStatement

This interface defines the public Vertica Analytic Database extensions to java.sql.Statement. All PreparedStatements constructed by the Vertica JDBC driver implement VerticaPreparedStatement.

Field Summary

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Method Summary

Methods inherited from interface java.sql.PreparedStatement

addBatch, clearParameters, execute, executeLargeUpdate, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

5.17 - VerticaRoutableConnection

  • All Superinterfaces: java.lang.AutoCloseable, java.sql.Connection, VerticaConnection, java.sql.Wrapper

Deprecated.  This feature is likely to stop working in a future release and to be removed as a result.

@Deprecated
public interface VerticaRoutableConnection
extends VerticaConnection

Provides advanced routing capabilities beyond those of a normal VerticaConnection. The VerticaRoutableConnection provides access to the VGet, which performs efficient key-based lookups. Connections returned by the driver will implement this interface when the EnableRoutableQueries connection property is set to true.

The VerticaRoutableConnection maintains an internal pool of connections and a cache of table metadata that is shared by all VGets that are produced by this connection's prepareGet(String, String) method. It is also a fully-fledged JDBC connection on its own. It supports all the functionality that a VerticaConnection supports. When this connection is closed, all pooled connections managed by this VerticaRoutableConnection and all child VGets are closed too.

By default, a VerticaRoutableConnection's internal pool will use no more than 20 concurrent connections to a cluster and no more than 5 concurrent connections to a given node (these are in addition to the single connection used for normal JDBC Connection operations). Those numbers can be overridden with the MaxPooledConnections and MaxPooledConnectionsPerNode connection properties. Using a large number of connections can improve VGet performance, but it can be taxing to keep many connections open on a busy cluster. It is important for users to configure these numbers optimally for their cluster's workload.

Because VGet operations utilize multiple JDBC connections (and multiple Vertica sessions), they can not honor the connection's JDBC transaction semantics. If consistency across multiple VGet operations is required, history must be enabled. Only VGet operations that have this limitation; other operations on this connection do follow normal transaction semantics.

The supportsConsistentRead() method can be used to check if history is enabled. When supportsConsistentRead() returns true, the beginConsistentRead() and endConsistentRead() methods can be used to guarantee that all child VGet operations occur at the same epoch.

Field Summary

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

Modifier and Type Method and Description
void beginConsistentRead() Deprecated. All subsequent VGet accesses will read from a consistent snapshot acquired at the time this method call is made.
void clearMetadataCache() Deprecated. Clears the cached projection metadata used by all VGets constructed by this connection.
VerticaRoutableExecutor createRoutableExecutor(java.lang.String schema, java.lang.String tableOrProjection) Deprecated. Create a KV query executor for a table/projection.
void endConsistentRead() Deprecated. Stops using snapshot acquired by the last call to beginConsistentRead().
VGet prepareGet(java.lang.String schema, java.lang.String tableOrProj) Deprecated. Creates a VGet for the given table or projection.
boolean supportsConsistentRead() Deprecated. Checks to see if the beginConsistentRead() and endConsistentRead() methods are supported.

Methods inherited from interface com.vertica.jdbc.VerticaConnection

getLastDatabaseError, getProperty, setProperty

Methods inherited from interface java.sql.Connection

abort, clearWarnings, close, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setTransactionIsolation, setTypeMap

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Detail

prepareGet

VGet prepareGet(java.lang.String schema,
java.lang.String tableOrProj)
throws java.sql.SQLException

Deprecated.  Creates a VGet for the given table or projection. Parameters:schema - The schema name of the table or projection to get values from.tableOrProj - The name of a table or projection to get values from. Returns A VGet instance for the provided table/projection. Throws: java.sql.SQLException - Thrown if the schema or table does not exist, or if a database access error occurs.

clearMetadataCache

void clearMetadataCache()
throws java.sql.SQLException

Deprecated.  Clears the cached projection metadata used by all VGets constructed by this connection. Throws: java.sql.SQLException - Thrown if a database access error occurs.

supportsConsistentRead

boolean supportsConsistentRead()
throws java.sql.SQLException

Deprecated.  Checks to see if the beginConsistentRead() and endConsistentRead() methods are supported. To support consistent reads, historical queries must be enabled in the database. Returns true if history retention is enabled on this database cluster. Throws: java.sql.SQLException - Thrown if a database access error occurs.See Also:beginConsistentRead(), endConsistentRead()

beginConsistentRead

void beginConsistentRead()
throws java.sql.SQLException

Deprecated.  All subsequent VGet accesses will read from a consistent snapshot acquired at the time this method call is made.

Care must be taken to configure Vertica to maintain historical snapshots (see AHM management in the Vertica documentation). If Vertica invalidates the snapshot, subsequent accesses will fail with error "Can't run historical queries at epochs prior to the Ancient History Mark" Throws: java.sql.SQLException - Thrown if snapshot cannot be acquired or if a database access error occurs.See Also:endConsistentRead()

endConsistentRead

void endConsistentRead()
throws java.sql.SQLException

Deprecated.  Stops using snapshot acquired by the last call to beginConsistentRead(). Throws: java.sql.SQLException - Thrown if a database access error occurs.See Also:beginConsistentRead()

createRoutableExecutor

VerticaRoutableExecutor createRoutableExecutor(java.lang.String schema,
java.lang.String tableOrProjection)
throws java.sql.SQLException

Deprecated.  Create a KV query executor for a table/projection. Parameters:schema - The schema name of the table or projection to get values from.tableOrProjection - The name of a table or projection to get values from. Returns a routable executor instance Throws: java.sql.SQLException - Thrown if a database access error occurs.

5.18 - VerticaRoutableExecutor

  • Deprecated.  This feature is likely to stop working in a future release and to be removed as a result.
@Deprecated
public interface VerticaRoutableExecutor

An alternate API for KV queries that takes a SQL query as an argument, plus the column/value bindings that are necessary to compute the targeted node. Simply call the execute(String, Map) method (or, if there is only one column name/value pair, execute(String, String, Object)) to run query.

Both VerticaRoutableExecutor and the VGet API uses the same internal operations to route the queries.

Method Summary

Modifier and Type Method and Description
void close() Deprecated. Release resource used by this VerticaRoutableExecutor - close the result set(s)
java.sql.ResultSet execute(java.lang.String sql, java.util.Map segKey) Deprecated. Execute a query using these segmentation key values arguments.
java.sql.ResultSet execute(java.lang.String sql, java.lang.String segCol, java.lang.Object value) Deprecated. Execute a query using a single column name/value pair as the routing information.
java.sql.SQLWarning getWarnings() Deprecated. Get SQLWarning after an VGet.execute() call.

Method Detail

execute

java.sql.ResultSet execute(java.lang.String sql,
java.util.Map segKey)
throws java.sql.SQLException

Deprecated.  Execute a query using these segmentation key values arguments. Parameters:sql - The query to be routed.segKey - The map containing column name/value pairs. Returns the result set created by the routable query. Throws: java.sql.SQLException - Query not routable or has failed.

execute

java.sql.ResultSet execute(java.lang.String sql,
java.lang.String segCol,
java.lang.Object value)
throws java.sql.SQLException

Deprecated.  Execute a query using a single column name/value pair as the routing information. Parameters:sql - The query to be routed.segCol - The column name.value - The column value. Returns the result set created by the routable query. Throws: java.sql.SQLException - Query not routable or has failed.

close

void close()
throws java.sql.SQLException

Deprecated.  Release resource used by this VerticaRoutableExecutor - close the result set(s) Throws: java.sql.SQLException - close operation has failed.

getWarnings

java.sql.SQLWarning getWarnings()
throws java.sql.SQLException

Deprecated.  Get SQLWarning after an VGet.execute() call. See VGet.getWarnings() Returns SQLWarning from execute call. Throws: java.sql.SQLException - attempt to get warning has failed.

5.19 - VerticaStatement

  • All Superinterfaces: java.lang.AutoCloseable, java.sql.Statement, java.sql.Wrapper
public interface VerticaStatement
extends java.sql.Statement

This interface defines the public Vertica Analytic Database extensions to java.sql.Statement. All Statements constructed by the Vertica JDBC driver implement VerticaStatement.

Field Summary

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Method Summary

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

5.20 - VerticaTypes

  • java.lang.Object

  • com.vertica.jdbc.VerticaTypes

public class VerticaTypes
extends java.lang.Object

This class defines Vertica identifiers for data types Vertica supports but which are not represented in java.sql.types.

These identifiers are used in metadata queries and to give Vertica JDBC applications a way to specify the types and determine how to correctly get or set their values.

Interval type constants

The JDBC specification does not define first class support for interval data types. There are no java.sql.Types type identifiers for intervals, there is no built in setter on the PreparedStatement interface and no built in getter on the ResultSet interface.

Instead, the Vertica JDBC driver follows the ODBC standard when it can. Each of the 10 day/time interval ranges is identified by the ODBC standard SQL type identifier. Those identifiers are recreated as integer fields in this class, analogous to those defined for the other data types by java.sql.Types.

UUID type constant

The JDBC specification does not define a UUID type. The Vertica JDBC driver uses the ODBC type identifier for UUIDs.

Field Summary

Modifier and Type Field and Description
static int INTERVAL_DAY The ODBC SQL type identifier for an INTERVAL DAY interval.
static int INTERVAL_DAY_TO_HOUR The ODBC SQL type identifier for an INTERVAL DAY TO HOUR interval.
static int INTERVAL_DAY_TO_MINUTE The ODBC SQL type identifier for an INTERVAL DAY TO MINUTE interval.
static int INTERVAL_DAY_TO_SECOND The ODBC SQL type identifier for an INTERVAL DAY TO SECOND interval.
static int INTERVAL_HOUR The ODBC SQL type identifier for an INTERVAL HOUR interval.
static int INTERVAL_HOUR_TO_MINUTE The ODBC SQL type identifier for an INTERVAL HOUR TO MINUTE interval.
static int INTERVAL_HOUR_TO_SECOND The ODBC SQL type identifier for an INTERVAL HOUR TO SECOND interval.
static int INTERVAL_MINUTE The ODBC SQL type identifier for an INTERVAL MINUTE interval.
static int INTERVAL_MINUTE_TO_SECOND The ODBC SQL type identifier for an INTERVAL MINUTE TO SECOND interval.
static int INTERVAL_MONTH The ODBC SQL type identifier for an INTERVAL MONTH interval.
static int INTERVAL_SECOND The ODBC SQL type identifier for an INTERVAL SECOND interval.
static int INTERVAL_YEAR The ODBC SQL type identifier for an INTERVAL YEAR interval.
static int INTERVAL_YEAR_TO_MONTH The ODBC SQL type identifier for an INTERVAL YEAR TO MONTH interval.
static int UUID The ODBC SQL type identifier for a UUID.

Constructor Summary

Constructor and Description
VerticaTypes()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INTERVAL_DAY

public static final int INTERVAL_DAY

The ODBC SQL type identifier for an INTERVAL DAY interval. See Also:Constant Field Values

INTERVAL_DAY_TO_HOUR

public static final int INTERVAL_DAY_TO_HOUR

The ODBC SQL type identifier for an INTERVAL DAY TO HOUR interval. See Also:Constant Field Values

INTERVAL_DAY_TO_MINUTE

public static final int INTERVAL_DAY_TO_MINUTE

The ODBC SQL type identifier for an INTERVAL DAY TO MINUTE interval. See Also:Constant Field Values

INTERVAL_DAY_TO_SECOND

public static final int INTERVAL_DAY_TO_SECOND

The ODBC SQL type identifier for an INTERVAL DAY TO SECOND interval. See Also:Constant Field Values

INTERVAL_HOUR

public static final int INTERVAL_HOUR

The ODBC SQL type identifier for an INTERVAL HOUR interval. See Also:Constant Field Values

INTERVAL_HOUR_TO_MINUTE

public static final int INTERVAL_HOUR_TO_MINUTE

The ODBC SQL type identifier for an INTERVAL HOUR TO MINUTE interval. See Also:Constant Field Values

INTERVAL_HOUR_TO_SECOND

public static final int INTERVAL_HOUR_TO_SECOND

The ODBC SQL type identifier for an INTERVAL HOUR TO SECOND interval. See Also:Constant Field Values

INTERVAL_MINUTE

public static final int INTERVAL_MINUTE

The ODBC SQL type identifier for an INTERVAL MINUTE interval. See Also:Constant Field Values

INTERVAL_MINUTE_TO_SECOND

public static final int INTERVAL_MINUTE_TO_SECOND

The ODBC SQL type identifier for an INTERVAL MINUTE TO SECOND interval. See Also:Constant Field Values

INTERVAL_SECOND

public static final int INTERVAL_SECOND

The ODBC SQL type identifier for an INTERVAL SECOND interval. See Also:Constant Field Values

INTERVAL_YEAR

public static final int INTERVAL_YEAR

The ODBC SQL type identifier for an INTERVAL YEAR interval. See Also:Constant Field Values

INTERVAL_YEAR_TO_MONTH

public static final int INTERVAL_YEAR_TO_MONTH

The ODBC SQL type identifier for an INTERVAL YEAR TO MONTH interval. See Also:Constant Field Values

INTERVAL_MONTH

public static final int INTERVAL_MONTH

The ODBC SQL type identifier for an INTERVAL MONTH interval. See Also:Constant Field Values

UUID

public static final int UUID

The ODBC SQL type identifier for a UUID. See Also:Constant Field Values

Constructor Detail

VerticaTypes

public VerticaTypes()

5.21 - VerticaYearMonthInterval

  • java.lang.Object

  • com.vertica.dsi.dataengine.utilities.DSIMonthSpan

  • com.vertica.jdbc.VerticaYearMonthInterval

  • All Implemented Interfaces: java.lang.Cloneable

public class VerticaYearMonthInterval
extends com.vertica.dsi.dataengine.utilities.DSIMonthSpan
implements java.lang.Cloneable

The JDBC representation of the Vertica INTERVAL YEAR TO MONTH type. It represents a span of time measured in years and months.

The JDBC specification does not define first class support for interval data types. There are no java.sql.Types type identifiers for intervals, there is no built in setter on the PreparedStatement interface and no built in getter on the ResultSet interface.

Instead, the Vertica JDBC driver follows the ODBC standard when it can. Each of the 3 year/month interval ranges is identified by the ODBC standard SQL type identifier. Those identifiers are recreated as integer fields in this class, analogous to those defined for the other data types by java.sql.Types.

To insert a year/month interval into the database, create an instance of this class and pass it to PreparedStatement.setObject, optionally passing one of the ODBC SQL types defined by this class as the target type parameter.

To retrieve a VericaYearMonthInterval from the database, select an INTERVAL YEAR TO MONTH column, call ResultSet.getObject and cast the result to a VerticaYearMonthInterval

Field Summary

Modifier and Type Field and Description
static int INTERVAL_MONTH Deprecated. superseded by VerticaTypes.INTERVAL_MONTH
static int INTERVAL_YEAR Deprecated. superseded by VerticaTypes.INTERVAL_YEAR
static int INTERVAL_YEAR_TO_MONTH Deprecated. superseded by VerticaTypes.INTERVAL_YEAR_TO_MONTH

Constructor Summary

Constructor and Description
VerticaYearMonthInterval(int year, int month, boolean isNegative) Constructs a new VerticaYearMonthInterval.
VerticaYearMonthInterval(int type, int year, int month, boolean isNegative) Constructs a new VerticaYearMonthInterval.

Method Summary

Modifier and Type Method and Description
VerticaYearMonthInterval clone() Returns a deep copy of this VerticaYearMonthInterval.
boolean equals(java.lang.Object obj) Returns true if obj is a VerticaYearMonthInterval and it represents the same span of time as this interval, regardless of which units are set.
int getIntervalType() Gets the ODBC SQL type identifier for this interval.
int hashCode() The hash code of an interval is calculated first by converting this interval to a number of months.
static boolean isYearMonthInterval(int type) A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 3 year/month intervals that this class is capable of representing.
void setMonth(int month) Sets the months component of this interval.
void setYear(int year) Sets the years component of this interval.
java.lang.String toString() Returns a string representation of this interval.

Methods inherited from class com.vertica.dsi.dataengine.utilities.DSIMonthSpan

getMonth, getYear, isNegative, setIsNegative

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

INTERVAL_YEAR

public static final int INTERVAL_YEAR

Deprecated. superseded by VerticaTypes.INTERVAL_YEAR The ODBC SQL type identifier for an INTERVAL YEAR interval. See Also:Constant Field Values

INTERVAL_YEAR_TO_MONTH

public static final int INTERVAL_YEAR_TO_MONTH

Deprecated. superseded by VerticaTypes.INTERVAL_YEAR_TO_MONTH The ODBC SQL type identifier for an INTERVAL YEAR TO MONTH interval. See Also:Constant Field Values

INTERVAL_MONTH

public static final int INTERVAL_MONTH

Deprecated. superseded by VerticaTypes.INTERVAL_MONTH The ODBC SQL type identifier for an INTERVAL MONTH interval. See Also:Constant Field Values

Constructor Detail

VerticaYearMonthInterval

public VerticaYearMonthInterval(int year,
int month,
boolean isNegative)

Constructs a new VerticaYearMonthInterval. The type is assumed to be INTERVAL_YEAR_TO_MONTH. Parameters:year - The number of years in this interval. Must be no less than zero.month - The number of months in this interval. Must be no less than zero.isNegative - True if this interval is negative, false if positive. Throws: java.lang.IllegalArgumentException - If year or month are negative.

VerticaYearMonthInterval

public VerticaYearMonthInterval(int type,
int year,
int month,
boolean isNegative)

Constructs a new VerticaYearMonthInterval. Parameters:type - The ODBC SQL type identifier for this interval.year - The number of years in this interval. Must be no less than zero.month - The number of months in this interval. Must be no less than zero.isNegative - True if this interval is negative, false if positive. Throws: java.lang.IllegalArgumentException - If year or month are negative, or if type is not one of the ODBC SQL type identifiers defined by this class.

Method Detail

setYear

public void setYear(int year)

Sets the years component of this interval. If this interval has no year component, it will be converted to a number of months.

Overrides setYear in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Parameters:year - A positive number of years. Throws: java.lang.IllegalArgumentException - If year is negative, or if using this many years would cause the interval to overflow.

setMonth

public void setMonth(int month)

Sets the months component of this interval. If this interval has no month component, it will be converted to a number of years. Any fraction on the converted years value is rounded down.

Overrides setMonth in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Parameters:month - A positive number of months. Throws: java.lang.IllegalArgumentException - If month is negative, or if using this many months would cause the interval to overflow.

hashCode

public int hashCode()

The hash code of an interval is calculated first by converting this interval to a number of months. Since the hash code must fit in an integer, it is possible that this calculation will overflow. Regardless of whether or not there was overflow, this number is then multiplied by -1 if this interval negative.

Overrides hashCode in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Returns A hash code for this interval.

equals

public boolean equals(java.lang.Object obj)

Returns true if obj is a VerticaYearMonthInterval and it represents the same span of time as this interval, regardless of which units are set. For example, a SQL INTERVAL YEAR of 1 year is equal to an INTERVAL YEAR TO MONTH of 1 year, 0 months, and an INTERVAL MONTH of 12 months.

Overrides equals in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Parameters:obj - An object to compare. Returns true if obj represents the same span of time as this interval.

clone

public VerticaYearMonthInterval clone()

Returns a deep copy of this VerticaYearMonthInterval. Equivalent to calling new VerticaYearMonthInterval(getIntervalType(), getYear(), getMonth(), isNegative())

Overrides clone in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Returns A copy of this interval.

toString

public java.lang.String toString()

Returns a string representation of this interval. The format of this string is the same format that is recognized by the driver and database. Fields smaller than this interval's range (as defined by the ODBC type identifier) are not included in the String.

Overrides toString in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Returns The string representation of this interval.

getIntervalType

public int getIntervalType()

Gets the ODBC SQL type identifier for this interval. An interval's range can be determined by comparing the return value of this method with the INTERVAL_* constants defined in this class.

Overrides getIntervalType in class com.vertica.dsi.dataengine.utilities.DSIMonthSpan Returns The ODBC SQL type identifier for this interval.

isYearMonthInterval

public static boolean isYearMonthInterval(int type)

A helper method to determine if the provided ODBC interval subtype identifier corresponds to one of the 3 year/month intervals that this class is capable of representing.

The SQL_DATETIME_SUB column of the ResultSet returned by DatabaseMetaData.getColumns() will contain an ODBC interval subtype when the column is an interval. When this happens, the object returned by the driver when selecting that column will be a VerticaYearMonthInterval when the subtype is one of the 3 interval subtypes defined in this class. This helper method checks the provided type to see if it matches one of those 3 types. Parameters:type - An ODBC interval subtype identifier. Returns true If type corresponds to one of the 3 year/month interval types representable by a VerticaYearMonthInterval.

5.22 - VGet

  • Deprecated.  This feature is likely to stop working in a future release and to be removed as a result.
@Deprecated
public interface VGet

A scalable key-based accessor for table data. The VGet directly queries Vertica nodes that have the data needed for the query, avoiding the distributed planning and execution costs associated with a normal execution. For workloads that access single rows based on a primary key, the VGet can be used to achieve lower latency and higher throughput than a traditional execution.

The VGet uses projection segmentation metadata and a set of equality predicates on table columns to determine an appropriate projection and node to send a query to.

The addPredicate(String, Object) method is used to specify equality predicates on table columns. The VGet uses these predicates to evaluate the segmentation expression on the client to determine which node to query. At a minimum, the predicates columns passed must cover the segmentation expression of at least one of the table's underlying projections.

Call the execute() method to run query. By default, the VGet fetches all the columns of all the rows that satisfy the logical AND of all the equality predicates passed via addPredicate(String, Object). To further customize the get operation, the addOutputColumn(String), addOutputExpression(String) addPredicateExpression(String), addSortColumn(String, SortOrder) and setLimit(int) may be used.

addOutputExpression(String) and addPredicateExpression(String) accept arbitrary SQL expressions that operate on the table's columns as input. Care must be taken to ensure that the columns exist on the table and projection used by the VGet, and that the expressions do not require distributed resources to execute. If an expression is sufficiently complex as to require more than one node to execute, execute() will throw a SQLException if the FailOnMultiNodePlans connection property is true.

Internally, VGet operations span multiple JDBC connections (and multiple Vertica sessions) and therefore do not honor the parent connection's transaction semantics. If consistency is required across multiple executions, the parent VerticaRoutableConnection's consistent read API can be used to guarantee all operations occur at the same epoch.

The VGet is thread safe, but all methods are synchronized, so threads that share a VGet instance will never run in parallel. For better parallelism, each thread should have its own VGet instance. All VGet instances created by the same VerticaRoutableConnection share pooled connections and metadata in a manner that enables a high degree of parallelism.

Nested Class Summary

Modifier and Type Interface and Description
static class VGet.SortOrder Deprecated. Describes the ordering of result data.

Method Summary

Modifier and Type Method and Description
void addOutputColumn(java.lang.String outputCol) Deprecated. Adds an output column to the ResultSet returned by execute().
void addOutputExpression(java.lang.String outputExpr) Deprecated. Adds the result of a free-form SQL expression to the ResultSet returned by execute().
void addPredicate(java.lang.String column, java.lang.Object value) Deprecated. Adds or updates a column equality predicate.
void addPredicateExpression(java.lang.String expr) Deprecated. Adds a free-form SQL predicate to filter results.
void addSortColumn(java.lang.String column, VGet.SortOrder order) Deprecated. Adds the specified column to the sort order of the result.
void clearOutputs() Deprecated. Clears out all outputs added with addOutputColumn(String) and addOutputExpression(String).
void clearPredicates() Deprecated. Clears out all predicates added with addPredicate(String, Object) and addPredicateExpression(String).
void clearSortColumns() Deprecated. Clears out all columns added to the sort by addSortColumn(String, SortOrder)
void close() Deprecated. Releases resources used by this VGet.
java.sql.ResultSet execute() Deprecated. Fetches the desired results.
java.sql.SQLWarning getWarnings() Deprecated. Retrieves the first warning reported by calls on this VGet.
void setLimit(int limit) Deprecated. Imposes a limit on the number of rows returned by execute().

Method Detail

addPredicate

void addPredicate(java.lang.String column,
java.lang.Object value)
throws java.sql.SQLException

Deprecated.  Adds or updates a column equality predicate.

Before execution, this method must be called for all columns of the segmentation key. Additional predicates on non-key columns are also allowed. Parameters:column - The name of a column.value - The value of the column. Pass null to indicate a SQL NULL. Throws: java.sql.SQLException - If the column does not exist or the value is not compatible with the data type of the column.

addPredicateExpression

void addPredicateExpression(java.lang.String expr)
throws java.sql.SQLException

Deprecated.  Adds a free-form SQL predicate to filter results. Predicates can be on any column in the table. Segmentation key columns may be used, but must also be specified with addPredicate(String, Object).

Currently the VGet does not check columns references in predicate expressions. Because they are not checked, the VGet can not ensure that they will exist on the projection chosen to answer the query. This can happen if a projection's column names do not match the anchor table's column names, or if the projection is not a superprojection. If this occurs, execute() will fail with a syntax error.

To avoid this error, applications can override the VGet's projection choice by passing a projection name instead of a table name to VerticaRoutableConnection.prepareGet(String, String)

Parameters:expr - A valid SQL expression acting on a column in the table. Incorrect syntax will cause execute() to fail. Throws: java.sql.SQLException - If this VGet is closed. In the future, may fail if the expression has invalid syntax.

clearPredicates

void clearPredicates()

Deprecated.  Clears out all predicates added with addPredicate(String, Object) and addPredicateExpression(String).

addSortColumn

void addSortColumn(java.lang.String column,
VGet.SortOrder order)
throws java.sql.SQLException

Deprecated.  Adds the specified column to the sort order of the result. Parameters:column - The name of a column in the tableorder - The sort order for the column Throws: java.sql.SQLException - If this VGet is closed, or if the column does not exist on this table

clearSortColumns

void clearSortColumns()

Deprecated.  Clears out all columns added to the sort by addSortColumn(String, SortOrder)

addOutputColumn

void addOutputColumn(java.lang.String outputCol)
throws java.sql.SQLException

Deprecated.  Adds an output column to the ResultSet returned by execute(). If no output columns or expressions are specified, the entire row is returned. Parameters:outputCol - A column from the table. Throws: java.sql.SQLException - If the column does not exist on this table.

addOutputExpression

void addOutputExpression(java.lang.String outputExpr)
throws java.sql.SQLException

Deprecated.  Adds the result of a free-form SQL expression to the ResultSet returned by execute(). The expression can reference and perform computation on any columns in the table.

If no output columns or expressions are specified, the entire row is returned.

Currently the VGet does not check columns references in output expressions. Because they are not checked, the VGet can not ensure that they will exist on the projection chosen to answer the query. This can happen if a projection's column names do not match the anchor table's column names, or if the projection is not a superprojection. If this occurs, execute() will fail with a syntax error.

To avoid this error, applications can override the VGet's projection choice by passing a projection name instead of a table name to VerticaRoutableConnection.prepareGet(String, String)

Parameters:outputExpr - A valid SQL expression. Incorrect syntax will cause execute() to fail. Throws: java.sql.SQLException - If this VGet is closed. In the future, may fail if the expression has invalid syntax.

clearOutputs

void clearOutputs()

Deprecated.  Clears out all outputs added with addOutputColumn(String) and addOutputExpression(String).

setLimit

void setLimit(int limit)

Deprecated.  Imposes a limit on the number of rows returned by execute(). The default value of zero indicates no limit. Parameters:limit - A maximum number of rows to return, or zero to indicate no limit.

execute

java.sql.ResultSet execute()
throws java.sql.SQLException

Deprecated.  Fetches the desired results. Routes the request directly to the node containing the data. If the get operation requires a distributed execution (due to complex expressions specified by addOutputExpression(String) or addPredicateExpression(String)) and FailOnMultiNodePlans is set to true, this will throw a SQLException. If FailOnMultiNodePlans is false, a warning is generated and returned by getWarnings(). Returns A ResultSet iterator over the rows of data produced by the get operation. Throws: java.sql.SQLException - If not enough predicates were provided to determine the routing, or if a database error occurs.

close

void close()
throws java.sql.SQLException

Deprecated.  Releases resources used by this VGet. Throws: java.sql.SQLException - If close operation fails.

getWarnings

java.sql.SQLWarning getWarnings()
throws java.sql.SQLException

Deprecated.  Retrieves the first warning reported by calls on this VGet. Subsequent warnings will be chained to the SQLWarning returned.

The warning chain is cleared with each call to execute(). Returns The first SQLWarning, or null if there are no warnings Throws: java.sql.SQLException - If attempt to get warning fails.

5.23 - VGet.SortOrder

  • java.lang.Object

  • java.lang.Enum

  • com.vertica.jdbc.kv.VGet.SortOrder

  • All Implemented Interfaces: java.io.Serializable, java.lang.Comparable

Enclosing interface: VGet

public static enum VGet.SortOrder
extends java.lang.Enum

Describes the ordering of result data. Semantics for ordering are the same as Vertica's ORDER BY clause.

Enum Constant Summary

Enum Constant and Description
ASC
DESC

Method Summary

Modifier and Type Method and Description
static VGet.SortOrder valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VGet.SortOrder[] values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASC

public static final VGet.SortOrder ASC

DESC

public static final VGet.SortOrder DESC

Method Detail

values

public static VGet.SortOrder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VGet.SortOrder c : VGet.SortOrder.values())
  System.out.println(c);

Returns an array containing the constants of this enum type, in the order they are declared

valueOf

public static VGet.SortOrder valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) Parameters:name - the name of the enum constant to be returned. Returns the enum constant with the specified name Throws: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name java.lang.NullPointerException - if the argument is null

5.24 - VHash

  • java.lang.Object

  • com.vertica.jdbc.kv.VHash

  • Deprecated.  This feature is likely to stop working in a future release and to be removed as a result.

@Deprecated
public class VHash
extends java.lang.Object

Implementation of Vertica's hash function used for data segmentation on the cluster. For single-value hashing, use static methods. For multi-value hashing, instantiate the class and call the add methods to add each value (order matters).

Constructor Summary

Constructor and Description
VHash() Deprecated. Creates an instance suitable for computing a hash of a chain of values, for use when a projection is segmented by multiple columns.

Method Summary

Modifier and Type Method and Description
void addBoolean(boolean v) Deprecated. adds hash of boolean value to the chain.
void addBooleanNull() Deprecated. adds hash of boolean null value to the chain.
void addBytes(byte[] v) Deprecated. adds hash of binary value to the chain.
void addDate(java.util.Date v, java.util.Calendar c) Deprecated. adds hash of Date value to the chain.
void addDate(java.sql.Date v, java.util.Calendar c) Deprecated. adds hash of Date value to the chain.
void addDouble(double v) Deprecated. adds hash of double value to the chain.
void addDoubleNull() Deprecated. adds hash of double null value to the chain.
void addLong(long v) Deprecated. adds hash of long value to the chain.
void addNull() Deprecated. Adds hash of null value to the chain.
void addNumeric(java.math.BigDecimal src, int typemod) Deprecated. adds hash of numeric value to the chain
void addString(java.lang.String v) Deprecated. adds hash of String value to the chain.
void addTime(java.util.Date v, java.util.Calendar c) Deprecated. adds hash of Time value to the chain.
void addTime(java.sql.Time v, java.util.Calendar c) Deprecated. adds hash of Time value to the chain.
void addTimestamp(java.util.Date v, java.util.Calendar c) Deprecated. adds hash of Timestamp value to the chain.
void addTimestamp(long v) Deprecated. adds hash of Timestamp value expressed as milliseconds since Jan 1, 1970 UTC to the chain.
void addTimestamp(java.sql.Timestamp v, java.util.Calendar c) Deprecated. adds hash of Timestamp value to the chain.
void addUUID(java.util.UUID v) Deprecated. adds hash of UUID value to the chain.
void addUUIDNull() Deprecated. adds hash of null UUID to the chain.
long getHash() Deprecated. returns the current hash value
static java.lang.String getNodeFor(java.sql.Connection conn, java.lang.String schema, java.lang.String proj, long hashValue) Deprecated. Returns the name of the node that will be responsible for the provided value in the hash space for a given projection.
static java.lang.String getNodeFor(java.lang.String getProjSegmentsOutput, long hashValue) Deprecated. Given a projection's get_projection_segments() output, this method will return the node that is responsible for the provided hashValue.
static long hashBoolean(boolean v) Deprecated. compute hash of boolean value
static long hashBooleanNull() Deprecated. compute hash of boolean null value
static long hashBytes(byte[] b) Deprecated. compute hash of a binary value
static long hashBytesNull() Deprecated. compute hash of a binary null value
static long hashBytesNull(long input) Deprecated. compute hash of a binary null value
static long hashDate(java.util.Date v) Deprecated. compute hash of java.util.Date value
static long hashDate(java.sql.Date v) Deprecated. compute hash of java.sql.Date value
static long hashDouble(double v) Deprecated. compute hash of double value
static long hashDoubleNull() Deprecated. compute hash of double null value
static long hashLong(long v) Deprecated. compute hash of long value
static long hashNull() Deprecated. Compute hash of null value
static long hashNull(long input) Deprecated. compute hash of null value.
static long hashNumeric(java.math.BigDecimal src, int typemod) Deprecated. compute hash of a numeric value
static long hashString(java.lang.String s) Deprecated. compute hash of String value
static long hashStringNull() Deprecated. compute hash of String null value
static long hashTime(java.sql.Time v) Deprecated. compute hash of Time value
static long hashTimestamp(long java_ms) Deprecated. compute hash of Timestamp value expressed in milliseconds since Jan 1, 1970.
static long hashTimestamp(java.sql.Timestamp v) Deprecated. compute hash of java.sql.Timestamp value
static long hashUUID(java.util.UUID v, long input) Deprecated. compute hash of UUID value.
static long hashUUIDNull() Deprecated. compute a hash of a null UUID value.
static long hashUUIDNull(long input) Deprecated. compute a hash of a null UUID value.
void reset() Deprecated. resets hash value for next chain.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VHash

public VHash()

Deprecated.  Creates an instance suitable for computing a hash of a chain of values, for use when a projection is segmented by multiple columns.

Method Detail

hashBooleanNull

public static long hashBooleanNull()

Deprecated.  compute hash of boolean null value Returns long hash value

hashBoolean

public static long hashBoolean(boolean v)

Deprecated.  compute hash of boolean value Parameters:v - boolean value to hash Returns long hash value

hashLong

public static long hashLong(long v)

Deprecated.  compute hash of long value Parameters:v - long value to hash Returns long hash value

hashNull

public static long hashNull(long input)

Deprecated.  compute hash of null value. First argument used to hash a list of values. Parameters:input - long value from previous hash function output Returns long hash value

hashNull

public static long hashNull()

Deprecated.  Compute hash of null value Returns long hash value

hashUUID

public static long hashUUID(java.util.UUID v,
long input)

Deprecated.  compute hash of UUID value. Parameters:v - fixed binary value to hashinput - variable input value to hash Returns long hash value

hashUUIDNull

public static long hashUUIDNull(long input)

Deprecated.  compute a hash of a null UUID value. First argument used to hash a list of values. Parameters:input - long value from previous hash function output Returns The hash for null UUID.

hashUUIDNull

public static long hashUUIDNull()

Deprecated.  compute a hash of a null UUID value. Returns The hash for null UUID.

hashDouble

public static long hashDouble(double v)

Deprecated.  compute hash of double value Parameters:v - double value to hash Returns long hash value

hashDoubleNull

public static long hashDoubleNull()

Deprecated.  compute hash of double null value Returns long hash value

hashTimestamp

public static long hashTimestamp(long java_ms)

Deprecated.  compute hash of Timestamp value expressed in milliseconds since Jan 1, 1970. Parameters:java_ms - A number of milliseconds since Jan 1, 1970 GMT Returns long hash value

hashDate

public static long hashDate(java.util.Date v)

Deprecated.  compute hash of java.util.Date value Parameters:v - Date value to hash Returns long hash value

hashDate

public static long hashDate(java.sql.Date v)

Deprecated.  compute hash of java.sql.Date value Parameters:v - Date value to hash Returns long hash value

hashTimestamp

public static long hashTimestamp(java.sql.Timestamp v)

Deprecated.  compute hash of java.sql.Timestamp value Parameters:v - Timestamp value to hash Returns long hash value

hashTime

public static long hashTime(java.sql.Time v)

Deprecated.  compute hash of Time value Parameters:v - Time value to hash Returns long hash value

hashString

public static long hashString(java.lang.String s)

Deprecated.  compute hash of String value Parameters:s - String value to hash Returns long hash value

hashStringNull

public static long hashStringNull()

Deprecated.  compute hash of String null value Returns long hash value

hashBytesNull

public static long hashBytesNull()

Deprecated.  compute hash of a binary null value Returns long hash value

hashBytesNull

public static long hashBytesNull(long input)

Deprecated.  compute hash of a binary null value Parameters:input - long value from previous hash function output Returns long hash value

hashBytes

public static long hashBytes(byte[] b)

Deprecated.  compute hash of a binary value Parameters:b - binary value to hash Returns long hash value

hashNumeric

public static long hashNumeric(java.math.BigDecimal src,
int typemod)

Deprecated.  compute hash of a numeric value Parameters:src - Numeric value to hashtypemod - The precision and scale of the numeric. Returns long hash value

reset

public void reset()

Deprecated.  resets hash value for next chain.

addNull

public void addNull()

Deprecated.  Adds hash of null value to the chain. Use hashBooleanNull() to hash a boolean null.

addBoolean

public void addBoolean(boolean v)

Deprecated.  adds hash of boolean value to the chain. Parameters:v - boolean value to hash

addBooleanNull

public void addBooleanNull()

Deprecated.  adds hash of boolean null value to the chain.

addLong

public void addLong(long v)

Deprecated.  adds hash of long value to the chain. Parameters:v - long value to hash

addUUID

public void addUUID(java.util.UUID v)

Deprecated.  adds hash of UUID value to the chain. Parameters:v - fixed binary value to hash

addUUIDNull

public void addUUIDNull()

Deprecated.  adds hash of null UUID to the chain.

addString

public void addString(java.lang.String v)

Deprecated.  adds hash of String value to the chain. Parameters:v - String value to hash

addBytes

public void addBytes(byte[] v)

Deprecated.  adds hash of binary value to the chain. Parameters:v - String value to hash

addTimestamp

public void addTimestamp(long v)

Deprecated.  adds hash of Timestamp value expressed as milliseconds since Jan 1, 1970 UTC to the chain. Parameters:v - long value to hash

addDate

public void addDate(java.util.Date v,
java.util.Calendar c)

Deprecated.  adds hash of Date value to the chain. Parameters:v - Date value to hashc - The calendar to providing a timezone context for v.

addDate

public void addDate(java.sql.Date v,
java.util.Calendar c)

Deprecated.  adds hash of Date value to the chain. Parameters:v - Date value to hash.c - The calendar to providing a timezone context for v.

addTimestamp

public void addTimestamp(java.sql.Timestamp v,
java.util.Calendar c)

Deprecated.  adds hash of Timestamp value to the chain. Parameters:v - Timestamp value to hashc - The calendar to providing a timezone context for v.

addTimestamp

public void addTimestamp(java.util.Date v,
java.util.Calendar c)

Deprecated.  adds hash of Timestamp value to the chain. Parameters:v - Timestamp value to hashc - The calendar to providing a timezone context for v.

addTime

public void addTime(java.sql.Time v,
java.util.Calendar c)

Deprecated.  adds hash of Time value to the chain. Parameters:v - Time value to hashc - The calendar to providing a timezone context for v. The date component of the calendar will influence the time due to DST.

addTime

public void addTime(java.util.Date v,
java.util.Calendar c)

Deprecated.  adds hash of Time value to the chain. Parameters:v - Time value to hashc - The calendar to providing a timezone context for v. The date component of the calendar will influence the time due to DST.

addDouble

public void addDouble(double v)

Deprecated.  adds hash of double value to the chain. Parameters:v - double value to hash

addDoubleNull

public void addDoubleNull()

Deprecated.  adds hash of double null value to the chain.

addNumeric

public void addNumeric(java.math.BigDecimal src,
int typemod)

Deprecated.  adds hash of numeric value to the chain Parameters:src - The numeric value to add to hash.typemod - The precision and scale of the numeric. Throws: java.lang.IllegalArgumentException - if src is too large to fit in a numeric.

getHash

public long getHash()

Deprecated.  returns the current hash value Returns long value of hash

getNodeFor

public static java.lang.String getNodeFor(java.sql.Connection conn,
java.lang.String schema,
java.lang.String proj,
long hashValue)
throws java.sql.SQLException

Deprecated.  Returns the name of the node that will be responsible for the provided value in the hash space for a given projection.

This method uses the provided Connection to call the get_projection_segments() SQL meta-function. It then relies on getNodeFor(String, long) to determine which node to use.

In situations where you need to compute many hashes for the same projection, it is would be much more efficient to call get_projection_segments() once via JDBC and then pass that output to getNodeFor(String, long) directly.

Caution: There is no guarantee that connecting to the node returned by this method will guarantee reduced intra-node traffic for a query or load based on the input hash value. While that is often true, the Vertica Optmizer may not always construct such a plan.

Additionally, no check is done to ensure that the input hash value was created in a manner that is consistent with the segmentation of the provided projection. This means, for example, if the projection is segmented by an INTEGER column and the caller provides a hashed DOUBLE PRECISION value, the answer may not be correct. Parameters:conn - A connection to a vertica database containing the projectionschema - The schema of the projectionproj - The name of the projectionhashValue - A hashed data value for this projection Returns The name of the node that is responsible for the provided hash value Throws: java.sql.SQLException - If a database error occurs java.lang.IllegalArgumentException - if the projection provided is not segmented by HASH(...) ALL NODES

getNodeFor

public static java.lang.String getNodeFor(java.lang.String getProjSegmentsOutput,
long hashValue)

Deprecated.  Given a projection's get_projection_segments() output, this method will return the node that is responsible for the provided hashValue.

The get_projection_segments() SQL meta-function returns a list of the segment ranges each node is responsible for for a given projection. This method parses the output of that function and maps the provided hashValue to the range to determine a node name.

Caution: There is no guarantee that connecting to the node returned by this method will guarantee reduced intra-node traffic for a query or load based on the input hash value. While that is often true, the Vertica Optmizer may not always construct such a plan.

Additionally, no check is done to ensure that the input hash value was created in a manner that is consistent with the segmentation of the provided projection. This means, for example, if the projection is segmented by an INTEGER column and the caller provides a hashed DOUBLE PRECISION value, the answer may not be correct. Parameters:getProjSegmentsOutput - -- a String containing the return value of the get_projection_segments() SQL meta-function for a particular projection.hashValue - -- a hashed data value for the projection. Returns string identifying node. Throws: java.lang.IllegalArgumentException - if getProjSegmentsOutput is malformed in any way, either due to bad input or due to not using a properly segmented projection.