List of Built-In Procedures

There are 131 built-in procedures available in TimesTen, all listed on the next table.

Built-in Name	Description	TimesTen Classic Support	TimesTen Scaleout Support
ttAgingLRUConfig	Sets the Least Recently Used (LRU) aging attributes on all regular tables that have been defined with an LRU aging policy.	Yes	No
ttAgingTableLRUConfig	Sets the Least Recently Used (LRU) aging attributes on a specified table that has been defined with an LRU aging policy.	Yes	No
ttAgingScheduleNow	Starts the aging process	Yes	No
ttApplicationContext	Sets application-defined context for the next update record to pass application specific data to XLA readers.	Yes	No
ttBackupStatus	Returns information about the current or last backup of the database.	Yes	Yes
ttBlockInfo	Provides information about perm blocks and the amount of block-level fragmentation in a database.	Yes	Yes
ttBookmark	Returns information about the TimesTen transaction log.	Yes	Yes
ttCacheADGStandbyStateGet	Returns the state for the standby Oracle database in an Active Data Guard configuration.	Yes	No
ttCacheADGStandbyStateSet	Sets the state of the standby Oracle database in an Active Data Guard configuration.	Yes	No
ttCacheADGStandbyTimeoutGet	Retrieves the timeout value of the Oracle database in an Active Data Guard configuration.	Yes	No
ttCacheADGStandbyTimeoutSet	Sets the timeout value of the standby Oracle database in an Active Data Guard configuration.	Yes	No
ttCacheAllowFlushAwtSet	Enables you to run a FLUSH CACHE GROUP statement on an AWT cache group.	Yes	No
ttCacheAutorefIntervalStatsGet	Returns statistical information about the last 10 autorefresh cycles for a specified autorefresh interval.	Yes	No
ttCacheAutorefresh	Starts an immediate autorefresh on a set of cache groups.	Yes	No
ttCacheAutorefreshLogDefrag	Compacts the trigger log space for a cache autorefresh table.	Yes	No
ttCacheAutorefreshStatsGet	Returns information about the last 10 autorefresh transactions on the specified cache group.	Yes	No
ttCacheAutorefreshSelectLimit	Configures the incremental autorefresh on a specific number of rows.	Yes	No
ttCacheAutorefreshXactLimit	Starts an immediate autorefresh on single table cache groups within a specified autorefresh interval and commits after the specified number of operations.	Yes	No
ttCacheAWTMonitorConfig	Sets AWT cache group monitoring.	Yes	No
ttCacheAWTThresholdGet	Returns the current transaction log file threshold for databases that include AWT cache groups.	Yes	No
ttCacheAWTThresholdSet	Sets the threshold for the number of transaction log files that can accumulate before AWT is considered terminated or too far behind to catch up.	Yes	No
ttCacheCheck	Checks for missing constraints for cached tables on the Oracle database	Yes	No
ttCacheConfig	Configures timeout value and recovery policies for cache groups.	Yes	No
ttCacheConnPoolApply	Applies the cache connection pool settings.	Yes	No
ttCacheConnPoolGet	Retrieves the cache connection pool settings.	Yes	No
ttCacheConnPoolSet	Configures the cache connection pool for dynamic cache groups.	Yes	No
ttCacheDbCgStatus	Returns the automatic refresh status of the database and the specified cache group.	Yes	No
ttCacheDDLTrackingConfig	Configures tracking of DDL statements issued on cached Oracle database tables.	Yes	No
ttCachePolicyGet	Returns the current policy used to determine when the TimesTen cache agent for the connected database should run.	Yes	No
ttCachePolicySet	Sets the policy used to determine when the TimesTen cache agent for the connected database should run.	Yes	No
ttCachePropagateFlagSet	Configures propagation of committed updates to a cache group within the current transaction to the Oracle database.	Yes	No
ttCacheSqlGet	Generates the Oracle SQL statements to install or uninstall Oracle database objects for certain types of cache groups.	Yes	No
ttCacheStart	Starts the TimesTen cache agent.	Yes	No
ttCacheStop	Stops the TimesTen cache agent.	Yes	No
ttCacheUidGet	Returns the cache administration user ID.	Yes	No
ttCacheUidPwdSet	Sets the cache administration user ID and password.	Yes	No
ttCkpt	Performs a non-blocking checkpoint operation.	Yes	No
ttCkptBlocking	Performs a blocking checkpoint operation.	Yes	No
ttCkptConfig	Reconfigures the background checkpointer dynamically or returns the currently active settings of the configuration parameters.	Yes	No
ttCkptHistory	Returns information about the last eight checkpoints.	Yes	No
ttCommitBufferStats	Returns the number of commit buffer overflows and the high watermark for memory used by transaction reclaim records during transaction commit process.	Yes	Yes
ttCommitBufferStatsReset	Resets transaction commit buffer statistics to 0.	Yes	No
ttCompact	Compacts both the permanent and temporary data partitions of the database.	Yes	No
ttComputeTabSizes	Refreshes table size statistics stored in TimesTen system tables.	Yes	Yes
ttConfiguration	Returns the values for most, but not all, connection attributes for the current database connection.	Yes	Yes
ttContext	Returns the context value of the current connection.	Yes	Yes
ttDataStoreStatus	Returns the list of processes connected to a database.	Yes	Yes
ttDBCompactConfig	Sets or returns the value of a TimesTen database system parameter.	Yes	Yes
ttDBConfig	Sets or returns the value of a TimesTen database system parameter.	Yes	Yes
ttDBWriteConcurrencyModeGet	Returns information about the write concurrency mode of the database and the status of write concurrency mode operations and transitions.	Yes	No
ttDBWriteConcurrencyModeSet	Controls read optimization during periods of concurrent write operations.	Yes	No
ttDistributionProgress	Returns a progress report of an ongoing redistribution process.	No	Yes
ttDurableCommit	Sets transaction durability.	Yes	Yes
ttEpochCreate	Causes the next committed transaction in a grid to commit as an epoch transaction.	No	Yes
ttEpochSessionGet	Returns the epoch identifier of the last epoch created by the current connection.	No	Yes
ttHeapInfo	Returns information about the size and usage of heap memory.	Yes	Yes
ttHostNameGet	Returns the name of the current local host.	Yes	No
ttHostNameSet	Specifies the name of the default local host	Yes	No
ttIndexAdviceCaptureDrop	Drops existing capture data for either the current connection	Yes	Yes
ttIndexAdviceCaptureEnd	Ends either an active connection level capture from the current connection or an active database level capture	Yes	Yes
ttIndexAdviceCaptureInfoGet	Returns information for each active capture.	Yes	Yes
ttIndexAdviceCaptureOutput	Returns index recommendations from the last recorded capture at the specified level.	Yes	Yes
ttIndexAdviceCaptureStart	Enables index advice capture.	Yes	Yes
ttLatchStatsGet	Displays latch statistics.	Yes	Yes
ttLoadFromOracle	Runs a query on the Oracle database and loads the result into a TimesTen table.	Yes	Yes
ttLockLevel	Changes the lock level between row-level and database-level locking on the next transaction and for all subsequent transactions for the connection.	Yes	Yes
ttLockWait	Changes the lock timeout interval of the current connection.	Yes	Yes
ttLogHolds	Returns information about transaction log holds	Yes	Yes
ttMonitorHighWaterReset	Changes the value of the PERM_IN_USE_HIGH_WATER column in the MONITOR system table to the value of the PERM_IN_USE_SIZE and sets the value of the TEMP_IN_USE_HIGH_WATER column to the current value of TEMP_IN_USE_SIZE column.	Yes	Yes
ttOptClearStats	Clears the statistics for the specified table.	Yes	Yes
ttOptCmdCacheInvalidate	Forces a recompilation should a dependent command be invoked again, or removes the command from the cache. It must be re-prepared by the user.	Yes	Yes
ttOptEstimateStats	Updates the statistics for the specified table.	Yes	Yes
ttOptGetColStats	Returns statistics information in text format.	Yes	Yes
ttOptGetFlag	Returns the optimizer flag settings for the current transaction.	Yes	Yes
ttOptGetMaxCmdFreeListCnt	Returns the size of the free list of SQL compiled command cache.	Yes	Yes
ttOptGetOrder	Returns a single-row result set containing the join order for the current transaction.	Yes	Yes
ttOptSetColIntvlStats	Modifies the statistics for the specified columns with interval information.	Yes	Yes
ttOptSetColStats	Modifies the statistics for the specified columns.	Yes	Yes
ttOptSetFlag	Sets flags to alter the generation of execution plans by the TimesTen query optimizer.	Yes	Yes
ttOptSetMaxCmdFreeListCnt	Sets the maximum count of the free list of SQL compiled commands for regular tables.	Yes	Yes
ttOptSetMaxPriCmdFreeListCnt	Sets the maximum count of the free list of SQL compiled commands that perform materialized view maintenance.	Yes	Yes
ttOptSetOrder	Specifies the order in which tables should be joined by the optimizer.	Yes	Yes
ttOptSetTblStats	Modifies the statistics for the specified table.	Yes	Yes
ttOptShowJoinOrder	Returns the join order of the last prepared or performed SQL statement in the current transaction.	Yes	Yes
ttOptStatsExport	Returns the set of statements required to restore the table statistics to the current state.	Yes	Yes
ttOptUpdateStats	Updates the statistics for the specified table.	Yes	Yes
ttOptUseIndex	Alters the generation of execution plans by the TimesTen query optimizer.	Yes	Yes
ttPageLevelTableInfo	Shows the page allocation for each table to determine whether TimesTen is actually reusing empty slots and freeing empty pages or if new pages are allocated to store new rows.	Yes	No
ttPLSQLMemoryStats	Returns result statistics about PL/SQL library cache performance and activity.	Yes	Yes
ttRamPolicyAutoReloadGet	Returns the RAM autoreload policy used to determine if a database is reloaded into RAM after an invalidation.	Yes	No
ttRamPolicyAutoReloadSet	Determines the RAM autoreload policy if a database is invalidated.	Yes	No
ttRamPolicyGet	Returns the RAM policy used to determine when a database is loaded into memory.	Yes	No
ttRamPolicySet	Defines the policy used to determine when a database is loaded into memory.	Yes	No
ttRedundantIndexCheck	Scans tables to find redundant indexes.	Yes	Yes
ttRepDeactivate	Changes the state of the active database in an active standby pair from ACTIVE to IDLE.	Yes	No
ttReplicationStatus	Returns the status of one or more replication peer databases.	Yes	No
ttRepPolicyGet	Returns the replication restart policy	Yes	No
ttRepPolicySet	Specifies the replication restart policy	Yes	No
ttRepQueryThresholdGet	Returns the number of seconds that was most recently specified as the query threshold for the replication agent.	Yes	No
ttRepQueryThresholdSet	Specifies the number of seconds that a query can be run by the replication agent before TimesTen writes a warning to the daemon log.	Yes	No
ttRepStart	Starts the TimesTen replication agent for the connected database.	Yes	No
ttRepStateGet	Returns the current replication state of a database in an active standby pair.	Yes	No
ttRepStateSave	Saves the state of a remote peer database in an active standby pair to the currently connected database.	Yes	No
ttRepStateSet	Sets the replication state of a database in an active standby pair replication scheme.	Yes	No
ttRepStop	Stops the TimesTen replication agent for the connected database.	Yes	No
ttRepSubscriberStateSet	Changes a replicating subscriber's state with respect to the executing master store.	Yes	No
ttRepSubscriberWait	Causes the caller to wait until all transactions that committed before the call have been transmitted to the subscriber.	Yes	No
ttRepSyncGet	Returns static attributes associated with the caller's use of the replication- based return service.	Yes	No
ttRepSyncSet	Sets static attributes associated with the caller's use of the replication-based return service.	Yes	No
ttRepSyncSubscriberStatus	Queries a subscriber database in a replication scheme configured with a return service and a RETURN DISABLE failure policy to determine whether return service blocking for the subscriber has been disabled by the failure policy.	Yes	No
ttRepTransmitGet	Returns the status of transmission of updates to subscribers for the current transaction.	Yes	No
ttRepTransmitSet	Updates on the connection it is performed in from being replicated to any subscriber.	Yes	No
ttRepXactStatus	Checks the status of a RETURN RECEIPT or RETURN TWOSAFE replication transaction.	Yes	No
ttRepXactTokenGet	Returns a token for RETURN RECEIPT or RETURN TWOSAFE replication transactions.	Yes	No
ttSetUserColumnID	Sets the value for the user-specified column ID.	Yes	No
ttSetUserTableID	Sets the value of the user table ID.	Yes	No
ttSize	Estimates the size of a table or view and the size of indexes.	Yes	Yes
ttSQLCmdCacheInfo	Returns information about all prepared SQL statements in the TimesTen SQL command cache.	Yes	Yes
ttSQLCmdCacheInfoGet	Returns information about the commands in the TimesTen SQL command cache.	Yes	Yes
ttSQLCmdQueryPlan	Returns all detailed runtime query plans for SQL statements in the TimesTen SQL command cache.	Yes	Yes
ttSQLExecutionTimeHistogram	Returns a histogram of SQL execution times.	Yes	Yes
ttStatsConfig	Controls statistics collection and parameters for the ttStats utility.	Yes	Yes
ttStatsConfigGet	Returns parameters of the ttStats utility that you can set with the ttStatsConfig built-in procedure.	Yes	Yes
ttTableSchemaFromOraQueryGet	Evaluates a SELECT query on a table in an Oracle database and generates a CREATE TABLE SQL statement that you can choose to run.	Yes	Yes
ttVersion	Returns TimesTen release information.	Yes	Yes
ttWarnOnLowMemory	Specifies that operations run on the current connection should return a warning if they allocate memory and find that memory is low.	Yes	Yes
ttXactIdGet	Returns transaction ID information for interpreting lock messages.	Yes	Yes
ttXlaBookmarkCreate	Creates the specified bookmark.	Yes	No
ttXlaBookmarkDelete	Deletes the specified bookmark.	Yes	No
ttXlaSubscribe	Configures persistent XLA tracking of a table.	Yes	No
ttXlaUnsubscribe	Stops persistent XLA tracking of a table.	Yes	No