Java SDK Documentation  24.2.0
com.vertica.sdk.SizedColumnTypes Class Reference
Collaboration diagram for com.vertica.sdk.SizedColumnTypes:
Collaboration graph

Classes

class  PartitionOrderColumnInfo
 Represents the partition by and order by column information for each phase in a multi-phase transform function.
 

Public Member Functions

void addBinary (int len, String fieldName)
 Adds a column of type BINARY. More...
 
void addBinary (int len)
 
void addBinaryOrderColumn (int len, String fieldName)
 Adds an order column of type BINARY. More...
 
void addBinaryPartitionColumn (int len, String fieldName)
 Adds a partition column of type BINARY. More...
 
void addBool (String fieldName)
 Adds a column of type BOOLEAN. More...
 
void addBool ()
 
void addBoolOrderColumn (String fieldName)
 Adds an order column of type BOOLEAN. More...
 
void addBoolPartitionColumn (String fieldName)
 Adds a partition column of type BOOLEAN. More...
 
void addChar (int len, String fieldName)
 Adds a column of type CHAR. More...
 
void addChar (int len)
 
void addCharOrderColumn (int len, String fieldName)
 Adds an order column of type CHAR. More...
 
void addCharPartitionColumn (int len, String fieldName)
 Adds a partition column of type CHAR. More...
 
void addDate (String fieldName)
 Adds a column of type DATE. More...
 
void addDate ()
 
void addDateOrderColumn (String fieldName)
 Adds an order column of type DATE. More...
 
void addDatePartitionColumn (String fieldName)
 Adds a partition column of type DATE. More...
 
void addFloat (String fieldName)
 Adds a column of type FLOAT. More...
 
void addFloat ()
 
void addFloatOrderColumn (String fieldName)
 Adds an order column of type FLOAT. More...
 
void addFloatPartitionColumn (String fieldName)
 Adds a partition column of type FLOAT. More...
 
void addInt (String fieldName)
 Adds a column of type INTEGER. More...
 
void addInt ()
 
void addIntervalOrderColumn (int precision, int range, String fieldName)
 Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND. More...
 
void addIntervalPartitionColumn (int precision, int range, String fieldName)
 Adds a partition column of type INTERVAL/INTERVAL DAY TO SECOND. More...
 
void addIntervalYMOrderColumn (int range, String fieldName)
 Adds an order column of type INTERVAL YEAR TO MONTH. More...
 
void addIntervalYMPartitionColumn (int range, String fieldName)
 Adds a partition column of type INTERVAL YEAR TO MONTH. More...
 
void addIntOrderColumn (String fieldName)
 Adds an order column of type INTEGER. More...
 
void addIntPartitionColumn (String fieldName)
 Adds a partition column of type INTEGER. More...
 
void addLongVarbinary (int len, String fieldName)
 Adds a column of type LONGVARBINARY. More...
 
void addLongVarbinary (int len)
 
void addLongVarbinaryOrderColumn (int len, String fieldName)
 Adds an order column of type VARBINARY. More...
 
void addLongVarbinaryPartitionColumn (int len, String fieldName)
 Adds a partition column of type VARBINARY. More...
 
void addLongVarchar (int len, String fieldName)
 Adds a column of type LONGVARCHAR. More...
 
void addLongVarchar (int len)
 
void addLongVarcharOrderColumn (int len, String fieldName)
 Adds an order column of type VARCHAR. More...
 
void addLongVarcharPartitionColumn (int len, String fieldName)
 Adds a partition column of type VARCHAR. More...
 
void addNumeric (int precision, int scale, String fieldName)
 Adds a column of type NUMERIC. More...
 
void addNumeric (int precision, int scale)
 
void addNumericOrderColumn (int precision, int scale, String fieldName)
 Adds an order column of type NUMERIC. More...
 
void addNumericPartitionColumn (int precision, int scale, String fieldName)
 Adds a partition column of type NUMERIC. More...
 
void addOrderColumn (BaseDataOID typeOid, int typeMod, String fieldName)
 
void addOrderColumn (VerticaType dt, String fieldName)
 Adds an order column of the specified type. (only relevant to multiphase UDTs.)
 
