User Guide Cancel

CacheSetProperties

Last updated on May 30, 2024 | Also applies to ColdFusion

CFML Reference User Guide
ColdFusion functions
ColdFusion Tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

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

Function syntax

CacheSetProperties(propStruct, [region])

History

ColdFusion 10: Added the parameter region.

ColdFusion 9: Added the function.

Parameters

Parameter	Description
propsStruct	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	Default	Description
diskPersistent	False	A Boolean value specifying whether to persist caches stored on disk through JVM restarts.
diskStore		The disk store. The disk store provides a spooling facility that can be used for additional storage during cache operation. The disk store can also be used for cache persistence. If one or more caches requires a disk store, but there isn't any disk store configured, a default directory is used. To disable creation of a disk store path, comment out the diskStore element in ehcache.xml, located in <ColdFusion home>/cfusion/lib. <diskStore path="java.io.tmpdir"/>
eternal	False	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.
maxElementsOnDisk	10000000	The maximum number of objects that can be stored on disk if overfllowtodisk is true.
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.
memoryEvictionPolicy	LRU	The algorithm used to evict old entries when the maximum limit is reached. The algorithms used are: LRU (Least Recently Used) LFU (Least Frequently Used)
objectType	Object	The type of cache: one of the following: template - Set properties for the page cache, which contains cached pages and page segments. object - Set properties for the object cache. all - Set properties for both cache types.
overflowToDisk	False	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	true indicates that statistics collection for Ehcache is enabled.
timeToIdleSeconds	86400	The idle time in seconds. Used if a cfcache tag does not specify an idleTime attribute.
timeToLiveSeconds	86400	The timeout time in seconds. Used if a cfcache tag does not specify a timespan attribute.

Note:

maxelementsinmemory property name is renamed to maxentrieslocalheap. The reason for this change is that Ehcache has deprecated maxelementsinmemory.

Example

<cfscript>
 myProps = StructNew();
 myProps.diskStore = "/Users/user1";
 myProps.diskPersistent = true
 myProps.eternal = false
 myProps.maxElementsInMemory = "5000";
 myProps.maxElementsOnDisk = "100000";
 myProps.memoryEvictionPolicy = "LRU";
 myProps.objectType = "Object";
 myProps.overflowToDisk = "true";
 myProps.timeToIdleSeconds = "86400";
 myProps.timeToLiveSecond = "86400";
 myProps.maxEntriesLocalHeap="20";
 // remove cache region
 CacheRegionRemove("myCacheRegion_1")
 // create a cache region with struct myProps
 CacheRegionNew("myCacheRegion_1",myProps,true)
 // set properties for the cache
 CacheSetProperties(myProps,"myCacheRegion_1")
 writeDump(cacheGetProperties("myCacheRegion_1"));
</cfscript>

Get help faster and easier

New user?

CacheSetProperties

Description

Returns

Category

Function syntax

See also

History

Parameters

Example

Get help faster and easier

Ask the Community

Contact Us