Project RestXQ documentation

Summary

This document provides details of the RestXQ annotations. These provide mappings from Web endpoints to XQuery code.

Base path: ///dba

View	Description	Format
index.html	Index of sources	xhtml
imports	Summary of import usage	xhtml
annotations	Summary of XQuery annotation use	xhtml
mermaid	Project wide module imports as a mermaid class diagram	html5
xqdoca.xml	xqDocA run configuration report (XML)	xml

Rest interface paths

2.1 /dba
#

ALL /dba
R

Description: Redirects to the start page.
dba:redirect#0

Annotations (1)

`%rest:path`	`('/dba')`

2.2 /dba/backup-create
#

GET /dba/backup-create
UR

Description

Creates a database backup.

dba:backup-create#1

Query parameters

Name	Type	Description	Default
name	xs:string	name of database

Annotations (4)

`%updating`	`()`
`%rest:GET`	`()`
`%rest:path`	`('/dba/backup-create')`
`%rest:query-param`	`('name','{$name}')`

2.3 /dba/backup-drop
#

GET /dba/backup-drop
UR

Description

Drops a database backup.

dba:backup-drop#2

Query parameters

Name	Type	Description	Default
name	xs:string	name of database
backups	xs:string*	backup files

Annotations (5)

`%updating`	`()`
`%rest:GET`	`()`
`%rest:path`	`('/dba/backup-drop')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('backup','{$backups}')`

2.4 /dba/backup-restore
#

GET /dba/backup-restore
UR

Description

Restores a database backup.

dba:backup-restore#2

Query parameters

Name	Type	Description	Default
name	xs:string	database
backup	xs:string	backup file

Annotations (5)

`%updating`	`()`
`%rest:GET`	`()`
`%rest:path`	`('/dba/backup-restore')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('backup','{$backup}')`

2.5 /dba/backup/{$backup}
#

GET /dba/backup/{$backup}
R

Description

Downloads a database backup.

dba:backup-download#1

Url parameters

Name	Description
$backup	name of backup file (ignored)

Annotations (2)

`%rest:GET`	`()`
`%rest:path`	`('/dba/backup/{$backup}')`

2.6 /dba/database
#

POST /dba/database
R

Description

Redirects to the specified action.

dba:database-redirect#4

Form parameters

Name	Type	Description
action	xs:string	action to perform
name	xs:string	database
resources	xs:string*	resources
backups	xs:string*	backups

Annotations (6)

`%rest:POST`	`()`
`%rest:path`	`('/dba/database')`
`%rest:form-param`	`('action','{$action}')`
`%rest:form-param`	`('name','{$name}')`
`%rest:form-param`	`('resource','{$resources}')`
`%rest:form-param`	`('backup','{$backups}')`

GET /dba/database
RA

Description

Manages a single database.

dba:database#6

Output

Serialization: html

Query parameters

Name	Type	Description	Default
name	xs:string	database
resource	xs:string?	resource
sort	xs:string	table sort key
page	xs:integer	current page	1
info	xs:string?	info string
error	xs:string?	error string

Annotations (9)

`%rest:GET`	`()`
`%rest:path`	`('/dba/database')`
`%rest:query-param`	`('name','{$name}','')`
`%rest:query-param`	`('resource','{$resource}')`
`%rest:query-param`	`('sort','{$sort}','')`
`%rest:query-param`	`('page','{$page}',1)`
`%rest:query-param`	`('info','{$info}')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.7 /dba/databases
#

POST /dba/databases
R

Description

Redirects to the specified action.

dba:databases-redirect#2

Query parameters

Name	Type	Description	Default
action	xs:string	action to perform
names	xs:string*	names of selected databases

Annotations (4)

`%rest:POST`	`()`
`%rest:path`	`('/dba/databases')`
`%rest:query-param`	`('action','{$action}')`
`%rest:query-param`	`('name','{$names}')`

GET /dba/databases
RA

Description

Main page.

dba:databases#4

Output

Serialization: html

Query parameters

Name	Type	Description	Default
sort	xs:string	table sort key
page	xs:integer	current page	1
info	xs:string?	info string
error	xs:string?	error string

Annotations (7)

`%rest:GET`	`()`
`%rest:path`	`('/dba/databases')`
`%rest:query-param`	`('sort','{$sort}','')`
`%rest:query-param`	`('page','{$page}',1)`
`%rest:query-param`	`('info','{$info}')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.8 /dba/db-add
#

POST /dba/db-add
UR

Description

Adds a resource.

dba:db-add-post#5

Form parameters

Name	Type	Description
name	xs:string	database
opts	xs:string*	chosen parsing options
path	xs:string	database path
file	map(*)	uploaded file
binary	xs:string?	store as binary file

Annotations (8)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/db-add')`
`%rest:form-param`	`('name','{$name}')`
`%rest:form-param`	`('opts','{$opts}')`
`%rest:form-param`	`('path','{$path}')`
`%rest:form-param`	`('file','{$file}')`
`%rest:form-param`	`('binary','{$binary}')`

