Sessions Module

From BaseX Documentation

Jump to: navigation, search

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

[edit] Conventions

import module namespace sessions = "http://basex.org/modules/sessions";
...

[edit] Functions

[edit] sessions:ids

Signatures sessions:ids() as xs:string*
Summary Returns the IDs of all registered sessions.

[edit] sessions:created

Signatures sessions:created($id as xs:string) as xs:dateTime
Summary Returns the creation time of the session specified by $id.

[edit] sessions:accessed

Signatures sessions:accessed($id as xs:string) as xs:dateTime
Summary Returns the last access time of the session specified by $id.

[edit] sessions:names

Signatures sessions:names($id as xs:string) as xs:string*
Summary Returns the names of all variables bound to the session specified by $id.

[edit] 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.
Errors get: the value of an attribute could not be retrieved.

[edit] 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.

[edit] 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.

[edit] sessions:close

Signatures sessions:close($id as xs:string) as empty-sequence()
Summary Unregisters the session specified by $id.

[edit] Errors

Code Description
get The stored attribute is no XQuery value.
set The supplied value cannot be materialized.
not-found The specified session was not found.

[edit] Changelog

Version 9.0
Version 8.4

This module was introduced with Version 7.5.

Personal tools
Namespaces
Variants
Actions
Navigation
Print/export