void addPartitionColumn (BaseDataOID typeOid, int typeMod, String fieldName)
 
void addPartitionColumn (VerticaType dt, String fieldName)
 Adds a partition column of the specified type (only relevant to multiphase UDTs.)
 
void addTime (int precision, String fieldName)
 Adds a column of type TIME. More...
 
void addTime (int precision)
 
void addTimeOrderColumn (int precision, String fieldName)
 Adds an order column of type TIME. More...
 
void addTimePartitionColumn (int precision, String fieldName)
 Adds a partition column of type TIME. More...
 
void addTimestamp (String fieldName)
 Adds a column of type TIMESTAMP. More...
 
void addTimestamp ()
 
void addTimestampOrderColumn (int precision, String fieldName)
 Adds an order column of type TIMESTAMP. More...
 
void addTimestampPartitionColumn (int precision, String fieldName)
 Adds a partition column of type TIMESTAMP. More...
 
void addTimestampTzOrderColumn (int precision, String fieldName)
 Adds an order column of type TIMESTAMP WITH TIMEZONE. More...
 
void addTimestampTzPartitionColumn (int precision, String fieldName)
 Adds a partition column of type TIMESTAMP WITH TIMEZONE. More...
 
void addTimeTz (int precision, String fieldName)
 Adds a column of type TIME WITH TIMEZONE. More...
 
void addTimeTz (int precision)
 
void addTimeTzOrderColumn (int precision, String fieldName)
 Adds an order column of type TIME WITH TIMEZONE. More...
 
void addVarbinary (int len, String fieldName)
 Adds a column of type VARBINARY. More...
 
void addVarbinary (int len)
 
void addVarbinaryOrderColumn (int len, String fieldName)
 Adds an order column of type VARBINARY. More...
 
void addVarbinaryPartitionColumn (int len, String fieldName)
 Adds a partition column of type VARBINARY. More...
 
void addVarchar (int len, String fieldName)
 Adds a column of type VARCHAR. More...
 
void addVarchar (int len)
 
void addVarcharOrderColumn (int len, String fieldName)
 Adds an order column of type VARCHAR. More...
 
void addVarcharPartitionColumn (int len, String fieldName)
 Adds a partition column of type VARCHAR. More...
 
void copyValues (SizedColumnTypes sizedColumnTypes)
 
void getArgumentColumns (ArrayList< Integer > cols)
 Retrieves indexes of argument columns. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t). More...
 
int getColumnCount ()
 Returns the number of columns.
 
String getColumnName (int idx)
 Returns the name of the column at the specified index. More...
 
VerticaType getColumnType (int idx)
 Returns the type of the column at the specified index. More...
 
int getLastOrderColumnIdx ()
 Gets the last ORDER BY column index.
 
int getLastPartitionColumnIdx ()
 Gets the last PARTITION BY column index.
 
void getOrderByColumns (ArrayList< Integer > cols)
 Retrieves indexes of ORDER BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t). More...
 
void getPartitionByColumns (ArrayList< Integer > cols)
 Retrieves indexes of PARTITION BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t). More...
 
boolean isOrderByColumn (int idx)
 Indicates whether the column at the specified index is an ORDER BY column. More...
 
boolean isPartitionByColumn (int idx)
 Indicates whether the column at the specified index is a PARTITION BY column. More...
 
void setPartitionOrderColumnIdx (int partition_idx, int order_idx)
 Sets the PARTITION BY and ORDER BY column indexes. More...
 
void setPartitionOrderColumnIdx (SizedColumnTypes other)
 Sets the PARTITION BY and ORDER BY column indexes from another SizedColumnTypes object. More...
 

Detailed Description

Represents types and information to determine the size of the columns as input/output of a User Defined Function/Transform

This class is used to exchange size and precision information between Vertica and the user defined function/transform function. Vertica provides the user code with size/precision information about the particular data types that it has been called with, and expects the user code to provide size/precision information about what it will return.

Member Function Documentation

◆ addBinary()

void com.vertica.sdk.SizedColumnTypes.addBinary ( int  len,
String  fieldName 
)

Adds a column of type BINARY.

Parameters
lenThe length of the binary string.
fieldNameThe name for the output column.

