From BaseX Documentation
This XQuery Module contains functions for performing admin-centric operations such as managing database users and log data.
All functions in this module are assigned to the
http://basex.org/modules/admin namespace, which is statically bound to the
All errors are assigned to the
http://basex.org/errors namespace, which is statically bound to the
admin:sessions() as element(session)*
||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 and the
SHOW SESSIONS command is similar.
admin:sessions() may e.g. return
<session user="admin" address="127.0.0.1:6286" database="factbook"/>
admin:logs() as element(file)*
admin:logs($date as xs:string) as element(entry)*
admin:logs($date as xs:string, $merge as xs:boolean) as element(entry)*
||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.
$merge is set to true, related log entries will be merged. Please note that the merge might not be 100% successful, as log entries may be ambiguous.
admin:logs() may return
<file size="834367"/>2015-01-23</file> if a single log file exists.
admin:logs() ! admin:logs(.) lists the contents of all log files.
admin:write-log($text as xs:string) as empty-sequence()
admin:write-log($text as xs:string, $type as xs:string) as empty-sequence()
||Writes a string to the database logs, along with current user data (timestamp, user name). An optional log |
$type can be specified, which must consist of letters in upper case. If omitted, the log type is
If the function is called from a database client, the IP will be logged. Otherwise, the string
SERVER will be logged.
BXAD0003: Log type must consist of uppercase letters.
admin:delete-logs($date as xs:string) as empty-sequence()
||Deletes the log entries from the specified |
BXAD0001: Today's log file cannot be deleted.
BXAD0002: An error occurred while deleting a log file.
|Today's log file cannot be deleted.
|An error occurred while deleting a log file.
|Log type must consist of uppercase letters.
- Version 8.3
- Version 8.2
- Version 8.0
- Version 7.8.2
- Updated: admin:users: md5-encoded password added to output.
- Updated: admin:logs: represent name of log files as string value;
$merge argument added.
The Module was introduced with Version 7.5.