Sets a list of dependencies that will help generate a unique cache key for the cache block.
For instance, if you wish to have cache generated depending on a querystring parameter or the current user-role, add vipers accordingly.

Properties

Data type	Attribute
Collection	-

Used in

Macro	Description
Cache	Cache macro. Used to cache blocks of SXML. The cache key is auto-generated based on the SXML in the Xml (default) parameter.

Examples

Cache with Keydependency Example

The cache macro is able to generate AIM relations so that cache is automatically flushed when related items shown in the cache result would change. For instance, a Sitemap is perfectly cacheable because it will be rebuilt whenever a change occurs in one of the listed folders.

Sometimes however, the cached result depends on external parameters, such as query strings, or userprofile settings (1.2+). In these cases, you can specify those parameters in the KeyDependencies collection.

In the example shown here, the code of a ContentType is passed over the querystring. This code is used in a cached SqlQuery macro.

Smartsite SXML	Copy Code
<se:cache> <se:parameters> <se:parameter name="keydependencies"> <se:collection> <se:member name="ct"> {request.query(ct)} </se:member> </se:collection> </se:parameter> <se:parameter name="xml"> <se:sqlquery sql="select nr, title from {channel.view()} where contenttype=?" params="{contenttype.getnumber(request.query(ct, default='CWP'))}" rowformat="{html.div(this.field(title))}" /> </se:parameter> </se:parameters> </se:cache>

Smartsite SXML

Copy Code

<se:cache>
    <se:parameters>
        <se:parameter name="keydependencies">
            <se:collection>
            <se:member name="ct">
                {request.query(ct)}
            </se:member>
            </se:collection>
        </se:parameter>
        <se:parameter name="xml">
            <se:sqlquery 
                sql="select nr, title from {channel.view()} where contenttype=?" 
                params="{contenttype.getnumber(request.query(ct, default='CWP'))}"
                rowformat="{html.div(this.field(title))}" 
            />
        </se:parameter>
    </se:parameters>
</se:cache>

Caching using environment variables with the 'keydependencies' parameter

In this example, we cache query results as datatables depending on a querystring variable. For each value of the querystring parameter 'ct', a new cache value is added.

Try this code with different contenttype numbers and see the resulting cache key differ.

Smartsite SXML	Copy Code
<se:cache save="cached=this.iscached(), key=this.getcachekey()" keydependencies="ct={request.query(ct, default=4)}" resulttype="none" trim="both" > <se:sqlquery sql="select nr, title from {channel.view()} where contenttype=?:ct" resulttype="datatable"> <se:parameters> <se:parameter name="params"> <se:collection> <se:member name="ct" type="integer">{request.query(ct, default=4)}</se:member> </se:collection> </se:parameter> </se:parameters> </se:sqlquery> </se:cache> Cached: {buffer.get(cached)} under key {buffer.get(key)} {cache.get($key)}

Smartsite SXML

Copy Code

<se:cache save="cached=this.iscached(), key=this.getcachekey()" 
    keydependencies="ct={request.query(ct, default=4)}" 
    resulttype="none" 
    trim="both" >
    <se:sqlquery sql="select nr, title from {channel.view()} where contenttype=?:ct" 
        resulttype="datatable">
        <se:parameters>
            <se:parameter name="params">
                <se:collection>
                    <se:member name="ct" type="integer">{request.query(ct, default=4)}</se:member>
                </se:collection>
            </se:parameter>
        </se:parameters>
    </se:sqlquery>
</se:cache>

Cached: {buffer.get(cached)} under key {buffer.get(key)}
{cache.get($key)}

More examples

SXML