Whatever message this page gives is out now! Go check it out!
CacheGetProperties
Last update:
May 18, 2026
Description
Gets the cache properties for the object cache, the page cache, or both. The information is application-specific.
Returns
An array of structures, or a single structure, containing the cache properties. Each structure has the properties for the cache type: object, template or query. If you specify the region parameter, the single structure is not wrapped in an array. Each structure has the following fields:
Structure element | Description |
diskpersistent | A Boolean value specifying whether to persist caches stored on disk through JVM restarts. |
eternal | A Boolean value specifying whether no timeout or idletime applies. A true value indicates that the object, template, or query is cached without any timespan being specified. |
maxelementsinmemory | The maximum number of objects that can be cached in memory. If the number is exceeded and overflowtodisk is false, the new objects entered replace old elements using algorithm specified in the memoryevictionpolicy entry. |
maxelementsondisk | The maximum number of objects that can be stored on disk if overflowtodisk is true. |
memoryevictionpolicy | The algorithm to used to evict old entries when maximum limit is reached, such as LRU (least recently used) or LFU (least frequently used). |
objecttype | The cache type: object, template or query. |
overflowtodisk | A Boolean value specifying whether when the maximum number of elements allowed in memory is reached, objects can be moved to disk, as determined by the memoryevictionpolicy value. |
statistics | true indicates that statistics collection for Ehcache is enabled. |
timetoidolseconds | The idle time in seconds. Used if a cfcache tag does not specify an idleTime attribute. |
timetoliveseconds | The timeout time in seconds. Used if a cfcache tag does not specify a timespan attribute. Used if a cfquery tag does not specify a cachedwithin attribute. |
The cacheGetProperties function also supports the following ehCache Structure Elements:
- cacheloadertimeoutmillis
- clearonflush
- copyonread
- copyonwrite
- diskaccessstripes
- diskexpirythreadintervalseconds
- diskpersistent
- diskspoolbuffersizemb
- eternal
- logging
- maxbyteslocaldisk
- maxbyteslocaldiskasstring
- maxbyteslocaldiskpercentageset
- maxbyteslocalheap
- maxbyteslocalheapasstring
- maxbyteslocalheappercentageset
- maxbyteslocaloffheap
- maxbyteslocaloffheapasstring
- maxbyteslocaloffheappercentageset
- maxelementsinmemory
- maxelementsondisk
- maxentrieslocaldisk
- maxentrieslocalheap
- maxmemoryoffheap
- maxmemoryoffheapinbytes
- memoryevictionpolicy
- name
- objecttype
- overflowtodisk
- overflowtooffheap
- overflowtooffheapset
- statistics
- timetoidleseconds
- timetoliveseconds For more information on the above mentioned structure elements, refer to EhCache Documentation.
Category
Function syntax
CacheGetProperties([region])See also
History
ColdFusion 10: Added the parameter region.
ColdFusion 9: Added the function.
Parameters
Parameter | Description |
region | (Optional) The name of the cache region. |
Example
<cfscript>
// create a cache region
rProps={};
CacheRegionNew("_Region",rProps,true);
// set cache properties
propStruct={};
propStruct.diskStore="store 1";
propStruct.diskPersistent=true;
propStruct.eternal=true;
propStruct.maxEntriesLocalHeap="20";
CacheSetProperties(propStruct,"_Region");
Writedump(CacheGetProperties("_Region"));
</cfscript>
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
