Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
|}
==JOBS LIST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|JOBS LIST}}
|-
| '''XML Syntax'''
|<code><jobs-list/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Returns information on all jobs that are currently queued or executed. See {{Function|Jobs|jobs:list-details}} for more details on the returned table entries.
|}
==JOBS RESULT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|JOBS RESULT [id]}}
|-
| '''XML Syntax'''
|<code><jobs-result id='...'/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Returns the cached result of a query with the specified job id:
* Results can only be retrieved once. After retrieval, the cached result will be dropped.
* If the original query has raised an error, the cached error will be raised instead.
|-
| '''Errors'''
|The command fails if the addressed job is still running or if the result has already been retrieved.
|}
==JOBS STOP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|JOBS STOP [id]}}
|-
| '''XML Syntax'''
|<code><jobs-stop id='...'/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Cancels the execution of a job with the specified id, or drops the cached result of a query. Unknown ids are ignored. All jobs are gracefully stopped; it is up to the process to decide when it is safe to shut down.
no edit summary
| '''Errors'''
| The command fails if the package to be deleted is required by another package.
|}
|}
=AdministrationUser Management=
==SHOW SESSIONSCREATE USER==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW SESSIONSCREATE USER [name] ([password])}}
|-
| '''XML Syntax'''
|<code><showcreate-sessionsuser name='...'>([password])</create-user></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Shows all sessions that are connected to Creates a user with the current server instancespecified {{Code|name}} and {{Code|password}}. If no password is specified, it is requested via the chosen frontend (GUI or bash).|-| '''Errors'''|The command fails if the specified user already exists.
|}
==SHOW USERSALTER USER==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW USERS ALTER USER [name] (ON [databasenewname])}}
|-
| '''XML Syntax'''
|<code><showalter-users (databaseuser name='...' newname='...')/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Shows all users that are visible to Renames the current user. If a with the specified {{Code|databasename}} to {{Code|newname}} is specified, only those users will be shown for which a pattern was specified that matches the database name.
|-
| '''Errors'''
|The command fails if the optional database could specified user does not be openedexist, or if the new user already exists.
|}
==KILLALTER PASSWORD==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|KILL ALTER PASSWORD [targetname]([password])}}
|-
| '''XML Syntax'''
|<code><kill targetalter-password name='...'>([password])</alter-password></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Kills sessions Alters the {{Code|password}} of a the user or an IP:port combination, with the specified by {{Code|targetname}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one userIf no password is specified, it is requested via the chosen frontend (GUI or bash).
|-
| '''Errors'''
|The command fails if a the specified user tried to kill his/her own sessiondoes not exist.
|}
==INFO DBDROP USER==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO DBDROP USER [name] (ON [pattern])}}:
|-
| '''XML Syntax'''
|<code><infodrop-dbuser name='...' (pattern='...')/></code><br/>
|-
| '''Permission'''
|''READADMIN''
|-
| '''Summary'''
|Shows general information and meta data on Drops the currently opened user with the specified {{Code|name}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database or user. If a glob {{Code|pattern}} is specified, only the assigned databasepattern will be removed.
|-
| '''Errors'''
|The command fails if no database {{Code|admin}} is openedspecified as user name, or if the specified user does not exist or is currently logged in.
|}
==INFO INDEXGRANT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO INDEX (GRANT [ELEMNAMENONE|ATTRNAMEREAD|PATHWRITE|TEXTCREATE|ATTRIBUTE|TOKEN|FULLTEXTADMIN] (ON [pattern])TO [user]}}
|-
| '''XML Syntax'''
|<code><info-index typegrant name='elemname...' permission='none|attrnameread|pathwrite|textcreate|attribute|token|fulltextadmin' (pattern='...')/></code><br/>
|-
| '''Permission'''
|''READADMIN''
|-
| '''Summary'''
|Shows information on Grants the existing specified [[IndexesUser_Management|indexpermission]] structuresto the specified {{Code|user}}. The output [[#Glob Syntax|Glob Syntax]] can be optionally limited used to address more than one user. If a glob {{Code|pattern}} is specified, the specified indexpermission will be applied to all databases that match this pattern.
|-
| '''Errors'''
|The command fails if no database {{Code|admin}} is opened, specified as user name or if the specified index user does not exist.|-| '''Examples'''|* {{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission to the user {{Code|JoeWinson}}.* {{Code|GRANT WRITE ON Wiki TO editor*}}<br/>grants {{Code|WRITE}} permissions on the {{Code|Wiki}} database to all users starting with the characters {{Code|editor*}}.|} ==PASSWORD== {| width='100%'|-|width='130'|'''Syntax'''|{{Code|PASSWORD ([password])}}|-| '''XML Syntax''' |<code><password>([password])</password></code><br/>|-| '''Permission'''|''NONE''|-| '''Summary'''|Changes the {{Code|password}} of the current user. If no password is specified, it is unknownrequested via the chosen frontend (GUI or bash).|} =Administration= ==SHOW SESSIONS== {| width='100%'|-|width='130'|'''Syntax'''|{{Code|SHOW SESSIONS}}|-| '''XML Syntax''' |<code><show-sessions/></code><br/>|-| '''Permission'''|''ADMIN''|-| '''Summary'''|Shows all sessions that are connected to the current server instance.
|}
==INFO STORAGESHOW USERS==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO STORAGE SHOW USERS (ON [start enddatabase])}}
|-
| '''XML Syntax'''
|<code><infoshow-storage users (start='...') (enddatabase='...')/></code><br/>
|-
| '''Permission'''
|''READADMIN''
|-
| '''Summary'''
|Shows all users that are visible to the internal main table of the currently opened current user. If a {{Code|database. An integer range may }} is specified, only those users will be shown for which a pattern was specified as argumentthat matches the database name.
|-
| '''Errors'''
|The command fails if no the optional database is could not be opened, or if one of the specified arguments is invalid.
|}
=User Management= ==CREATE USERKILL==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CREATE USER KILL [nametarget] ([password])}}
|-
| '''XML Syntax'''
|<code><create-user namekill target='...'>([password])</create-user></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Creates Kills sessions of a user with the or an IP:port combination, specified by {{Code|nametarget}} and {{Code. The [[#Glob Syntax|password}}. If no password is specified, it is requested via the chosen frontend (GUI or bash)Glob Syntax]] can be used to address more than one user.
|-
| '''Errors'''
|The command fails if the specified a user already existstried to kill his/her own session.
|}
==ALTER USERINFO DB==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ALTER USER [name] ([newname])INFO DB}}
|-
| '''XML Syntax'''
|<code><alterinfo-user name='...' newname='...'db/></code><br/>
|-
| '''Permission'''
|''ADMINREAD''
|-
| '''Summary'''
|Renames Shows general information and meta data on the user with the specified {{Code|name}} to {{Code|newname}}currently opened database.
|-
| '''Errors'''
|The command fails if the specified user does not exist, or if the new user already existsno database is opened.
|}
==ALTER PASSWORDINFO INDEX==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ALTER PASSWORD [name] INFO INDEX ([passwordELEMNAME|ATTRNAME|PATH|TEXT|ATTRIBUTE|TOKEN|FULLTEXT])}}
|-
| '''XML Syntax'''
|<code><alterinfo-password nameindex type='...elemname|attrname|path|text|attribute|token|fulltext'>([password])</alter-password></code><br/>
|-
| '''Permission'''
|''ADMINREAD''
|-
| '''Summary'''
|Alters Shows information on the {{Codeexisting [[Indexes|password}} of index]] structures. The output can be optionally limited to the user with the specified {{Code|name}}. If no password is specified, it is requested via the chosen frontend (GUI or bash)index.
|-
| '''Errors'''
|The command fails if no database is opened, or if the specified user does not existindex is unknown.
|}
==DROP USERINFO STORAGE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP USER INFO STORAGE [namestart end] (ON [pattern])}}:
|-
| '''XML Syntax'''
|<code><dropinfo-user namestorage (start='...' ) (patternend='...')/></code><br/>
|-
| '''Permission'''
|''ADMINREAD''
|-
| '''Summary'''
|Drops Shows the user with internal main table of the specified {{Code|name}}currently opened database. The [[#Glob Syntax|Glob Syntax]] can An integer range may be used to address more than one database or user. If a glob {{Code|pattern}} is specified, only the assigned database pattern will be removedas argument.
|-
| '''Errors'''
|The command fails if no database is opened, or if one of the specified arguments is invalid.|} ==JOBS LIST== {| width='100%'|-|width='130'|'''Syntax'''|{{Code|adminJOBS LIST}} is specified as user name, |-| '''XML Syntax''' |<code><jobs-list/></code><br/>|-| '''Permission'''|''ADMIN''|-| '''Summary'''|Returns information on all jobs that are currently queued or if executed. See {{Function|Jobs|jobs:list-details}} for more details on the specified user does not exist or is currently logged inreturned table entries.
|}
==GRANTJOBS RESULT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|GRANT JOBS RESULT [NONE|READ|WRITE|CREATE|ADMIN] (ON [pattern]) TO [userid]}}
|-
| '''XML Syntax'''
|<code><grant namejobs-result id='...' permission='none|read|write|create|admin' (pattern='...')/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Grants Returns the specified [[User_Management|permission]] to cached result of a query with the specified {{Code|user}}job id:* Results can only be retrieved once. The [[#Glob Syntax|Glob Syntax]] can After retrieval, the cached result will be used to address more than one userdropped. * If a glob {{Code|pattern}} is specifiedthe original query has raised an error, the permission cached error will be applied to all databases that match this patternraised instead.
|-
| '''Errors'''
|The command fails if {{Code|admin}} the addressed job is specified as user name still running or if the specified user does not exist.|-| '''Examples'''|* {{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission to the user {{Code|JoeWinson}}.* {{Code|GRANT WRITE ON Wiki TO editor*}}<br/>grants {{Code|WRITE}} permissions on the {{Code|Wiki}} database to all users starting with the characters {{Code|editor*}}result has already been retrieved.
|}
==PASSWORDJOBS STOP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|PASSWORD (JOBS STOP [passwordid])}}
|-
| '''XML Syntax'''
|<code><password>([password])<jobs-stop id='...'/password></code><br/>
|-
| '''Permission'''
|''NONEADMIN''
|-
| '''Summary'''
|Changes Cancels the {{Code|password}} execution of a job with the current user. If no password is specifiedid, or drops the cached result of a query. Unknown ids are ignored. All jobs are gracefully stopped; it is requested via up to the chosen frontend (GUI or bash)process to decide when it is safe to shut down.
|}
