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