GET /dba/db-add
RA

Description

Form for adding a new resource.

dba:db-add#5

Output

Serialization: html

Query parameters

Name	Type	Description
name	xs:string	entered name
opts	xs:string*	chosen parsing options
path	xs:string?	database path
binary	xs:string?	store as binary
error	xs:string?	error string

Annotations (8)

`%rest:GET`	`()`
`%rest:path`	`('/dba/db-add')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('opts','{$opts}')`
`%rest:query-param`	`('path','{$path}')`
`%rest:query-param`	`('binary','{$binary}')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.9 /dba/db-alter
#

POST /dba/db-alter
UR

Description

Renames a database.

dba:db-alter#2

Query parameters

Name	Type	Description	Default
name	xs:string	name of database
newname	xs:string	new name

Annotations (5)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/db-alter')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('newname','{$newname}')`

GET /dba/db-alter
RA

Description

Form for renaming a database.

dba:db-alter#3

Output

Serialization: html

Query parameters

Name	Type	Description
name	xs:string	name of database
newname	xs:string?	new name
error	xs:string?	error string

Annotations (6)

`%rest:GET`	`()`
`%rest:path`	`('/dba/db-alter')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('newname','{$newname}')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.10 /dba/db-copy
#

POST /dba/db-copy
UR

Description

Copies a database.

dba:db-copy#2

Query parameters

Name	Type	Description	Default
name	xs:string	name of database
newname	xs:string	new name

Annotations (5)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/db-copy')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('newname','{$newname}')`

GET /dba/db-copy
RA

Description

Form for copying a database.

dba:db-copy#3

Output

Serialization: html

Query parameters

Name	Type	Description
name	xs:string	name of database
newname	xs:string?	new name
error	xs:string?	error string

Annotations (6)

`%rest:GET`	`()`
`%rest:path`	`('/dba/db-copy')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('newname','{$newname}')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.11 /dba/db-create
#

POST /dba/db-create
UR

Description

Creates a database.

dba:db-create#3

Query parameters

Name	Type	Description
name	xs:string	database
opts	xs:string*	database options
lang	xs:string?	language

Annotations (6)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/db-create')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('opts','{$opts}')`
`%rest:query-param`	`('lang','{$lang}')`

GET /dba/db-create
RA

Description

Form for creating a new database.

dba:db-create#4

Output

Serialization: html

Query parameters

Name	Type	Description	Default
name	xs:string?	entered name
opts	xs:string*	chosen database options
lang	xs:string?	entered language	en
error	xs:string?	error string

Annotations (7)

`%rest:GET`	`()`
`%rest:path`	`('/dba/db-create')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('opts','{$opts}')`
`%rest:query-param`	`('lang','{$lang}','en')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.12 /dba/db-delete
#

GET /dba/db-delete
UR

Description

Deletes resources.

dba:db-delete#2

Query parameters

Name	Type	Description	Default
name	xs:string	s database
resources	xs:string*

Annotations (5)

`%updating`	`()`
`%rest:GET`	`()`
`%rest:path`	`('/dba/db-delete')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('resource','{$resources}')`

2.13 /dba/db-download
#

ALL /dba/db-download
R

Description

Downloads a resource.

dba:db-download#2

Query parameters

Name	Type	Description	Default
name	xs:string	database
resource	xs:string	resource

Annotations (3)

`%rest:path`	`('/dba/db-download')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('resource','{$resource}')`

2.14 /dba/db-drop
#

GET /dba/db-drop
UR

Description

Drops databases.

dba:db-drop#1

Query parameters

Name	Type	Description	Default
names	xs:string*	names of databases

Annotations (4)

`%updating`	`()`
`%rest:GET`	`()`
`%rest:path`	`('/dba/db-drop')`
`%rest:query-param`	`('name','{$names}')`

2.15 /dba/db-optimize
#

POST /dba/db-optimize
UR

Description

Optimizes the current database.

dba:db-optimize#4

Form parameters

Name	Type	Description
name	xs:string	database
all	xs:string?	optimize all
opts	xs:string*	database options
lang	xs:string?	language

Annotations (7)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/db-optimize')`
`%rest:form-param`	`('name','{$name}')`
`%rest:form-param`	`('all','{$all}')`
`%rest:form-param`	`('opts','{$opts}')`
`%rest:form-param`	`('lang','{$lang}')`

GET /dba/db-optimize
RA

Description

Form for optimizing a database.

dba:db-optimize#5

Output

Serialization: html

Query parameters

Name	Type	Description	Default
name	xs:string	entered name
all	xs:string?	optimize all
opts	xs:string*	database options
lang	xs:string?	language	en
error	xs:string?	error string

Annotations (8)

