User Module - Revision history

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:39:29Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:34:42Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG: Text replacement - "" to "

2023-12-01T16:31:18Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG at 14:18, 9 March 2023

2023-03-09T14:18:57Z

CG: Text replacement - "'''Signatures'''" to "'''Signature'''"

2023-03-09T13:09:17Z

Text replacement - "'''Signatures'''" to "'''Signature'''"

CG at 11:10, 9 March 2023

2023-03-09T11:10:15Z

CG at 13:39, 25 July 2022

2022-07-25T13:39:27Z

CG: /* user:check */

2022-07-25T09:02:20Z

user:check

CG at 12:20, 20 July 2022

2022-07-20T12:20:07Z

Show changes

CG at 18:56, 18 July 2022

2022-07-18T18:56:56Z

@@ Line 52: / Line 52: @@
+|
 * After a fresh installation, {{Code|user:list-details()}} returns output similar to the following one:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <user name="admin" permission="admin">
    <password algorithm="digest">

@@ Line 62: / Line 62: @@
    </password>
 </user>
-</syntaxhighlight>
+</pre>
 |- valign="top"
 | '''Errors'''
@@ Line 267: / Line 267: @@
    return element group { $group }
 })
-</syntaxhighlight>
+</pre>
 * Add a group to a specific user:
 <pre lang='xquery'>
 user:update-info(<info group='editor'/>, 'john')
-</syntaxhighlight>
+</pre>
 |}

