List of Built-In Procedures

There are 133 built-in procedures available in TimesTen. All are listed in the table below.

Built-in Name Description

ttAgingLRUConfig

Sets the Least Recently Used (LRU) aging attributes on all regular tables that have been defined with an LRU aging policy.

ttAgingTableLRUConfig

Sets the Least Recently Used (LRU) aging attributes on a specified table that has been defined with an LRU aging policy.

ttAgingScheduleNow

Starts the aging process

ttApplicationContext

Sets application-defined context for the next update record to pass application specific data to XLA readers.

ttBackupStatus

Returns information about the current or last backup of the database.

ttBlockInfo

Provides information about perm blocks and the amount of block-level fragmentation in a database.

ttBookmark

Returns information about the TimesTen transaction log.

ttCacheADGStandbyStateGet

Returns the state for the standby Oracle database in an Active Data Guard configuration.

ttCacheADGStandbyStateSet

Sets the state of the standby Oracle database in an Active Data Guard configuration.

ttCacheADGStandbyTimeoutGet

Retrieves the timeout value of the Oracle database in an Active Data Guard configuration.

ttCacheADGStandbyTimeoutSet

Sets the timeout value of the standby Oracle database in an Active Data Guard configuration.

ttCacheAllowFlushAwtSet

Enables you to run a FLUSH CACHE GROUP statement on an AWT cache group.

ttCacheAutorefIntervalStatsGet

Returns statistical information about the last 10 autorefresh cycles for a specified autorefresh interval.

ttCacheAutorefresh

Starts an immediate autorefresh on a set of cache groups.

ttCacheAutorefreshLogDefrag

Compacts the trigger log space for a cache autorefresh table.

ttCacheAutorefreshStatsGet

Returns information about the last 10 autorefresh transactions on the specified cache group.

ttCacheAutorefreshSelectLimit

Configures the incremental autorefresh on a specific number of rows.

ttCacheAutorefreshXactLimit

Starts an immediate autorefresh on single table cache groups within a specified autorefresh interval and commits after the specified number of operations.

ttCacheAWTMonitorConfig

Sets AWT cache group monitoring.

ttCacheAWTThresholdGet

Returns the current transaction log file threshold for databases that include AWT cache groups.

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.

ttCacheCheck

Checks for missing constraints for cached tables on the Oracle database

ttCacheConfig

Configures timeout value and recovery policies for cache groups.

ttCacheConnPoolApply

Applies the cache connection pool settings.

ttCacheConnPoolGet

Retrieves the cache connection pool settings.

ttCacheConnPoolSet

Configures the cache connection pool for dynamic cache groups.

ttCacheDbCgStatus

Returns the automatic refresh status of the database and the specified cache group.

ttCacheDDLTrackingConfig

Configures tracking of DDL statements issued on cached Oracle database tables.

ttCacheLoadSCNGet Retrieves the load SCN (System Change Number) for a log-based cache group.
ttCacheLogStats Provides statistics on changes applied by GoldenGate to the specified log-based cache group.

ttCachePolicyGet

Returns the current policy used to determine when the TimesTen cache agent for the connected database should run.

ttCachePolicySet

Sets the policy used to determine when the TimesTen cache agent for the connected database should run.

ttCachePropagateFlagSet

Configures propagation of committed updates to a cache group within the current transaction to the Oracle database.

ttCacheSqlGet

Generates the Oracle SQL statements to install or uninstall Oracle database objects for certain types of cache groups.

ttCacheStart

Starts the TimesTen cache agent.

ttCacheStop

Stops the TimesTen cache agent.

ttCacheUidGet

Returns the cache administration user ID.

ttCacheUidPwdSet

Sets the cache administration user ID and password.

ttCkpt

Performs a non-blocking checkpoint operation.

ttCkptBlocking

Performs a blocking checkpoint operation.

ttCkptConfig

Reconfigures the background checkpointer dynamically or returns the currently active settings of the configuration parameters.

ttCkptConfigGet Returns the current values of the configuration parameters.

ttCkptHistory

Returns information about the last eight checkpoints.

ttCommitBufferStats

Returns the number of commit buffer overflows and the high watermark for memory used by transaction reclaim records during transaction commit process.

ttCommitBufferStatsReset

Resets transaction commit buffer statistics to 0.

ttCompact

Compacts both the permanent and temporary data partitions of the database.

ttComputeTabSizes

Refreshes table size statistics stored in TimesTen system tables.

ttConfiguration

Returns the values for most, but not all, connection attributes for the current database connection.

ttContext

Returns the context value of the current connection.

ttDataStoreStatus

Returns the list of processes connected to a database.

ttDBCompactConfig

Sets or returns the value of a TimesTen database system parameter.

ttDBConfig

Sets or returns the value of a TimesTen database system parameter.

ttDBWriteConcurrencyModeGet

Returns information about the write concurrency mode of the database and the status of write concurrency mode operations and transitions.

ttDBWriteConcurrencyModeSet

Controls read optimization during periods of concurrent write operations.

ttDurableCommit

Sets transaction durability.

ttHeapInfo

Returns information about the size and usage of heap memory.

ttHostNameGet

Returns the name of the current local host.

ttHostNameSet

Specifies the name of the default local host

ttIndexAdviceCaptureDrop

Drops existing capture data for either the current connection

ttIndexAdviceCaptureEnd

Ends either an active connection level capture from the current connection or an active database level capture

ttIndexAdviceCaptureInfoGet

Returns information for each active capture.

ttIndexAdviceCaptureOutput

