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 xs:string) as element(user)*
Summary Returns an element sequence, containing all registered users along with their access permissions.
If a database $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() returns <user permission="admin">admin</user> if no additional users have been created.
  • admin:users("factbook") returns all users that have been 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.
Examples
  • admin:sessions() may e.g. return <session user="admin" address="127.0.0.1:6286" database="factbook"/>

admin:logs

Signatures admin:logs() as element(file)*
admin:logs($date as xs:string) as element(entry)*
Summary Returns Logging data compiled by the database or HTTP server.
If no argument is specified, a list of all log files will be returned, including the file size and date.
If a $date is specified, the contents of a single log file will be returned. An empty sequence will be returned if no logging data exists for the specified date.
Examples
  • admin:logs() may return <file date="2013-01-23" size="834367"/> if a single log file exists.
  • for $i in admin:logs() return admin:logs($i/@date) lists the contents of all log files.

Changelog

The Module was introduced with Version 7.5.