Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
==admin:users==
{| width='100%'
|-
| width='120' | '''Signatures'''
|{{Func|admin:users||element(user)*}}<br/>{{Func|admin:users|$db as xs:string|element(user)*}}<br/>
|-
| '''Summary'''
|Returns an element sequence, containing all registered users along with their access permissions and md5-encoded passwords.<br/>If a database {{Code|$db}} is specified, users registered for a particular database will be returned.<br/>The output of this function is similar to the [[Commands#SHOW_USERS|SHOW USERS]] command.
|-
| '''Examples'''
|
* {{Code|admin:users()}} returns <code><user permission="admin">admin</user></code> if no additional users have been created.
* {{Code|admin:users("factbook")}} returns all users that have been registered for the specified database.
|}
[[Category:XQuery]]
→admin:write-log
=Conventions=
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.
=Functions=
==admin:sessions==
|-
| '''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 is similar to and the [[Commands#SHOW_SESSIONS{{Command|SHOW SESSIONS]] }} commandis similar.
|-
| '''Examples'''
| '''Examples'''
|
* {{Code|admin:logs()}} may return <code><file size="834367"/>20132015-01-23</file></code> if a single log file exists.* {{Code|for $log in admin:logs() return ! admin:logs($log.)}} lists the contents of all log files.
|}
==admin:write-log==
{| width='100%'|-| width='120' | '''Signatures'''|{Mark{Func|admin:write-log|$text as xs:string|Introduced 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 Version 8current user data (timestamp, user name). An optional log {{Code|$type}} can be specified. If omitted, the log type is {{Code|INFO}}.0<br/>If the function is called from a database client, the IP will be logged. Otherwise, the string {{Code|SERVER}}will be logged.|-| '''Errors'''|{{Error|type|#Errors}} Type string contains whitespaces.|} ==admin:delete-logs==
{| width='100%'
|-
| width='120' | '''Signatures'''
|{{Func|admin:writedelete-loglogs|$text date as xs:string|empty-sequence()}}
|-
| '''Summary'''
|Writes a string to Deletes the log entries from the database logs, along with current user data (timestamp, user name)specified <code>$date</code>|-| '''Errors'''|{{Error|today|#Errors}} Today's log file cannot be deleted. If the function is called in <br/>{{Error|delete|#Errors}} An error occurred while deleting a web application or log file.|} =Errors= {| class="wikitable" width="100%"! width="110"|Code|Description|-|{{Code|delete}}|An error occurred while deleting a database client, the IP will log file.|-|{{Code|today}}|Today's log file cannot be loggeddeleted. Otherwise, the string |-|{{Code|STANDALONEtype}} will be logged|Type 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.2
* Added: [[#admin:delete-logs|admin:delete-logs]]
;Version 8.0
* Added: [[#admin:write-log|admin:write-log]]
* Deleted: admin:users (renamed to [[User Module#user:list-details|user:list-details]])
;Version 7.8.2
The Module was introduced with Version 7.5.
