Difference between revisions of "Admin Module"
Jump to navigation
Jump to search
Line 50: | Line 50: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns [[Logging]] data compiled by the database or HTTP server | + | |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 {{Code|$date}} is specified, the contents of a single log file will be returned. | ||
+ | * If {{Code|$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. | ||
|- | |- | ||
| '''Examples''' | | '''Examples''' |
Revision as of 23:30, 5 March 2014
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
Template:Mark md5-encoded password added to output.
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 and md5-encoded passwords. 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: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:logs
Template:Mark represent name of log files as string value; $merge
argument added.
Signatures | 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)* |
Summary | Returns Logging data compiled by the database or HTTP server:
|
Examples |
|
Changelog
- 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.