Difference between revisions of "Admin Module"
Jump to navigation
Jump to search
Line 53: | Line 53: | ||
| '''Summary''' | | '''Summary''' | ||
|Writes a string to the database logs, along with current user data (timestamp, user name). An optional log {{Code|$type}} can be specified, which must consist of letters in upper case. If omitted, the log type is {{Code|INFO}}.<br/>If the function is called from a database client, the IP will be logged. Otherwise, the string {{Code|SERVER}} will be logged. | |Writes a string to the database logs, along with current user data (timestamp, user name). An optional log {{Code|$type}} can be specified, which must consist of letters in upper case. If omitted, the log type is {{Code|INFO}}.<br/>If the function is called from a database client, the IP will be logged. Otherwise, the string {{Code|SERVER}} will be logged. | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|BXAD0003|#Errors}} Log type must contain of letters in upper case. | ||
|} | |} | ||
Line 80: | Line 83: | ||
|{{Code|BXAD0002}} | |{{Code|BXAD0002}} | ||
|An error occurred while deleting a log file. | |An error occurred while deleting a log file. | ||
+ | |- | ||
+ | |{{Code|BXAD0003}} | ||
+ | |Log type must contain of letters in upper case. | ||
|} | |} | ||
Revision as of 14:10, 3 July 2015
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: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 and the SHOW SESSIONS command is similar. |
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:write-log
Template:Mark: optional log type added
Signatures | admin:write-log($text as xs:string) as empty-sequence() admin:write-log($text as xs:string, $type as xs:string) as empty-sequence()
|
Summary | Writes a string to the database logs, along with current user data (timestamp, user name). An optional log $type can be specified, which must consist of letters in upper case. If omitted, the log type is INFO .If the function is called from a database client, the IP will be logged. Otherwise, the string SERVER will be logged.
|
Errors | BXAD0003 : Log type must contain of letters in upper case.
|
admin:delete-logs
Signatures | admin:delete-logs($date as xs:string) as empty-sequence()
|
Summary | Deletes the log entries from the specified $date
|
Errors | BXAD0001 : Today's log file cannot be deleted.BXAD0002 : An error occurred while deleting a log file.
|
Errors
Code | Description |
---|---|
BXAD0001
|
Today's log file cannot be deleted. |
BXAD0002
|
An error occurred while deleting a log file. |
BXAD0003
|
Log type must contain of letters in upper case. |
Changelog
- Version 8.3
- Updated: admin:write-log: optional log type added
- Version 8.2
- Added: admin:delete-logs
- Version 8.0
- Added: admin:write-log
- Deleted: admin:users (renamed to user:list-details)
- 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.