ttGridDestroy

Description

Destroys a cache grid by removing all cache grid objects stored on the Oracle database.

By default, this built-in procedure does not destroy the grid if there are still attached members or existing global cache groups. Before destroying a cache grid, detach all of the TimesTen data stores from the cache grid. To force the grid to be destroyed, supply a value of '1' as an argument to the force parameter.

Required privilege

This procedure requires the CACHE_MANAGER privilege.

Syntax

ttGridDestroy('gridName', [force])

Parameters

ttGridDestroy has the parameters:

Parameter	Type	Description
`gridName`	TT_VARCHAR (30) NOT NULL	The fully qualified name of the grid to be destroyed.
`force`	TT_INTEGER	This optional parameter forces the cache grid to be destroyed even if there are still grid members attached to the cache grid or if it still contains global cache groups. Valid value is 1.

Result set

ttGridDestroy returns no results.

Example

To destroy the mygrid cache grid with force, use:

CALL ttGridDestroy ('mygrid', 1);