Summary of XLA Functions by Category

TimesTen XLA can be used to detect updates on a TimesTen Classic database or as a toolkit to build your own replication solution.

See XLA and TimesTen Event Management.

This section categorizes the XLA functions based on their use and provides a brief description of each function. It includes the following categories:

XLA Core Functions

The following table lists all the XLA functions used in typical XLA operations, aside from data conversion functions which are listed separately below.

See Writing an XLA Event-Handler Application for a discussion on how to use most of these functions.

Function	Description
`ttXlaAcknowledge`	Acknowledges receipt of one or more transaction update records from the transaction log.
`ttXlaClose`	Closes the XLA handle opened by `ttXlaPersistOpen`.
`ttXlaConvertCharType`	Converts column data into the connection character set.
`ttXlaDeleteBookmark`	Deletes a transaction log bookmark.
`ttXlaError`	Retrieves error information.
`ttXlaErrorRestart`	Resets error stack information.
`ttXlaGetColumnInfo`	Retrieves information about all the columns in the table.
`ttXlaGetLSN`	Retrieves the log record identifier of the current bookmark for a database.
`ttXlaGetTableInfo`	Retrieves information about a table.
`ttXlaGetVersion`	Retrieves the current version of XLA.
`ttXlaNextUpdate`	Retrieves a batch of updates from TimesTen.
`ttXlaNextUpdateWait`	Retrieves a batch of updates from TimesTen. Waits for a specified time if no updates are available in the transaction log.
`ttXlaPersistOpen`	Initializes a handle to a database to access the transaction log.
`ttXlaSetLSN`	Sets the log record identifier of the current bookmark for a database.
`ttXlaSetVersion`	Sets the XLA version to be used.
`ttXlaTableByName`	Finds the system and user table identifiers for a table given the table owner and name.
`ttXlaTableStatus`	Sets and retrieves XLA status for a table.
`ttXlaTableVersionVerify`	Checks whether the cached table definitions are compatible with the XLA record being processed.
`ttXlaVersionColumnInfo`	Retrieves information about the columns in a table for which a change update record must be processed.
`ttXlaVersionCompare`	Compares two XLA versions.

XLA Data Type Conversion Functions

The following table lists data type conversion functions.

See XLA Data Types.

Function	Description
`ttXlaDateToODBCCType`	Converts a `TTXLA_DATE_TT` value to an ODBC C value usable by applications.
`ttXlaDecimalToCString`	Converts a `TTXLA_DECIMAL_TT` value to a character string usable by applications.
`ttXlaNumberToBigInt`	Converts a `TTXLA_NUMBER` value to a `SQLBIGINT` C value usable by applications.
`ttXlaNumberToCString`	Converts a `TTXLA_NUMBER` value to a character string usable by applications.
`ttXlaNumberToDouble`	Converts a `TTXLA_NUMBER` value to a long floating point number value usable by applications.
`ttXlaNumberToInt`	Converts a `TTXLA_NUMBER` value to an integer usable by applications.
`ttXlaNumberToSmallInt`	Converts a `TTXLA_NUMBER` value to a `SQLSMALLINT` C value usable by applications.
`ttXlaNumberToTinyInt`	Converts a `TTXLA_NUMBER` value to a `SQLCHAR` C value usable by applications.
`ttXlaNumberToUInt`	Converts a `TTXLA_NUMBER` value to an unsigned integer usable by applications.
`ttXlaOraDateToODBCTimeStamp`	Converts a `TTXLA_DATE` value to an ODBC timestamp usable by applications.
`ttXlaOraTimeStampToODBCTimeStamp`	Converts a `TTXLA_TIMESTAMP` value to an ODBC timestamp usable by applications.
`ttXlaRowidToCString`	Converts a `ROWID` value to a character string value usable by applications.
`ttXlaTimeToODBCCType`	Converts a `TTXLA_TIME` value to an ODBC C value usable by applications.
`ttXlaTimeStampToODBCCType`	Converts a `TTXLA_TIMESTAMP_TT` value to an ODBC C value usable by applications.

XLA Replication Functions

TimesTen replication as described in Overview of TimesTen Replication in the Oracle TimesTen In-Memory Database Replication Guide is sufficient for most TimesTen customer needs. However, it is also possible to use XLA functions to replicate updates from one database to another. Implementing your own replication scheme on top of XLA in this way is fairly complicated, but can be considered if TimesTen replication is not feasible for some reason.

The following table lists functions used exclusively for XLA as a replication mechanism. (Reference information for these functions is in a separate section from other XLA functions, XLA Replication Function Reference.)

Function	Description
`ttXlaApply`	Applies the update to the database associated with the XLA handle.
`ttXlaCommit`	Commits a transaction.
`ttXlaGenerateSQL`	Generates a SQL statement that expresses the effect of an update record.
`ttXlaLookup`	Looks for an update record for a table with a specific key value.
`ttXlaRollback`	Rolls back a transaction.
`ttXlaTableCheck`	Verifies that the named table in the table description received from the sending database is compatible with the receiving database.

See Using XLA as a Replication Mechanism for a discussion on how to use these functions.