getResourceCacheConfig
Get the cache configuration for a resource. TABLE and PROCEDURE resources support caching.
Location
/services/webservices/system/admin/resource/operations/
Request Elements
path: The path of a cacheable resource.
type: The type of the resource. A valid input is TABLE or PROCEDURE.
Response Elements
The getResourceCacheConfig response has five levels of elements. Elements at the fourth and fifth levels are preceded by their level number in square brackets ([4] and [5]).
cacheConfig: The cache configuration of the given resource.
• allOrNothing (optional): The refresh policy of the cache group: TRUE if cache group refresh policy should be all or nothing; FALSE if cache group refresh policy should be best effort. This flag applies only to cache group. For individual cache groups, this flag always returns TRUE and setting this flag has no effect.
• configured (optional): TRUE if caching should be configured for the given resource; otherwise FALSE. If configured is FALSE, all other elements are ignored.
• enabled (optional): TRUE if the cache is enabled; otherwise FALSE.
• incremental (optional): TRUE if the cache is incrementally maintained; otherwise FALSE.
• storage (optional): How the cached is stored.
— useDefaultCacheStorage (optional): The server returns TRUE for this value if default cache data source is used to store the cache tables; otherwise, FALSE.
— mode (optional): The type of storage to use for the cache. May be AUTOMATIC, DATA_SOURCE or DATA_SOURCE_OTPS.
— bucketMode (optional): Present when storage mode is DATA_SOURCE_OTPS; otherwise ignored. May be AUTO_GEN or MANUAL.
— bucketProperties (optional): Present when bucketMode is AUTO_GEN; otherwise ignored.
— [4] bucketCatalog (optional): Database catalog in which to create the bucket.
— [4] bucketSchema (optional): Database schema in which to create the bucket.
— [4] bucketPrefix (optional): Short string which begins the name of each bucket.
— [4] numBuckets (optional): Number of buckets to use for caching.
— dropCreateIdx (optional): If TRUE, TDV automatically drops indexes before loading cache data, and creates them after loading.
— storageDataSourcePath (optional): If the mode is DATA_SOURCE or DATA_SOURCE_OTPS, this identifies the path to the data source being used to store cache data.
— storageTargets: (optional) Used for storing cache data. If the mode is DATA_SOURCE or DATA_SOURCE_OTPS, this identifies the tables. If the latter, it is required when bucketMode is MANUAL; otherwise, storageTargets is ignored.
— [4] entry (optional):
— [5] targetName: For a TABLE resource and storage mode DATA_SOURCE, this is always the result. For a TABLE resource and storage mode DATA_SOURCE_OTPS, this may be result, result1, result2, and so on. For a PROCEDURE resource, this is the name of a cursor parameter, or an empty string for the scalar output parameters.
— [5] path: The path to the table used for storing this data.
— [5] type: Always TABLE.
• refresh (optional): How the cache should be refreshed. See
Refresh Element.
— mode: How the cache should be refreshed. May be MANUAL or SCHEDULED.
Note: The value of the mode element under schedule is always INTERVAL for cache.
Faults
IllegalArgument: If the path is malformed or an illegal type is provided.
IllegalState: If the resource type does not support caching.
NotFound: If the resource or any portion of the path to the resource does not exist.
Security: If the user does not have READ access on all items in path.
Security: If the user does not have the ACCESS_TOOLS right.