Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
Introduced with {{Version|8.2}}:
[[Category:XQuery]]
→admin:write-log
=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.
=Functions=
|-
| '''Summary'''
|Returns an element sequence with all currently opened database sessions, including the user name, address (IP:port) and an optionally opened database.<br/>The output of this function and the [[Commands#SHOW_SESSIONS{{Command|SHOW SESSIONS]] }} command is similar.
|-
| '''Examples'''
|-
| 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()}}
|-
| '''Summary'''
|Writes a string to the database logs, along with current user data (timestamp, user name). An optional log {{Code|$type}} can be specified. If omitted, the log type is {{Code|INFO}}.<br/>If the function is called in a web application or from a database client, the IP will be logged. Otherwise, the string {{Code|STANDALONESERVER}} will be logged.|-| '''Errors'''|{{Error|type|#Errors}} Type string contains whitespaces.
|}
==admin:delete-logs==
{| width='100%'
|-
| '''Errors'''
|{{Error|BXAD0001today|#Errors}} Today's log file cannot be deleted.<br/>{{Error|BXAD0002delete|#Errors}} An error occurred while deleting a log file.
|}
|Description
|-
|{{Code|BXAD0001delete}}|An error occurred while deleting a log file.|-|{{Code|today}}
|Today's log file cannot be deleted.
|-
|{{Code|BXAD0002type}}|An error occurred while deleting a log fileType string contains whitespaces.
|}
=Changelog=
;Version 9.2 * Updated: [[#admin:write-log|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|admin:write-log]]: optional log type added ;Version 8.02
* Added: [[#admin:delete-logs|admin:delete-logs]]
The Module was introduced with Version 7.5.
