Difference between revisions of "Admin Module"
Jump to navigation
Jump to search
m (Text replace - "assigned to the \{\{Code\|([^}]*)\}\} namespace" to "assigned to the <code><nowiki>$1</nowiki></code> namespace") |
|||
Line 51: | Line 51: | ||
| '''Summary''' | | '''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 {{Code|STANDALONE}} will be logged. | |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. | ||
+ | |} | ||
+ | |||
+ | ==admin:delete-logs== | ||
+ | |||
+ | Introduced with {{Version|8.2}}: | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|admin:delete-logs|$date as xs:string|empty-sequence()}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Deletes the log entries from the specified <code>$date</code> | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|BXAD0001|#Errors}} Today's log file cannot be deleted.<br/>{{Error|BXAD0002|#Errors}} An error occurred while deleting a log file. | ||
+ | |} | ||
+ | |||
+ | =Errors= | ||
+ | |||
+ | {| class="wikitable" width="100%" | ||
+ | ! width="110"|Code | ||
+ | |Description | ||
+ | |- | ||
+ | |{{Code|BXAD0001}} | ||
+ | |Today's log file cannot be deleted. | ||
+ | |- | ||
+ | |{{Code|BXAD0002}} | ||
+ | |An error occurred while deleting a log file. | ||
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 8.0 | ||
+ | |||
+ | * Added: [[#admin:delete-logs|admin:delete-logs]] | ||
;Version 8.0 | ;Version 8.0 |
Revision as of 15:51, 14 April 2015
This XQuery Module contains functions for performing admin-centric operations such as managing database users and log data.
Contents
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: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 and the SHOW SESSIONS command is similar. |
Examples |
|
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:
|
Examples |
|
admin:write-log
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.
|
admin:delete-logs
Introduced with Version 8.2:
Signatures | admin:delete-logs($date as xs:string) as empty-sequence()
|
Summary | Deletes the log entries from the specified $date
|
Errors | BXAD0001 : Today's log file cannot be deleted.BXAD0002 : An error occurred while deleting a log file.
|
Errors
Code | Description |
---|---|
BXAD0001
|
Today's log file cannot be deleted. |
BXAD0002
|
An error occurred while deleting a log file. |
Changelog
- Version 8.0
- Added: admin:delete-logs
- Version 8.0
- Added: admin:write-log
- Deleted: admin:users (renamed to user:list-details)
- 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.