Vertica documentation is moving! Use our new documentation site at https://docs.rocketsoftware.com/bundle/vertica_24.1/page/index.html

Vertica::SizedColumnTypes Class Reference

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

Inheritance diagram for Vertica::SizedColumnTypes:

Collaboration diagram for Vertica::SizedColumnTypes:

Public Types
using Properties = Field::Properties
Public Member Functions
Fields & addArrayType (const Field &element, const std::string &fieldName="", int maxElems=-1, const Properties &props=Properties())
Fields & addBinary (int32 len, const std::string &fieldName="")
Adds a column of type BINARY.
Fields & addBinary (int32 len, const std::string &fieldName, const Properties &props)
void addBinaryOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type BINARY.
void addBinaryPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type BINARY.
Fields & addBool (const std::string &fieldName="")
Adds a column of type BOOLEAN.
Fields & addBool (const std::string &fieldName, const Properties &props)
void addBoolOrderColumn (const std::string &fieldName="")
Adds an order column of type BOOLEAN.
void addBoolPartitionColumn (const std::string &fieldName="")
Adds a partition column of type BOOLEAN.
Fields & addChar (int32 len, const std::string &fieldName="")
Adds a column of type CHAR.
Fields & addChar (int32 len, const std::string &fieldName, const Properties &props)
void addCharOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type CHAR.
void addCharPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type CHAR.
Fields & addDate (const std::string &fieldName="")
Adds a column of type DATE.
Fields & addDate (const std::string &fieldName, const Properties &props)
void addDateOrderColumn (const std::string &fieldName="")
Adds an order column of type DATE.
void addDatePartitionColumn (const std::string &fieldName="")
Adds a partition column of type DATE.
Fields & addFloat (const std::string &fieldName="")
Adds a column of type FLOAT.
Fields & addFloat (const std::string &fieldName, const Properties &props)
void addFloatOrderColumn (const std::string &fieldName="")
Adds an order column of type FLOAT.
void addFloatPartitionColumn (const std::string &fieldName="")
Adds a partition column of type FLOAT.
Fields & addInt (const std::string &fieldName="")
Adds a column of type INTEGER.
Fields & addInt (const std::string &fieldName, const Properties &props)
Fields & addInterval (int32 precision, int32 range, const std::string &fieldName="")
Adds a column of type INTERVAL/INTERVAL DAY TO SECOND.
Fields & addInterval (int32 precision, int32 range, const std::string &fieldName, const Properties &props)
void addIntervalOrderColumn (int32 precision, int32 range, const std::string &fieldName="")
Adds an order column of type INTERVAL/INTERVAL DAY TO SECOND.
void addIntervalPartitionColumn (int32 precision, int32 range, const std::string &fieldName="")
Adds a partition column of type INTERVAL/INTERVAL DAY TO SECOND.
Fields & addIntervalYM (int32 range, const std::string &fieldName="")
Adds a column of type INTERVAL YEAR TO MONTH.
Fields & addIntervalYM (int32 range, const std::string &fieldName, const Properties &props)
void addIntervalYMOrderColumn (int32 range, const std::string &fieldName="")
Adds an order column of type INTERVAL YEAR TO MONTH.
void addIntervalYMPartitionColumn (int32 range, const std::string &fieldName="")
Adds a partition column of type INTERVAL YEAR TO MONTH.
void addIntOrderColumn (const std::string &fieldName="")
Adds an order column of type INTEGER.
void addIntPartitionColumn (const std::string &fieldName="")
Adds a partition column of type INTEGER.
Fields & addLongVarbinary (int32 len, const std::string &fieldName="")
Adds a column of type LONG VARBINARY.
Fields & addLongVarbinary (int32 len, const std::string &fieldName, const Properties &props)
void addLongVarbinaryOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type VARBINARY.
void addLongVarbinaryPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type VARBINARY.
Fields & addLongVarchar (int32 len, const std::string &fieldName="")
Adds a column of type LONG VARCHAR.
Fields & addLongVarchar (int32 len, const std::string &fieldName, const Properties &props)
void addLongVarcharOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type VARCHAR.
void addLongVarcharPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type VARCHAR.
Fields & addNumeric (int32 precision, int32 scale, const std::string &fieldName="")
Adds a column of type NUMERIC.
Fields & addNumeric (int32 precision, int32 scale, const std::string &fieldName, const Properties &props)
void addNumericOrderColumn (int32 precision, int32 scale, const std::string &fieldName="")
Adds an order column of type NUMERIC.
void addNumericPartitionColumn (int32 precision, int32 scale, const std::string &fieldName="")
Adds a partition column of type NUMERIC.
void addOrderColumn (const VerticaType &dt, const std::string &fieldName="")
Adds an order column of the specified type. (only relevant to multiphase UDTs.)
void addPartitionColumn (const VerticaType &dt, const std::string &fieldName="")
Adds a partition column of the specified type (only relevant to multiphase UDTs.)
Fields & addRowType (const Fields &rowfields, const std::string &fieldName="")
Adds a column of complex row type, with the provided fields.
Fields & addRowType (const Fields &rowfields, const std::string &fieldName, const Properties &props)
void addRowType (const SizedColumnTypes &rowfields, const std::string &fieldName="", const Properties &props=Properties())
Adds a column of complex row type, with the provided fields.
Fields & addTime (int32 precision, const std::string &fieldName="")
Adds a column of type TIME.
Fields & addTime (int32 precision, const std::string &fieldName, const Properties &props)
void addTimeOrderColumn (int32 precision, const std::string &fieldName="")
Adds an order column of type TIME.
void addTimePartitionColumn (int32 precision, const std::string &fieldName="")
Adds a partition column of type TIME.
Fields & addTimestamp (int32 precision, const std::string &fieldName="")
Adds a column of type TIMESTAMP.
Fields & addTimestamp (int32 precision, const std::string &fieldName, const Properties &props)
void addTimestampOrderColumn (int32 precision, const std::string &fieldName="")
Adds an order column of type TIMESTAMP.
void addTimestampPartitionColumn (int32 precision, const std::string &fieldName="")
Adds a partition column of type TIMESTAMP.
Fields & addTimestampTz (int32 precision, const std::string &fieldName="")
Adds a column of type TIMESTAMP WITH TIMEZONE.
Fields & addTimestampTz (int32 precision, const std::string &fieldName, const Properties &props)
void addTimestampTzOrderColumn (int32 precision, const std::string &fieldName="")
Adds an order column of type TIMESTAMP WITH TIMEZONE.
void addTimestampTzPartitionColumn (int32 precision, const std::string &fieldName="")
Adds a partition column of type TIMESTAMP WITH TIMEZONE.
Fields & addTimeTz (int32 precision, const std::string &fieldName="")
Adds a column of type TIME WITH TIMEZONE.
Fields & addTimeTz (int32 precision, const std::string &fieldName, const Properties &props)
void addTimeTzOrderColumn (int32 precision, const std::string &fieldName="")
Adds an order column of type TIME WITH TIMEZONE.
void addTimeTzPartitionColumn (int32 precision, const std::string &fieldName="")
Adds a partition column of type TIME WITH TIMEZONE.
Fields & addUserDefinedType (const char *typeName, int32 len, const std::string &fieldName="")
Adds a column of a user-defined type.
Fields & addUserDefinedType (const char *typeName, int32 len, const std::string &fieldName, const Properties &props)
Fields & addUuid (const std::string &fieldName="")
Adds a column of type UUID.
Fields & addUuid (const std::string &fieldName, const Properties &props)
void addUuidOrderColumn (const std::string &fieldName="")
Adds an order column of type UUID.
Fields & addVarbinary (int32 len, const std::string &fieldName="")
Adds a column of type VARBINARY.
Fields & addVarbinary (int32 len, const std::string &fieldName, const Properties &props)
void addVarbinaryOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type VARBINARY.
void addVarbinaryPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type VARBINARY.
Fields & addVarchar (int32 len, const std::string &fieldName="")
Adds a column of type VARCHAR.
Fields & addVarchar (int32 len, const std::string &fieldName, const Properties &props)
void addVarcharOrderColumn (int32 len, const std::string &fieldName="")
Adds an order column of type VARCHAR.
void addVarcharPartitionColumn (int32 len, const std::string &fieldName="")
Adds a partition column of type VARCHAR.
void getArgumentColumns (std::vector< size_t > &cols) const
Retrieves indexes of argument columns. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).
size_t getColumnCount () const
Returns the number of columns.
const std::string & getColumnName (size_t idx) const
Returns the name of the column at the specified index.
const Properties & getColumnProperties (size_t idx) const
Returns column properties.
const VerticaType & getColumnType (size_t idx) const
Returns the type of the column at the specified index.
VerticaType & getColumnType (size_t idx)
Returns the type of the column at the specified index.
size_t getFixedPartSize () const
Retrieves the fixed-part size, computing and stashing it if needed.
int getLastOrderColumnIdx () const
Gets the last ORDER BY column index.
int getLastPartitionColumnIdx () const
Gets the last PARTITION BY column index.
void getOrderByColumns (std::vector< size_t > &cols) const
Retrieves indexes of ORDER BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).
void getPartitionByColumns (std::vector< size_t > &cols) const
Retrieves indexes of PARTITION BY columns in the OVER() clause. Indexes in cols can be used in conjunction with other functions, e.g. getColumnType(size_t) and getColumnName(size_t).
bool isOrderByColumn (int idx) const
Indicates whether the column at the specified index is an ORDER BY column.
bool isPartitionByColumn (int idx) const
Indicates whether the column at the specified index is a PARTITION BY column.
void setColumnProperties (size_t idx, const Properties &props)
Sets column properties.
void setPartitionOrderColumnIdx (int partition_idx, int order_idx)
Sets the PARTITION BY and ORDER BY column indexes.
void setPartitionOrderColumnIdx (const SizedColumnTypes &other)
Sets the PARTITION BY and ORDER BY column indexes from another SizedColumnTypes object.
Protected Member Functions
void validateStringLengthOrThrow (int32 len, const char *typeStr, int32 maxLength)
void validateUDTypeLengthOrThrow (Oid udTypeOid, const char *typeName, int32 len)