Returns index recommendations from the last recorded capture at the specified level.

ttIndexAdviceCaptureStart

Enables index advice capture.

ttLatchStatsGet

Displays latch statistics.

ttLoadFromOracle

Runs a query on the Oracle database and loads the result into a TimesTen table.

ttLockLevel

Changes the lock level between row-level and database-level locking on the next transaction and for all subsequent transactions for the connection.

ttLockWait

Changes the lock timeout interval of the current connection.

ttLogHolds

Returns information about transaction log holds

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.

ttOptClearStats

Clears the statistics for the specified table.

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.

ttOptEstimateStats

Updates the statistics for the specified table.

ttOptGetColStats

Returns statistics information in text format.

ttOptGetFlag

Returns the optimizer flag settings for the current transaction.

ttOptGetMaxCmdFreeListCnt

Returns the size of the free list of SQL compiled command cache.

ttOptGetOrder

Returns a single-row result set containing the join order for the current transaction.

ttOptSetColIntvlStats

Modifies the statistics for the specified columns with interval information.

ttOptSetColStats

Modifies the statistics for the specified columns.

ttOptSetFlag

Sets flags to alter the generation of execution plans by the TimesTen query optimizer.

ttOptSetMaxCmdFreeListCnt

Sets the maximum count of the free list of SQL compiled commands for regular tables.

ttOptSetMaxPriCmdFreeListCnt

Sets the maximum count of the free list of SQL compiled commands that perform materialized view maintenance.

ttOptSetOrder

Specifies the order in which tables should be joined by the optimizer.

ttOptSetTblStats

Modifies the statistics for the specified table.

ttOptShowJoinOrder

Returns the join order of the last prepared or performed SQL statement in the current transaction.

ttOptStatsExport

Returns the set of statements required to restore the table statistics to the current state.

ttOptUpdateStats

Updates the statistics for the specified table.

ttOptUseIndex

Alters the generation of execution plans by the TimesTen query optimizer.

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.

ttPLSQLMemoryStats

Returns result statistics about PL/SQL library cache performance and activity.

ttRamPolicyAutoReloadGet

Returns the RAM autoreload policy used to determine if a database is reloaded into RAM after an invalidation.

ttRamPolicyAutoReloadSet

Determines the RAM autoreload policy if a database is invalidated.

ttRamPolicyGet

Returns the RAM policy used to determine when a database is loaded into memory.

ttRamPolicySet

Defines the policy used to determine when a database is loaded into memory.

ttRedundantIndexCheck

Scans tables to find redundant indexes.

ttRekeyStatus

Returns information about the currently ongoing or last completed rekey operation.

ttRepDeactivate

Changes the state of the active database in an active standby pair from ACTIVE to IDLE.

ttReplicationStatus

Returns the status of one or more replication peer databases.

ttRepPolicyGet

Returns the replication restart policy

ttRepPolicySet

Specifies the replication restart policy

ttRepQueryThresholdGet

Returns the number of seconds that was most recently specified as the query threshold for the replication agent.

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.

ttRepStart

Starts the TimesTen replication agent for the connected database.

ttRepStateGet

Returns the current replication state of a database in an active standby pair.

ttRepStateSave

Saves the state of a remote peer database in an active standby pair to the currently connected database.

ttRepStateSet

Sets the replication state of a database in an active standby pair replication scheme.

ttRepStop

Stops the TimesTen replication agent for the connected database.

ttRepSubscriberStateSet

Changes a replicating subscriber's state with respect to the executing master store.

ttRepSubscriberWait

Causes the caller to wait until all transactions that committed before the call have been transmitted to the subscriber.

ttRepSyncGet

Returns static attributes associated with the caller's use of the replication- based return service.

ttRepSyncSet

Sets static attributes associated with the caller's use of the replication-based return service.

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.

ttRepTransmitGet

Returns the status of transmission of updates to subscribers for the current transaction.

ttRepTransmitSet

Updates on the connection it is performed in from being replicated to any subscriber.

ttRepXactStatus

Checks the status of a RETURN RECEIPT or RETURN TWOSAFE replication transaction.

ttRepXactTokenGet

Returns a token for RETURN RECEIPT or RETURN TWOSAFE replication transactions.

ttSetUserColumnID

Sets the value for the user-specified column ID.

ttSetUserTableID

Sets the value of the user table ID.

ttSize

Estimates the size of a table or view and the size of indexes.

ttSQLCmdCacheInfo

Returns information about all prepared SQL statements in the TimesTen SQL command cache.

ttSQLCmdCacheInfoGet

Returns information about the commands in the TimesTen SQL command cache.

ttSQLCmdQueryPlan

Returns all detailed runtime query plans for SQL statements in the TimesTen SQL command cache.

ttSQLExecutionTimeHistogram

Returns a histogram of SQL execution times.

ttStatsConfig

Controls statistics collection and parameters for the ttStats utility.

ttStatsConfigGet

Returns parameters of the ttStats utility that you can set with the ttStatsConfig built-in procedure.

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.

ttVersion

Returns TimesTen release information.

ttWarnOnLowMemory

Specifies that operations run on the current connection should return a warning if they allocate memory and find that memory is low.

ttXactIdGet

Returns transaction ID information for interpreting lock messages.

ttXlaBookmarkCreate

Creates the specified bookmark.

ttXlaBookmarkDelete

Deletes the specified bookmark.

ttXlaSubscribe

Configures persistent XLA tracking of a table.

ttXlaUnsubscribe

Stops persistent XLA tracking of a table.