Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
|}
==GET==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|GET [option]}}
|-
| '''XML Syntax'''
|<code><get (option='...')/></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Returns the current value of the [[Options|Option]] specified via {{Code|option}}. Global options can only be requested by users with ADMIN permissions.
|-
| '''Errors'''
|The command fails if the specified option is unknown.
* Added: {{Command|DIR}}
→GET
|}
==RETRIEVEGET== {{Announce|Introduced with Version 10.}} The old {{Code|GET}} command has been renamed to {{Command|SHOW OPTIONS}}.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RETRIEVE GET [path]}}
|-
| '''XML Syntax'''
|<code><retrieve get path='...'/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Retrieves a [[Binary Data|raw file]] an XML document from the opened database at the specified {{Code|path}}.
|-
| '''Errors'''
|The command fails if no database is opened, or if the source path is invalid .|} ==BINARY GET== {{Announce|Updated with Version 10:}} Renamed (before: {{Code|RETRIEVE}}). {| width='100%'|-|width='130'|'''Syntax'''|{{Code|BINARY GET [path]}}|-| '''XML Syntax''' |<code><binary-get path='...'/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Retrieves a [[Binary Data|binary resource]] from the opened database at the specified {{Code|path}}.|-| '''Errors'''|The command fails if no database is opened or if the data cannot not be retrieved for some other reasonsource path is invalid.
|}
|Adds a file, directory or XML string specified by {{Code|input}} to the currently opened database at the specified {{Code|path}}:
* {{Code|input}} may either be a single XML document, a directory, a remote URL or a plain XML string.
* A document with the same path may occur than once in a database. If this is unwanted, the {{Command|REPLACEPUT}} command can be used.
* If a file is too large to be added in one go, its data structures will be cached to disk first. Caching can be enforced by turning the {{Option|ADDCACHE}} option on.
If files are to be added to an empty database, it is usually faster to use the {{Command|CREATE DB}} command and specify the initial input as argument.
|}
==REPLACEPUT== {{Announce|Updated with Version 10:}} Renamed (before: {{Code|REPLACE}}).
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|REPLACE PUT [path] [input]}}
|-
| '''XML Syntax'''
|<code><replace put path='...'>[input]</replaceput></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Replaces Adds or replaces resources in the currently opened database, addressed by {{Code|path}}, with the file, directory or XML string specified by {{Code|input}}, or adds new documents if no resource exists at the specified path.
|-
| '''Errors'''
| '''Examples'''
|
* {{Code|REPLACE PUT one.xml input.xml}}<br/>replaces the document {{Code|one.xml}} with the contents of the file {{Code|input.xml}}.* {{Code|REPLACE PUT top.xml <xml/>}}<br/>replaces the document {{Code|top.xml}} with the XML document {{Code|<xml/>}}.
|}
==STOREBINARY PUT== {{Announce|Updated with Version 10:}} Renamed (before: {{Code|STORE}}).
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|STORE BINARY PUT (TO [path]) [input]}}
|-
| '''XML Syntax'''
|<code><store binary-put (path='...')>[input]</store></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Stores a [[Binary Data|raw filebinary resource]] specified via {{Code|input}} in the opened database to the specified {{Code|path}}:
* The input may either be a file reference, a remote URL, or a plain string.
* If the path denotes a directory, it needs to be suffixed with a slash ({{Code|/}}).
=Administration=
==SHOW OPTIONS==
{{Announce|Updated with Version 10:}} Renamed (before: {{Code|GET}}).
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW OPTIONS [name]}}
|-
| '''XML Syntax'''
|<code><show-options (name='...')/></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Returns the current value of all [[Options]], or a single options with the specified {{Code|name}}. Global options can only be requested by users with ADMIN permissions.
|-
| '''Errors'''
|The command fails if the specified option is unknown.
|}
==SHOW SESSIONS==
|
* <code>EXECUTE "<commands><create-db name='db1'/><create-db name='db2'/></commands>"</code><br/>Two databases will be created in a single transaction.
|}
;Version 10
* Added: [[#Backups|Backups]]: Support for general data ([[User Management|registered users]], [[Jobs Module#Services|scheduled services]] and [[Store Module|key-value stores]]).
* Added: {{Command|DIR}}, {{Command|GET}}
* Updated: {{Command|SHOW OPTIONS}}: Renamed (before: {{Code|GET}}).
* Updated: {{Command|BINARY GET}}: Renamed (before: {{Code|RETRIEVE}}).
* Updated: {{Command|BINARY PUT}}: Renamed (before: {{Code|STORE}}).
* Updated: {{Command|PUT}}: Renamed (before: {{Code|REPLACE}}).
* Updated: {{Command|CREATE BACKUP}}: Support for comments.
* Updated: {{Command|OPEN}}: {{Code|path}} argument dropped.
;Version 7.2.1
* Updated: permissions for {{CommandCode|GET}} and {{Command|SET}} changed from {{Code|READ}} to {{Code|NONE}}.
;Version 7.2
