Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
→Introduction
=Introduction=
==Preliminaries==
The RESTXQ service is accessible via {{Code|http://localhost:8984/}}.
Whenever a RESTXQ URL is requested, the [[Options#RESTXQPATH|RESTXQPATH]] module directory and its sub-directories will be parsed for functions with RESTXQ annotations in library modules (detected by the extension {{Code|.xqm}}) and main modules (detected by {{Code|.xq}}). In main expressions, the main module will never be evaluated. All modules will be cached and parsed again when their timestamp changes.
The following features are available with {{Version|8.3}}:
* Module caching can be turned on by setting [[Options#CACHERESTXQ|CACHERESTXQ]] to true. This option is particularly helpful in productive environments with a high load.
* The static root path {{Code|/.init}} can be called to invalidate the RESTXQ module cache.
* A sub-directory will be skipped if it contains a file named {{Code|.ignore}}.
==Examples==
A first RESTXQ function is shown below:
