com.vertica.sdk.SizedColumnTypes Class Reference
Collaboration diagram for com.vertica.sdk.SizedColumnTypes:
| Classes | |
|---|---|
| class | PartitionOrderColumnInfo |
| Represents the partition by and order by column information for each phase in a multi-phase transform function. |
| Public Member Functions | |
|---|---|
| void | addBinary (int len, String fieldName) |
| Adds a column of type BINARY. | |
| void | addBinary (int len) |
| void | addBinaryOrderColumn (int len, String fieldName) |
| Adds an order column of type BINARY. | |
| void | addBinaryPartitionColumn (int len, String fieldName) |
| Adds a partition column of type BINARY. | |
| void | addBool (String fieldName) |
| Adds a column of type BOOLEAN. | |
| void | addBool () |
| void | addBoolOrderColumn (String fieldName) |
| Adds an order column of type BOOLEAN. | |
| void | addBoolPartitionColumn (String fieldName) |
| Adds a partition column of type BOOLEAN. | |
| void | addChar (int len, String fieldName) |
| Adds a column of type CHAR. | |
| void | addChar (int len) |
| void | addCharOrderColumn (int len, String fieldName) |
| Adds an order column of type CHAR. | |
| void | addCharPartitionColumn (int len, String fieldName) |
| Adds a partition column of type CHAR. | |
| void | addDate (String fieldName) |
| Adds a column of type DATE. | |
| void | addDate () |
| void | addDateOrderColumn (String fieldName) |
| Adds an order column of type DATE. | |
| void | addDatePartitionColumn (String fieldName) |
| Adds a partition column of type DATE. | |
| void | addFloat (String fieldName) |
| Adds a column of type FLOAT. | |
| void | addFloat () |
| void | addFloatOrderColumn (String fieldName) |
| Adds an order column of type FLOAT. | |
| void | addFloatPartitionColumn (String fieldName) |
| Adds a partition column of type FLOAT. | |
| void | addInt (String fieldName) |
| Adds a column of type INTEGER. | |
| void | addInt () |
| void | addIntervalOrderColumn (int precision, int range, String fieldName) |
| Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND. | |
| void | addIntervalPartitionColumn (int precision, int range, String fieldName) |
| Adds a partition column of type INTERVAL/INTERVAL DAY TO SECOND. | |
| void | addIntervalYMOrderColumn (int range, String fieldName) |
| Adds an order column of type INTERVAL YEAR TO MONTH. | |
| void | addIntervalYMPartitionColumn (int range, String fieldName) |
| Adds a partition column of type INTERVAL YEAR TO MONTH. | |
| void | addIntOrderColumn (String fieldName) |
| Adds an order column of type INTEGER. | |
| void | addIntPartitionColumn (String fieldName) |
| Adds a partition column of type INTEGER. | |
| void | addLongVarbinary (int len, String fieldName) |
| Adds a column of type LONGVARBINARY. | |
| void | addLongVarbinary (int len) |
| void | addLongVarbinaryOrderColumn (int len, String fieldName) |
| Adds an order column of type VARBINARY. | |
| void | addLongVarbinaryPartitionColumn (int len, String fieldName) |
| Adds a partition column of type VARBINARY. | |
| void | addLongVarchar (int len, String fieldName) |
| Adds a column of type LONGVARCHAR. | |
| void | addLongVarchar (int len) |
| void | addLongVarcharOrderColumn (int len, String fieldName) |
| Adds an order column of type VARCHAR. | |
| void | addLongVarcharPartitionColumn (int len, String fieldName) |
| Adds a partition column of type VARCHAR. | |
| void | addNumeric (int precision, int scale, String fieldName) |
| Adds a column of type NUMERIC. | |
| void | addNumeric (int precision, int scale) |
| void | addNumericOrderColumn (int precision, int scale, String fieldName) |
| Adds an order column of type NUMERIC. | |
| void | addNumericPartitionColumn (int precision, int scale, String fieldName) |
| Adds a partition column of type NUMERIC. | |
| void | addOrderColumn (BaseDataOID typeOid, int typeMod, String fieldName) |
| void | addOrderColumn (VerticaType dt, String fieldName) |
| Adds an order column of the specified type. (only relevant to multiphase UDTs.) | |
| void | addPartitionColumn (BaseDataOID typeOid, int typeMod, String fieldName) |
| void | addPartitionColumn (VerticaType dt, String fieldName) |
| Adds a partition column of the specified type (only relevant to multiphase UDTs.) | |
| void | addTime (int precision, String fieldName) |
| Adds a column of type TIME. | |
| void | addTime (int precision) |
| void | addTimeOrderColumn (int precision, String fieldName) |
| Adds an order column of type TIME. | |
| void | addTimePartitionColumn (int precision, String fieldName) |
| Adds a partition column of type TIME. | |
| void | addTimestamp (String fieldName) |
| Adds a column of type TIMESTAMP. | |
| void | addTimestamp () |
| void | addTimestampOrderColumn (int precision, String fieldName) |
| Adds an order column of type TIMESTAMP. | |
| void | addTimestampPartitionColumn (int precision, String fieldName) |
| Adds a partition column of type TIMESTAMP. | |
| void | addTimestampTzOrderColumn (int precision, String fieldName) |
| Adds an order column of type TIMESTAMP WITH TIMEZONE. | |
| void | addTimestampTzPartitionColumn (int precision, String fieldName) |
| Adds a partition column of type TIMESTAMP WITH TIMEZONE. | |
| void | addTimeTz (int precision, String fieldName) |
| Adds a column of type TIME WITH TIMEZONE. | |
| void | addTimeTz (int precision) |
| void | addTimeTzOrderColumn (int precision, String fieldName) |
| Adds an order column of type TIME WITH TIMEZONE. | |
| void | addVarbinary (int len, String fieldName) |
| Adds a column of type VARBINARY. | |
| void | addVarbinary (int len) |
| void | addVarbinaryOrderColumn (int len, String fieldName) |
| Adds an order column of type VARBINARY. | |
| void | addVarbinaryPartitionColumn (int len, String fieldName) |
| Adds a partition column of type VARBINARY. | |
| void | addVarchar (int len, String fieldName) |
| Adds a column of type VARCHAR. | |
| void | addVarchar (int len) |
| void | addVarcharOrderColumn (int len, String fieldName) |
| Adds an order column of type VARCHAR. | |
| void | addVarcharPartitionColumn (int len, String fieldName) |
| Adds a partition column of type VARCHAR. | |
| void | copyValues (SizedColumnTypes sizedColumnTypes) |
| void | getArgumentColumns (ArrayList< 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). | |
| int | getColumnCount () |
| Returns the number of columns. | |
| String | getColumnName (int idx) |
| Returns the name of the column at the specified index. | |
| VerticaType | getColumnType (int idx) |
| Returns the type of the column at the specified index. | |
| int | getLastOrderColumnIdx () |
| Gets the last ORDER BY column index. | |
| int | getLastPartitionColumnIdx () |
| Gets the last PARTITION BY column index. | |
| void | getOrderByColumns (ArrayList< 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). | |
| 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). | |
| boolean | isOrderByColumn (int idx) |
| Indicates whether the column at the specified index is an ORDER BY column. | |
| boolean | isPartitionByColumn (int idx) |
| Indicates whether the column at the specified index is a PARTITION BY column. | |
| void | setPartitionOrderColumnIdx (int partition_idx, int order_idx) |
| Sets the PARTITION BY and ORDER BY column indexes. | |
| void | setPartitionOrderColumnIdx (SizedColumnTypes other) |
| Sets the PARTITION BY and ORDER BY column indexes from another SizedColumnTypes object. |
Detailed Description
Represents types and information to determine the size of the columns as input/output of a User Defined Function/Transform
This class is used to exchange size and precision information between Vertica and the user defined function/transform function. Vertica provides the user code with size/precision information about the particular data types that it has been called with, and expects the user code to provide size/precision information about what it will return.
Member Function Documentation
void com.vertica.sdk.SizedColumnTypes.addBinary(int len, String fieldName)
Adds a column of type BINARY.
Parameters
len: The length of the binary string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBinaryOrderColumn(int len, String fieldName)
Adds an order column of type BINARY.
Parameters
len: The length of the binary string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBinaryPartitionColumn(int len, String fieldName)
Adds a partition column of type BINARY.
Parameters
len: The length of the binary string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBool(String fieldName)
Adds a column of type BOOLEAN.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBoolOrderColumn(String fieldName)
Adds an order column of type BOOLEAN.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addBoolPartitionColumn(String fieldName)
Adds a partition column of type BOOLEAN.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addChar(int len, String fieldName)
Adds a column of type CHAR.
Parameters
len: The length of the string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addCharOrderColumn(int len, String fieldName)
Adds an order column of type CHAR.
Parameters
len: The length of the string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addCharPartitionColumn(int len, String fieldName)
Adds a partition column of type CHAR.
Parameters
len: The length of the string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addDate(String fieldName)
Adds a column of type DATE.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addDateOrderColumn(String fieldName)
Adds an order column of type DATE.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addDatePartitionColumn(String fieldName)
Adds a partition column of type DATE.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addFloat(String fieldName)
Adds a column of type FLOAT.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addFloatOrderColumn(String fieldName)
Adds an order column of type FLOAT.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addFloatPartitionColumn(String fieldName)
Adds a partition column of type FLOAT.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addInt(String fieldName)
Adds a column of type INTEGER.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntervalOrderColumn(int precision, int range, String fieldName)
Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND.
Parameters
precision: The precision for the interval.range: The range for the interval.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntervalPartitionColumn(int precision, int range, String fieldName)
Adds a partition column of type INTERVAL/INTERVAL DAY TO SECOND.
Parameters
precision: The precision for the interval.range: The range for the interval.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntervalYMOrderColumn(int range, String fieldName)
Adds an order column of type INTERVAL YEAR TO MONTH.
Parameters
range: The range for the interval.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntervalYMPartitionColumn(int range, String fieldName)
Adds a partition column of type INTERVAL YEAR TO MONTH.
Parameters
range: The range for the interval.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntOrderColumn(String fieldName)
Adds an order column of type INTEGER.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addIntPartitionColumn(String fieldName)
Adds a partition column of type INTEGER.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarbinary(int len, String fieldName)
Adds a column of type LONGVARBINARY.
Parameters
len: The length of the binary string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarbinaryOrderColumn(int len, String fieldName)
Adds an order column of type VARBINARY.
Parameters
len: The length of the binary string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarbinaryPartitionColumn(int len, String fieldName)
Adds a partition column of type VARBINARY.
Parameters
len: The length of the binary string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarchar(int len, String fieldName)
Adds a column of type LONGVARCHAR.
Parameters
len: The length of the string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarcharOrderColumn(int len, String fieldName)
Adds an order column of type VARCHAR.
Parameters
len: The length of the string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addLongVarcharPartitionColumn(int len, String fieldName)
Adds a partition column of type VARCHAR.
Parameters
len: The length of the string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addNumeric(int precision, int scale, String fieldName)
Adds a column of type NUMERIC.
Parameters
precision: The precision for the numeric value.scale: The scale for the numeric value.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addNumericOrderColumn(int precision, int scale, String fieldName)
Adds an order column of type NUMERIC.
Parameters
precision: The precision for the numeric value.scale: The scale for the numeric value.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addNumericPartitionColumn(int precision, int scale, String fieldName)
Adds a partition column of type NUMERIC.
Parameters
precision: The precision for the numeric value.scale: The scale for the numeric value.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTime(int precision, String fieldName)
Adds a column of type TIME.
Parameters
precision: The precision for the time.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimeOrderColumn(int precision, String fieldName)
Adds an order column of type TIME.
Parameters
precision: The precision for the time.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimePartitionColumn(int precision, String fieldName)
Adds a partition column of type TIME.
Parameters
precision: The precision for the time.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestamp(String fieldName)
Adds a column of type TIMESTAMP.
Parameters
fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestampOrderColumn(int precision, String fieldName)
Adds an order column of type TIMESTAMP.
Parameters
precision: The precision for the timestamp.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestampPartitionColumn(int precision, String fieldName)
Adds a partition column of type TIMESTAMP.
Parameters
precision: The precision for the timestamp.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestampTzOrderColumn(int precision, String fieldName)
Adds an order column of type TIMESTAMP WITH TIMEZONE.
Parameters
precision: The precision for the timestamp.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimestampTzPartitionColumn(int precision, String fieldName)
Adds a partition column of type TIMESTAMP WITH TIMEZONE.
Parameters
precision: The precision for the timestamp.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimeTz(int precision, String fieldName)
Adds a column of type TIME WITH TIMEZONE.
Parameters
precision: The precision for the time.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addTimeTzOrderColumn(int precision, String fieldName)
Adds an order column of type TIME WITH TIMEZONE.
Parameters
precision: The precision for the time.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarbinary(int len, String fieldName)
Adds a column of type VARBINARY.
Parameters
len: The length of the binary string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarbinaryOrderColumn(int len, String fieldName)
Adds an order column of type VARBINARY.
Parameters
len: The length of the binary string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarbinaryPartitionColumn(int len, String fieldName)
Adds a partition column of type VARBINARY.
Parameters
len: The length of the binary string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarchar(int len, String fieldName)
Adds a column of type VARCHAR.
Parameters
len: The length of the string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarcharOrderColumn(int len, String fieldName)
Adds an order column of type VARCHAR.
Parameters
len: The length of the string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.addVarcharPartitionColumn(int len, String fieldName)
Adds a partition column of type VARCHAR.
Parameters
len: The length of the string.fieldName: The name for the output column.
void com.vertica.sdk.SizedColumnTypes.getArgumentColumns(ArrayList< 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
cols: A vector to store the retrieved column indexes.
String com.vertica.sdk.SizedColumnTypes.getColumnName(int idx)
Returns the name of the column at the specified index.
Parameters
idx: The index of the column
VerticaType com.vertica.sdk.SizedColumnTypes.getColumnType(int idx)
Returns the type of the column at the specified index.
Parameters
idx: The index of the column
Returns a VerticaType object describing the column's data type.
Referenced by com.vertica.sdk.BlockReader.getVNumeric().
void com.vertica.sdk.SizedColumnTypes.getOrderByColumns(ArrayList< 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
cols: A vector to store the retrieved column indexes.
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
cols: A vector to store the retrieved column indexes.
boolean com.vertica.sdk.SizedColumnTypes.isOrderByColumn(int idx)
Indicates whether the column at the specified index is an ORDER BY column.
Parameters
idx: The index of the column
boolean com.vertica.sdk.SizedColumnTypes.isPartitionByColumn(int idx)
Indicates whether the column at the specified index is a PARTITION BY column.
Parameters
idx: The index of the column
void com.vertica.sdk.SizedColumnTypes.setPartitionOrderColumnIdx(int partition_idx, int order_idx)
Sets the PARTITION BY and ORDER BY column indexes.
Parameters
partition_idx: Index of the last partition-by columnorder_idx: Index of the last order-by column
void com.vertica.sdk.SizedColumnTypes.setPartitionOrderColumnIdx(SizedColumnTypes other)
Sets the PARTITION BY and ORDER BY column indexes from another SizedColumnTypes object.
Parameters
other: The SizedColumnTypes object to set the indexes from