Difference between revisions of "RESTXQ Module"
Jump to navigation
Jump to search
Line 57: | Line 57: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Initializes the RESTXQ module cache. This function should be called if {{Option|CACHERESTXQ}} is enabled and if RESTXQ | + | |Initializes the RESTXQ module cache. This function should be called if {{Option|CACHERESTXQ}} is enabled and if RESTXQ modules are replaced while the web server is running. |
|} | |} | ||
Revision as of 13:43, 7 July 2016
This XQuery Module contains helper functions for the RESTXQ API, some of which are defined in the RESTXQ Draft.
Contents
Conventions
- The
basex-api
package must be included in the classpath. This is always the case if you use one of the complete distributions (zip, exe, war) of BaseX. - All functions are assigned to the
http://exquery.org/ns/restxq
namespace. The module must be imported in the query prolog:
import module namespace rest = "http://exquery.org/ns/restxq"; ...
- In this documentation, the namespace is bound to the
rest
prefix, and thehttp://wadl.dev.java.net/2009/02
namespace is bound to thewadl
prefix. - If any of the functions is called outside the servlet context, the error
BXSE0003
: is raised.
General Functions
rest:base-uri
Signatures | rest:base-uri() as xs:anyURI
|
Summary | Returns the implementation-defined base URI of the resource function. |
rest:uri
Signatures | rest:uri() as xs:anyURI
|
Summary | Returns the complete URI that addresses the Resource Function. This is the result of rest:base-uri appended with the path from the path annotation of the resource function. |
rest:wadl
Signatures | rest:wadl() as element(wadl:application)
|
Summary | Returns a WADL description of all available REST services. |
rest:init
Signatures | rest:init() as empty-sequence()
|
Summary | Initializes the RESTXQ module cache. This function should be called if CACHERESTXQ is enabled and if RESTXQ modules are replaced while the web server is running.
|
Changelog
- Version 8.6
- Added: rest:init
This module was introduced with Version 7.7.