TTXlaColumn Reference

A TTXlaColumn object contains the metadata for a single column of a table being monitored for changes.

Public Members

None

Public Methods

This section summarizes then describes the TTXlaColumn public methods.

Public Methods Summary

Method	Description
`getColName()`	Returns the name of the column.
`getPrecision()`	Returns the precision of the column.
`getScale()`	Returns the scale of the column.
`getSize()`	Returns the size of the column data, in bytes.
`getSysColNum()`	Returns the system-generated column number of this column as stored in the database.
`getType()`	Returns the data type of the column, as an integer.
`getUserColNum()`	Returns a column number optionally specified by the user, or 0.
`isNullable()`	Indicates whether the column allows `NULL` values.
`isPKColumn()`	Indicates whether the column is the primary key for the table.
`isTTTimestamp()`	Indicates whether the column is a `TT_TIMESTAMP` column.
`isUpdated()`	Indicates whether the column was updated.

getColName()

const char* getColName() const

Returns the name of the column.

getPrecision()

SQLULEN getPrecision() const

Returns the precision for data in the column, referring to the maximum number of digits that are used by the data type.

getScale()

int getScale() const

Returns the scale for data in the column, referring to the maximum number of digits to the right of the decimal point.

getSize()

SQLUINTEGER getSize() const

Returns the size of values in the column, in bytes.

getSysColNum()

SQLUINTEGER getSysColNum() const

This is the system-generated column number of the column, numbered from 1. It equals the corresponding COLNUM value in SYS.COLUMNS. (See SYS.COLUMNS in Oracle TimesTen In-Memory Database System Tables and Views Reference.)

getType()

int getType() const

Returns an integer representing the TimesTen XLA data type (TTXLA_xxx) of the column. This is a value from the dataType field of the TimesTen ttXlaColDesc_t data structure. In some cases this corresponds to an ODBC SQL data type (SQL_xxx) and the corresponding standard integer value.

Refer to XLA Data Types in Oracle TimesTen In-Memory Database C Developer's Guide. The corresponding integer values are defined for use in any TTClasses application that includes the TTXla.h header file.

Also refer to ttXlaColDesc_t in Oracle TimesTen In-Memory Database C Developer's Guide.

getUserColNum()

SQLUINTEGER getUserColNum() const

Returns a column number optionally specified by the user through the ttSetUserColumnID TimesTen built-in procedure, or 0.

See ttSetUserColumnID in Oracle TimesTen In-Memory Database Reference.

isNullable()

bool isNullable() const

Returns TRUE if null values are allowed in the column, or FALSE otherwise.

isPKColumn()

bool isPKColumn() const

Returns TRUE if this column is the primary key for the table, or FALSE otherwise.

isTTTimestamp()

bool isTTTimestamp() const

Returns TRUE if this column is a TT_TIMESTAMP column, or FALSE otherwise.

isUpdated()

bool isUpdated() const

Returns TRUE if this column was updated, or FALSE otherwise.