Vertica 24.1.x – Class Index

Api-Reference: Class Hierarchy

Mon, 01 Jan 0001 00:00:00 +0000

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

[detail level 12345]

Ccom.vertica.sdk.BaseDataOID
Ccom.vertica.sdk.Basics
Ccom.vertica.sdk.BuildInfo
Ccom.vertica.sdk.ColumnTypes
Ccom.vertica.sdk.ContinuousReader
Ccom.vertica.sdk.ContinuousRejecter
Ccom.vertica.sdk.ContinuousUDParser.CoroutineState
Ccom.vertica.sdk.DataBuffer
Ccom.vertica.sdk.DFSConstants
Ccom.vertica.sdk.DFSFile
Ccom.vertica.sdk.DFSFile.DFSDistribution
Ccom.vertica.sdk.DFSFile.DFSRootParentType
Ccom.vertica.sdk.DFSFile.DFSScope
Ccom.vertica.sdk.DFSFileReader
Ccom.vertica.sdk.DFSFileStatus
Ccom.vertica.sdk.DFSFileWriter
Ccom.vertica.sdk.FileManager
Ccom.vertica.sdk.PerColumnParamReader
Ccom.vertica.sdk.PGUDxShared
▼Ccom.vertica.sdk.PlanContext
▼Ccom.vertica.sdk.NodeSpecifyingPlanContext
Ccom.vertica.sdk.ExecutorPlanContext
Ccom.vertica.sdk.Portion
Ccom.vertica.sdk.RejectedRecord
Ccom.vertica.sdk.ScalarFunction.InterfaceType
Ccom.vertica.sdk.ScalarFunctionFactory.strictness
Ccom.vertica.sdk.ScalarFunctionFactory.volatility
Ccom.vertica.sdk.ServerInterface
Ccom.vertica.sdk.SessionParamReaderMap
Ccom.vertica.sdk.SessionParamWriterMap
Ccom.vertica.sdk.SizedColumnTypes
Ccom.vertica.sdk.StandardTypeCoercion.BooleanEvaluation
Ccom.vertica.sdk.StandardTypeCoercion.SpecialBigDecimal
Ccom.vertica.sdk.State
Ccom.vertica.sdk.State.InputState
Ccom.vertica.sdk.State.StreamState
Ccom.vertica.sdk.StringUtils
Ccom.vertica.sdk.TimestampUDxShared
Ccom.vertica.sdk.TimestampUDxShared.DTtype
Ccom.vertica.sdk.TransformFunctionPhase	Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function
▼Ccom.vertica.sdk.TypeCoercion
▼Ccom.vertica.sdk.NullTypeCoercion
▼Ccom.vertica.sdk.NoopTypeCoercion
Ccom.vertica.sdk.StandardTypeCoercion
Ccom.vertica.sdk.TypeCoercion.MetaType
Ccom.vertica.sdk.TypeCoercionPolicy
▼Ccom.vertica.sdk.UDXFactory
Ccom.vertica.sdk.AnalyticFunctionFactory
Ccom.vertica.sdk.MultiPhaseTransformFunctionFactory
Ccom.vertica.sdk.ScalarFunctionFactory
Ccom.vertica.sdk.TransformFunctionFactory
▼Ccom.vertica.sdk.UDLFactory
Ccom.vertica.sdk.FilterFactory
▼Ccom.vertica.sdk.IterativeSourceFactory
Ccom.vertica.sdk.SourceFactory
Ccom.vertica.sdk.ParserFactory
Ccom.vertica.sdk.UDXFactory.UDXType
Ccom.vertica.sdk.UDXLibrary
▼Ccom.vertica.sdk.UDXObject
▼Ccom.vertica.sdk.SourceIterator
Ccom.vertica.sdk.DefaultSourceIterator
Ccom.vertica.sdk.UDFilter
▼Ccom.vertica.sdk.UDParser
Ccom.vertica.sdk.ContinuousUDParser
▼Ccom.vertica.sdk.UDXFunction
Ccom.vertica.sdk.AnalyticFunction
Ccom.vertica.sdk.ScalarFunction
Ccom.vertica.sdk.TransformFunction
▼Ccom.vertica.sdk.UnsizedUDSource
Ccom.vertica.sdk.UDSource
▼Ccom.vertica.sdk.VerticaBlock
▼Ccom.vertica.sdk.BlockReader
▼Ccom.vertica.sdk.ParamReader
▼Ccom.vertica.sdk.ParamWriter
Ccom.vertica.sdk.ExecutorParamWriter
▼Ccom.vertica.sdk.PartitionReader
Ccom.vertica.sdk.AnalyticPartitionReader
Ccom.vertica.sdk.BlockWriter
▼Ccom.vertica.sdk.PartitionWriter
Ccom.vertica.sdk.AnalyticPartitionWriter
Ccom.vertica.sdk.StreamWriter
Ccom.vertica.sdk.VerticaType
▼Ccom.vertica.sdk.vmap.v1.KeySelector
Ccom.vertica.sdk.vmap.v1.Encoder
Ccom.vertica.sdk.vmap.v1.Encoder.MatchingKeySelector
Ccom.vertica.sdk.VNumeric
Ccom.vertica.sdk.VResources
Ccom.vertica.sdk.VString
▼CRuntimeException
Ccom.vertica.sdk.UdfException
▼CThrowable
Ccom.vertica.sdk.DestroyInvocation
▼CIllegalArgumentException
Ccom.vertica.sdk.TypeCoercionException
▼Ccom.vertica.sdk.vmap.VMapEncodingException
Ccom.vertica.sdk.vmap.InvalidMapKeyException
▼CComparator
Ccom.vertica.sdk.IdentComparator

