Difference between revisions of "Sessions Module"
Jump to navigation
Jump to search
(21 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
=Conventions= | =Conventions= | ||
− | + | * 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 of the <code><nowiki>http://basex.org/modules/sessions</nowiki></code> namespace, which is statically bound to the {{Code|sessions}} prefix. | |
− | * The {{Code|basex-api}} | + | * If any of the functions is called outside the servlet context, <code>[[XQuery Errors#BaseX Errors|basex:http]]</code> is raised. |
− | * All functions and errors are assigned | + | * 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 ''non-deterministic''. As a result, some query optimizations will be suppressed. | |
− | |||
− | |||
− | |||
− | * If any of the functions is called outside the servlet context, | ||
− | * If | ||
− | * As sessions are side-effecting operations, all functions are flagged as ''non-deterministic''. | ||
=Functions= | =Functions= | ||
Line 22: | Line 16: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|sessions:ids||xs:string}} | + | |{{Func|sessions:ids||xs:string*}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
Line 58: | Line 52: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns the names of all | + | |Returns the names of all attributes bound to the session specified by {{Mono|$id}}. |
|} | |} | ||
Line 66: | Line 60: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|sessions:get|$id as xs:string, $ | + | |{{Func|sessions:get|$id as xs:string, $name as xs:string|item()*}}<br/>{{Func|sessions:get|$id as xs:string, $name as xs:string, $default as item()*|item()*}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns the value of | + | |Returns the value of an attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}. If the attribute is unknown, an empty sequence or the optionally specified {{Code|$default}} value will be returned instead. |
− | |||
− | |||
− | |||
|} | |} | ||
Line 80: | Line 71: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|sessions:set|$id as xs:string, $ | + | |{{Func|sessions:set|$id as xs:string, $name as xs:string, $value as item()*|empty-sequence()}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Returns the specified {{Code|value}} to the attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error|set|#Errors}} | + | |{{Error|set|#Errors}} The supplied value cannot be materialized. |
|} | |} | ||
Line 94: | Line 85: | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|sessions:delete|$id as xs:string, $ | + | |{{Func|sessions:delete|$id as xs:string, $name as xs:string|empty-sequence()}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Deletes | + | |Deletes an attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}. |
|} | |} | ||
Line 112: | Line 103: | ||
=Errors= | =Errors= | ||
− | |||
− | |||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
Line 120: | Line 109: | ||
|- | |- | ||
|{{Code|set}} | |{{Code|set}} | ||
− | | | + | |The supplied value cannot be stored. |
− | |||
− | |||
− | |||
|- | |- | ||
|{{Code|not-found}} | |{{Code|not-found}} | ||
− | |The specified session | + | |The specified session is not available. |
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 9.3 | ||
+ | * Updated: [[#sessions:get|sessions:get]]: Values that have no XQuery type will be returned as strings. | ||
;Version 9.0 | ;Version 9.0 | ||
− | |||
* Updated: error codes updated; errors now use the module namespace | * Updated: error codes updated; errors now use the module namespace | ||
;Version 8.4 | ;Version 8.4 | ||
− | |||
* Updated: Allow sequences as session values. | * Updated: Allow sequences as session values. | ||
This module was introduced with Version 7.5. | This module was introduced with Version 7.5. |
Revision as of 12:49, 8 July 2020
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
- 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 of the
http://basex.org/modules/sessions
namespace, which is statically bound to thesessions
prefix. - If any of the functions is called outside the servlet context,
basex:http
is raised. - If a specified session id is not found,
not-found
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
sessions:ids
Signatures | sessions:ids() as xs:string*
|
Summary | Returns the IDs of all registered sessions. |
sessions:created
Signatures | sessions:created($id as xs:string) as xs:dateTime
|
Summary | Returns the creation time of the session specified by $id .
|
sessions:accessed
Signatures | sessions:accessed($id as xs:string) as xs:dateTime
|
Summary | Returns the last access time of the session specified by $id .
|
sessions:names
Signatures | 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
Signatures | sessions:get($id as xs:string, $name as xs:string) as item()* 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
Signatures | 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 .
|
Errors | set : The supplied value cannot be materialized.
|
sessions:delete
Signatures | 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
Signatures | sessions:close($id as xs:string) as empty-sequence()
|
Summary | Unregisters the session specified by $id .
|
Errors
Code | Description |
---|---|
set
|
The supplied value cannot be stored. |
not-found
|
The specified session is not available. |
Changelog
- 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.