◆ addBinaryOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addBinaryOrderColumn ( int  len,
String  fieldName 
)

Adds an order column of type BINARY.

Parameters
lenThe length of the binary string.
fieldNameThe name for the output column.

◆ addBinaryPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addBinaryPartitionColumn ( int  len,
String  fieldName 
)

Adds a partition column of type BINARY.

Parameters
lenThe length of the binary string.
fieldNameThe name for the output column.

◆ addBool()

void com.vertica.sdk.SizedColumnTypes.addBool ( String  fieldName)

Adds a column of type BOOLEAN.

Parameters
fieldNameThe name for the output column.

◆ addBoolOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addBoolOrderColumn ( String  fieldName)

Adds an order column of type BOOLEAN.

Parameters
fieldNameThe name for the output column.

◆ addBoolPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addBoolPartitionColumn ( String  fieldName)

Adds a partition column of type BOOLEAN.

Parameters
fieldNameThe name for the output column.

◆ addChar()

void com.vertica.sdk.SizedColumnTypes.addChar ( int  len,
String  fieldName 
)

Adds a column of type CHAR.

Parameters
lenThe length of the string.
fieldNameThe name for the output column.

◆ addCharOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addCharOrderColumn ( int  len,
String  fieldName 
)

Adds an order column of type CHAR.

Parameters
lenThe length of the string.
fieldNameThe name for the output column.

◆ addCharPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addCharPartitionColumn ( int  len,
String  fieldName 
)

Adds a partition column of type CHAR.

Parameters
lenThe length of the string.
fieldNameThe name for the output column.

◆ addDate()

void com.vertica.sdk.SizedColumnTypes.addDate ( String  fieldName)

Adds a column of type DATE.

Parameters
fieldNameThe name for the output column.

◆ addDateOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addDateOrderColumn ( String  fieldName)

Adds an order column of type DATE.

Parameters
fieldNameThe name for the output column.

◆ addDatePartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addDatePartitionColumn ( String  fieldName)

Adds a partition column of type DATE.

Parameters
fieldNameThe name for the output column.

◆ addFloat()

void com.vertica.sdk.SizedColumnTypes.addFloat ( String  fieldName)

Adds a column of type FLOAT.

Parameters
fieldNameThe name for the output column.

◆ addFloatOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addFloatOrderColumn ( String  fieldName)

Adds an order column of type FLOAT.

Parameters
fieldNameThe name for the output column.

◆ addFloatPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addFloatPartitionColumn ( String  fieldName)

Adds a partition column of type FLOAT.

Parameters
fieldNameThe name for the output column.

◆ addInt()

void com.vertica.sdk.SizedColumnTypes.addInt ( String  fieldName)

Adds a column of type INTEGER.

Parameters
fieldNameThe name for the output column.

◆ addIntervalOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addIntervalOrderColumn ( int  precision,
int  range,
String  fieldName 
)

Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND.

Parameters
precisionThe precision for the interval.
rangeThe range for the interval.
fieldNameThe name for the output column.

◆ addIntervalPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addIntervalPartitionColumn ( int  precision,
int  range,
String  fieldName 
)

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

Parameters
precisionThe precision for the interval.
rangeThe range for the interval.
fieldNameThe name for the output column.

◆ addIntervalYMOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addIntervalYMOrderColumn ( int  range,
String  fieldName 
)

Adds an order column of type INTERVAL YEAR TO MONTH.

Parameters
rangeThe range for the interval.
fieldNameThe name for the output column.

◆ addIntervalYMPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addIntervalYMPartitionColumn ( int  range,
String  fieldName 
)

Adds a partition column of type INTERVAL YEAR TO MONTH.

Parameters
rangeThe range for the interval.
fieldNameThe name for the output column.

◆ addIntOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addIntOrderColumn ( String  fieldName)

Adds an order column of type INTEGER.

Parameters
fieldNameThe name for the output column.

◆ addIntPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addIntPartitionColumn ( String  fieldName)

Adds a partition column of type INTEGER.

Parameters
fieldNameThe name for the output column.

◆ addLongVarbinary()

void com.vertica.sdk.SizedColumnTypes.addLongVarbinary ( int  len,
String  fieldName 
)

