Main Page » XQuery » Functions » Session Functions

Session Functions

This module contains functions for accessing and modifying server-side session information. 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 to the http://basex.org/modules/session namespace, which is statically bound to the session prefix.
  • If any of the functions is called outside the servlet context, basex:http is raised.
  • As sessions are side-effecting operations, all functions are flagged as nondeterministic. As a result, some query optimizations will be suppressed.

Functions

session:id

Signature
session:id() as xs:string
SummaryReturns the session ID of a servlet request.
Errors
not-foundNo session is available for the current client.
Examples
import module namespace session = "http://basex.org/modules/session";
'Session ID: ' || session:id()
Running the server-side XQuery file id.xq via http://localhost:8080/id.xq.

session:client-id

Added: New function.

Signature
session:client-id() as xs:string
SummaryReturns the session ID passed by the client. The ID may differ from the server-side ID returned by session:id. The function can for example be used to check if a client-side cookie exists for which a session ID is registered.
Errors
not-foundNo session is available for the current client.

session:created

Signature
session:created() as xs:dateTime
SummaryReturns the creation time of a session.
Errors
not-foundNo session is available for the current client.

session:accessed

Signature
session:accessed() as xs:dateTime
SummaryReturns the last access time of a session.
Errors
not-foundNo session is available for the current client.

session:names

Signature
session:names() as xs:string*
SummaryReturns the names of all attributes bound to the current session.
Examples
import module namespace session = "http://basex.org/modules/session";
session:names() ! element variable { . }
Running the server-side XQuery file names.xq via http://localhost:8080/names.xq.

session:get

Signature
session:get(
  $name     as xs:string,
  $default  as item()*    := ()
) as item()*
SummaryReturns the value of a session attribute with the specified $name. If the attribute is unknown, an empty sequence or the optionally specified $default value will be returned instead.
Examples
import module namespace session = "http://basex.org/modules/session";
'Value of ' || $key || ': ' || session:get($key)
Running the server-side XQuery file get.xq via http://localhost:8080/get.xq?key=user.

session:set

Signature
session:set(
  $name   as xs:string,
  $value  as item()*
) as empty-sequence()
SummaryBinds the specified $value to the session attribute with the specified $name.
Errors
not-foundNo session is available for the current client.
Examples
import module namespace session = "http://basex.org/modules/session";
session:set($key, $value), 'Variable was set.'
Running the server-side XQuery file set.xq via http://localhost:8080/set.xq?key=user&value=john.

session:delete

Signature
session:delete(
  $name  as xs:string
) as empty-sequence()
SummaryDeletes a session attribute with the specified $name.
Examples
import module namespace session = "http://basex.org/modules/session";
session:delete($key), 'Variable was deleted.'
Running the server-side XQuery file delete.xq via http://localhost:8080/delete.xq?key=user.

session:close

Signature
session:close() as empty-sequence()
SummaryUnregisters a session and all data associated with it.

Errors

CodeDescription
not-foundNo session is available for the current client.

Changelog

Version 11.0Version 9.4
  • Updated: Only create session if required.
Version 9.3
  • Updated: session: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.0
  • Updated: Allow sequences as session values.
Version 7.5
  • Added: New module added.

⚡Generated with XQuery