`%rest:GET`	`()`
`%rest:path`	`('/dba/db-optimize')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('all','{$all}')`
`%rest:query-param`	`('opts','{$opts}')`
`%rest:query-param`	`('lang','{$lang}','en')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.16 /dba/db-optimize-all
#

GET /dba/db-optimize-all
UR

Description

Optimizes databases with the current settings.

dba:db-optimize-all#1

Query parameters

Name	Type	Description	Default
names	xs:string*	names of databases

Annotations (4)

`%updating`	`()`
`%rest:GET`	`()`
`%rest:path`	`('/dba/db-optimize-all')`
`%rest:query-param`	`('name','{$names}')`

2.17 /dba/db-query
#

POST /dba/db-query
RA

Description

Runs a query on a document and returns the result as string.

dba:db-query#3

Output

Serialization: text

Query parameters

Name	Type	Description	Default
name	xs:string	name of database
resource	xs:string	resource

Annotations (6)

`%rest:POST`	`('{$query}')`
`%rest:path`	`('/dba/db-query')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('resource','{$resource}')`
`%rest:single`	`()`
`%output:method`	`('text')`

2.18 /dba/db-rename
#

POST /dba/db-rename
UR

Description

Renames a database resource.

dba:db-rename#3

Query parameters

Name	Type	Description
name	xs:string	database
resource	xs:string	resource
target	xs:string	new name of resource

Annotations (6)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/db-rename')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('resource','{$resource}')`
`%rest:query-param`	`('target','{$target}')`

GET /dba/db-rename
RA

Description

Form for renaming a resource.

dba:db-rename#4

Output

Serialization: html

Query parameters

Name	Type	Description
name	xs:string	database
resource	xs:string	resource
target	xs:string?	target path
error	xs:string?	error string

Annotations (7)

`%rest:GET`	`()`
`%rest:path`	`('/dba/db-rename')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('resource','{$resource}')`
`%rest:query-param`	`('target','{$target}')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.19 /dba/db-replace
#

POST /dba/db-replace
UR

Description

Replaces a database resource.

dba:db-replace-post#3

Form parameters

Name	Type	Description
name	xs:string	database
resource	xs:string	resource
file	map(*)?	file input

Annotations (6)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/db-replace')`
`%rest:form-param`	`('name','{$name}')`
`%rest:form-param`	`('resource','{$resource}')`
`%rest:form-param`	`('file','{$file}')`

GET /dba/db-replace
RA

Description

Form for replacing a resource.

dba:db-replace#3

Output

Serialization: html

Query parameters

Name	Type	Description
name	xs:string	database
resource	xs:string	resource
error	xs:string?	error string

Annotations (6)

