UpdateResourceCacheKeyStatus
Update the cache key for a specified resource of type TABLE, or of type PROCEDURE with zero parameters. Also see
CreateResourceCacheKey and
GetResourceCacheStatus. The cache key identifies a snapshot of values for a query. The cache key and corresponding values are stored in the cache storage table.
The user may wish to create a cache key to assist with the manual insertion of data into the cache storage table. This procedure provides a switch to manually set the status to TRUE after inserting the data, to let the cache system know when the new snapshot is ready for use.
Use the message input to publish a note to the cache refresh status. All inputs are required, although an empty string may be entered if no message is desired.
This built-in procedure is discussed in the “TDV Caching” section of the TDV User Guide.
Location
/lib/resource/
Inputs
path: The path to the resource.
type: The type of the resource (TABLE or PROCEDURE).
cacheKey: The cache key from CreateResourceCacheKey.
status: Whether cache refresh succeeded (TRUE) or failed (FALSE).
startTime: Timestamp when the cache refresh starts.
message: If refresh failed, explains what was wrong.
Outputs
N/A
Exceptions
IllegalArgumentException: If the path is malformed or the type is illegal.
IllegalStateException: If the resource type does not support being cached.
IllegalStateException: If the resource is not configured for caching.
IllegalStateException: If the data source used by the resource for caching is not properly configured.
NotFoundException: If the resource does not exist.
SecurityException: If the user does not have READ access on all items in the path other than the last one.
SecurityException: If the user does not have WRITE access to the last item in path.