Difference between revisions of "Admin Module"
Jump to navigation
Jump to search
(10 intermediate revisions by the same user not shown) | |||
Line 5: | Line 5: | ||
All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/admin</nowiki></code> namespace, which is statically bound to the {{Code|admin}} prefix.<br/> | All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/admin</nowiki></code> namespace, which is statically bound to the {{Code|admin}} prefix.<br/> | ||
− | = | + | =Database Logs= |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
==admin:logs== | ==admin:logs== | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|admin:logs||element(file)*}}<br/>{{Func|admin:logs|$date as xs:string|element(entry)*}}<br/>{{Func|admin:logs|$date as xs:string, $merge as xs:boolean|element(entry)*}}<br/> | |{{Func|admin:logs||element(file)*}}<br/>{{Func|admin:logs|$date as xs:string|element(entry)*}}<br/>{{Func|admin:logs|$date as xs:string, $merge as xs:boolean|element(entry)*}}<br/> | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Returns [[Logging]] data compiled by the database or HTTP server: | |Returns [[Logging]] data compiled by the database or HTTP server: | ||
Line 34: | Line 19: | ||
* If a {{Code|$date}} is specified, the contents of a single log file will be returned. | * If a {{Code|$date}} is specified, the contents of a single log file will be returned. | ||
* If {{Code|$merge}} is set to true, related log entries will be merged. Please note that the merge might not be 100% successful, as log entries may be ambiguous. | * If {{Code|$merge}} is set to true, related log entries will be merged. Please note that the merge might not be 100% successful, as log entries may be ambiguous. | ||
− | |- | + | |- valign="top" |
| '''Examples''' | | '''Examples''' | ||
| | | | ||
Line 42: | Line 27: | ||
==admin:write-log== | ==admin:write-log== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|admin:write-log|$text as xs:string|empty-sequence()}}<br/>{{Func|admin:write-log|$text as xs:string, $type as xs:string|empty-sequence()}} | |{{Func|admin:write-log|$text as xs:string|empty-sequence()}}<br/>{{Func|admin:write-log|$text as xs:string, $type as xs:string|empty-sequence()}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
− | |Writes a string to the database logs, along with current user data (timestamp, | + | |Writes a string to the database logs, along with current user data (timestamp, username). An optional log {{Code|$type}} can be specified. 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. |
− | |- | + | |- valign="top" |
| '''Errors''' | | '''Errors''' | ||
− | |{{Error|type|#Errors}} | + | |{{Error|type|#Errors}} Type string contains whitespaces. |
|} | |} | ||
Line 60: | Line 43: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|admin:delete-logs|$date as xs:string|empty-sequence()}} | |{{Func|admin:delete-logs|$date as xs:string|empty-sequence()}} | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Deletes the log entries from the specified <code>$date</code> | |Deletes the log entries from the specified <code>$date</code> | ||
− | |- | + | |- valign="top" |
| '''Errors''' | | '''Errors''' | ||
|{{Error|today|#Errors}} Today's log file cannot be deleted.<br/>{{Error|delete|#Errors}} An error occurred while deleting a log file. | |{{Error|today|#Errors}} Today's log file cannot be deleted.<br/>{{Error|delete|#Errors}} An error occurred while deleting a log file. | ||
+ | |} | ||
+ | |||
+ | =Database Sessions= | ||
+ | |||
+ | ==admin:sessions== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- valign="top" | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|admin:sessions||element(session)*}} | ||
+ | |- valign="top" | ||
+ | | '''Summary''' | ||
+ | |Returns an element sequence with all currently opened database sessions, including the username, address (IP:port) and an optionally opened database.<br/>The output of this function and the {{Command|SHOW SESSIONS}} command is similar. | ||
+ | |- valign="top" | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * {{Code|admin:sessions()}} may e.g. return <code><session user="admin" address="127.0.0.1:6286" database="factbook"/></code> | ||
|} | |} | ||
Line 76: | Line 76: | ||
! width="110"|Code | ! width="110"|Code | ||
|Description | |Description | ||
− | |- | + | |- valign="top" |
|{{Code|delete}} | |{{Code|delete}} | ||
|An error occurred while deleting a log file. | |An error occurred while deleting a log file. | ||
− | |- | + | |- valign="top" |
|{{Code|today}} | |{{Code|today}} | ||
|Today's log file cannot be deleted. | |Today's log file cannot be deleted. | ||
− | |- | + | |- valign="top" |
|{{Code|type}} | |{{Code|type}} | ||
− | | | + | |Type string contains whitespaces. |
|} | |} | ||
Line 91: | Line 91: | ||
;Version 9.2 | ;Version 9.2 | ||
− | * Updated: | + | * Updated: {{Function||admin:write-log}}: type string may contain more characters |
;Version 9.0 | ;Version 9.0 | ||
Line 99: | Line 99: | ||
;Version 8.3 | ;Version 8.3 | ||
− | * Updated: | + | * Updated: {{Function||admin:write-log}}: optional log type added |
;Version 8.2 | ;Version 8.2 | ||
− | * Added: | + | * Added: {{Function||admin:delete-logs}} |
;Version 8.0 | ;Version 8.0 | ||
− | * Added: | + | * Added: {{Function||admin:write-log}} |
− | * Deleted: admin:users (renamed to | + | * Deleted: admin:users (renamed to {{Function|User|user:list-details}}). |
;Version 7.8.2 | ;Version 7.8.2 | ||
− | * Updated: | + | * Updated: {{Function||admin:users}}: md5-encoded password added to output. |
− | * Updated: | + | * Updated: {{Function||admin:logs}}: represent name of log files as string value; {{Code|$merge}} argument added. |
The Module was introduced with Version 7.5. | The Module was introduced with Version 7.5. |
Revision as of 15:39, 25 July 2022
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.
Database Logs
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, username). An optional log $type can be specified. 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 : Type string contains whitespaces.
|
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.
|
Database Sessions
admin:sessions
Signatures | admin:sessions() as element(session)*
|
Summary | Returns an element sequence with all currently opened database sessions, including the username, address (IP:port) and an optionally opened database. The output of this function and the SHOW SESSIONS command is similar.
|
Examples |
|
Errors
Code | Description |
---|---|
delete
|
An error occurred while deleting a log file. |
today
|
Today's log file cannot be deleted. |
type
|
Type string contains whitespaces. |
Changelog
- Version 9.2
- Updated:
admin:write-log
: type string may contain more characters
- Version 9.0
- Updated: error codes updated; 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.