Changes

Jump to navigation Jump to search
5 bytes added ,  12:28, 17 June 2022
no edit summary
| '''Summary'''
|Performs some integrity checks on the opened database and returns a brief summary.
|}
 
==INFO DB==
 
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO DB}}
|-
| '''XML Syntax'''   
|<code><info-db/></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Shows general information and meta data on the currently opened database.
|-
| '''Errors'''
|The command fails if no database is opened.
|}
 
==INFO INDEX==
 
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO INDEX ([ELEMNAME&#x7c;ATTRNAME&#x7c;PATH&#x7c;TEXT&#x7c;ATTRIBUTE&#x7c;TOKEN&#x7c;FULLTEXT])}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><info-index type='elemname&#x7c;attrname&#x7c;path&#x7c;text&#x7c;attribute&#x7c;token&#x7c;fulltext'/></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Shows information on the existing [[Indexes|index]] structures. The output can be optionally limited to the specified index.
|-
| '''Errors'''
|The command fails if no database is opened, or if the specified index is unknown.
|}
 
==INFO STORAGE==
 
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO STORAGE [start end]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><info-storage (start='...') (end='...')/></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Shows the internal main table of the currently opened database. An integer range may be specified as argument.
|-
| '''Errors'''
|The command fails if no database is opened, or if one of the specified arguments is invalid.
|}
| '''Errors'''
| The command fails if the package to be deleted is required by another package.
|}
 
==JOBS LIST==
 
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|JOBS LIST}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<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&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<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&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<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.
|}
|}
=MonitoringAdministration=
==SHOW SESSIONS==
|}
==JOBS LISTINFO DB==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|JOBS LISTINFO DB}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><jobsinfo-listdb/></code><br/>
|-
| '''Permission'''
|''ADMINREAD''
|-
| '''Summary'''
|Returns Shows general information and meta data on all jobs that are the currently queued or executedopened database. See {{Function|-|Jobs'''Errors'''|jobs:list-details}} for more details on the returned table entriesThe command fails if no database is opened.
|}
==JOBS RESULTINFO INDEX==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|JOBS RESULT INFO INDEX ([idELEMNAME&#x7c;ATTRNAME&#x7c;PATH&#x7c;TEXT&#x7c;ATTRIBUTE&#x7c;TOKEN&#x7c;FULLTEXT])}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><jobsinfo-result idindex type='...elemname&#x7c;attrname&#x7c;path&#x7c;text&#x7c;attribute&#x7c;token&#x7c;fulltext'/></code><br/>
|-
| '''Permission'''
|''ADMINREAD''
|-
| '''Summary'''
|Returns Shows information on the cached result of a query with the specified job id:* Results existing [[Indexes|index]] structures. The output can only be retrieved once. After retrieval, optionally limited to the cached result will be dropped.* If the original query has raised an error, the cached error will be raised insteadspecified index.
|-
| '''Errors'''
|The command fails if the addressed job no database is still running opened, or if the result has already been retrievedspecified index is unknown.
|}
==JOBS STOPINFO STORAGE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|JOBS STOP INFO STORAGE [idstart end]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><jobsinfo-stop idstorage (start='...') (end='...')/></code><br/>
|-
| '''Permission'''
|''ADMINREAD''
|-
| '''Summary'''
|Cancels Shows the execution internal main table of a job with the currently opened database. An integer range may be specified idas argument.|-| '''Errors'''|The command fails if no database is opened, or drops the cached result if one of a query. Unknown ids are ignored. All jobs are gracefully stopped; it is up to the process to decide when it specified arguments is safe to shut downinvalid.
|}
==EXIT==
 
{| width='100%'
|-
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu