Changes

* The module will be available if the {{Code|basex-api}} library is found in the classpath. This is the case if you use one of the complete distributions of BaseX (zip, exe, war).* All functions and errors are assigned of the <code><nowiki>http://basex.org/modules/sessions</nowiki></code> namespace, which is statically bound to the {{Code|sessions}} prefix.* If any of the functions is called outside the servlet context, <code>[[XQuery Errors#BaseX Errors|basex:http]]</code> is raised.* If a specified session id is not found, <code>[[#Errors|not-found]]</code> is raised.* As sessions are side-effecting operations, all functions in this module are flagged as ''non-deterministicnondeterministic''. This means that the evaluation order of the functions As a result, some query optimizations will not be influenced by the compilersuppressed.

All functions are assigned to the {{Code|http://basex.org/modules/sessions}} namespace, which must be dynamically imported. In this documentation, the namespace is bound to the {{Code|sessions}} prefix. Errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix. If the module is called outside the servlet context, the error [[#BXSE0003|BXSE0003]] is raised. If a specified session is not found, [[#BXSE0004|BXSE0004]] is raised.=Functions=

=Functions=sessions:ids==

|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|<pre>sessions:ids||() as xs:string}}*</pre>|-valign="top"

|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|<pre>sessions:created||( $id as xs:string) as xs:dateTime}}</pre>|-valign="top"

|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|<pre>sessions:accessed||( $id as xs:string) as xs:dateTime}}</pre>|-valign="top"

|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|<pre>sessions:names|( $id as xs:string|) as xs:string*}}</pre>|-valign="top"

|Returns the names of all variables attributes bound to the session specified by {{Mono|$id}}.

|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|sessions:get|$id as xs:string, $key as xs:string|xs:string?}}<br/pre>{{Func|sessions:get|( $id as xs:string, $key name as xs:string, $default as xsitem()* :string|xs:string}}= ()) as item()*</pre>|-valign="top"

|Returns the value of a variable bound to an attribute with the specified {{Code|$name}} from the session with the specified by {{Mono|$id}}. If the variable does not existattribute is unknown, an empty sequence or the optionally specified default value is returned instead.|-| '''Errors'''|{{ErrorCode|BXSE0002|#Errors$default}} the value of a session variable could not will be retrievedreturned instead.

|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|<pre>sessions:set|( $id as xs:string, $key name as xs:string, $value as item()*) as xs:string|empty-sequence()}}</pre>|-valign="top"

|Assigns a Returns the specified {{Code|value }} to a variable bound to the session attribute with the specified by {{MonoCode|$idname}}.|-| '''Errors'''|from the session with the specified {{ErrorMono|BXSE0001|#Errors$id}} a function item was specified as value of a session variable.

|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|<pre>sessions:delete|( $id as xs:string, $key name as xs:string|) as empty-sequence()}}</pre>|-valign="top"

|Deletes a variable bound to an attribute with the specified {{Code|$name}} from the session with the specified by {{Mono|$id}}.

|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Func|<pre>sessions:close|( $id as xs:string|) as empty-sequence()}}</pre>|-valign="top"

! width="5%110"|Code! width="95%"|Description|-valign="top"|{{Code|BXSE0001}}|A function item was specified as value of a session attribute.|not-|{{Code|BXSE0002}}|An error occurred while retrieving the value of a session attribute.|-|{{Code|BXSE0003}}|A function was called outside the servlet context.|-|{{Code|BXSE0004found}}|The specified session was is not foundavailable.