User Module

From BaseX Documentation
Revision as of 23:39, 10 December 2014 by CG (talk | contribs) (Created page with "This XQuery Module contains functions for creating and administering database users. =Conventions= All functions in this module are assigned to the {{Code|ht...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This XQuery Module contains functions for creating and administering database users.

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
  • admin:list() returns all registered users.

user:list-details

Signatures user:list-details() as element(user)*
Summary Returns an element sequence, containing all registered users, their permissions, and their encoded password strings.
The SHOW USERS command yields similar output.
Examples
  • admin:list-details() returns information on all registered users. By default, it returns the following output:
<user name="admin" permission="admin">
  <password algorithm="digest">
    <hash>304bdfb0383c16f070a897fc1eb25cb4</hash>
  </password>
  <password algorithm="salted-sha256">
    <salt>871602799292195</salt>
    <hash>a065ca66fa3d6da5762c227587f1c8258c6dc08ee867e44a605a72da115dcb41</hash>
  </password>
</user>

Changelog

The Module was introduced with Version 8.0.