Api-Reference: Class Hierarchy

Mon, 01 Jan 0001 00:00:00 +0000

Go to the textual class hierarchy

Api-Reference: Class List

Mon, 01 Jan 0001 00:00:00 +0000

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 1234567]

▼Ncom
▼Nvertica
▼Nsdk
▼Nvmap
▼Nv1
▼CEncoder
CMatchingKeySelector
CKeySelector
CInvalidMapKeyException
CVMapEncodingException
CAnalyticFunction
CAnalyticFunctionFactory
CAnalyticPartitionReader
CAnalyticPartitionWriter
CBaseDataOID
CBasics
CBlockReader
CBlockWriter
CBuildInfo
CColumnTypes
CContinuousReader
CContinuousRejecter
▼CContinuousUDParser
CCoroutineState
CDataBuffer
CDefaultSourceIterator
CDestroyInvocation
CDFSConstants
▼CDFSFile
CDFSDistribution
CDFSRootParentType
CDFSScope
CDFSFileReader
CDFSFileStatus
CDFSFileWriter
CExecutorParamWriter
CExecutorPlanContext
CFileManager
CFilterFactory
CIdentComparator
CIterativeSourceFactory
CMultiPhaseTransformFunctionFactory
CNodeSpecifyingPlanContext
CNoopTypeCoercion
CNullTypeCoercion
CParamReader
CParamWriter
CParserFactory
CPartitionReader
CPartitionWriter
CPerColumnParamReader
CPGUDxShared
CPlanContext
CPortion
CRejectedRecord
▼CScalarFunction
CInterfaceType
▼CScalarFunctionFactory
Cstrictness
Cvolatility
CServerInterface
CSessionParamReaderMap
CSessionParamWriterMap
CSizedColumnTypes
CSourceFactory
CSourceIterator
▼CStandardTypeCoercion
CBooleanEvaluation
CSpecialBigDecimal
▼CState
CInputState
CStreamState
CStreamWriter
CStringUtils
▼CTimestampUDxShared
CDTtype
CTransformFunction
CTransformFunctionFactory
CTransformFunctionPhase	Interface to provide compile-time information for a single phase of a multi-phase user-defined transform function
▼CTypeCoercion
CMetaType
CTypeCoercionException
CTypeCoercionPolicy
CUdfException
CUDFilter
CUDLFactory
CUDParser
CUDSource
▼CUDXFactory
CUDXType
CUDXFunction
CUDXLibrary
CUDXObject
CUnsizedUDSource
CVerticaBlock
CVerticaType
CVNumeric
CVResources
CVString

Api-Reference: com.vertica.sdk.AnalyticFunction Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆cancel()

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().

◆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

◆destroy() [1/2]

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().

◆destroy() [2/2]

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

◆isCanceled()

boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

◆processPartition()

abstract void com.vertica.sdk.AnalyticFunction.processPartition(ServerInterface srvInterface, AnalyticPartitionReader input_reader, AnalyticPartitionWriter output_writer) throws UdfException, DestroyInvocation