Detailed Description

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

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

Member Function Documentation

◆addBinary()

Fields & Vertica::Fields::addBinary(int32 len, const std::string & fieldName = "")

inherited Adds a column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.

◆addBinaryOrderColumn()

void Vertica::SizedColumnTypes::addBinaryOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.

◆addBinaryPartitionColumn()

void Vertica::SizedColumnTypes::addBinaryPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type BINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.

◆addBool()

Fields & Vertica::Fields::addBool(const std::string & fieldName = "")

inherited Adds a column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.

◆addBoolOrderColumn()

void Vertica::SizedColumnTypes::addBoolOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.

◆addBoolPartitionColumn()

void Vertica::SizedColumnTypes::addBoolPartitionColumn(const std::string & fieldName = "")

inline Adds a partition column of type BOOLEAN.

Parameters

  • fieldName: The name for the output column.

◆addChar()

Fields & Vertica::Fields::addChar(int32 len, const std::string & fieldName = "")

inherited Adds a column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

◆addCharOrderColumn()

void Vertica::SizedColumnTypes::addCharOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

◆addCharPartitionColumn()

void Vertica::SizedColumnTypes::addCharPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type CHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

◆addDate()

Fields & Vertica::Fields::addDate(const std::string & fieldName = "")

inherited Adds a column of type DATE.

