Difference between revisions of "Sessions Module"

From BaseX Documentation
Jump to navigation Jump to search
 
(9 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 ''non-deterministic''. As a result, some query optimizations will be suppressed.
+
* As sessions are side-effecting operations, all functions are flagged as ''nondeterministic''. As a result, some query optimizations will be suppressed.
  
 
=Functions=
 
=Functions=
Line 14: Line 14:
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
−
|{{Func|sessions:ids||xs:string*}}
+
|<pre>sessions:ids() as xs:string*</pre>
−
|-
+
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the IDs of all registered sessions.
 
|Returns the IDs of all registered sessions.
Line 25: Line 25:
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
−
|{{Func|sessions:created|$id as xs:string|xs:dateTime}}
+
|<pre>sessions:created(
−
|-
+
  $id as xs:string
 +
) as xs:dateTime</pre>
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the creation time of the session specified by {{Mono|$id}}.
 
|Returns the creation time of the session specified by {{Mono|$id}}.
Line 36: Line 38:
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
−
|{{Func|sessions:accessed|$id as xs:string|xs:dateTime}}
+
|<pre>sessions:accessed(
−
|-
+
  $id as xs:string
 +
) as xs:dateTime</pre>
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the last access time of the session specified by {{Mono|$id}}.
 
|Returns the last access time of the session specified by {{Mono|$id}}.
Line 47: Line 51:
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
−
|{{Func|sessions:names|$id as xs:string|xs:string*}}
+
|<pre>sessions:names(
−
|-
+
  $id as xs:string
 +
) as xs:string*</pre>
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the names of all attributes bound to the session specified by {{Mono|$id}}.
 
|Returns the names of all attributes bound to the session specified by {{Mono|$id}}.
Line 56: Line 62:
  
 
==sessions:get==
 
==sessions:get==
−
 
−
{{Mark|Updated with Version 9.3:}} Values that have no XQuery type will be returned as strings.
 
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
−
|{{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()*}}
+
|<pre>sessions:get(
−
|-
+
  $id       as xs:string,
 +
  $name     as xs:string,
 +
  $default as item()*   := ()
 +
) as item()*</pre>
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|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.
 
|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 71: Line 79:
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
−
|{{Func|sessions:set|$id as xs:string, $name as xs:string, $value as item()*|empty-sequence()}}
+
|<pre>sessions:set(
−
|-
+
  $id     as xs:string,
 +
  $name   as xs:string,
 +
  $value as item()*
 +
) as empty-sequence()</pre>
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Returns the specified {{Code|value}} to the attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}.
 
|Returns the specified {{Code|value}} to the attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}.
−
|-
 
−
| '''Errors'''
 
−
|{{Error|set|#Errors}} The supplied value cannot be materialized.
 
 
|}
 
|}
  
Line 85: Line 94:
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
−
|{{Func|sessions:delete|$id as xs:string, $name as xs:string|empty-sequence()}}
+
|<pre>sessions:delete(
−
|-
+
  $id   as xs:string,
 +
  $name as xs:string
 +
) as empty-sequence()</pre>
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Deletes an attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}.
 
|Deletes an attribute with the specified {{Code|$name}} from the session with the specified {{Mono|$id}}.
Line 96: Line 108:
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
−
|{{Func|sessions:close|$id as xs:string|empty-sequence()}}
+
|<pre>sessions:close(
−
|-
+
  $id as xs:string
 +
) as empty-sequence()</pre>
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Unregisters the session specified by {{Mono|$id}}.
 
|Unregisters the session specified by {{Mono|$id}}.
Line 109: Line 123:
 
! width="110"|Code
 
! width="110"|Code
 
|Description
 
|Description
−
|-
+
|- valign="top"
−
|{{Code|set}}
 
−
|The supplied value cannot be materialized.
 
−
|-
 
 
|{{Code|not-found}}
 
|{{Code|not-found}}
−
|The specified session was not found.
+
|The specified session is not available.
 
|}
 
|}
  
Line 120: Line 131:
  
 
;Version 9.3
 
;Version 9.3
−
 
+
* Updated: {{Function||sessions:get}}: Values that have no XQuery type will be returned as strings.
−
* 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.

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.

Conventions[edit]

  • 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 the sessions 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 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.

Retrieved from "http://docs.basex.org/index.php?title=Sessions_Module&oldid=16678"