`%rest:GET`	`()`
`%rest:path`	`('/dba/db-replace')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('resource','{$resource}')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.20 /dba/dir-change
#

ALL /dba/dir-change
R

Description

Changes the directory.

dba:dir-change#1

Query parameters

Name	Type	Description	Default
dir	xs:string	directory

Annotations (2)

`%rest:path`	`('/dba/dir-change')`
`%rest:query-param`	`('dir','{$dir}')`

2.21 /dba/dir-create
#

POST /dba/dir-create
R

Description

Creates a directory.

dba:dir-create#1

Query parameters

Name	Type	Description	Default
name	xs:string	name of directory to create

Annotations (3)

`%rest:POST`	`()`
`%rest:path`	`('/dba/dir-create')`
`%rest:query-param`	`('name','{$name}')`

2.22 /dba/file-delete
#

GET /dba/file-delete
R

Description

Deletes files.

dba:file-delete#1

Query parameters

Name	Type	Description	Default
names	xs:string*	names of files

Annotations (3)

`%rest:GET`	`()`
`%rest:path`	`('/dba/file-delete')`
`%rest:query-param`	`('name','{$names}')`

2.23 /dba/file-start
#

GET /dba/file-start
R

Description

Starts a job.

dba:file-start#1

Query parameters

Name	Type	Description	Default
file	xs:string	file name

Annotations (3)

`%rest:GET`	`()`
`%rest:path`	`('/dba/file-start')`
`%rest:query-param`	`('file','{$file}','')`

2.24 /dba/file-stop
#

GET /dba/file-stop
R

Description

Stops jobs.

dba:file-stop#1

Query parameters

Name	Type	Description	Default
id	xs:string	s session ids

Annotations (3)

`%rest:GET`	`()`
`%rest:path`	`('/dba/file-stop')`
`%rest:query-param`	`('id','{$id}')`

2.25 /dba/file-upload
#

POST /dba/file-upload
R

Description

Upploads files.

dba:file-upload#1

Form parameters

Name	Type	Description	Default
files	map(xs:string, xs:base64Binary)	map with uploaded files

Annotations (3)

`%rest:POST`	`()`
`%rest:path`	`('/dba/file-upload')`
`%rest:form-param`	`('files','{$files}')`

2.26 /dba/file/{$name}
#

GET /dba/file/{$name}
R

Description

Downloads a file.

dba:file-download#1

Url parameters

Name	Description
$name	name of file

Annotations (2)

`%rest:GET`	`()`
`%rest:path`	`('/dba/file/{$name}')`

2.27 /dba/files
#

POST /dba/files
R

Description

Redirects to the specified action.

dba:files-redirect#2

Query parameters

Name	Type	Description	Default
action	xs:string	action to perform
names	xs:string*	names of files

Annotations (4)

`%rest:POST`	`()`
`%rest:path`	`('/dba/files')`
`%rest:query-param`	`('action','{$action}')`
`%rest:query-param`	`('name','{$names}')`

GET /dba/files
RA

Description

Files page.

dba:files#4

Output

Serialization: html

Query parameters

Name	Type	Description	Default
sort	xs:string	table sort key
error	xs:string?	error message
info	xs:string?	info message
page	xs:string		1

Annotations (7)

`%rest:GET`	`()`
`%rest:path`	`('/dba/files')`
`%rest:query-param`	`('sort','{$sort}','')`
`%rest:query-param`	`('error','{$error}')`
`%rest:query-param`	`('info','{$info}')`
`%rest:query-param`	`('page','{$page}','1')`
`%output:method`	`('html')`

2.28 /dba/job-discard
#

GET /dba/job-discard
R

Description

Discards jobs.

dba:job-discard#1

Query parameters

Name	Type	Description	Default
ids	xs:string*	job ids

Annotations (3)

`%rest:GET`	`()`
`%rest:path`	`('/dba/job-discard')`
`%rest:query-param`	`('id','{$ids}')`

2.29 /dba/job-result
#

GET /dba/job-result
R

Description

Downloads the result of a job.

dba:job-result#1

Query parameters

Name	Type	Description	Default
id	xs:string	job id

Annotations (3)

`%rest:GET`	`()`
`%rest:path`	`('/dba/job-result')`
`%rest:query-param`	`('id','{$id}','')`

2.30 /dba/job-stop
#

GET /dba/job-stop
R

Description

Stops jobs.

dba:job-stop#1

Query parameters

Name	Type	Description	Default
ids	xs:string*	job ids

Annotations (3)

`%rest:GET`	`()`
`%rest:path`	`('/dba/job-stop')`
`%rest:query-param`	`('id','{$ids}')`

2.31 /dba/jobs
#

POST /dba/jobs
R

Description

Redirects to the specified action.

dba:jobs-redirect#2

Query parameters

Name	Type	Description	Default
action	xs:string	action to perform
ids	xs:string*	ids

Annotations (4)

`%rest:POST`	`()`
`%rest:path`	`('/dba/jobs')`
`%rest:query-param`	`('action','{$action}')`
`%rest:query-param`	`('id','{$ids}')`

GET /dba/jobs
RA

Description

Jobs page.

dba:jobs#4

Output

Serialization: html

Query parameters

Name	Type	Description	Default
sort	xs:string	table sort key	duration
job	xs:string?	highlighted job
error	xs:string?	error message
info	xs:string?	info message

Annotations (7)

`%rest:GET`	`()`
`%rest:path`	`('/dba/jobs')`
`%rest:query-param`	`('sort','{$sort}','duration')`
`%rest:query-param`	`('job','{$job}')`
`%rest:query-param`	`('error','{$error}')`
`%rest:query-param`	`('info','{$info}')`
`%output:method`	`('html')`

2.32 /dba/log
#

POST /dba/log
RA

Description

Returns a log entry table.

dba:log#5

Output

Serialization: html

Query parameters

Name	Type	Description	Default
name	xs:string	name of selected log files
sort	xs:string	table sort key	time
page	xs:string	current page	1
time	xs:string?	timestamp to highlight

Annotations (10)

`%rest:POST`	`('{$input}')`
`%rest:path`	`('/dba/log')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('sort','{$sort}','time')`
`%rest:query-param`	`('page','{$page}','1')`
`%rest:query-param`	`('time','{$time}')`
`%output:method`	`('html')`
`%output:html-version`	`('5.0')`
`%output:indent`	`('no')`
`%rest:single`	`()`

2.33 /dba/log-delete
#

GET /dba/log-delete
R

Description

Deletes database logs.

dba:log-delete#1

Query parameters

Name	Type	Description	Default
names	xs:string*	names of log files

Annotations (3)

`%rest:GET`	`()`
`%rest:path`	`('/dba/log-delete')`
`%rest:query-param`	`('name','{$names}')`

2.34 /dba/log-download
#

POST /dba/log-download
R

Description

Downloads database logs.

dba:log-download#1

Query parameters

Name	Type	Description	Default
name	xs:string	name (date) of log file

Annotations (3)

`%rest:POST`	`()`
`%rest:path`	`('/dba/log-download')`
`%rest:query-param`	`('name','{$name}')`

2.35 /dba/login
#

ALL /dba/login
RA

Description

dba:login#3

Output

Serialization: html

Query parameters

Name	Type	Description
name	xs:string?	user name (optional)
error	xs:string?	error string (optional)
page	xs:string?	page to redirect to (optional)

Annotations (6)

`%rest:path`	`('/dba/login')`
`%rest:query-param`	`('_name','{$name}')`
`%rest:query-param`	`('_error','{$error}')`
`%rest:query-param`	`('_page','{$page}')`
`%output:method`	`('html')`
`%perm:allow`	`('public')`

2.36 /dba/login-check
#

POST /dba/login-check
RA

Description

Checks the user input and redirects to the main page, or back to the login page.

dba:login-check#3

Query parameters

Name	Type	Description
name	xs:string	user name
pass	xs:string	password
page	xs:string?	page to redirect to (optional)

Annotations (6)

`%rest:POST`	`()`
`%rest:path`	`('/dba/login-check')`
`%rest:query-param`	`('_name','{$name}')`
`%rest:query-param`	`('_pass','{$pass}')`
`%rest:query-param`	`('_page','{$page}')`
`%perm:allow`	`('public')`

2.37 /dba/logout
#

ALL /dba/logout
R

Description: Ends a session and redirects to the login page.
dba:logout#0

Annotations (1)

`%rest:path`	`('/dba/logout')`

2.38 /dba/logs
#

POST /dba/logs
R

Description

Redirects to the specified action.

dba:logs-redirect#2

Query parameters

Name	Type	Description	Default
action	xs:string	action to perform
names	xs:string*	names of selected log files

Annotations (4)

`%rest:POST`	`()`
`%rest:path`	`('/dba/logs')`
`%rest:query-param`	`('action','{$action}')`
`%rest:query-param`	`('name','{$names}')`

GET /dba/logs
RA

Description

Logging page.

dba:logs#7

Output

Serialization: html

Query parameters

Name	Type	Description	Default
input	xs:string?	search input
name	xs:string?	name (date) of log file
sort	xs:string	table sort key
error	xs:string?	error string
info	xs:string?	info string
page	xs:string	current page	1
time	xs:string?	timestamp to highlight

Annotations (10)

`%rest:GET`	`()`
`%rest:path`	`('/dba/logs')`
`%rest:query-param`	`('input','{$input}')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('sort','{$sort}','')`
`%rest:query-param`	`('error','{$error}')`
`%rest:query-param`	`('info','{$info}')`
`%rest:query-param`	`('page','{$page}','1')`
`%rest:query-param`	`('time','{$time}')`
`%output:method`	`('html')`

2.39 /dba/logs-jump
#

GET /dba/logs-jump
R

Description

Redirects to the URL that creates a log entry table for the specified timestamp.

dba:logs-jump#2

Query parameters

Name	Type	Description	Default
name	xs:string	name (date) of log file
time	xs:string	timestamp to be found

Annotations (4)

`%rest:GET`	`()`
`%rest:path`	`('/dba/logs-jump')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('time','{$time}')`

2.40 /dba/pattern-add
#

POST /dba/pattern-add
UR

Description

Creates a pattern.

dba:create#3

Query parameters

Name	Type	Description
name	xs:string	user name
perm	xs:string	permission
pattern	xs:string	pattern

Annotations (6)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/pattern-add')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('perm','{$perm}')`
`%rest:query-param`	`('pattern','{$pattern}')`