Parameters

  • fieldName: The name for the output column.

◆addDateOrderColumn()

void Vertica::SizedColumnTypes::addDateOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type DATE.

Parameters

  • fieldName: The name for the output column.

◆addDatePartitionColumn()

void Vertica::SizedColumnTypes::addDatePartitionColumn(const std::string & fieldName = "")

inline Adds a partition column of type DATE.

Parameters

  • fieldName: The name for the output column.

◆addFloat()

Fields & Vertica::Fields::addFloat(const std::string & fieldName = "")

inherited Adds a column of type FLOAT.

Parameters

  • fieldName: The name for the output column.

◆addFloatOrderColumn()

void Vertica::SizedColumnTypes::addFloatOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type FLOAT.

Parameters

  • fieldName: The name for the output column.

◆addFloatPartitionColumn()

void Vertica::SizedColumnTypes::addFloatPartitionColumn(const std::string & fieldName = "")

inline Adds a partition column of type FLOAT.

Parameters

  • fieldName: The name for the output column.

◆addInt()

Fields & Vertica::Fields::addInt(const std::string & fieldName = "")

inherited Adds a column of type INTEGER.

Parameters

  • fieldName: The name for the output column.

◆addInterval()

Fields & Vertica::Fields::addInterval(int32 precision, int32 range, const std::string & fieldName = "")

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

