Cache Module Documentation Is Missing

[nsincaglia]

Where is the problem

eXist-db's XQuery Function Library documentation does not include the Cache module's functions.

What is the problem

The following Cache module functions are missing from the documentation.
cache:cleanup($cache-name as xs:string)
cache:clear($cache-name as xs:string)
cache:clear()
cache:create($cache-name as xs:string, $config as map())
cache:destroy($cache-name as xs:string)
cache:get($cache-name as xs:string, $key as xs:anyType+)
cache:keys($cache-name as xs:string)
cache:list($cache-name as xs:string, $keys as xs:anyType)
cache:names()
cache:put($cache-name as xs:string, $key as xs:anyType+, $value as item()*)
cache:remove($cache-name as xs:string, $key as xs:anyType+)

[karkraeg]

How do those commands work? I’m on eXist 4.5.0 and I get an invalid qname when evaluating. Do I have to import module namespace cache="http://exist-db.org/xquery/cache"; or something like this? Documentation/Information on this would be greatly appreciated!

Thanks

[adamretter]

Yes you need to import the module first.

[karkraeg]

Evaluating

xquery version "3.1";
import module namespace cache="http://exist-db.org/xquery/cache";
cache:names()

I get the following error:

Cannot compile xquery: err:XQST0059 error found while loading module cache: failed to load module: 'http://exist-db.org/xquery/cache' from: 'http://exist-db.org/xquery/cache', location: 'http://exist-db.org/xquery/cache'. Source not found. 

[adamretter]

@karbecker Ah, you will also need to uncomment the following line in your conf.xml and restart it:

<module uri="http://exist-db.org/xquery/cache" class="org.exist.xquery.modules.cache.CacheModule" />

[karkraeg]

Thanks! Now, those cache commands don’t interact with the Cache usage shown by Monex, do they?

I was hoping to be able to clear the exist cache on demand as we are experiencing some performance issues we believe are connected to the cache being overfull...

[adamretter]

@karbecker Ah! No they are completely different types of Cache. The Cache module is just a simple wrapper around a HashMap for use from XQuery for caching things the user might interested in for their own application needs.

[karkraeg]

Ah okay, thanks for clarifying. While we’re at this, even though it probably doesn't belong in this Github Issue: Is there any option to clear/purge the main eXist cache?

Thanks!

[adamretter]

Nope

…

On Fri, 6 Sep 2019, 10:26 Karl Becker, ***@***.***> wrote: Ah okay, thanks for clarifying. While we’re at this, even though it probably doesn't belong in this Github Issue: Is there any option to clear/purge the main eXist cache? Thanks! — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#34?email_source=notifications&email_token=AAJUTOKT6KMPKCFTNMC2PPTQIIO4PA5CNFSM4IKXWSJKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD6CJLTY#issuecomment-528782799>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJUTOPXWXFGFT5NPJ55VP3QIIO4PANCNFSM4IKXWSJA> .