Adds a column of type LONGVARBINARY.

Parameters
lenThe length of the binary string.
fieldNameThe name for the output column.

◆ addLongVarbinaryOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addLongVarbinaryOrderColumn ( int  len,
String  fieldName 
)

Adds an order column of type VARBINARY.

Parameters
lenThe length of the binary string.
fieldNameThe name for the output column.

◆ addLongVarbinaryPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addLongVarbinaryPartitionColumn ( int  len,
String  fieldName 
)

Adds a partition column of type VARBINARY.

Parameters
lenThe length of the binary string.
fieldNameThe name for the output column.

◆ addLongVarchar()

void com.vertica.sdk.SizedColumnTypes.addLongVarchar ( int  len,
String  fieldName 
)

Adds a column of type LONGVARCHAR.

Parameters
lenThe length of the string.
fieldNameThe name for the output column.

◆ addLongVarcharOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addLongVarcharOrderColumn ( int  len,
String  fieldName 
)

Adds an order column of type VARCHAR.

Parameters
lenThe length of the string.
fieldNameThe name for the output column.

◆ addLongVarcharPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addLongVarcharPartitionColumn ( int  len,
String  fieldName 
)

Adds a partition column of type VARCHAR.

Parameters
lenThe length of the string.
fieldNameThe name for the output column.

◆ addNumeric()

void com.vertica.sdk.SizedColumnTypes.addNumeric ( int  precision,
int  scale,
String  fieldName 
)

Adds a column of type NUMERIC.

Parameters
precisionThe precision for the numeric value.
scaleThe scale for the numeric value.
fieldNameThe name for the output column.

◆ addNumericOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addNumericOrderColumn ( int  precision,
int  scale,
String  fieldName 
)

Adds an order column of type NUMERIC.

Parameters
precisionThe precision for the numeric value.
scaleThe scale for the numeric value.
fieldNameThe name for the output column.

◆ addNumericPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addNumericPartitionColumn ( int  precision,
int  scale,
String  fieldName 
)

Adds a partition column of type NUMERIC.

Parameters
precisionThe precision for the numeric value.
scaleThe scale for the numeric value.
fieldNameThe name for the output column.

◆ addTime()

void com.vertica.sdk.SizedColumnTypes.addTime ( int  precision,
String  fieldName 
)

Adds a column of type TIME.

Parameters
precisionThe precision for the time.
fieldNameThe name for the output column.

◆ addTimeOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addTimeOrderColumn ( int  precision,
String  fieldName 
)

Adds an order column of type TIME.

Parameters
precisionThe precision for the time.
fieldNameThe name for the output column.

◆ addTimePartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addTimePartitionColumn ( int  precision,
String  fieldName 
)

Adds a partition column of type TIME.

Parameters
precisionThe precision for the time.
fieldNameThe name for the output column.

◆ addTimestamp()

void com.vertica.sdk.SizedColumnTypes.addTimestamp ( String  fieldName)

Adds a column of type TIMESTAMP.

Parameters
fieldNameThe name for the output column.

◆ addTimestampOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addTimestampOrderColumn ( int  precision,
String  fieldName 
)

Adds an order column of type TIMESTAMP.

Parameters
precisionThe precision for the timestamp.
fieldNameThe name for the output column.

◆ addTimestampPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addTimestampPartitionColumn ( int  precision,
String  fieldName 
)

Adds a partition column of type TIMESTAMP.

Parameters
precisionThe precision for the timestamp.
fieldNameThe name for the output column.

◆ addTimestampTzOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addTimestampTzOrderColumn ( int  precision,
String  fieldName 
)

Adds an order column of type TIMESTAMP WITH TIMEZONE.

Parameters
precisionThe precision for the timestamp.
fieldNameThe name for the output column.

◆ addTimestampTzPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addTimestampTzPartitionColumn ( int  precision,
String  fieldName 
)

Adds a partition column of type TIMESTAMP WITH TIMEZONE.

Parameters
precisionThe precision for the timestamp.
fieldNameThe name for the output column.

◆ addTimeTz()

void com.vertica.sdk.SizedColumnTypes.addTimeTz ( int  precision,
String  fieldName 
)

