Difference between revisions of "Sessions Module"
Jump to navigation
Jump to search
| (2 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
* 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. | ||
* If a specified session id is not found, <code>[[#Errors|not-found]]</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 are flagged as '' | + | * As sessions are side-effecting operations, all functions are flagged as ''nondeterministic''. As a result, some query optimizations will be suppressed. |
=Functions= | =Functions= | ||
| Line 15: | Line 15: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>sessions:ids() as xs:string*</pre> | |<pre>sessions:ids() as xs:string*</pre> | ||
|- valign="top" | |- valign="top" | ||
| Line 26: | Line 26: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>sessions:created( | |<pre>sessions:created( | ||
$id as xs:string | $id as xs:string | ||
| Line 39: | Line 39: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>sessions:accessed( | |<pre>sessions:accessed( | ||
$id as xs:string | $id as xs:string | ||
| Line 52: | Line 52: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>sessions:names( | |<pre>sessions:names( | ||
$id as xs:string | $id as xs:string | ||
| Line 65: | Line 65: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>sessions:get( | |<pre>sessions:get( | ||
| − | $id as xs:string | + | $id as xs:string, |
| − | $name as xs:string | + | $name as xs:string, |
$default as item()* := () | $default as item()* := () | ||
) as item()*</pre> | ) as item()*</pre> | ||
| Line 80: | Line 80: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>sessions:set( | |<pre>sessions:set( | ||
| − | $id as xs:string | + | $id as xs:string, |
| − | $name as xs:string | + | $name as xs:string, |
$value as item()* | $value as item()* | ||
) as empty-sequence()</pre> | ) as empty-sequence()</pre> | ||
| Line 95: | Line 95: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>sessions:delete( | |<pre>sessions:delete( | ||
| − | $id as xs:string | + | $id as xs:string, |
$name as xs:string | $name as xs:string | ||
) as empty-sequence()</pre> | ) as empty-sequence()</pre> | ||
| Line 109: | Line 109: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>sessions:close( | |<pre>sessions:close( | ||
$id as xs:string | $id as xs:string | ||
Latest revision as of 14:52, 31 October 2023
This XQuery Module can only be called from users with Admin permissions. It contains functions for accessing and modifying all registered server-side sessions. This module is mainly useful in the context of Web Applications.
Contents
Conventions[edit]
- The module will be available if the
basex-apilibrary 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
http://basex.org/modules/sessionsnamespace, which is statically bound to thesessionsprefix. - If any of the functions is called outside the servlet context,
basex:httpis raised. - If a specified session id is not found,
not-foundis raised. - As sessions are side-effecting operations, all functions are flagged as nondeterministic. As a result, some query optimizations will be suppressed.
Functions[edit]
sessions:ids[edit]
| Signature | sessions:ids() as xs:string* |
| Summary | Returns the IDs of all registered sessions. |
sessions:created[edit]
| Signature | sessions:created( $id as xs:string ) as xs:dateTime |
| Summary | Returns the creation time of the session specified by $id.
|
sessions:accessed[edit]
| Signature | sessions:accessed( $id as xs:string ) as xs:dateTime |
| Summary | Returns the last access time of the session specified by $id.
|
sessions:names[edit]
| Signature | sessions:names( $id as xs:string ) as xs:string* |
| Summary | Returns the names of all attributes bound to the session specified by $id.
|
sessions:get[edit]
| Signature | sessions:get( $id as xs:string, $name as xs:string, $default as item()* := () ) as item()* |
| Summary | Returns the value of an attribute with the specified $name from the session with the specified $id. If the attribute is unknown, an empty sequence or the optionally specified $default value will be returned instead.
|
sessions:set[edit]
| Signature | sessions:set( $id as xs:string, $name as xs:string, $value as item()* ) as empty-sequence() |
| Summary | Returns the specified value to the attribute with the specified $name from the session with the specified $id.
|
sessions:delete[edit]
| Signature | sessions:delete( $id as xs:string, $name as xs:string ) as empty-sequence() |
| Summary | Deletes an attribute with the specified $name from the session with the specified $id.
|
sessions:close[edit]
| Signature | sessions:close( $id as xs:string ) as empty-sequence() |
| Summary | Unregisters the session specified by $id.
|
Errors[edit]
| Code | Description |
|---|---|
not-found
|
The specified session is not available. |
Changelog[edit]
- Version 9.3
- Updated:
sessions: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.4
- Updated: Allow sequences as session values.
This module was introduced with Version 7.5.
