Difference between revisions of "User Module"
Jump to navigation
Jump to search
Line 20: | Line 20: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code| | + | * {{Code|user:list()}} returns all registered users. |
|} | |} | ||
Line 31: | Line 31: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns an element sequence, containing all registered users | + | |Returns an element sequence, containing all registered users and their permissions.<br/>In addition to the [[Commands#SHOW_USERS|SHOW USERS]], encoded password strings and database permissions will be output. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code| | + | * {{Code|user:list-details()}} returns information on all registered users. By default, it returns the following output:<br/> |
<pre class="brush:xml"> | <pre class="brush:xml"> | ||
<user name="admin" permission="admin"> | <user name="admin" permission="admin"> | ||
Line 47: | Line 47: | ||
</user> | </user> | ||
</pre> | </pre> | ||
+ | |} | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|user:exists|$name as xs:string|xs:boolean}}<br/> | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Checks if a user with the specified {{Code|$name}} exists. | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * {{Code|user:exists('admin')}} will always yield true. | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|BXUS0001|#Errors}} The specified user name is invalid. | ||
|} | |} | ||
Revision as of 23:52, 10 December 2014
This XQuery Module contains functions for creating and administering database users. The User Management article gives more information on database users and permissions.
Conventions
All functions in this module are assigned to the http://basex.org/modules/user
namespace, which is statically bound to the user
prefix.
All errors are assigned to the http://basex.org/errors
namespace, which is statically bound to the bxerr
prefix.
Functions
user:list
Signatures | user:list() as xs:string* |
Summary | Returns the names of all registered users. |
Examples |
|
user:list-details
Signatures | user:list-details() as element(user)* |
Summary | Returns an element sequence, containing all registered users and their permissions. In addition to the SHOW USERS, encoded password strings and database permissions will be output. |
Examples |
<user name="admin" permission="admin"> <password algorithm="digest"> <hash>304bdfb0383c16f070a897fc1eb25cb4</hash> </password> <password algorithm="salted-sha256"> <salt>871602799292195</salt> <hash>a065ca66fa3d6da5762c227587f1c8258c6dc08ee867e44a605a72da115dcb41</hash> </password> </user> |
Signatures | user:exists($name as xs:string) as xs:boolean |
Summary | Checks if a user with the specified $name exists.
|
Examples |
|
Errors | BXUS0001 : The specified user name is invalid.
|
Errors
Code | Description |
---|---|
BXUS0001
|
The specified user name is invalid. |
BXUS0002
|
The specified database name is invalid. |
BXUS0003
|
The specified permission is invalid. |
BXUS0004
|
The specified user does not exist. |
BXUS0005
|
The "admin" user cannot be modified. |
BXUS0006
|
Name of old and new user is equal. |
BXUS0007
|
A local permission can only be 'none', 'read' or 'write'. |
BXUS0008
|
A specified user is currently logged in. |
BXUS0009
|
A user, or its associated permission, can only be created, modified or dropped once. |
BXUS0010
|
A user cannot be both altered and dropped. |
Changelog
The Module was introduced with Version 8.0.