Difference between revisions of "Admin Module"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
− | This [[Module Library|XQuery Module]] contains functions for performing operations | + | This [[Module Library|XQuery Module]] contains functions for performing admin-centric operations such as managing database users and log data. |
=Conventions= | =Conventions= | ||
Line 56: | Line 56: | ||
* {{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 $log in admin:logs() return admin:logs($log)}} lists the contents of all log files. | * {{Code|for $log in admin:logs() return admin:logs($log)}} lists the contents of all log files. | ||
+ | |} | ||
+ | |||
+ | ==admin:logs== | ||
+ | |||
+ | {{Mark|Introduced with Version 8.0}}: | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|admin:write-log|$text as xs:string|empty-sequence()}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Writes a string to the database logs. | ||
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 8.0 | ||
+ | |||
+ | * Added: [[#admin:write-log|admin:write-log]] | ||
;Version 7.8.2 | ;Version 7.8.2 |
Revision as of 23:50, 27 November 2014
This XQuery Module contains functions for performing admin-centric operations such as managing database users and log data.
Contents
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 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)* 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 |
|
admin:logs
Signatures | admin:write-log($text as xs:string) as empty-sequence()
|
Summary | Writes a string to the database logs. |
Changelog
- Version 8.0
- Added: admin:write-log
- 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.