abstract

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

◆setup()

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)

Api-Reference: com.vertica.sdk.AnalyticFunction Member List

Mon, 01 Jan 0001 00:00:00 +0000

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
setup(ServerInterface srvInterface, SizedColumnTypes argTypes)	com.vertica.sdk.UDXFunction
UDXObject() (defined in com.vertica.sdk.UDXObject)	com.vertica.sdk.UDXObject

Api-Reference: com.vertica.sdk.AnalyticFunctionFactory Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆createAnalyticFunction()

abstract AnalyticFunction com.vertica.sdk.AnalyticFunctionFactory.createAnalyticFunction(ServerInterface srvInterface)

abstract

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.

◆getParameterType()

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

◆getPerInstanceResources() [1/2]

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().

◆getPerInstanceResources() [2/2]

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.

◆getPrototype()

abstract void com.vertica.sdk.UDXFactory.getPrototype(ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

abstractinherited

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

Referenced by com.vertica.sdk.ScalarFunctionFactory.getReturnType().

◆getReturnType()

abstract void com.vertica.sdk.UDXFactory.getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException

abstractinherited

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.

◆getUDXFactoryType()

UDXType com.vertica.sdk.AnalyticFunctionFactory.getUDXFactoryType()

Returns the object type internally used by Vertica

Api-Reference: com.vertica.sdk.AnalyticFunctionFactory Member List

Mon, 01 Jan 0001 00:00:00 +0000

This is the complete list of members for com.vertica.sdk.AnalyticFunctionFactory, including all inherited members.

createAnalyticFunction(ServerInterface srvInterface)	com.vertica.sdk.AnalyticFunctionFactory
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
getReturnType(ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)	com.vertica.sdk.UDXFactory
getUDXFactoryType()	com.vertica.sdk.AnalyticFunctionFactory
libOid (defined in com.vertica.sdk.UDXFactory)	com.vertica.sdk.UDXFactory	protected
sqlName (defined in com.vertica.sdk.UDXFactory)	com.vertica.sdk.UDXFactory	protected

Api-Reference: com.vertica.sdk.AnalyticPartitionReader Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆addCol() [1/4]

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().

◆addCol() [2/4]

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.

◆addCol() [3/4]

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.

◆addCol() [4/4]

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

◆getBoolean()

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.

◆getColDataAreaRef()

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().

◆getColRef()

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

◆getDate()

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.

◆getDouble()

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.

◆getInlineColBuffer()

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

◆getLong()

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

◆getNumCols()

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

◆getNumRows()

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

◆getString()

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.

◆getStringLength()

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

◆getStringLoc()

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().

◆getTimestamp()

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'.

◆getTypeMetaData()

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

◆getVNumeric()

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.

◆getVString()

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().

◆isBooleanNull()

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.

◆isDateNull()

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().

◆isDoubleNull()

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.

◆isLongNull()

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

◆isStringNull()

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().

◆isTimestampInfinite()

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().

◆isTimestampInfiniteNeg()

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().

◆isTimestampInfinitePos()

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().

◆isTimestampNull()

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().

◆readNextBlock()

abstract boolean com.vertica.sdk.AnalyticPartitionReader.readNextBlock() throws UdfException, DestroyInvocation

abstract

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

Returns false if there's no more input data

Api-Reference: com.vertica.sdk.AnalyticPartitionReader Member List

Mon, 01 Jan 0001 00:00:00 +0000

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
resetBuffers() (defined in com.vertica.sdk.VerticaBlock)	com.vertica.sdk.VerticaBlock
setupColsAndStrides() (defined in com.vertica.sdk.AnalyticPartitionReader)	com.vertica.sdk.AnalyticPartitionReader
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

Api-Reference: com.vertica.sdk.AnalyticPartitionWriter Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆addCol() [1/4]

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().

◆addCol() [2/4]

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.

◆addCol() [3/4]

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.

◆addCol() [4/4]

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

◆copyFromInput()

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)

◆getColDataAreaRef()

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().

◆getColRef()

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

◆getDefaultTypeCoercion()

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.

◆getInlineColBuffer()

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

Parameters

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

Returns the ByteBuffer for the column

Referenced by

◆getNumCols()

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

◆getNumRows()

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

◆getTypeMetaData()

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

◆setBooleanValue()

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

◆setDateValue()

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

