-<xqdoc:xqdoc>

-<xqdoc:module type="library">

<xqdoc:uri>http://exist-db.org/xquery/system</xqdoc:uri>

-<xqdoc:comment>

<xqdoc:description>Functions to retrieve information about eXist and the system.</xqdoc:description>

</xqdoc:comment>

</xqdoc:module>

-<xqdoc:functions>

-<xqdoc:function>

<xqdoc:name>ft-index-lookup</xqdoc:name>

<xqdoc:signature>system:ft-index-lookup($a as node()*, $b as xs:string?) node()*</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Internal function</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>count-instances-max</xqdoc:name>

<xqdoc:signature>system:count-instances-max() xs:integer</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the maximum number of eXist instances.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>count-instances-active</xqdoc:name>

<xqdoc:signature>system:count-instances-active() xs:integer</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the number of eXist instances that are active.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>count-instances-available</xqdoc:name>

<xqdoc:signature>system:count-instances-available() xs:integer</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the number of eXist instances that are available.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>get-memory-max</xqdoc:name>

<xqdoc:signature>system:get-memory-max() xs:long</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the maximum amount of memory eXist may use.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>get-memory-total</xqdoc:name>

<xqdoc:signature>system:get-memory-total() xs:long</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the total amount of memory in use by eXist.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>get-memory-free</xqdoc:name>

<xqdoc:signature>system:get-memory-free() xs:long</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the amount of free memory available to eXist.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>get-version</xqdoc:name>

<xqdoc:signature>system:get-version() xs:string</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the version of eXist running this query.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>get-build</xqdoc:name>

<xqdoc:signature>system:get-build() xs:string</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the build of eXist running this query.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>get-revision</xqdoc:name>

<xqdoc:signature>system:get-revision() xs:string</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the SubVersion (SVN) revision id of eXist running this query.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>get-exist-home</xqdoc:name>

<xqdoc:signature>system:get-exist-home() xs:string</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the eXist home location.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>shutdown</xqdoc:name>

<xqdoc:signature>system:shutdown() empty()</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Shutdown eXist (dba role only).</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>shutdown</xqdoc:name>

<xqdoc:signature>system:shutdown($a as xs:long) empty()</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Shutdown eXist. $a is the delay in milliseconds. (dba role only)</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>get-module-load-path</xqdoc:name>

<xqdoc:signature>system:get-module-load-path() xs:string</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Returns the module load path from the current context. The module load path corresponds to the location on the file system from where modules are loaded into an XQuery. This will usually the directory from which the main XQuery was compiled.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>trigger-system-task</xqdoc:name>

<xqdoc:signature>system:trigger-system-task($a as xs:string, $b as node()?) empty()</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>Trigger a system task. The first argument specifies the name of the Java class to be executed. The class has to implement org.exist.storage.SystemTask. An XML fragment may be passed as second argument. It should have the following structure: <parameters><param name="param-name1" value="param-value1"/></parameters>. The parameters are transformed into Java properties and passed to the system task.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

-<xqdoc:function>

<xqdoc:name>as-user</xqdoc:name>

<xqdoc:signature>system:as-user($a as xs:string, $b as xs:string?, $c as item()*) item()*</xqdoc:signature>

-<xqdoc:comment>

<xqdoc:description>A pseudo-function to execute a limited block of code as a different user. The first argument is the name of the user, the second is the password. If the user can be authenticated, the function will execute the code block given in the third argument with the permissions of that user andreturns the result of the execution. Before the function completes, it switches the current user back to the old user.</xqdoc:description>

</xqdoc:comment>

</xqdoc:function>

</xqdoc:functions>

</xqdoc:xqdoc>