Difference between revisions of "Admin Module"
Jump to navigation
Jump to search
m (table width adjustment) |
|||
Line 9: | Line 9: | ||
==admin:users== | ==admin:users== | ||
+ | |||
+ | {{Mark|Updated with Version 7.8.2:}} password added to output. | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 15: | Line 18: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns an element sequence, containing all registered users along with their access permissions.<br/>If a database {{Code|$db}} is specified, users registered for a particular database will be returned.<br/>The output of this function is similar to the [[Commands#SHOW_USERS|SHOW USERS]] command. | + | |Returns an element sequence, containing all registered users along with their access permissions and md5-encoded passwords.<br/>If a database {{Code|$db}} is specified, users registered for a particular database will be returned.<br/>The output of this function is similar to the [[Commands#SHOW_USERS|SHOW USERS]] command. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 53: | Line 56: | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 7.8.2 | ||
+ | |||
+ | * Updated: [[#admin:users|admin:users]]: password added to output. | ||
The Module was introduced with Version 7.5. | The Module was introduced with Version 7.5. | ||
[[Category:XQuery]] | [[Category:XQuery]] |
Revision as of 21:17, 2 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 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
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 |
|
Changelog
- Version 7.8.2
- Updated: admin:users: password added to output.
The Module was introduced with Version 7.5.