Description
Sets the cache properties for the object cache, the page cache, or both. If a cache does not yet exist, creates it. The cache and properties are application-specific.
Returns
Nothing
CacheSetProperties(propStruct)
See also
cfcache, CacheGet, CachePut, CacheGetAllIds, CacheGetProperties, CacheGetMetadata, CacheRemove
History
ColdFusion 10: Added the attribute {{region}}ColdFusion 9: Added the function.
Parameters
Parameter |
Description |
|---|---|
propsSruct |
A structure specifying the cache properties plus identifying information |
region |
(Optional) The name of the cache region |
The propsStruct structure can have any or all of the following fields:
Structure element |
Description |
|---|---|
diskstore |
The disk store. |
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 or page is cached without any timespan being specified. |
maxentrieslocalheap |
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 overfllowtodisk 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 or template. |
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. |
timetoidoleconds |
The idle time in seconds. Used if a cfcache tag does not specify an idleTime attribute. |
timetolivesecond |
The timeout time in seconds. Used if a cfcache tag does not specify a timespan attribute. |
objecttype |
The type of cache: one of the following:
|
Note:
maxelementsinmemory property name is renamed to maxentrieslocalheap. The reason for this change is that Ehcache has deprecated maxelementsinmemory.
Twitter™ and Facebook posts are not covered under the terms of Creative Commons.