@@ Line 262: / Line 262: @@
+|
 * Store initial groups information:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 user:update-info(element info {
    for $group in ('editor', 'author', 'writer')
@@ Line 269: / Line 269: @@
 </syntaxhighlight>
 * Add a group to a specific user:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 user:update-info(<info group='editor'/>, 'john')
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
-This [[Module Library|XQuery Module]] contains functions for creating and administering database users. The [[User Management]] article gives more information on database users and permissions.
+This [[Module Library|XQuery Module]] contains functions for creating and administering database users. The [[User Management]] article provides more information on database users and permissions.
 =Conventions=
@@ Line 15: / Line 15: @@
 |- valign="top"
 | '''Summary'''
-|Returns the name of the currently logged in user.
+|Returns the name of the currently logged-in user.
 |- valign="top"
 | '''Examples'''
@@ Line 30: / Line 30: @@
 |- valign="top"
 | '''Summary'''
-|Returns the names of all registered users that are visible to the current user.
+|Returns the names of all registered users who are visible to the current user.
 |- valign="top"
 | '''Examples'''
@@ Line 47: / Line 47: @@
 |- valign="top"
 | '''Summary'''
-|Returns an element sequence, containing all registered users that are visible to the current user.<br/>In addition to the {{Command|SHOW USERS}} command, encoded password strings and database permissions will be output. A user {{Code|$name}} can be specified to filter the results in advance.
+|Returns an element sequence, containing all registered users who are visible to the current user.<br/>In addition to the {{Command|SHOW USERS}} command, encoded password strings and database permissions will be output. A user {{Code|$name}} can be specified to filter the results in advance.
 |- valign="top"
 | '''Examples'''
@@ Line 94: / Line 94: @@
 | width='120' | '''Signature'''
 |<pre>user:check(
-   $name      as xs:string
+   $name      as xs:string,
    $password  as xs:string
 ) as empty-sequence()</pre>
@@ Line 128: / Line 128: @@
 =Updates=
-'''Important note:''' All functions in this section are ''updating functions'': they will not be immediately executed, but queued on the [[XQuery Update#Pending Update List|Pending Update List]], which will be processed after the actual query has been evaluated. This means that the order in which the functions are specified in the query does usually not reflect the order in which the code will be evaluated.
+'''Important note:''' All functions in this section are ''updating functions'': they will not be immediately executed, but queued on the [[XQuery Update#Pending Update List|Pending Update List]], which will be processed after the actual query has been evaluated. This means that the order in which the functions are specified in the query usually does not reflect the order in which the code will be evaluated.
 ==user:create==
@@ Line 136: / Line 136: @@
 | width='120' | '''Signature'''
 |<pre>user:create(
-   $name         as xs:string
+   $name         as xs:string,
-   $password     as xs:string
+   $password     as xs:string,
-   $permissions  as xs:string*     := ()
+   $permissions  as xs:string*     := (),
-   $patterns     as xs:string*     := ()
+   $patterns     as xs:string*     := (),
    $info         as element(info)  := ()
 ) as empty-sequence()</pre>
@@ Line 165: / Line 165: @@
 | width='120' | '''Signature'''
 |<pre>user:grant(
-   $name         as xs:string
+   $name         as xs:string,
-   $permissions  as xs:string*
+   $permissions  as xs:string*,
    $patterns     as xs:string*  := ()
 ) as empty-sequence()</pre>
@@ Line 188: / Line 188: @@
 | width='120' | '''Signature'''
 |<pre>user:drop(
-   $name      as xs:string
+   $name      as xs:string,
    $patterns  as xs:string*  := ()
 ) as empty-sequence()</pre>
@@ Line 210: / Line 210: @@
 | width='120' | '''Signature'''
 |<pre>user:alter(
-   $name     as xs:string
+   $name     as xs:string,
    $newname  as xs:string
 ) as empty-sequence()</pre>
@@ Line 231: / Line 231: @@
 | width='120' | '''Signature'''
 |<pre>user:password(
-   $name      as xs:string
+   $name      as xs:string,
    $password  as xs:string
 ) as empty-sequence()</pre>
@@ Line 252: / Line 252: @@
 | width='120' | '''Signature'''
 |<pre>user:update-info(
-   $info  as element(info)
+   $info  as element(info),
    $name  as xs:string      := ()
 ) as empty-sequence()</pre>

@@ Line 11: / Line 11: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:current() as xs:string</pre>
 |- valign="top"
@@ Line 26: / Line 26: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:list() as xs:string*</pre>
 |- valign="top"
@@ Line 41: / Line 41: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:list-details(
    $name  as xs:string  := ()
@@ Line 72: / Line 72: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:exists(
    $name  as xs:string
@@ Line 92: / Line 92: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:check(
    $name      as xs:string
@@ Line 113: / Line 113: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:info(
    $name  as xs:string  := ()
@@ Line 134: / Line 134: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:create(
    $name         as xs:string
@@ Line 163: / Line 163: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:grant(
    $name         as xs:string
@@ Line 186: / Line 186: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:drop(
    $name      as xs:string
@@ Line 208: / Line 208: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:alter(
    $name     as xs:string
@@ Line 229: / Line 229: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:password(
    $name      as xs:string
@@ Line 250: / Line 250: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>user:update-info(
    $info  as element(info)

@@ Line 63: / Line 63: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|unknown|#Errors}} The specified user name is unknown.
+|{{Error|unknown|#Errors}} The specified username is unknown.
 |}
@@ Line 81: / Line 81: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|name|#Errors}} The specified user name is invalid.
+|{{Error|name|#Errors}} The specified username is invalid.
 |}
@@ Line 99: / Line 99: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|unknown|#Errors}} The specified user does not exist.<br/>{{Error|password|#Errors}} The specified password is wrong.<br/>
+|{{Error|name|#Errors}} The specified username is invalid.<br/>{{Error|unknown|#Errors}} The specified user does not exist.<br/>{{Error|password|#Errors}} The specified password is wrong.<br/>
 |}
@@ Line 141: / Line 141: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|permission|#Errors}} The specified permission is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.
+|{{Error|name|#Errors}} The specified username is invalid.<br/>{{Error|permission|#Errors}} The specified permission is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.
 |}
@@ Line 160: / Line 160: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|unknown|#Errors}} The specified user name is unknown.<br/>{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|pattern|#Errors}} The specified database pattern is invalid.<br/>{{Error|permission|#Errors}} The specified permission is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|local|#Errors}} A local permission can only be 'none', 'read' or 'write'.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.
+|{{Error|unknown|#Errors}} The specified username is unknown.<br/>{{Error|name|#Errors}} The specified username is invalid.<br/>{{Error|pattern|#Errors}} The specified database pattern is invalid.<br/>{{Error|permission|#Errors}} The specified permission is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|local|#Errors}} A local permission can only be 'none', 'read' or 'write'.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.
 |}
@@ Line 179: / Line 179: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|unknown|#Errors}} The specified user name is unknown.<br/>{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|pattern|#Errors}} The specified database pattern is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.<br/>{{Error|conflict|#Errors}} A user cannot be both altered and dropped.
+|{{Error|unknown|#Errors}} The specified username is unknown.<br/>{{Error|name|#Errors}} The specified username is invalid.<br/>{{Error|pattern|#Errors}} The specified database pattern is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.<br/>{{Error|conflict|#Errors}} A user cannot be both altered and dropped.
 |}
@@ Line 197: / Line 197: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|unknown|#Errors}} The specified user name is unknown.<br/>{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.<br/>{{Error|conflict|#Errors}} A user cannot be both altered and dropped.
+|{{Error|unknown|#Errors}} The specified username is unknown.<br/>{{Error|name|#Errors}} The specified username is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.<br/>{{Error|conflict|#Errors}} A user cannot be both altered and dropped.
 |}
@@ Line 215: / Line 215: @@
 |- valign="top"
 | '''Errors'''
-|{{Error|unknown|#Errors}} The specified user name is unknown.<br/>{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.
+|{{Error|unknown|#Errors}} The specified username is unknown.<br/>{{Error|name|#Errors}} The specified username is invalid.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.
 |}
@@ Line 265: / Line 265: @@
 |- valign="top"
 |{{Code|name}}
-|The specified user name is invalid.
+|The specified username is invalid.
 |- valign="top"
 |{{Code|password}}