Changes

All functions and errors in this module are assigned to the {{Code|<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|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.

=FunctionsDatabase Logs=

==admin:userslogs==

|-valign="top"

|{{Func|admin:userslogs||element(userfile)*}}<br/>{{Func|admin:userslogs|$db date as xs:string|element(userentry)*}}<br/>{{Func|admin:logs|$date as xs:string, $merge as xs:boolean|element(entry)*}}<br/>|-valign="top"

|Returns an element sequence[[Logging]] data compiled by the database or HTTP server:* If no argument is specified, containing a list of all registered users along with their access permissions log files will be returned, including the file size and md5-encoded passwordsdate.<br/>* If a database {{Code|$dbdate}} is specified, users registered for the contents of a particular database single log file will be returned.<br/>The output of this function * If {{Code|$merge}} is similar set to true, related log entries will be merged. Please note that the [[Commands#SHOW_USERS|SHOW USERS]] commandmerge might not be 100% successful, as log entries may be ambiguous.|-valign="top"

* {{Code|admin:userslogs()}} returns may return <code><user permissionfile size="admin834367"/>admin2015-01-23</userfile></code> if no additional users have been createda single log file exists.* {{Code|admin:userslogs() ! admin:logs("factbook".)}} returns lists the contents of all users that have been registered for the specified databaselog files.

==admin:sessionswrite-log==

|-valign="top"

|{{Func|admin:sessionswrite-log|$text as xs:string|elementempty-sequence()}}<br/>{{Func|admin:write-log|$text as xs:string, $type as xs:string|empty-sequence(session)*}}|-valign="top"

|Returns an element sequence Writes a string to the database logs, along with all currently opened sessions, including the current user namedata (timestamp, address (IP:portusername) and an optionally opened database. An optional log {{Code|$type}} can be specified. If omitted, the log type is {{Code|INFO}}.<br/>The output of this If the function is similar to called from a database client, the IP will be logged. Otherwise, the [[Commands#SHOW_SESSIONSstring {{Code|SHOW SESSIONS]] commandSERVER}} will be logged.|-valign="top"| '''ExamplesErrors'''|* {{CodeError|type|admin:sessions()#Errors}} may e.g. return <code><session user="admin" address="127.0.0Type string contains whitespaces.1:6286" database="factbook"/></code>

==admin:delete-logs==

|-valign="top"

|{{Func|admin:logs||element(file)*}}<br/>{{Func|admin:delete-logs|$date as xs:string|element(entry)*}}<br/>{{Func|admin:logs|$date as xs:string, $merge as xs:boolean|elementempty-sequence(entry)*}}<br/>|-valign="top"

|Returns [[Logging]] data compiled by Deletes the database or HTTP server:* If no argument is specified, a list of all log files will be returned, including entries from the file size and date.* If a {{Code|specified <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.</code>|-valign="top"| '''ExamplesErrors'''|* {{CodeError|today|admin:logs()#Errors}} may return <code><Today's log file size="834367"/>2013-01-23cannot be deleted.<br/code> if a single log file exists.* {{CodeError|for $log in admin:logs() return admin:logs($log)delete|#Errors}} lists the contents of all An error occurred while deleting a log filesfile.

==admin:write-log=Database Sessions=

{{Mark|Introduced with Version 8.0}}==admin:sessions==

|-valign="top"

|{{Func|admin:write-logsessions|$text as xs:string|empty-sequenceelement(session)*}}|-valign="top"

|Writes a string to Returns an element sequence with all currently opened database sessions, including the database logsusername, along with current user data address (timestamp, user nameIP:port)and an optionally opened database. If <br/>The output of this function and the function {{Command|SHOW SESSIONS}} command is called in similar.|- valign="top"| '''Examples'''|* {{Code|admin:sessions()}} may e.g. return <code><session user="admin" address="127.0.0.1:6286" database="factbook"/></code>|} =Errors= {| class="wikitable" width="100%"! width="110"|Code|Description|- valign="top"|{{Code|delete}}|An error occurred while deleting a web application or a database client, the IP will log file.|- valign="top"|{{Code|today}}|Today's log file cannot be loggeddeleted. Otherwise, the string |- valign="top"|{{Code|STANDALONEtype}} will be logged|Type string contains whitespaces.

* Added: [[#{{Function||admin:write-log}}* Deleted: admin:users (renamed to {{Function|adminUser|user:writelist-log]]details}}).

* 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.