Difference between revisions of "Session Module"
m (Text replacement - "'''Signatures'''" to "'''Signature'''") |
|||
Line 83: | Line 83: | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|<pre>session:get( | |<pre>session:get( | ||
− | $name as xs:string | + | $name as xs:string, |
$default as item()* := () | $default as item()* := () | ||
) as item()*</pre> | ) as item()*</pre> | ||
Line 104: | Line 104: | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|<pre>session:set( | |<pre>session:set( | ||
− | $name as xs:string | + | $name as xs:string, |
$value as item()* | $value as item()* | ||
) as empty-sequence()</pre> | ) as empty-sequence()</pre> |
Revision as of 16:24, 9 March 2023
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
Conventions
- The module will be available if the
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
http://basex.org/modules/session
namespace, which is statically bound to thesession
prefix. - If any of the functions is called outside the servlet context,
basex:http
is raised. - As sessions are side-effecting operations, all functions are flagged as non-deterministic. As a result, some query optimizations will be suppressed.
Functions
session:id
Signature | session:id() as xs:string |
Summary | Returns the session ID of a servlet request. |
Errors | not-found : No session is available for the current client.
|
Examples | Running the server-side XQuery file id.xq via http://localhost:8080/id.xq :
<syntaxhighlight lang="xquery"> import module namespace session = "http://basex.org/modules/session"; 'Session ID: ' || session:id() </syntaxhighlight> |
session:created
Signature | session:created() as xs:dateTime |
Summary | Returns the creation time of a session. |
Errors | not-found : No session is available for the current client.
|
session:accessed
Signature | session:accessed() as xs:dateTime |
Summary | Returns the last access time of a session. |
Errors | not-found : No session is available for the current client.
|
session:names
Signature | 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:8080/names.xq :
<syntaxhighlight lang="xquery"> import module namespace session = "http://basex.org/modules/session"; session:names() ! element variable { . } </syntaxhighlight> |
session:get
Signature | 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:8080/get.xq?key=user :
<syntaxhighlight lang="xquery"> import module namespace session = "http://basex.org/modules/session"; 'Value of ' || $key || ': ' || session:get($key) </syntaxhighlight> |
session:set
Signature | 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 | not-found : No session is available for the current client.
|
Examples | Running the server-side XQuery file set.xq via http://localhost:8080/set.xq?key=user&value=john :
<syntaxhighlight lang="xquery"> import module namespace session = "http://basex.org/modules/session"; session:set($key, $value), 'Variable was set.' </syntaxhighlight> |
session:delete
Signature | 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:8080/delete.xq?key=user :
<syntaxhighlight lang="xquery"> import module namespace session = "http://basex.org/modules/session"; session:delete($key), 'Variable was deleted.' </syntaxhighlight> |
session:close
Signature | session:close() as empty-sequence() |
Summary | Unregisters a session and all data associated with it. |
Errors
Code | Description |
---|---|
not-found
|
No session is available for the current client. |
Changelog
- Version 9.4
- Updated: Only create session if required.
- Version 9.3
- Updated:
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.