Difference between revisions of "Admin Module"
Jump to navigation
Jump to search
Line 42: | Line 42: | ||
==admin:logs== | ==admin:logs== | ||
− | {{Mark|Updated with Version 7.8.2:}} represent name of log files as string value. | + | {{Mark|Updated with Version 7.8.2:}} represent name of log files as string value; {{Code|$merge}} argument added. |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|admin:logs||element(file)*}}<br/>{{Func|admin:logs|$date as xs:string|element(entry)*}}<br/> | + | |{{Func|admin:logs||element(file)*}}<br/>{{Func|admin:logs|$date as xs:string|element(entry)*}}<br/>{{Func|admin:logs|$date as xs:string, $merge as xs:boolean|element(entry)*}}<br/> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns [[Logging]] data compiled by the database or HTTP server.<br/>If no argument is specified, a list of all log files will be returned, including the file size and date.<br/>If a {{Code|$date}} is specified, the contents of a single log file will be returned. | + | |Returns [[Logging]] data compiled by the database or HTTP server.<br/>If no argument is specified, a list of all log files will be returned, including the file size and date.<br/>If a {{Code|$date}} is specified, the contents of a single log file will be returned.<br/>If {{Code|$merge}} is set to true, related log entries will be merged. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
* {{Code|admin:logs()}} may return <code><file size="834367"/>2013-01-23</code> if a single log file exists. | * {{Code|admin:logs()}} may return <code><file size="834367"/>2013-01-23</code> if a single log file exists. | ||
− | * {{Code|for $ | + | * {{Code|for $log in admin:logs() return admin:logs($log)}} lists the contents of all log files. |
|} | |} | ||
Line 63: | Line 63: | ||
* Updated: [[#admin:users|admin:users]]: md5-encoded password added to output. | * Updated: [[#admin:users|admin:users]]: md5-encoded password added to output. | ||
− | * Updated: [[#admin:logs|admin:logs]]: represent name of log files as string value. | + | * Updated: [[#admin:logs|admin:logs]]: represent name of log files as string value; {{Code|$merge}} argument added. |
The Module was introduced with Version 7.5. | The Module was introduced with Version 7.5. | ||
[[Category:XQuery]] | [[Category:XQuery]] |
Revision as of 23:12, 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. 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.If $merge is set to true, related log entries will be merged.
|
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.