Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
{{Updated with Version 8.3}}: optional log type added
Introduced with {{Version|8.2}}:
[[Category:XQuery]]
no edit summary
=Conventions=
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 errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.
=FunctionsDatabase Logs= ==admin:sessions== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|admin:sessions||element(session)*}}|-| '''Summary'''|Returns an element sequence with all currently opened sessions, including the user name, address (IP:port) and an optionally opened database.<br/>The output of this function and the [[Commands#SHOW_SESSIONS|SHOW SESSIONS]] command is similar.|-| '''Examples'''|* {{Code|admin:sessions()}} may e.g. return <code><session user="admin" address="127.0.0.1:6286" database="factbook"/></code>|}
==admin:logs==
{| width='100%'
|-valign="top"
| 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/>
|-valign="top"
| '''Summary'''
|Returns [[Logging]] data compiled by the database or HTTP server:
* 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.
|-valign="top"
| '''Examples'''
|
==admin:write-log==
{| width='100%'
|-valign="top"
| 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()}}
|-valign="top"
| '''Summary'''
|Writes a string to the database logs, along with current user data (timestamp, user nameusername). 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.|- valign="top"| '''Errors'''|{{Error|type|#Errors}} Type string contains whitespaces.
|}
==admin:delete-logs==
{| width='100%'
|-valign="top"
| width='120' | '''Signatures'''
|{{Func|admin:delete-logs|$date as xs:string|empty-sequence()}}
|-valign="top"
| '''Summary'''
|Deletes the log entries from the specified <code>$date</code>
|-valign="top"
| '''Errors'''
|{{Error|BXAD0001today|#Errors}} Today's log file cannot be deleted.<br/>{{Error|BXAD0002delete|#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>
|}
! width="110"|Code
|Description
|-valign="top"|{{Code|BXAD0001delete}}|An error occurred while deleting a log file.|- valign="top"|{{Code|today}}
|Today's log file cannot be deleted.
|-valign="top"|{{Code|BXAD0002type}}|An error occurred while deleting a log fileType string contains whitespaces.
|}
=Changelog=
;Version 9.2
* Updated: {{Function||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{{Function||admin:write-log]]}}: optional log type added
;Version 8.2
* Added: [[#admin:delete-logs{{Function||admin:delete-logs]]}}
;Version 8.0
* Added: [[#admin:write-log{{Function||admin:write-log]]}}* Deleted: admin:users (renamed to [[{{Function|User Module#user:list-details|user:list-details]]}}).
;Version 7.8.2
* Updated: [[#admin:users{{Function||admin:users]]}}: md5-encoded password added to output.* Updated: [[#admin:logs{{Function||admin:logs]]}}: represent name of log files as string value; {{Code|$merge}} argument added.
The Module was introduced with Version 7.5.
