Difference between revisions of "Admin Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 68: Line 68:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Writes a string to the database logs.
+
|Writes a string to the database logs, along with current user data (timestamp, user name). If the function is called in a web application or a database client, the IP will be logged. Otherwise, the string {{Code|STANDALONE}} will be logged.
 
|}
 
|}
  

Revision as of 22:54, 27 November 2014

This XQuery Module contains functions for performing admin-centric operations such as managing database users and log data.

Conventions

All functions in this module are assigned to the http://basex.org/modules/admin namespace, which is statically bound to the admin prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.

Functions

admin:users

Signatures admin:users() as element(user)*
admin:users($db as xs:string) as element(user)*
Summary Returns an element sequence, containing all registered users along with their access permissions and md5-encoded passwords.
If a database $db is specified, users registered for a particular database will be returned.
The output of this function is similar to the SHOW USERS command.
Examples
  • admin:users() returns <user permission="admin">admin</user> if no additional users have been created.
  • admin:users("factbook") returns all users that have been registered for the specified database.

admin:sessions

Signatures admin:sessions() as element(session)*
Summary Returns an element sequence with all currently opened sessions, including the user name, address (IP:port) and an optionally opened database.
The output of this function is similar to the SHOW SESSIONS command.
Examples
  • admin:sessions() may e.g. return <session user="admin" address="127.0.0.1:6286" database="factbook"/>

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:
  • If no argument is specified, a list of all log files will be returned, including the file size and date.
  • If a $date is specified, the contents of a single log file will be returned.
  • If $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.
Examples
  • admin:logs() may return <file size="834367"/>2013-01-23 if a single log file exists.
  • for $log in admin:logs() return admin:logs($log) lists the contents of all log files.

admin:write-log

Template:Mark:

Signatures admin:write-log($text as xs:string) as empty-sequence()
Summary Writes a string to the database logs, along with current user data (timestamp, user name). If the function is called in a web application or a database client, the IP will be logged. Otherwise, the string STANDALONE will be logged.

Changelog

Version 8.0
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.