Cache
Component which provides caching functionality, including content, individual entries, and HTTP headers
Component Signature
Attributes
action
string
false
The cache action - "flush", "clientcache", "servercache", "optimal", "content", "put", "get"
cache
key
string
false
Cache key - optional for GET, DELETE functions and when body content is present. If not provided, a unique identifier of the body will provide the key
value
any
false
- mandatory value for put action
name
any
false
- a variable name for the result of the cache action. Required for GET action
cacheName
string
false
- optional cache name. If not provided the default cache will be used
metadata
struct
false
- any additional metadata to store with the cache object
directory
string
false
- Optional directory attribute which implements a file storage cache
timespan
double
false
- The duration to cache the object, defaults to either the cache default or unlimited until a server restart
idleTime
double
false
- The maximum idle time for an object to remain in the cache, defaults to the timeout
metadata
struct
false
- any additional metadata to store with the cache object
stripWhitespace
boolean
false
false
throwOnError
boolean
false
false
useCache
boolean
false
true
expireURL
string
false
- GLOB pattern or regex this string is found in the URL, the cache object will be invalidated.
password
string
false
port
integer
false
- Legacy CFML attributes. Not implemented
protocol
string
false
- Legacy CFML attribute. Not implemented
region
string
false
useQueryString
boolean
false
false
username
string
false
dependsOn
string
false
Examples
Last updated
Was this helpful?