Adds a column of type TIME WITH TIMEZONE.

Parameters
precisionThe precision for the time.
fieldNameThe name for the output column.

◆ addTimeTzOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addTimeTzOrderColumn ( int  precision,
String  fieldName 
)

Adds an order column of type TIME WITH TIMEZONE.

Parameters
precisionThe precision for the time.
fieldNameThe name for the output column.

◆ addVarbinary()

void com.vertica.sdk.SizedColumnTypes.addVarbinary ( int  len,
String  fieldName 
)

Adds a column of type VARBINARY.

Parameters
lenThe length of the binary string.
fieldNameThe name for the output column.

◆ addVarbinaryOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addVarbinaryOrderColumn ( int  len,
String  fieldName 
)

Adds an order column of type VARBINARY.

Parameters
lenThe length of the binary string.
fieldNameThe name for the output column.

◆ addVarbinaryPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addVarbinaryPartitionColumn ( int  len,
String  fieldName 
)

Adds a partition column of type VARBINARY.

Parameters
lenThe length of the binary string.
fieldNameThe name for the output column.

◆ addVarchar()

void com.vertica.sdk.SizedColumnTypes.addVarchar ( int  len,
String  fieldName 
)

Adds a column of type VARCHAR.

Parameters
lenThe length of the string.
fieldNameThe name for the output column.

◆ addVarcharOrderColumn()

void com.vertica.sdk.SizedColumnTypes.addVarcharOrderColumn ( int  len,
String  fieldName 
)

Adds an order column of type VARCHAR.

Parameters
lenThe length of the string.
fieldNameThe name for the output column.

◆ addVarcharPartitionColumn()

void com.vertica.sdk.SizedColumnTypes.addVarcharPartitionColumn ( int  len,
String  fieldName 
)

Adds a partition column of type VARCHAR.

Parameters
lenThe length of the string.
fieldNameThe name for the output column.

◆ getArgumentColumns()

void com.vertica.sdk.SizedColumnTypes.getArgumentColumns ( ArrayList< Integer >  cols)

Retrieves indexes of argument columns. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).

Parameters
colsA vector to store the retrieved column indexes.

◆ getColumnName()

String com.vertica.sdk.SizedColumnTypes.getColumnName ( int  idx)

Returns the name of the column at the specified index.

Parameters
idxThe index of the column

Referenced by com.vertica.sdk.PartitionWriter.setRowFromMap().

◆ getColumnType()

VerticaType com.vertica.sdk.SizedColumnTypes.getColumnType ( int  idx)

◆ getOrderByColumns()

void com.vertica.sdk.SizedColumnTypes.getOrderByColumns ( ArrayList< Integer >  cols)

Retrieves indexes of ORDER BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).

Parameters
colsA vector to store the retrieved column indexes.

◆ getPartitionByColumns()

void com.vertica.sdk.SizedColumnTypes.getPartitionByColumns ( ArrayList< Integer >  cols)

Retrieves indexes of PARTITION BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).

Parameters
colsA vector to store the retrieved column indexes.

◆ isOrderByColumn()

boolean com.vertica.sdk.SizedColumnTypes.isOrderByColumn ( int  idx)

Indicates whether the column at the specified index is an ORDER BY column.

Parameters
idxThe index of the column

◆ isPartitionByColumn()

boolean com.vertica.sdk.SizedColumnTypes.isPartitionByColumn ( int  idx)

Indicates whether the column at the specified index is a PARTITION BY column.

Parameters
idxThe index of the column

◆ setPartitionOrderColumnIdx() [1/2]

void com.vertica.sdk.SizedColumnTypes.setPartitionOrderColumnIdx ( int  partition_idx,
int  order_idx 
)

Sets the PARTITION BY and ORDER BY column indexes.

Parameters
partition_idxIndex of the last partition-by column
order_idxIndex of the last order-by column

◆ setPartitionOrderColumnIdx() [2/2]

void com.vertica.sdk.SizedColumnTypes.setPartitionOrderColumnIdx ( SizedColumnTypes  other)

Sets the PARTITION BY and ORDER BY column indexes from another SizedColumnTypes object.

Parameters
otherThe SizedColumnTypes object to set the indexes from