Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
Whenever If a RESTXQ URL is requested, the [[Options#RESTXQPATH|RESTXQPATH]] module directory and its sub-directories will be traversed, and all [[XQuery Extensions#Suffixes|XQuery files]] will be parsed for functions with RESTXQ annotations in library modules (detected by the extension {{Code|.xqm}}) and main modules (detected by Sub-directories that include an {{Code|.xqignore}}). In main expressions, the main module file will never be evaluated. All modules will be cached and parsed again when their timestamp changesskipped.
A sub-directory To speed up processing, the functions of the existing XQuery modules are automatically cached in main memory. Functions will not be invalidated and parsed for RESTXQ files again if it contains a file named the timestamp of their module changes. {{CodeMark|Updated with Version 8.ignore6:}}. Module caching * RESTXQ file monitoring has been improved and can be turned on by setting adjusted via the new [[Options#CACHERESTXQPARSERESTXQ|CACHERESTXQPARSERESTXQ]] to trueoption. The option is helpful in In productive environments with a high load, but it may be recommendable to change the timeout, or completely disable monitoring. If files should not be are replaced while the web server is running. If files are still replaced, the RESTXQ module cache must should be explicitly invalidated by calling the static root path {{Code|/.init}}or by calling the [[RESTXQ Module#rest:init|rest:init]] function.* Authentication was readded to RESTXQ (see [[Web Application]] for more details).
function page:hello-postman( $message as xs:string, $agent as xs:string*) as element(response){
function page:multipart($data as item()*){
function page:params($id as xs:string?, $add as xs:integer+){
function page:upload($files){
{{Mark|Introduced with Version 8.4}}: <code>%rest:single</code> annotation. In many RESTXQ search scenarios, input from browser input forms is processed, and search results are returned. User experience can generally be made more interactive if an updated search request is triggered with each key click. However, such search patterns this may lead to numerous many expensive parallel requests, from which only the result of the last request will be relevant for the client.
function page:cities(){
function page:html(){
function page:check($user){
function page:user-error($user){
function page:teapot(){
Currently, the following external resources on RESTXQ existDocumentation:
→Preliminaries
* Quality factors in the [[#Content Negotiation|Accept header]] will be evaluated
* <code>%input</code> annotations, support for input-specific content-type parameters
* Since {{Version 8.4}}: <code>%rest:single</code> annotation to cancel running RESTXQ functions
<br />
All RESTXQ [[XQuery 3.0#Annotations|annotations]] are assigned to the <code><nowiki>http://exquery.org/ns/restxq</nowiki></code> namespace, which is statically bound to the {{Code|rest}} prefix. A ''Resource Function'' is an XQuery function that has been marked up with RESTXQ annotations. When an HTTP request comes in, a resource function will be invoked that matches the constraints indicated by its annotations.
==Examples==
%rest:form-param("message","{$message}", "(no message)")
%rest:header-param("User-Agent", "{$agent}")
<response type='form'>
<message>{ $message }</message>
===Input options===
Conversion options for [[Options#JSONPARSER|JSON]], [[Options#CSVPARSER|CSV ]] and [[Options#HTMLPARSER|HTML ]] can also be specified via annotations using with the <code>input</code> prefix. The following function interprets the input as text with the CP1252 encoding and treats the first line of the textual input as CSV header:
<pre class="brush:xquery">
%rest:path("/store.csv")
%rest:POST("{$csv}")
%input:csv("header=true,encoding=CP1252") function page:store-csv($csv as document-node()){
"Number of rows: " || count($csv/csv/record)
};
%rest:POST("{$data}")
%rest:consumes("multipart/mixed") (: optional :)
"Number of items: " || count($data)
};
%rest:query-param("id", "{$id}")
%rest:query-param("add", "{$add}", 42, 43, 44)
<result id="{ $id }" sum="{ sum($add) }"/>
};
%rest:path("/upload")
%rest:form-param("files", "{$files}")
for $name in map:keys($files)
let $content := $files($name)
==Query Execution==
With the <code>%rest:single</code> annotation, it can be enforced that only one instance of a function will be executed for the same client. If the same function will be called for the second time, the already running query will be stopped, and the HTTP error code {{Code|410}} (Gone) will be returned instead:
%output:method("json")
%output:json("format=jsonml")
element cities {
db:open('factbook')//city/name
%output:doctype-public("-//W3C//DTD XHTML 1.0 Transitional//EN")
%output:doctype-system("http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd")
<html xmlns="http://www.w3.org/1999/xhtml">
<body>done</body>
declare
%rest:path("/check/{$user}")
if($user = ('jack', 'lisa'))
then 'User exists'
%rest:error("err:user")
%rest:error-param("description", "{$user}")
'User "' || $user || '" is unknown'
};
declare
%rest:path("/teapot")
fn:error(xs:QName('error'), "I'm a teapot", 418)
};
=References=
* [http://exquery.org/spec/restxq RESTXQ Specification], First Draft
* [http://www.adamretter.org.uk/presentations/restxq_mugl_20120308.pdf RESTXQ]. Slides, MarkLogic User Group London, 2012
* [http://files.basex.org/publications/xmlprague/2013/Develop-RESTXQ-WebApps-with-BaseX.pdf Web Application Development]. Slides from XMLPrague 2013
Examples:
* Sample code combining XQuery and JavaScript: [http://balisage.net/Proceedings/vol17/author-pkg/Galtman01/BalisageVol17-Galtman01.html Materials] and [http://balisage.net/Proceedings/vol17/html/Galtman01/BalisageVol17-Galtman01.html paper] from Amanda Galtman, Balisage 2016.
* [[DBA]]: The Database Administration interface, bundled with the full distributions of BaseX.
=Changelog=
