Gets the key.

Syntax

Smartsite SXML	Copy Code
string this.getcachekey()

Parameters

This Viper method does not expose any parameters.

Return Value

Data Type	Description
String	The key.

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.

Remarks

Examples

Smartsite SXML	Copy Code
<!--// Create datatable and cache it, saving the key for later use... Set resulttype to "none" to suppress output. --> <se:cache save="key = this.getcachekey()" resulttype="none" maxage="00:05"> <se:sqlquery resulttype="datatable"> <se:parameters> <se:parameter name="sql"> select top 5 c.nr, c.title, u.fullname from {channel.view()} c join vwUsers u on c.userid=u.nr where c.nr in (SELECT nr FROM dbo.fn_RecurseChildren(2,0)) order by c.nr </se:parameter> </se:parameters> </se:sqlquery> </se:cache> <!--// Now, use the cached datatable as inputdata for Xlinks.. --> <se:xlinks inputdata="key" trim="both"> <se:parameters> <se:parameter name="rowformat"> <li>{this.field(title)} - {this.field(fullname)}</li>{char.crlf()} </se:parameter> <se:parameter name="resultformat"> <ul>{char.crlf()}{this.result()}</ul> </se:parameter> </se:parameters> </se:xlinks>

Smartsite SXML

Copy Code

<!--//
    Create datatable and cache it, saving the key for later use...
    Set resulttype to "none" to suppress output.
-->
<se:cache save="key = this.getcachekey()" resulttype="none" maxage="00:05">
    <se:sqlquery resulttype="datatable">
        <se:parameters>
            <se:parameter name="sql"> 
                select top 5 c.nr, c.title, u.fullname from  
                {channel.view()} c join vwUsers u 
                on c.userid=u.nr
                where c.nr in (SELECT nr FROM dbo.fn_RecurseChildren(2,0))
                order by c.nr
            </se:parameter>    
        </se:parameters>
    </se:sqlquery>
</se:cache>
<!--//
    Now, use the cached datatable as inputdata for Xlinks..
-->
<se:xlinks inputdata="key" trim="both">
    <se:parameters>
        <se:parameter name="rowformat">
            <li>{this.field(title)} - {this.field(fullname)}</li>{char.crlf()}
        </se:parameter>
        <se:parameter name="resultformat">
            <ul>{char.crlf()}{this.result()}</ul>
        </se:parameter>
    </se:parameters>
</se:xlinks>

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)}