Changes

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

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

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

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

|-valign="top"| width='120' | '''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='120' | '''SignaturesSignature'''|{{Func|sessions:get|$id as xs:string, $key as xs:string|item()*}}<br/pre>{{Func|sessions:get|( $id as xs:string, $key name as xs:string, $default as item()*| := ()) 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 exist, or if the key attribute 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='120' | '''SignaturesSignature'''|{{Func|<pre>sessions:set|( $id as xs:string, $key name as xs:string, $value as item()*|) as empty-sequence()}}</pre>|-valign="top"

|Binds Returns the specified key/{{Code|value pair }} 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='120' | '''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='120' | '''SignaturesSignature'''|{{Func|<pre>sessions:close|( $id as xs:string|) as empty-sequence()}}</pre>|-valign="top"

|-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.