Difference between revisions of "Admin Module"
Jump to navigation
Jump to search
Line 15: | Line 15: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns an | + | |Returns an element sequence, containing all registered users along with their access permissions.<br/>If a [[Database Module#Database Nodes|database node]] {{Code|$db}} is specified, users registered for a particular database will be returned. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
* {{Code|admin:users("factbook")}} returns all users that have particularly registered for the specified database. | * {{Code|admin:users("factbook")}} returns all users that have particularly registered for the specified database. | ||
+ | |} | ||
+ | |||
+ | ==admin:sessions== | ||
+ | {| | ||
+ | |- | ||
+ | | width='90' | '''Signatures''' | ||
+ | |{{Func|admin:sessions||element(session)*}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns an element sequence with all currently opened sessions, including the user name and address (IP:port). | ||
|} | |} | ||
Revision as of 18:46, 23 August 2012
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 item()) as element(user)* |
Summary | Returns an element sequence, containing all registered users along with their access permissions. If a database node $db is specified, users registered for a particular database will be returned.
|
Examples |
|
admin:sessions
Signatures | admin:sessions() as element(session)*
|
Summary | Returns an element sequence with all currently opened sessions, including the user name and address (IP:port). |
Changelog
The Module was introduced with Version 7.4.