◆setDefaultTypeCoercion()

TypeCoercion com.vertica.sdk.PartitionWriter.setDefaultTypeCoercion(TypeCoercion coerce)

inherited Set the default type coercion instance.

◆setDoubleValue()

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

◆setLongValue()

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

◆setNumericValue()

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

◆setRowFromMap() [1/2]

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()

◆setRowFromMap() [2/2]

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)

◆setStringBytes()

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

◆setStringValue()

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

◆setTimestampValue()

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

◆setValue()

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().

◆setVMap() [1/2]

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()

◆setVMap() [2/2]

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.

Api-Reference: com.vertica.sdk.AnalyticPartitionWriter Member List

Mon, 01 Jan 0001 00:00:00 +0000

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() (defined in com.vertica.sdk.AnalyticPartitionWriter)	com.vertica.sdk.AnalyticPartitionWriter
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

Api-Reference: com.vertica.sdk.BaseDataOID Enum Reference

Mon, 01 Jan 0001 00:00:00 +0000

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)

Api-Reference: com.vertica.sdk.BaseDataOID Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.Basics Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆JavaSQLDateToVerticaDate()

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

◆VerticaDateToJavaSQLDate()

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

Referenced by com.vertica.sdk.BlockReader.getDate().

◆VerticaTimestampToJavaSQLTimestamp()

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

Referenced by com.vertica.sdk.BlockReader.getTimestamp().

Api-Reference: com.vertica.sdk.Basics Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.BlockReader Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆addCol() [1/4]

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().

◆addCol() [2/4]

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.

◆addCol() [3/4]

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.

◆addCol() [4/4]

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

◆getBoolean()

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.

◆getColDataAreaRef()

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().

◆getColRef()

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

◆getDate()

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.

◆getDouble()

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.

◆getInlineColBuffer()

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

Parameters

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

Returns the ByteBuffer for the column

Referenced by

◆getLong()

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

◆getNumCols()

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

◆getNumRows()

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

◆getString()

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.

◆getStringLength()

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

◆getStringLoc()

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().

◆getTimestamp()

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'.

◆getTypeMetaData()

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

◆getVNumeric()

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.

◆getVString()

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().

◆isBooleanNull()

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.

◆isDateNull()

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().

◆isDoubleNull()

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.

◆isLongNull()

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

◆isStringNull()

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().

◆isTimestampInfinite()

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().

◆isTimestampInfiniteNeg()

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().

◆isTimestampInfinitePos()

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().

◆isTimestampNull()

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().

◆next()

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

Api-Reference: com.vertica.sdk.BlockReader Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.BlockWriter Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆addCol() [1/4]

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().

◆addCol() [2/4]

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.

◆addCol() [3/4]

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.

◆addCol() [4/4]

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

◆getColDataAreaRef()

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().

◆getColRef()

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

◆getInlineColBuffer()

ByteBuffer com.vertica.sdk.VerticaBlock.getInlineColBuffer(int idx)

Parameters

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

Returns the ByteBuffer for the column

Referenced by

◆getNumCols()

int com.vertica.sdk.VerticaBlock.getNumCols()

inherited Returns the number of arguments held by this reader.

◆getNumRows()

int com.vertica.sdk.VerticaBlock.getNumRows()

inherited Returns the number of rows held by this block.

◆getTypeMetaData()

SizedColumnTypes com.vertica.sdk.VerticaBlock.getTypeMetaData()

inherited Returns information about the types and numbers of arguments

Referenced by

◆getVStringWriter()

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.

◆next()

void com.vertica.sdk.BlockWriter.next()

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

◆setBoolean()

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.

◆setDate()

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.

◆setDouble()

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.

◆setLong()

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.

◆setNumeric()

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.

◆setString()

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.

◆setTimestamp()

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.

Api-Reference: com.vertica.sdk.BlockWriter Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.BuildInfo Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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 = "master"
static final String	VERTICA_BUILD_ID_Brand_Name = "Vertica Analytic Database"
static final String	VERTICA_BUILD_ID_Brand_Version = "v25.1.0"
static final String	VERTICA_BUILD_ID_Checksum = "b8809d9b667d1599d57ea9f73feecbca"
static final String	VERTICA_BUILD_ID_Codename = "Nibbler"
static final String	VERTICA_BUILD_ID_Date = "Fri Oct 4 04:49:28 2024"
static final String	VERTICA_BUILD_ID_Machine = "re-docker7-server"
static final String	VERTICA_BUILD_ID_Revision = "a741b15f902dfc3b1e6a52b8929be3f7dd0ab5a6"
static final String	VERTICA_BUILD_ID_SDK_Version = "24.2.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 = 24
static final int	VERTICA_BUILD_ID_SDK_Version_Minor = 2
static final int	VERTICA_BUILD_ID_SDK_Version_SP = 0

