Admin Module

From BaseX Documentation
Jump to navigation Jump to search

This XQuery Module contains functions for performing operations that are restricted to users with Admin Permissions. Existing users can be listed, and soon more.

Conventions

All functions in this module are assigned to the http://basex.org/modules/admin namespace, which is statically bound to the admin prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.

Functions

admin:users

Signatures admin:users() as element(user)*
admin:users($db as item()) as element(user)*
Summary Returns an element sequence, containing all registered users along with their access permissions.
If a database node $db is specified, users registered for a particular database will be returned.
The output of this function is similar to the SHOW USERS command.
Examples
  • admin:users("factbook") returns all users that have particularly registered for the specified database.

admin:sessions

Signatures admin:sessions() as element(session)*
Summary Returns an element sequence with all currently opened sessions, including the user name, address (IP:port) and an optionally opened database.
The output of this function is similar to the SHOW SESSIONS command.

Changelog

The Module was introduced with Version 7.4.