GET /dba/pattern-add
RA

Description

Form for adding a new pattern.

dba:pattern-add#4

Output

Serialization: html

Query parameters

Name	Type	Description	Default
name	xs:string	user name
pattern	xs:string?	entered pattern
perm	xs:string	chosen permission	write
error	xs:string?	error string

Annotations (7)

`%rest:GET`	`()`
`%rest:path`	`('/dba/pattern-add')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('pattern','{$pattern}')`
`%rest:query-param`	`('perm','{$perm}','write')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.41 /dba/pattern-drop
#

GET /dba/pattern-drop
UR

Description

Drops a pattern.

dba:pattern-drop#2

Query parameters

Name	Type	Description	Default
name	xs:string	user name
patterns	xs:string*	database patterns

Annotations (5)

`%updating`	`()`
`%rest:GET`	`()`
`%rest:path`	`('/dba/pattern-drop')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('pattern','{$patterns}')`

2.42 /dba/queries
#

GET /dba/queries
RA

Description

Queries page.

dba:queries#3

Output

Serialization: html

Query parameters

Name	Type	Description
error	xs:string?	error string
info	xs:string?	info string
file	xs:string?	file to be opened

Annotations (6)

`%rest:GET`	`()`
`%rest:path`	`('/dba/queries')`
`%rest:query-param`	`('error','{$error}')`
`%rest:query-param`	`('info','{$info}')`
`%rest:query-param`	`('file','{$file}')`
`%output:method`	`('html')`

2.43 /dba/query-close
#

POST /dba/query-close
R

Description

Closes a query file.

dba:query-save#1

Query parameters

Name	Type	Description	Default
name	xs:string	name of query file

Annotations (3)

`%rest:POST`	`()`
`%rest:path`	`('/dba/query-close')`
`%rest:query-param`	`('name','{$name}')`

2.44 /dba/query-eval
#

POST /dba/query-eval
RA

Description: Evaluates a query and returns the result.
dba:query-eval#1
Output: Serialization: text

Annotations (4)

`%rest:POST`	`('{$query}')`
`%rest:path`	`('/dba/query-eval')`
`%rest:single`	`()`
`%output:method`	`('text')`

2.45 /dba/query-open
#

ALL /dba/query-open
RA

Description

Returns the contents of a query file.

dba:query-open#1

Output

Serialization: text

Query parameters

Name	Type	Description	Default
name	xs:string	name of query file

Annotations (3)

`%rest:path`	`('/dba/query-open')`
`%rest:query-param`	`('name','{$name}')`
`%output:method`	`('text')`

2.46 /dba/query-save
#

POST /dba/query-save
RA

Description

Saves a query file and returns the list of stored queries.

dba:query-save#2

Output

Serialization: text

Query parameters

Name	Type	Description	Default
name	xs:string	name of query file

Annotations (4)

`%rest:POST`	`('{$query}')`
`%rest:path`	`('/dba/query-save')`
`%rest:query-param`	`('name','{$name}')`
`%output:method`	`('text')`

2.47 /dba/query-update
#

POST /dba/query-update
URA

Description: Runs an updating query.
dba:query-update#1
Output: Serialization: text

Annotations (5)

`%updating`	`()`
`%rest:POST`	`('{$query}')`
`%rest:path`	`('/dba/query-update')`
`%rest:single`	`()`
`%output:method`	`('text')`

2.48 /dba/resource
#

POST /dba/resource
R

Description

Redirects to the specified action.

dba:resource-redirect#3

Form parameters

Name	Type	Description
action	xs:string	action to perform
name	xs:string	name of resource
resource	xs:string*	resource

Annotations (5)

`%rest:POST`	`()`
`%rest:path`	`('/dba/resource')`
`%rest:form-param`	`('action','{$action}')`
`%rest:form-param`	`('name','{$name}')`
`%rest:form-param`	`('resource','{$resource}')`

2.49 /dba/session-kill
#

GET /dba/session-kill
R

Description

Kills web sessions.

dba:drop#1

Query parameters

Name	Type	Description	Default
ids	xs:string*	session ids (including names)

Annotations (3)

`%rest:GET`	`()`
`%rest:path`	`('/dba/session-kill')`
`%rest:query-param`	`('id','{$ids}')`

2.50 /dba/sessions
#

POST /dba/sessions
R

Description

Redirects to the specified action.

dba:users-redirect#3

Query parameters

Name	Type	Description
action	xs:string	action to perform
names	xs:string*	names of users
ids	xs:string*	ids

Annotations (5)

`%rest:POST`	`()`
`%rest:path`	`('/dba/sessions')`
`%rest:query-param`	`('action','{$action}')`
`%rest:query-param`	`('name','{$names}')`
`%rest:query-param`	`('id','{$ids}')`

GET /dba/sessions
RA

Description

Sessions page.

dba:sessions#3

Output

Serialization: html

Query parameters

Name	Type	Description	Default
sort	xs:string	table sort key	access
error	xs:string?	error message
info	xs:string?	info message

Annotations (6)

`%rest:GET`	`()`
`%rest:path`	`('/dba/sessions')`
`%rest:query-param`	`('sort','{$sort}','access')`
`%rest:query-param`	`('error','{$error}')`
`%rest:query-param`	`('info','{$info}')`
`%output:method`	`('html')`

2.51 /dba/settings
#

POST /dba/settings
R

Description: Saves the settings.
dba:settings-save#0

Annotations (2)

`%rest:POST`	`()`
`%rest:path`	`('/dba/settings')`

GET /dba/settings
RA

Description

Settings page.

dba:settings#2

Output

Serialization: html

Query parameters

Name	Type	Description	Default
error	xs:string?	error string
info	xs:string?	info string

Annotations (5)

`%rest:GET`	`()`
`%rest:path`	`('/dba/settings')`
`%rest:query-param`	`('error','{$error}')`
`%rest:query-param`	`('info','{$info}')`
`%output:method`	`('html')`

2.52 /dba/settings-gc
#

POST /dba/settings-gc
R

Description: Triggers garbage collection.
dba:settings-gc#0

Annotations (2)

`%rest:POST`	`()`
`%rest:path`	`('/dba/settings-gc')`

2.53 /dba/static/{$file=.+}
#

ALL /dba/static/{$file=.+}
RA

Description

Returns a file.

dba:file#1

Output

Serialization: basex

Url parameters

Name	Description
$file	file or unknown path

Annotations (3)

`%rest:path`	`('/dba/static/{$file=.+}')`
`%output:method`	`('basex')`
`%perm:allow`	`('public')`

2.54 /dba/user
#

POST /dba/user
R

Description

Redirects to the specified action.

dba:user-redirect#3

Form parameters

Name	Type	Description
action	xs:string	action to perform
name	xs:string	user name
patterns	xs:string*	patterns

Annotations (5)

`%rest:POST`	`()`
`%rest:path`	`('/dba/user')`
`%rest:form-param`	`('action','{$action}')`
`%rest:form-param`	`('name','{$name}')`
`%rest:form-param`	`('pattern','{$patterns}')`

GET /dba/user
RA

Description

Returns a single user page.

dba:user#6

Output

Serialization: html

Query parameters

Name	Type	Description
name	xs:string	user name
newname	xs:string?	new name
pw	xs:string?	password
perm	xs:string?	permission
error	xs:string?	error string
info	xs:string?	info string

Annotations (9)

`%rest:GET`	`()`
`%rest:path`	`('/dba/user')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('newname','{$newname}')`
`%rest:query-param`	`('pw','{$pw}')`
`%rest:query-param`	`('perm','{$perm}')`
`%rest:query-param`	`('error','{$error}')`
`%rest:query-param`	`('info','{$info}')`
`%output:method`	`('html')`

2.55 /dba/user-create
#

POST /dba/user-create
UR

Description

Creates a user.

dba:user-create#3

Query parameters

Name	Type	Description
name	xs:string	user name
pw	xs:string	password
perm	xs:string	permission

Annotations (6)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/user-create')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('pw','{$pw}')`
`%rest:query-param`	`('perm','{$perm}')`