Api-Reference: com.vertica.sdk.BuildInfo Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.ColumnTypes Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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.

Api-Reference: com.vertica.sdk.ColumnTypes Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.ContinuousReader Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆capacity()

int com.vertica.sdk.ContinuousStreamer.capacity()

inherited Returns Number of bytes reserved

◆getBytesConsumed()

int com.vertica.sdk.ContinuousStreamer.getBytesConsumed()

inherited Returns returns the number of bytes consumed so far by the ContinuousStreamer.

◆getCs()

CoroutineState com.vertica.sdk.ContinuousStreamer.getCs()

inherited Returns returns the Co-routine state.

◆getCurrentBuffer()

DataBuffer com.vertica.sdk.ContinuousStreamer.getCurrentBuffer()

inherited Returns Returns current Buffer of the ContinuousStreamer.

◆getDataAt()

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()

◆getLastReservationSize()

int com.vertica.sdk.ContinuousStreamer.getLastReservationSize()

inherited Returns Returns the Last reservation size of the ContinuousStreamer.

◆getPrev_reserved()

int com.vertica.sdk.ContinuousStreamer.getPrev_reserved()

inherited Returns returns the previous reservation size.

◆getState()

InputState com.vertica.sdk.ContinuousStreamer.getState()

inherited Returns Returns the Input State of ContinuousStreamer.

◆isEOF()

boolean com.vertica.sdk.ContinuousStreamer.isEOF()

inherited Returns true iff we have reached the end of input stream and no data can be reserved

◆isNeedInput()

boolean com.vertica.sdk.ContinuousStreamer.isNeedInput()

inherited Returns boolean flag to indicate whether more input is needed or not.

◆noMoreData()

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

◆read()

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.

◆reserve()

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.

◆seek()

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

◆setCs()

void com.vertica.sdk.ContinuousStreamer.setCs(CoroutineState cs)

inherited Parameters

cs: used to set the Co-routine state

◆setCurrentBuffer()

void com.vertica.sdk.ContinuousStreamer.setCurrentBuffer(DataBuffer currentBuffer)

inherited Parameters

currentBuffer: used to set the currentBuffer of the ContinuousStreamer.

◆setLastReservationSize()

void com.vertica.sdk.ContinuousStreamer.setLastReservationSize(int lastReservationSize)

inherited Parameters

lastReservationSize: Used to set the lastReservationSize of the ContinuousStreamer

◆setNeedInput()

void com.vertica.sdk.ContinuousStreamer.setNeedInput(boolean needInput)

inherited Parameters

needInput: used to set the needInput flag of ContinuousStreamer.

◆setPrev_reserved()

void com.vertica.sdk.ContinuousStreamer.setPrev_reserved(int prev_reserved)

inherited Parameters

prev_reserved: used to set the previous reservation size.

◆setState()

void com.vertica.sdk.ContinuousStreamer.setState(InputState state)

inherited Parameters

state: used to set the InputState of ContinuousStreamer.

Api-Reference: com.vertica.sdk.ContinuousReader Member List

Mon, 01 Jan 0001 00:00:00 +0000

This is the complete list of members for com.vertica.sdk.ContinuousReader, including all inherited members.

Api-Reference: com.vertica.sdk.ContinuousRejecter Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆ContinuousRejecter()

com.vertica.sdk.ContinuousRejecter.ContinuousRejecter(ContinuousUDParserLocks continuousUDParserLocks)

Default Constructor

Parameters

continuousUDParserLocks: the locks

Member Function Documentation

◆reject()

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

Api-Reference: com.vertica.sdk.ContinuousRejecter Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.ContinuousUDParser Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆cancel()

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().

◆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

◆deinitialize()

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().

◆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.

◆getContinuousReader()

ContinuousReader com.vertica.sdk.ContinuousUDParser.getContinuousReader()

Returns returns ContinuousReader object of the ContinuousUDParser.

