ttRamPolicySet

Description

Defines the policy used to determine when a data store is loaded into memory. The policy can be either always, manual, or inUse.

Required privilege

This procedure requires the ADMIN privilege.

Syntax

ttRamPolicySet('ramPolicy', ramGrace)

Parameters

ttRamPolicySet has the parameters:

Parameter Type Description

Parameter	Type	Description
`ramPolicy`	TT_VARCHAR (10) NOT NULL	The policy used to determine when the data store is loaded into system RAM. Valid values are: `always` - specifies that the data store should remain in system RAM all the time. `manual` - specifies that the data store is only to be loaded in system RAM when explicitly loaded by the user, using the ttAdmin `-ramLoad` command. `inUse` - specifies that the data store is only loaded in system RAM when in use (i.e.:when applications are connected). This option cannot be used with temporary data stores. TimesTen only allows a temporary data store to be loaded into RAM manually. Trying to set the policy generates a warning.
`ramGrace`	TT_INTEGER	Sets the number of seconds the data store is kept in RAM after the last application has disconnected. This number is only effective if `ramPoliy` is `inUse`. This parameter is optional, and when omitted or set to NULL, the existing `ramGrace` period is left unchanged.

ramPolicy

TT_VARCHAR (10) NOT NULL

The policy used to determine when the data store is loaded into system RAM. Valid values are:

always - specifies that the data store should remain in system RAM all the time.

manual - specifies that the data store is only to be loaded in system RAM when explicitly loaded by the user, using the ttAdmin -ramLoad command.

inUse - specifies that the data store is only loaded in system RAM when in use (i.e.:when applications are connected). This option cannot be used with temporary data stores. TimesTen only allows a temporary data store to be loaded into RAM manually. Trying to set the policy generates a warning.

ramGrace TT_INTEGER Sets the number of seconds the data store is kept in RAM after the last application has disconnected. This number is only effective if ramPoliy is inUse. This parameter is optional, and when omitted or set to NULL, the existing ramGrace period is left unchanged.

Result set

ttRamPolicySet returns no results.

Examples

To set the policy for loading a data store into RAM to be inUse and for the data store to kept in RAM for 10 seconds after the last application has disconnected, use:

CALL ttRamPolicySet('inUse', 10);