C++ SDK Documentation  23.3.0
Vertica::ColumnTypes Class Reference

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

Collaboration diagram for Vertica::ColumnTypes:
Collaboration graph

Public Member Functions

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

Detailed Description

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

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

Member Function Documentation

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

Adds a column of 1D array type.

Parameters
elementOidthe type of the array element
Returns
this

Referenced by addArrayType().

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

Adds a column of complex array type.

Parameters
rowprototypethe fields of the complex array element
Returns
this
ColumnTypes& Vertica::ColumnTypes::addBinary ( )
inline

Adds a column of type BINARY.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addBool ( )
inline

Adds a column of type BOOLEAN.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addChar ( )
inline

Adds a column of type CHAR.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addDate ( )
inline

Adds a column of type DATE.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addFloat ( )
inline

Adds a column of type FLOAT.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addInt ( )
inline

Adds a column of type INTEGER.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addInterval ( )
inline

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

Returns
this
ColumnTypes& Vertica::ColumnTypes::addIntervalYM ( )
inline

Adds a column of type INTERVAL YEAR TO MONTH.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addLongVarbinary ( )
inline

Adds a column of type VARBINARY.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addLongVarchar ( )
inline

Adds a column of type VARBINARY.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addNumeric ( )
inline

Adds a column of type NUMERIC.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addRowType ( const ColumnTypes &  rowprototype)
inline

Adds a column of complex row type.

Parameters
rowprototypethe fields of the complex row type
Returns
this
ColumnTypes& Vertica::ColumnTypes::addTime ( )
inline

Adds a column of type TIME.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addTimestamp ( )
inline

Adds a column of type TIMESTAMP.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addTimestampTz ( )
inline

Adds a column of type TIMESTAMP WITH TIMEZONE.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addTimeTz ( )
inline

Adds a column of type TIME WITH TIMEZONE.

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

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

Returns
this
ColumnTypes& Vertica::ColumnTypes::addUserDefinedType ( const char *  typeName)
inline

Adds a column of user-defined type.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addUuid ( )
inline

Adds a column of type UUID.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addVarbinary ( )
inline

Adds a column of type VARBINARY.

Returns
this
ColumnTypes& Vertica::ColumnTypes::addVarchar ( )
inline

Adds a column of type VARCHAR.

Returns
this