Description
Removes an object from the cache.
Returns
Nothing.
CacheRemove(Object id, boolean throwOnError, String key, boolean exact)
See also
cfcache, CacheGet, CachePut, CacheGetAllIds, CacheGetProperties, CacheGetMetadata, CacheSetProperties
History
ColdFusion 11: The ids parameter will also accept an array.
ColdFusion 10: Added the attributes region and {{exact}}.
ColdFusion 9: Added the function.
Parameters
Parameter |
Description |
|---|---|
id |
A comma delimited string of IDs of the cached objects to remove. Starting from ColdFusion 11, you can also specify an array of IDs. |
throwOnError |
(Optional) A Boolean value specifying whether to throw an exception if any ID does not specify a cached element. The default value is false. |
key |
(Optional) Name of the cache region from which to remove the cached objects. |
exact |
(Optional) If true, the search narrows down to values that exactly match the IDs (for removal). The default value is true. |
Example with parameter exact set to true
<!--- clear all object caches --->
<cfif ArrayLen(cacheGetAllIds()) gt 0>
<cfset cacheRemove(ArrayToList(cacheGetAllIds()))>
</cfif>
<!--- create few caches --->
<cfloop from="1" to="10" index="i">
<cfset id = "cache_#i#">
<cfset timeToLive = CreateTimeSpan(0,0,30,0)>
<cfset timeToIdle = CreateTimeSpan(0,0,30,0)>
<cfset cachePut(id,createQryObj(i),timeToLive,timeToIdle)>
</cfloop>
<cfoutput>Before cacheRemove() :: Number of objects in the cache: #ArrayLen(cacheGetAllIds())#<br></cfoutput>
<!--- clear all objects from the cache --->
<cfset cacheRemove("cache_1",true,"object",true)>
<cfoutput>(List of cache Ids - #ListSort(ArrayToList(cacheGetAllIds()),"textnocase","ASC")#)</cfoutput><br>
<cfoutput>After cacheRemove() :: Number of objects in the cache: #ArrayLen(cacheGetAllIds())#<br><br></cfoutput>
<!--- create an obj to put into the cache --->
<cffunction name="createQryObj" hint="create a query object to put in the cache">
<cfargument name="loopIdx" type="numeric" required="yes">
<cfset var colList = "">
<cfset var alphabet = ["a","b","c","d","e","f","g","h","i","j","k","l","m","n","o","p","q","r","s","t","u","v","w","x","y","z"]>
<cfloop from="1" to="#loopIdx#" index="q">
<cfset colList = (len(colList) gt 0)? (colList & "," & "col#q#") : "col#q#">
</cfloop>
<cfset var nbrCols = listlen(colList)>
<cfset var qObj = querynew(colList)>
<cfset queryaddrow(qObj,loopIdx)>
<cfloop from="1" to="#loopIdx#" index="q">
<cfloop from="1" to="#nbrCols#" index="c">
<cfset querysetcell(qObj,"col#c#","#alphabet[randrange(1,arraylen(alphabet))]##randrange(1,1000000)#",q)>
</cfloop>
</cfloop>
<cfreturn qObj>
</cffunction>
<!--- clear all object caches --->
<cfif ArrayLen(cacheGetAllIds()) gt 0>
<cfset cacheRemove(ArrayToList(cacheGetAllIds()))>
</cfif>
<!--- create few caches --->
<cfloop from="1" to="10" index="i">
<cfset id = "cache_#i#">
<cfset timeToLive = CreateTimeSpan(0,0,30,0)>
<cfset timeToIdle = CreateTimeSpan(0,0,30,0)>
<cfset cachePut(id,createQryObj(i),timeToLive,timeToIdle)>
</cfloop>
<cfoutput>Before cacheRemove() :: Number of objects in the cache: #ArrayLen(cacheGetAllIds())#<br></cfoutput>
<!--- clear all objects from the cache --->
<cfset cacheRemove("cache_1",true,"object",false)>
<cfoutput>(List of cache Ids - #ListSort(ArrayToList(cacheGetAllIds()),"textnocase","ASC")#)</cfoutput><br>
<cfoutput>After cacheRemove() :: Number of objects in the cache: #ArrayLen(cacheGetAllIds())#<br><br></cfoutput>
<!--- create an obj to put into the cache --->
<cffunction name="createQryObj" hint="create a query object to put in the cache">
<cfargument name="loopIdx" type="numeric" required="yes">
<cfset var colList = "">
<cfset var alphabet = ["a","b","c","d","e","f","g","h","i","j","k","l","m","n","o","p","q","r","s","t","u","v","w","x","y","z"]>
<cfloop from="1" to="#loopIdx#" index="q">
<cfset colList = (len(colList) gt 0)? (colList & "," & "col#q#") : "col#q#">
</cfloop>
<cfset var nbrCols = listlen(colList)>
<cfset var qObj = querynew(colList)>
<cfset queryaddrow(qObj,loopIdx)>
<cfloop from="1" to="#loopIdx#" index="q">
<cfloop from="1" to="#nbrCols#" index="c">
<cfset querysetcell(qObj,"col#c#","#alphabet[randrange(1,arraylen(alphabet))]##randrange(1,1000000)#",q)>
</cfloop>
</cfloop>
<cfreturn qObj>
</cffunction>
Twitter™ and Facebook posts are not covered under the terms of Creative Commons.