Session Module

From BaseX Documentation

(Difference between revisions)
Jump to: navigation, search
(Errors)
(Conventions)
 
Line 4: Line 4:
* 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).
* 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 to the <code><nowiki>http://basex.org/modules/session</nowiki></code> namespace, which is statically bound to the {{Code|session}} prefix. Prior to {{Version|9.2}}, the module needed to be imported in the query prolog:
+
* All functions and errors are assigned to the <code><nowiki>http://basex.org/modules/session</nowiki></code> namespace, which is statically bound to the {{Code|session}} prefix.
-
<pre class="brush:xquery">
+
-
import module namespace session = "http://basex.org/modules/session";
+
-
...
+
-
</pre>
+
* If any of the functions is called outside the servlet context, <code>[[XQuery Errors#BaseX Errors|basex:http]]</code> is raised.
* If any of the functions is called outside the servlet context, <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, some query optimizations will be suppressed.
* As sessions are side-effecting operations, all functions are flagged as ''non-deterministic''. As a result, some query optimizations will be suppressed.

Latest revision as of 04:53, 29 November 2019

This XQuery Module contains functions for accessing and modifying server-side session information. This module is mainly useful in the context of Web Applications.

Contents

[edit] Conventions

[edit] Functions

[edit] session:id

Signatures session:id() as xs:string
Summary Returns the session ID of a servlet request.
Examples Running the server-side XQuery file id.xq via http://localhost:8984/id.xq:
import module namespace session = "http://basex.org/modules/session";
'Session ID: ' || session:id()

[edit] session:created

Signatures session:created() as xs:dateTime
Summary Returns the creation time of a session.

[edit] session:accessed

Signatures session:accessed() as xs:dateTime
Summary Returns the last access time of a session.

[edit] session:names

Signatures session:names() as xs:string*
Summary Returns the names of all attributes bound to the current session.
Examples Running the server-side XQuery file names.xq via http://localhost:8984/names.xq:
import module namespace session = "http://basex.org/modules/session";
session:names() ! element variable { . }

[edit] session:get

Updated with Version 9.3: Values that have no XQuery type will be returned as strings.

Signatures session:get($name as xs:string) as item()*
session:get($name as xs:string, $default as item()*) as item()*
Summary Returns the value of a session attribute with the specified $name. If the attribute is unknown, an empty sequence or the optionally specified $default value will be returned instead.
Examples Running the server-side XQuery file get.xq via http://localhost:8984/get.xq?key=user:
import module namespace session = "http://basex.org/modules/session";
'Value of ' || $key || ': ' || session:get($key)

[edit] session:set

Signatures session:set($name as xs:string, $value as item()*) as empty-sequence()
Summary Binds the specified $value to the session attribute with the specified $name.
Errors set: The supplied value cannot be materialized.
Examples Running the server-side XQuery file set.xq via http://localhost:8984/set.xq?key=user&value=john:
import module namespace session = "http://basex.org/modules/session";
session:set($key, $value), 'Variable was set.'

[edit] session:delete

Signatures session:delete($name as xs:string) as empty-sequence()
Summary Deletes a session attribute with the specified $name.
Examples Running the server-side XQuery file delete.xq via http://localhost:8984/delete.xq?key=user:
import module namespace session = "http://basex.org/modules/session";
session:delete($key), 'Variable was deleted.'

[edit] session:close

Signatures session:close() as empty-sequence()
Summary Unregisters a session and all data associated with it.

[edit] Errors

Code Description
set The supplied value cannot be materialized.

[edit] Changelog

Version 9.3
Version 9.0
Version 8.0

This module was introduced with Version 7.5.

Personal tools
Namespaces
Variants
Actions
Navigation
Print/export