Difference between revisions of "Sessions Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 16: Line 16:
 
|- valign="top"
 
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
−
|{{Func|sessions:ids||xs:string*}}
+
|<pre>sessions:ids() as xs:string*</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 27: Line 27:
 
|- valign="top"
 
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
−
|{{Func|sessions:created|$id as xs:string|xs:dateTime}}
+
|<pre>sessions:created(
 +
  $id as xs:string
 +
) as xs:dateTime</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 38: Line 40:
 
|- valign="top"
 
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
−
|{{Func|sessions:accessed|$id as xs:string|xs:dateTime}}
+
|<pre>sessions:accessed(
 +
  $id as xs:string
 +
) as xs:dateTime</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 49: Line 53:
 
|- valign="top"
 
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
−
|{{Func|sessions:names|$id as xs:string|xs:string*}}
+
|<pre>sessions:names(
 +
  $id as xs:string
 +
) as xs:string*</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 60: Line 66:
 
|- valign="top"
 
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
−
|{{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"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 71: Line 81:
 
|- valign="top"
 
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
−
|{{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"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 82: Line 96:
 
|- valign="top"
 
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
−
|{{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"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 93: Line 110:
 
|- valign="top"
 
|- valign="top"
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
−
|{{Func|sessions:close|$id as xs:string|empty-sequence()}}
+
|<pre>sessions:close(
 +
  $id as xs:string
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''

Revision as of 13:02, 9 March 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

  • 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 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
  $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.

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
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.

Retrieved from "https://old.docs.basex.org/index.php?title=Sessions_Module&oldid=16338"