GET /dba/user-create
RA

Description

Form for creating a new user.

dba:user-create#4

Output

Serialization: html

Query parameters

Name	Type	Description	Default
name	xs:string?	entered user name
pw	xs:string?	entered password
perm	xs:string	chosen permission	none
error	xs:string?	error string

Annotations (7)

`%rest:GET`	`()`
`%rest:path`	`('/dba/user-create')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('pw','{$pw}')`
`%rest:query-param`	`('perm','{$perm}','none')`
`%rest:query-param`	`('error','{$error}')`
`%output:method`	`('html')`

2.56 /dba/user-drop
#

GET /dba/user-drop
UR

Description

Drops users.

dba:user-drop#1

Query parameters

Name	Type	Description	Default
names	xs:string*	names of users

Annotations (4)

`%updating`	`()`
`%rest:GET`	`()`
`%rest:path`	`('/dba/user-drop')`
`%rest:query-param`	`('name','{$names}')`

2.57 /dba/user-edit
#

POST /dba/user-edit
UR

Description

Edits a user.

dba:user-edit#5

Form parameters

Name	Type	Description
name	xs:string	user name
newname	xs:string	new name
pw	xs:string	password
perm	xs:string	permission
info	xs:string

Annotations (8)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/user-edit')`
`%rest:form-param`	`('name','{$name}')`
`%rest:form-param`	`('newname','{$newname}')`
`%rest:form-param`	`('pw','{$pw}')`
`%rest:form-param`	`('perm','{$perm}')`
`%rest:form-param`	`('info','{$info}')`

