Difference between revisions of "Admin Module"
Jump to navigation
Jump to search
Line 54: | Line 54: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|type|#Errors}} Log type must consist of uppercase letters. |
|} | |} | ||
Line 68: | Line 68: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|today|#Errors}} Today's log file cannot be deleted.<br/>{{Error|delete|#Errors}} An error occurred while deleting a log file. |
|} | |} | ||
=Errors= | =Errors= | ||
+ | |||
+ | {{Mark|Updated with Version 9.0}}: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
Line 77: | Line 79: | ||
|Description | |Description | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|today}} |
|Today's log file cannot be deleted. | |Today's log file cannot be deleted. | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|delete}} |
|An error occurred while deleting a log file. | |An error occurred while deleting a log file. | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|type}} |
|Log type must consist of uppercase letters. | |Log type must consist of uppercase letters. | ||
|} | |} | ||
Line 91: | Line 93: | ||
;Version 9.0 | ;Version 9.0 | ||
− | * Updated: errors now use the module namespace | + | * Updated: error codes updates; errors now use the module namespace |
;Version 8.3 | ;Version 8.3 |
Revision as of 18:50, 20 November 2017
This XQuery Module contains functions for performing admin-centric operations such as managing database users and log data.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/admin
namespace, which is statically bound to the admin
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
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 | type : Log type must consist of uppercase letters.
|
admin:delete-logs
Signatures | admin:delete-logs($date as xs:string) as empty-sequence()
|
Summary | Deletes the log entries from the specified $date
|
Errors | today : Today's log file cannot be deleted.delete : An error occurred while deleting a log file.
|
Errors
Code | Description |
---|---|
today
|
Today's log file cannot be deleted. |
delete
|
An error occurred while deleting a log file. |
type
|
Log type must consist of uppercase letters. |
Changelog
- Version 9.0
- Updated: error codes updates; errors now use the module namespace
- 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.