Parameters

  • precision: The precision for the interval.
  • range: The range for the interval.
  • fieldName: The name for the output column.

◆addIntervalOrderColumn()

void Vertica::SizedColumnTypes::addIntervalOrderColumn(int32 precision, int32 range, const std::string & fieldName = "")

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

Parameters

  • precision: The precision for the interval.
  • range: The range for the interval.
  • fieldName: The name for the output column.

◆addIntervalPartitionColumn()

void Vertica::SizedColumnTypes::addIntervalPartitionColumn(int32 precision, int32 range, const std::string & fieldName = "")

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

Parameters

  • precision: The precision for the interval.
  • range: The range for the interval.
  • fieldName: The name for the output column.

◆addIntervalYM()

Fields & Vertica::Fields::addIntervalYM(int32 range, const std::string & fieldName = "")

inherited Adds a column of type INTERVAL YEAR TO MONTH.

Parameters

  • range: The range for the interval.
  • fieldName: The name for the output column.

◆addIntervalYMOrderColumn()

void Vertica::SizedColumnTypes::addIntervalYMOrderColumn(int32 range, const std::string & fieldName = "")

inline Adds an order column of type INTERVAL YEAR TO MONTH.

Parameters

  • range: The range for the interval.
  • fieldName: The name for the output column.

◆addIntervalYMPartitionColumn()

void Vertica::SizedColumnTypes::addIntervalYMPartitionColumn(int32 range, const std::string & fieldName = "")

inline Adds a partition column of type INTERVAL YEAR TO MONTH.

Parameters

  • range: The range for the interval.
  • fieldName: The name for the output column.

◆addIntOrderColumn()

void Vertica::SizedColumnTypes::addIntOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type INTEGER.

Parameters

  • fieldName: The name for the output column.

◆addIntPartitionColumn()

void Vertica::SizedColumnTypes::addIntPartitionColumn(const std::string & fieldName = "")

inline Adds a partition column of type INTEGER.

Parameters

  • fieldName: The name for the output column.

◆addLongVarbinary()

Fields & Vertica::Fields::addLongVarbinary(int32 len, const std::string & fieldName = "")

inherited Adds a column of type LONG VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.

◆addLongVarbinaryOrderColumn()

void Vertica::SizedColumnTypes::addLongVarbinaryOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.

◆addLongVarbinaryPartitionColumn()

void Vertica::SizedColumnTypes::addLongVarbinaryPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.

◆addLongVarchar()

Fields & Vertica::Fields::addLongVarchar(int32 len, const std::string & fieldName = "")

inherited Adds a column of type LONG VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

◆addLongVarcharOrderColumn()

void Vertica::SizedColumnTypes::addLongVarcharOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

◆addLongVarcharPartitionColumn()

void Vertica::SizedColumnTypes::addLongVarcharPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

◆addNumeric()

Fields & Vertica::Fields::addNumeric(int32 precision, int32 scale, const std::string & fieldName = "")

inherited Adds a column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.

◆addNumericOrderColumn()

void Vertica::SizedColumnTypes::addNumericOrderColumn(int32 precision, int32 scale, const std::string & fieldName = "")

inline Adds an order column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.

◆addNumericPartitionColumn()