◆getContinuousRejector()

ContinuousRejecter com.vertica.sdk.ContinuousUDParser.getContinuousRejector()

Returns returns ContinuousRejector object of the ContinuousUDParser.

◆getRejectedRecord()

RejectedRecord com.vertica.sdk.ContinuousUDParser.getRejectedRecord()

Returns Returns information about the Rejected Record

◆getServerInterface()

ServerInterface com.vertica.sdk.ContinuousUDParser.getServerInterface()

Returns returns ServerInterface object of the ContinuousUDParser.

◆initialize()

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.
returnType: a SizedColumnTypes object.

Referenced by com.vertica.sdk.ContinuousUDParser.setup().

◆isCanceled()

boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

◆process()

final StreamState com.vertica.sdk.ContinuousUDParser.process(ServerInterface srvInterface, DataBuffer input, InputState input_state) throws UdfException,DestroyInvocation

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.

◆run()

abstract void com.vertica.sdk.ContinuousUDParser.run() throws UdfException

abstract

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.

◆setup()

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

◆writer

StreamWriter com.vertica.sdk.UDParser.writer

protected inherited Writer to write parsed tuples to. Has the same API as PartitionWriter, from the UDT framework.

Api-Reference: com.vertica.sdk.ContinuousUDParser Member List

Mon, 01 Jan 0001 00:00:00 +0000

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
recordsAcceptedInBatch (defined in com.vertica.sdk.UDParser)	com.vertica.sdk.UDParser	protected
run()	com.vertica.sdk.ContinuousUDParser
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

Api-Reference: com.vertica.sdk.ContinuousUDParser.CoroutineState Enum Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.ContinuousUDParser.CoroutineState Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.DataBuffer Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆buf

byte [] com.vertica.sdk.DataBuffer.buf

The buffer of data.

◆offset

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.

Api-Reference: com.vertica.sdk.DataBuffer Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.DefaultSourceIterator Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆cancel()

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().

◆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

◆destroy()

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

◆isCanceled()

boolean com.vertica.sdk.UDXObject.isCanceled()

inherited Returns true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

◆setup()

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

Api-Reference: com.vertica.sdk.DefaultSourceIterator Member List

Mon, 01 Jan 0001 00:00:00 +0000

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) (defined in com.vertica.sdk.DefaultSourceIterator)	com.vertica.sdk.DefaultSourceIterator
DefaultSourceIterator(ArrayList sources) (defined in com.vertica.sdk.DefaultSourceIterator)	com.vertica.sdk.DefaultSourceIterator
destroy(ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt)	com.vertica.sdk.SourceIterator
getNumberOfSources() (defined in com.vertica.sdk.DefaultSourceIterator)	com.vertica.sdk.DefaultSourceIterator
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

Api-Reference: com.vertica.sdk.DestroyInvocation Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.DFSConstants Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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"

Api-Reference: com.vertica.sdk.DFSConstants Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.DFSFile Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆DFSFile()

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

◆deleteIt()

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

◆listFiles()

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

Api-Reference: com.vertica.sdk.DFSFile Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.DFSFile.DFSDistribution Enum Reference

Mon, 01 Jan 0001 00:00:00 +0000

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.

Api-Reference: com.vertica.sdk.DFSFile.DFSDistribution Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.DFSFile.DFSRootParentType Enum Reference

Mon, 01 Jan 0001 00:00:00 +0000

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.

Api-Reference: com.vertica.sdk.DFSFile.DFSRootParentType Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.DFSFile.DFSScope Enum Reference

Mon, 01 Jan 0001 00:00:00 +0000

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.

Api-Reference: com.vertica.sdk.DFSFile.DFSScope Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.DFSFileReader Class Reference

Mon, 01 Jan 0001 00:00:00 +0000

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

◆close()

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

◆read()

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

◆seek()

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

Api-Reference: com.vertica.sdk.DFSFileReader Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

Api-Reference: com.vertica.sdk.DFSFileStatus Enum Reference

Mon, 01 Jan 0001 00:00:00 +0000

Collaboration diagram for com.vertica.sdk.DFSFileStatus:

Public Attributes
	READ_OPEN
	WRITE_CREATED
	WRITE_OPEN

Detailed Description

Internal DFSFile status to indicate its state

Api-Reference: com.vertica.sdk.DFSFileStatus Member List

Mon, 01 Jan 0001 00:00:00 +0000

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

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