2.58 /dba/users
#

POST /dba/users
R

Description

Redirects to the specified action.

dba:users-redirect#3

Query parameters

Name	Type	Description
action	xs:string	action to perform
names	xs:string*	names of users
ids	xs:string*	ids

Annotations (5)

`%rest:POST`	`()`
`%rest:path`	`('/dba/users')`
`%rest:query-param`	`('action','{$action}')`
`%rest:query-param`	`('name','{$names}')`
`%rest:query-param`	`('id','{$ids}')`

GET /dba/users
RA

Description

Returns the users page.

dba:users#3

Output

Serialization: html

Query parameters

Name	Type	Description	Default
sort	xs:string	table sort key	name
error	xs:string?	error message
info	xs:string?	info message

Annotations (6)

`%rest:GET`	`()`
`%rest:path`	`('/dba/users')`
`%rest:query-param`	`('sort','{$sort}','name')`
`%rest:query-param`	`('error','{$error}')`
`%rest:query-param`	`('info','{$info}')`
`%output:method`	`('html')`

2.59 /dba/users-info
#

POST /dba/users-info
UR

Description

Saves users information.

dba:users-info#1

Form parameters

Name	Type	Description	Default
info	xs:string	users information

Annotations (4)

`%updating`	`()`
`%rest:POST`	`()`
`%rest:path`	`('/dba/users-info')`
`%rest:form-param`	`('info','{$info}')`

2.60 /dba/{$path}
#

ALL /dba/{$path}
RA

Description

Shows a 'page not found' error.

dba:unknown#1

Output

Serialization: html

Url parameters

Name	Description
$path	path to unknown page

Annotations (2)

`%rest:path`	`('/dba/{$path}')`
`%output:method`	`('html')`

Project RestXQ documentation

Summary

Rest interface paths

2.1 /dba#

ALL /dbaR

2.2 /dba/backup-create#

GET /dba/backup-createUR

2.3 /dba/backup-drop#

GET /dba/backup-dropUR

2.4 /dba/backup-restore#

GET /dba/backup-restoreUR

2.5 /dba/backup/{$backup}#

GET /dba/backup/{$backup}R

