Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
{{Mark|Updated with Version 9.0}}: * 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 the <code><nowiki>http://basex.org/modules/session</nowiki></code> namespace. The module must be imported in , which is statically bound to the query prolog:<pre class="brush:xquery">import module namespace {{Code|session = "http://basex.org/modules/session";..}} prefix.</pre>* If any of the functions is called outside the servlet context, the error {{Error|basex:http|<code>[[XQuery Errors#BaseX Errors}} |basex:http]]</code> is raised.* As sessions are side-effecting operations, all functions are flagged as ''non-deterministic''. As a result, the functions some query optimizations will not be reordered by the compilersuppressed.
{{Mark|Updated with Version 9.0}}:
no edit summary
=Conventions=
=Functions=
| '''Summary'''
|Returns the session ID of a servlet request.
|-
| '''Errors'''
|{{Error|not-found|#Errors}} No session is available for the current client.
|-
| '''Examples'''
|Running the server-side XQuery file {{Code|id.xq}} via <code><nowiki>http://localhost:8984/id.xq</nowiki></code>:
<pre classsyntaxhighlight lang="brush:xquery">
import module namespace session = "http://basex.org/modules/session";
'Session ID: ' || session:id()
</presyntaxhighlight>
|}
| '''Summary'''
|Returns the creation time of a session.
|-
| '''Errors'''
|{{Error|not-found|#Errors}} No session is available for the current client.
|}
| '''Summary'''
|Returns the last access time of a session.
|-
| '''Errors'''
|{{Error|not-found|#Errors}} No session is available for the current client.
|}
|-
| '''Summary'''
|Returns the names of all variables attributes bound to the current session.
|-
| '''Examples'''
|Running the server-side XQuery file {{Code|names.xq}} via <code><nowiki>http://localhost:8984/names.xq</nowiki></code>:
<pre classsyntaxhighlight lang="brush:xquery">
import module namespace session = "http://basex.org/modules/session";
session:names() ! element variable { . }
</presyntaxhighlight>
|}
|-
| '''Summary'''
|Returns the value of a session attribute with the specified <code>$name</code> bound to the current session. If the specified variable attribute is unknown, an empty sequence or the optionally specified default value is returned instead.|-| '''Errors'''|{{ErrorCode|get|#Errors$default}} the value of a session variable could not will be retrievedreturned instead.
|-
| '''Examples'''
|Running the server-side XQuery file {{Code|get.xq}} via <code><nowiki>http://localhost:8984/get.xq?key=user</nowiki></code>:
<pre classsyntaxhighlight lang="brush:xquery">
import module namespace session = "http://basex.org/modules/session";
'Value of ' || $key || ': ' || session:get($key)
</presyntaxhighlight>
|}
|-
| '''Summary'''
|Binds the specified name/{{Code|$value pair }} to a the sessionattribute with the specified {{Code|$name}}.
|-
| '''Errors'''
|{{Error|set|#Errors}} a function item was specified as The supplied value of a cannot be materialized.<br/>{{Error|not-found|#Errors}} No session variableis available for the current client.
|-
| '''Examples'''
|Running the server-side XQuery file {{Code|set.xq}} via <code><nowiki>http://localhost:8984/set.xq?key=user&value=john</nowiki></code>:
<pre classsyntaxhighlight lang="brush:xquery">
import module namespace session = "http://basex.org/modules/session";
session:set($key, $value), 'Variable was set.'
</presyntaxhighlight>
|}
|-
| '''Summary'''
|Deletes a session value bound to attribute with the specified <code>$name</code>.
|-
| '''Examples'''
|Running the server-side XQuery file {{Code|delete.xq}} via <code><nowiki>http://localhost:8984/delete.xq?key=user</nowiki></code>:
<pre classsyntaxhighlight lang="brush:xquery">
import module namespace session = "http://basex.org/modules/session";
session:delete($key), 'Variable was deleted.'
</presyntaxhighlight>
|}
=Errors=
{| class="wikitable" width="100%"
! width="110" |Code
|Description
|-
|{{Code|set}}
|Function items The supplied value cannot be stored.
|-
|{{Code|getnot-found}}|The stored attribute No session is no XQuery valueavailable for the current client.
|}
=Changelog=
;Version 9.4
* Updated: Only create session if required.
;Version 9.3
* Updated: [[#session:get|session:get]]: Values that have no XQuery type will be returned as strings.
;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.
