Bureaucrats, editor, reviewer, Administrators
13,551
edits
Changes
Jump to navigation
Jump to search
no edit summary
=Conventions=
{{Mark|Updated with Version 9.0}}:
* The {{Code|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 and errors are assigned to the <code><nowiki>http://basex.org/modules/sessions</nowiki></code> namespace. The module must be imported in the query prolog:
<pre class="brush:xquery">
import module namespace sessions = "http://basex.org/modules/sessions";
...
</pre>
* In this documentation, If any of the namespace functions is bound to called outside the servlet context, the error {{CodeError|sessions}} prefix.* Errors are assigned to the <code><nowiki>basex:http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerrXQuery Errors#BaseX Errors}} prefixis raised.* If any of the functions requested session is called outside the servlet contextnot found, the error {{Error|BXSE0003not-found|#Errors}} is raised.
* As sessions are side-effecting operations, all functions are flagged as ''non-deterministic''. This means that the functions will not be reordered by the compiler.
==sessions:ids==
{| width='100%'
|-
==sessions:created==
{| width='100%'
|-
==sessions:accessed==
{| width='100%'
|-
==sessions:names==
{| width='100%'
|-
|-
| '''Errors'''
|{{Error|BXSE0002get|#Errors}} the value of a session variable could not be retrieved.
|}
|-
| '''Errors'''
|{{Error|BXSE0001set|#Errors}} a function item was specified as value of a session variable.
|}
==sessions:close==
{| width='100%'
|-
=Errors=
{{Mark|Updated with Version 9.0}}:
{| class="wikitable" width="100%"
|Description
|-
|{{Code|BXSE0001set}}|A function item was specified as value of a session attributeFunction items cannot be stored.
|-
|{{Code|BXSE0002get}}|An error occurred while retrieving the The stored attribute is no XQuery value of a session attribute.
|-
|{{Code|BXSE0003}}|A function was called outside the servlet context.|not-|{{Code|BXSE0004found}}
|The specified session was not found.
|}
=Changelog=
;Version 9.0
* Updated: error codes updated; errors now use the module namespace
;Version 8.4
* Updated: Allow sequences as session values.
This module was introduced with Version 7.5.