2.6 /dba/database#

POST /dba/databaseR

GET /dba/databaseRA

2.7 /dba/databases#

POST /dba/databasesR

GET /dba/databasesRA

2.8 /dba/db-add#

POST /dba/db-addUR

GET /dba/db-addRA

2.9 /dba/db-alter#

POST /dba/db-alterUR

GET /dba/db-alterRA

2.10 /dba/db-copy#

POST /dba/db-copyUR

GET /dba/db-copyRA

2.11 /dba/db-create#

POST /dba/db-createUR

GET /dba/db-createRA

2.12 /dba/db-delete#

GET /dba/db-deleteUR

2.13 /dba/db-download#

ALL /dba/db-downloadR

2.14 /dba/db-drop#

GET /dba/db-dropUR

2.15 /dba/db-optimize#

POST /dba/db-optimizeUR

GET /dba/db-optimizeRA

2.16 /dba/db-optimize-all#

GET /dba/db-optimize-allUR

2.17 /dba/db-query#

POST /dba/db-queryRA

2.18 /dba/db-rename#

POST /dba/db-renameUR

GET /dba/db-renameRA

2.19 /dba/db-replace#

POST /dba/db-replaceUR

GET /dba/db-replaceRA

2.20 /dba/dir-change#

ALL /dba/dir-changeR

2.21 /dba/dir-create#

POST /dba/dir-createR

2.22 /dba/file-delete#

GET /dba/file-deleteR

2.23 /dba/file-start#

GET /dba/file-startR

2.24 /dba/file-stop#

GET /dba/file-stopR

2.25 /dba/file-upload#

POST /dba/file-uploadR

2.26 /dba/file/{$name}#

GET /dba/file/{$name}R

2.27 /dba/files#

POST /dba/filesR

GET /dba/filesRA

2.28 /dba/job-discard#

GET /dba/job-discardR

2.29 /dba/job-result#

GET /dba/job-resultR

2.30 /dba/job-stop#

GET /dba/job-stopR

2.31 /dba/jobs#

POST /dba/jobsR

GET /dba/jobsRA

2.32 /dba/log#

POST /dba/logRA

2.33 /dba/log-delete#

GET /dba/log-deleteR

2.1 /dba
#

ALL /dba
R

2.2 /dba/backup-create
#

GET /dba/backup-create
UR

2.3 /dba/backup-drop
#

GET /dba/backup-drop
UR

2.4 /dba/backup-restore
#

GET /dba/backup-restore
UR

2.5 /dba/backup/{$backup}
#

GET /dba/backup/{$backup}
R

2.6 /dba/database
#

POST /dba/database
R

GET /dba/database
RA

2.7 /dba/databases
#

POST /dba/databases
R

GET /dba/databases
RA

2.8 /dba/db-add
#

POST /dba/db-add
UR

GET /dba/db-add
RA

2.9 /dba/db-alter
#

POST /dba/db-alter
UR

GET /dba/db-alter
RA

2.10 /dba/db-copy
#

POST /dba/db-copy
UR

GET /dba/db-copy
RA

2.11 /dba/db-create
#

POST /dba/db-create
UR

GET /dba/db-create
RA

2.12 /dba/db-delete
#

GET /dba/db-delete
UR

2.13 /dba/db-download
#

ALL /dba/db-download
R

2.14 /dba/db-drop
#

GET /dba/db-drop
UR

2.15 /dba/db-optimize
#

POST /dba/db-optimize
UR

GET /dba/db-optimize
RA

2.16 /dba/db-optimize-all
#

GET /dba/db-optimize-all
UR

2.17 /dba/db-query
#

POST /dba/db-query
RA

2.18 /dba/db-rename
#

POST /dba/db-rename
UR

GET /dba/db-rename
RA

2.19 /dba/db-replace
#

POST /dba/db-replace
UR

GET /dba/db-replace
RA

2.20 /dba/dir-change
#

ALL /dba/dir-change
R

2.21 /dba/dir-create
#

POST /dba/dir-create
R

2.22 /dba/file-delete
#

GET /dba/file-delete
R

2.23 /dba/file-start
#

GET /dba/file-start
R

2.24 /dba/file-stop
#

GET /dba/file-stop
R

2.25 /dba/file-upload
#

POST /dba/file-upload
R

2.26 /dba/file/{$name}
#

GET /dba/file/{$name}
R

2.27 /dba/files
#

POST /dba/files
R

GET /dba/files
RA

2.28 /dba/job-discard
#

GET /dba/job-discard
R

2.29 /dba/job-result
#

GET /dba/job-result
R

2.30 /dba/job-stop
#

GET /dba/job-stop
R

2.31 /dba/jobs
#

POST /dba/jobs
R

GET /dba/jobs
RA

2.32 /dba/log
#

POST /dba/log
RA

2.33 /dba/log-delete
#

GET /dba/log-delete
R

2.34 /dba/log-download
#

POST /dba/log-download
R

2.35 /dba/login
#