Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
Created page with "This XQuery Module contains functions for performing operations that are restricted to users with |Admin Permissions. Existing users can be..."
This [[Module Library|XQuery Module]] contains functions for performing operations that are restricted to users with [[User Management||Admin Permissions]]. Existing users can be listed, and soon more.
=Conventions=
All functions in this module are assigned to the {{Code|http://basex.org/modules/admin}} 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:users==
{|
|-
| width='90' | '''Signatures'''
|{{Func|admin:users||element(user)*}}<br/>{{Func|admin:users|$db as item()|element(user)*}}<br/>
|-
| '''Summary'''
|Returns an {{Code|element}} sequence, containing all registered users along with their access permissions.<br/>If a [[Database Module#Database Nodes|database node]] {{Code|$db}} is specified, users registered for a particular database will be returned.
|-
| '''Examples'''
|
* {{Code|admin:users("factbook")}} returns all users that have particularly registered for the specified database.
|}
=Conventions=
All functions in this module are assigned to the {{Code|http://basex.org/modules/admin}} 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:users==
{|
|-
| width='90' | '''Signatures'''
|{{Func|admin:users||element(user)*}}<br/>{{Func|admin:users|$db as item()|element(user)*}}<br/>
|-
| '''Summary'''
|Returns an {{Code|element}} sequence, containing all registered users along with their access permissions.<br/>If a [[Database Module#Database Nodes|database node]] {{Code|$db}} is specified, users registered for a particular database will be returned.
|-
| '''Examples'''
|
* {{Code|admin:users("factbook")}} returns all users that have particularly registered for the specified database.
|}