void Vertica::SizedColumnTypes::addNumericPartitionColumn(int32 precision, int32 scale, const std::string & fieldName = "")

inline Adds a partition column of type NUMERIC.

Parameters

  • precision: The precision for the numeric value.
  • scale: The scale for the numeric value.
  • fieldName: The name for the output column.

◆addRowType() [1/2]

Fields & Vertica::Fields::addRowType(const Fields & rowfields, const std::string & fieldName = "")

inherited Adds a column of complex row type, with the provided fields.

Parameters

  • rowfields: the fields of the complex row type
  • fieldName: the name of the added field

Referenced by addRowType().

◆addRowType() [2/2]

void Vertica::SizedColumnTypes::addRowType(const SizedColumnTypes & rowfields, const std::string & fieldName = "", const Properties & props = Properties())

inline Adds a column of complex row type, with the provided fields.

Parameters

  • rowfields: the fields of the complex type row
  • fieldName: the name of the complex row field
  • props: optional field properties

◆addTime()

Fields & Vertica::Fields::addTime(int32 precision, const std::string & fieldName = "")

inherited Adds a column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.

◆addTimeOrderColumn()

void Vertica::SizedColumnTypes::addTimeOrderColumn(int32 precision, const std::string & fieldName = "")

inline Adds an order column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.

◆addTimePartitionColumn()

void Vertica::SizedColumnTypes::addTimePartitionColumn(int32 precision, const std::string & fieldName = "")

inline Adds a partition column of type TIME.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.

◆addTimestamp()

Fields & Vertica::Fields::addTimestamp(int32 precision, const std::string & fieldName = "")

inherited Adds a column of type TIMESTAMP.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.

◆addTimestampOrderColumn()

void Vertica::SizedColumnTypes::addTimestampOrderColumn(int32 precision, const std::string & fieldName = "")

inline Adds an order column of type TIMESTAMP.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.

◆addTimestampPartitionColumn()

void Vertica::SizedColumnTypes::addTimestampPartitionColumn(int32 precision, const std::string & fieldName = "")

inline Adds a partition column of type TIMESTAMP.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.

◆addTimestampTz()

Fields & Vertica::Fields::addTimestampTz(int32 precision, const std::string & fieldName = "")

inherited Adds a column of type TIMESTAMP WITH TIMEZONE.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.

◆addTimestampTzOrderColumn()

void Vertica::SizedColumnTypes::addTimestampTzOrderColumn(int32 precision, const std::string & fieldName = "")

inline Adds an order column of type TIMESTAMP WITH TIMEZONE.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.

◆addTimestampTzPartitionColumn()

void Vertica::SizedColumnTypes::addTimestampTzPartitionColumn(int32 precision, const std::string & fieldName = "")

inline Adds a partition column of type TIMESTAMP WITH TIMEZONE.

Parameters

  • precision: The precision for the timestamp.
  • fieldName: The name for the output column.

◆addTimeTz()

Fields & Vertica::Fields::addTimeTz(int32 precision, const std::string & fieldName = "")

inherited Adds a column of type TIME WITH TIMEZONE.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.

◆addTimeTzOrderColumn()

void Vertica::SizedColumnTypes::addTimeTzOrderColumn(int32 precision, const std::string & fieldName = "")

inline Adds an order column of type TIME WITH TIMEZONE.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.

◆addTimeTzPartitionColumn()

void Vertica::SizedColumnTypes::addTimeTzPartitionColumn(int32 precision, const std::string & fieldName = "")

inline Adds a partition column of type TIME WITH TIMEZONE.

Parameters

  • precision: The precision for the time.
  • fieldName: The name for the output column.

◆addUserDefinedType()

Fields & Vertica::Fields::addUserDefinedType(const char * typeName, int32 len, const std::string & fieldName = "")

inherited Adds a column of a user-defined type.

Parameters

  • typeName: the name of the type
  • len: the length of the type field, in bytes
  • fieldName: the name of the field
  • fieldName: The name for the output column.

◆addUuid()

Fields & Vertica::Fields::addUuid(const std::string & fieldName = "")

inherited Adds a column of type UUID.

Parameters

  • fieldName: The name for the output column.

◆addUuidOrderColumn()

void Vertica::SizedColumnTypes::addUuidOrderColumn(const std::string & fieldName = "")

inline Adds an order column of type UUID.

Parameters

  • fieldName: The name for the output column.

◆addVarbinary()

Fields & Vertica::Fields::addVarbinary(int32 len, const std::string & fieldName = "")

inherited Adds a column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.

◆addVarbinaryOrderColumn()

void Vertica::SizedColumnTypes::addVarbinaryOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.

◆addVarbinaryPartitionColumn()

void Vertica::SizedColumnTypes::addVarbinaryPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type VARBINARY.

Parameters

  • len: The length of the binary string.
  • fieldName: The name for the output column.

◆addVarchar()

Fields & Vertica::Fields::addVarchar(int32 len, const std::string & fieldName = "")

inherited Adds a column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

◆addVarcharOrderColumn()

void Vertica::SizedColumnTypes::addVarcharOrderColumn(int32 len, const std::string & fieldName = "")

inline Adds an order column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

◆addVarcharPartitionColumn()

void Vertica::SizedColumnTypes::addVarcharPartitionColumn(int32 len, const std::string & fieldName = "")

inline Adds a partition column of type VARCHAR.

Parameters

  • len: The length of the string.
  • fieldName: The name for the output column.

◆getArgumentColumns()

void Vertica::SizedColumnTypes::getArgumentColumns(std::vector< size_t > & cols) const

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

Parameters

  • cols: A vector to store the retrieved column indexes.

◆getColumnName()

const std::string& Vertica::SizedColumnTypes::getColumnName(size_t idx) const

inline Returns the name of the column at the specified index.

Parameters

  • idx: The index of the column

Referenced by Vertica::ParserFactory::getParserReturnType().

◆getColumnProperties()

const Properties& Vertica::SizedColumnTypes::getColumnProperties(size_t idx) const

inline Returns column properties.

Parameters

  • idx: The index of the column

◆getColumnType() [1/2]

const VerticaType& Vertica::SizedColumnTypes::getColumnType(size_t idx) const

inline Returns the type of the column at the specified index.

Parameters

  • idx: The index of the column

Returns a VerticaType object describing the column's data type.

Referenced by

◆getColumnType() [2/2]

VerticaType& Vertica::SizedColumnTypes::getColumnType(size_t idx)

inline Returns the type of the column at the specified index.

Parameters

  • idx: The index of the column

◆getOrderByColumns()

void Vertica::SizedColumnTypes::getOrderByColumns(std::vector< size_t > & cols) const

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

Parameters

  • cols: A vector to store the retrieved column indexes.

◆getPartitionByColumns()

void Vertica::SizedColumnTypes::getPartitionByColumns(std::vector< size_t > & cols) const

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

Parameters

  • cols: A vector to store the retrieved column indexes.

◆isOrderByColumn()

bool Vertica::SizedColumnTypes::isOrderByColumn(int idx) const

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

Parameters

  • idx: The index of the column

◆isPartitionByColumn()

bool Vertica::SizedColumnTypes::isPartitionByColumn(int idx) const

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

Parameters

  • idx: The index of the column

◆setColumnProperties()

void Vertica::SizedColumnTypes::setColumnProperties(size_t idx, const Properties & props)

inline Sets column properties.

Parameters

  • idx: The index of the column

◆setPartitionOrderColumnIdx() [1/2]

void Vertica::SizedColumnTypes::setPartitionOrderColumnIdx(int partition_idx, int order_idx)

inline Sets the PARTITION BY and ORDER BY column indexes.

Parameters

  • partition_idx: Index of the last partition-by column
  • order_idx: Index of the last order-by column

◆setPartitionOrderColumnIdx() [2/2]

void Vertica::SizedColumnTypes::setPartitionOrderColumnIdx(const SizedColumnTypes & other)

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

Parameters

  • other: The SizedColumnTypes object to set the indexes from