Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
Multiple On command line, multiple commands can be written down in a single line – (separated by semicolons – or stored as ). You can also put them into a command script. : Database commands in both string and XML syntax can be placed in a text file and stored as file with the BaseX command script suffix {{Code|.bxs}}. If the path to a script file is passed on to BaseX on command-line, or if it is opened in the GUI editor, it will automatically be recognized and evaluated as such.
ADD input.xml
This is why database commands can also be specified in The XMLsyntax provides more flexibility here.Multiple commands can be enclosed by a {{Code|<commands/>}} root element. Some commands, such as {{Command|ADD}}, allow you to directly embed XML documents. If you want to embed XML in XQuery expressions, entities should be encoded, or the {{Code|CDATA}} syntax should be used:
<add>input.xml</add>
==Command Scripts==In all commands, the {{Code|DB}} keyword can be replaced by {{Code|DATABASE}}.
Multiple commands can be written down in a single line – separated by semicolons – or stored as command script. =Database commands in both string and XML syntax can be placed in a text file and stored as file with the BaseX command script suffix {{Code|.bxs}}. If the path to a script file is passed on to BaseX on command-line, or if it is opened in the GUI editor, it will automatically be recognized and evaluated as such.Operations=
Lines starting with {| width='100%'|-|width='130'|'''Syntax'''|{{Code|CREATE DB [name] ([input])}}|-| '''XML Syntax''' |<code>#<create-db name='...'>([input])</create-db></code> are interpreted as comments <br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Creates a new database with the specified {{Code|name}} and, optionally, an initial {{Code|input}}, and are skippedopens it. An existing database will be overwritten. <br />The following script creates input can be a file or directory path to XML documents, a remote URL, or a string containing XML:* {{Code|name}} must be a [[#Valid Names|valid database name]]* database creation can be controlled by setting [[Options#Create Options|Create Options]]|-| '''Errors'''|The command fails if a databasewith the specified name is currently used by another process, adds two if one of the documents to be added is not well-formed or if it and performs a query:cannot be parsed for some other reason.|-| '''Examples'''|* {{Code|CREATE DB input}}<pre class="brushbr/>creates an empty database {{Code|input}}.* {{Code|CREATE DB xmark http://files.basex.org/xml/xmark.xml"}}<br/>creates the database {{Code|xmark}}, containing a single initial document called {{Code|xmark.xml}}.* {{Code|CREATE DATABASE coll /path/to/input}}<br/>creates the database {{Code|coll}} with all documents found in the {{Code|input}} directory.* {{Code|SET INTPARSE false; CREATE DB testADD input input.xmlADD TO embedded}}<br/>creates a database {{Code|input}} with {{Code|input.xml }} as initial document, which will be parsed with Java's [[Parsers#XML Parsers|default XML parser]].* <code><create-db name='simple'><roothello>embeddedUniverse</roothello># run queryXQUERY count(</create-db></text())code><br/>creates a database named {{Code|simple}} with an initial document {{Code|<hello>Universe</prehello>}}. ===XML Syntax===|}
The string syntax is limited when XML snippets need to be embedded in a command,or when complex queries are to be specified.==OPEN==
This is why database commands can also be specified in XML.{| width='100%'|-|width='130'|'''Syntax'''Multiple commands can be enclosed by a |{{Code|<commands/>OPEN [name] ([path])}} root element:|-<pre class="brush:xml">| '''XML Syntax''' |<commandscode> <create-db open name='test...'/> <add>input.xml</add> <add (path='embedded.xml..'><root>embedded<)/root></addcode> <xquery>count(//text())</xquery>|-| '''Permission'''|''READ''|-| '''Summary'''|Opens the database specified by {{Code|name}}. The documents to be opened can be specified by the [path] argument.|-| '''Errors'''</commands>|The command fails if the specified database does not exist, is currently being updated by another process or cannot be opened for some other reason.</pre>|}
Some commands support the glob syntax to address more than one database or user. Question marks and asterisks can be used to match one or more characters, and commas can be used to separate multiple patterns. Some examples:{| width='100%'|-|width='130'|'''Syntax'''* |{{Code|AB?CHECK [input]}} addresses all names with the characters |-| '''XML Syntax''' |<code><check input='...'/></code><br/>|-| '''Permission'''|''READ/CREATE''|-| '''Summary'''|This convenience command combines {{CodeCommand|ABOPEN}} and one more character.* {{CodeCommand|*ABCREATE DB}} addresses all names ending : if a database with the characters name {{Code|ABinput}}exists, it is opened.* {{Code|X*Otherwise,Y*a new database is created; if the specified input points to an existing resource,Z*}} addresses all names starting with the characters {{Codeit is stored as initial content.|X}}, {{Code-|Y}}, or {{Code'''Errors'''|Z}}The command fails if the addressed database could neither be opened nor created. ==Valid Names==|}
Database and user names follow the same naming constraints: Names are restricted to ASCII characters. They must at least have one character, and they may contain letters, numbers and any of the special characters <code>!#$%&'()+-=@[]^_`{}~</code>. The following characters are reserved for other features: * <code>,?*</code>: [[#Glob Syntax|glob syntax]]* <code>;</code>: Separator for multiple database commands on the [[Command-Line Options|command line]]* <code>\/</code>: Directory path separators* <code>.</code>: hidden folders (e.g. the [[Logging|.logs directory]])* <code>:*?\"<>|}</code>: invalid filename characters on Windows ==Aliases== In all commands, the {{Code|DB}} keyword can be replaced by {{Code|DATABASE}}. =Database Operations= ==CREATE DBCLOSE==
| '''Errors'''|The command fails if the specified database does not exist, or if it could not be zipped for some other reason.|-| '''Examples'''
* Updated: {{Command|KILL}} (killing sessions by specifying IP:port)
;Version 7.0
* Added: {{Command|FLUSH}}, {{Command|RETRIEVE}}, {{Command|STORE}}.
* Updated: {{Command|ADD}}: simplified arguments.
-Line Options|command line]]
* <code>\/</code>: Directory path separators
* <code>.</code>: hidden folders (e.g. the [[Logging|.logs directory]])
* <code>:*?\"<>|}</code>: invalid filename characters on Windows
==Aliases==
In all commands, the {{Code|DB}} keyword can be replaced by {{Code|DATABASE}}.
=Database Operations=
==CREATE DB==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CREATE DB [name] ([input])}}
|-
| '''XML Syntax'''
|<code><create-db name='...'>([input])</create-db></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Creates a new database with the specified {{Code|name}} and, optionally, an initial {{Code|input}}, and opens it. An existing database will be overwritten.<br />The input may either be a reference to a single XML document, a directory, a remote URL, or a string containing XML:
* {{Code|name}} must be a [[#Valid Names|valid database name]]
* database creation can be controlled by setting [[Options#Create Options|Create Options]]
|-
| '''Errors'''
|The command fails if a database with the specified name is currently used by another process, if one of the documents to be added is not well-formed or if it cannot be parsed for some other reason.
|-
| '''Examples'''
|
* {{Code|CREATE DB input}}<br/>creates an empty database {{Code|input}}.
* {{Code|CREATE DB xmark http://files.basex.org/xml/xmark.xml}}<br/>creates the database {{Code|xmark}}, containing a single initial document called {{Code|xmark.xml}}.
* {{Code|CREATE DATABASE coll /path/to/input}}<br/>creates the database {{Code|coll}} with all documents found in the {{Code|input}} directory.
* {{Code|SET INTPARSE false; CREATE DB input input.xml}}<br/>creates a database {{Code|input}} with {{Code|input.xml}} as initial document, which will be parsed with Java's [[Parsers#XML Parsers|default XML parser]].
* <code><create-db name='simple'><hello>Universe</hello></create-db></code><br/>creates a database named {{Code|simple}} with an initial document {{Code|<hello>Universe</hello>}}.
|}
==OPEN==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|OPEN [name] ([path])}}
|-
| '''XML Syntax'''
|<code><open name='...' (path='...')/></code>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Opens the database specified by {{Code|name}}. The documents to be opened can be specified by the [path] argument.
|-
| '''Errors'''
|The command fails if the specified database does not exist, is currently being updated by another process or cannot be opened for some other reason.
|}
==CHECK==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CHECK [input]}}
|-
| '''XML Syntax'''
|<code><check input='...'/></code><br/>
|-
| '''Permission'''
|''READ/CREATE''
|-
| '''Summary'''
|This convenience command combines {{Command|OPEN}} and {{Command|CREATE DB}}: if a database with the name {{Code|input}} exists, it is opened. Otherwise, a new database is created; if the specified input points to an existing resource, it is stored as initial content.
|-
| '''Errors'''
|The command fails if the addressed database could neither be opened nor created.
|}
==CLOSE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CLOSE }}
|-
| '''XML Syntax'''
|<code><close/></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Closes the currently opened database.
|-
| '''Errors'''
|The command fails if the database files could not be closed for some reason.
|}
==EXPORT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|EXPORT [path]}}
|-
| '''XML Syntax'''
|<code><export path='...'/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Exports all documents in the database to the specified file {{Code|path}}, using the serializer options specified by the <code>[[Options#EXPORTER|EXPORTER]]</code> option.
|-
| '''Errors'''
|The command fails if no database is opened, if the target path points to a file or is invalid, if the serialization parameters are invalid, or if the documents cannot be serialized for some other reason.
|}
==CREATE INDEX==
{{Mark|Updated with Version 8.4:}} Token index added.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CREATE INDEX [TEXT|ATTRIBUTE|TOKEN|FULLTEXT]}}
|-
| '''XML Syntax'''
|<code><create-index type='text|attribute|token|fulltext'/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Creates the specified [[Indexes#Value Indexes|Value Index]]. The current [[Options#Indexing|Index Options]] will be considered when creating the index.
|-
| '''Errors'''
|The command fails if no database is opened, if the specified index is unknown, or if indexing fails for some other reason.
|}
==DROP INDEX==
{{Mark|Updated with Version 8.4:}} Token index added.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP INDEX [TEXT|ATTRIBUTE|TOKEN|FULLTEXT]}}
|-
| '''XML Syntax'''
|<code><drop-index type='text|attribute|token|fulltext'/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Drops the specified [[Indexes#Value Indexes|Value Index]].
|-
| '''Errors'''
|The command fails if no database is opened, if the specified index is unknown, or if it could not be deleted for some other reason.
|}
=Administration=
==ALTER DB==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ALTER DB [name] [newname]}}
|-
| '''XML Syntax'''
|<code><alter-db name='...' newname='...'/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Renames the database specified by {{Code|name}} to {{Code|newname}}. {{Code|newname}} must be a [[#Valid Names|valid database name]].
|-
| '''Errors'''
|The command fails if the target database already exists, if the source database does not exist or is currently locked, or if it could not be renamed for some other reason.
|-
| '''Examples'''
|
* {{Code|ALTER DB db tempdb}}<br/>renames the database {{Code|db}} into {{Code|tempdb}}.
|}
==DROP DB==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP DB [name]}}
|-
| '''XML Syntax'''
|<code><drop-db name='...'/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Drops the database with the specified {{Code|name}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
|-
| '''Errors'''
|The command fails if the specified database does not exist or is currently locked, or if the database could not be deleted for some other reason.
|}
==CREATE BACKUP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CREATE BACKUP [name]}}
|-
| '''XML Syntax'''
|<code><create-backup name='...'/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Creates a zipped backup of the database specified by {{Code|name}}. The backup file will be suffixed with the current timestamp and stored in the database directory. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
|-
| '''Errors'''
|The command fails if the specified database does not exist, or if it could not be zipped for some other reason.
|-
| '''Examples'''
|
* {{Code|BACKUP db}}<br/>creates a zip archive of the database {{Code|db}} (e.g. {{Code|db-2014-04-01-12-27-28.zip}}) in the [[Configuration#Database_Directory|database directory]].
|}
==RESTORE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RESTORE [name]}}
|-
| '''XML Syntax'''
|<code><restore name='...'/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Restores a database with the specified {{Code|name}}. The name may include the timestamp of the backup file.
|-
| '''Errors'''
|The command fails if the specified backup does not exist, if the database to be restored is currently locked, or if it could not be restored for some other reason.
|}
==INSPECT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INSPECT}}
|-
| '''XML Syntax'''
|<code><inspect/></code>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Performs some integrity checks on the opened database and returns a brief summary.
|}
==DROP BACKUP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP BACKUP [name]}}
|-
| '''XML Syntax'''
|<code><drop-backup name='...'/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Drops all backups of the database with the specified {{Code|name}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
|-
| '''Examples'''
|
* {{Code|DROP BACKUP abc*}}<br/>deletes the backups of all databases starting with the characters {{Code|abc}}.
|}
==SHOW BACKUPS==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW BACKUPS}}
|-
| '''XML Syntax'''
|<code><show-backups/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Shows all database backups.
|}
==COPY==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|COPY [name] [newname]}}
|-
| '''XML Syntax'''
|<code><copy name='...' newname='...'/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Creates a copy of the database specified by {{Code|name}}. {{Code|newname}} must be a [[#Valid Names|valid database name]].
|-
| '''Errors'''
|The command fails if the target database already exists, or if the source database does not exist.
|}
==INFO DB==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO DB}}
|-
| '''XML Syntax'''
|<code><info-db/></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Shows information on the currently opened database.
|-
| '''Errors'''
|The command fails if no database is opened.
|}
==INFO INDEX==
{{Mark|Updated with Version 8.4:}} Token index added; index {{Code|TAG}} renamed to {{Code|ELEMNAME}}; index {{Code|ATTNAME}} renamed to {{Code|ATTRNAME}}.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO INDEX ([ELEMNAME|ATTRNAME|PATH|TEXT|ATTRIBUTE|TOKEN|FULLTEXT])}}
|-
| '''XML Syntax'''
|<code><info-index type='elemname|attrname|path|text|attribute|token|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==
{{Mark|Updated with Version 8.4}}: Query argument removed, start/end added to XML syntax.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO STORAGE [start end]}}
|-
| '''XML Syntax'''
|<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.
|}
= Querying =
==LIST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|LIST ([name] ([path]))}}
|-
| '''XML Syntax'''
|<code><list (name='...' (path='...'))/></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Lists all available databases. If {{Code|name}} is specified, the resources of a database are listed. The output can be further restricted to the resources matching the specified {{Code|path}}.<br/>If database resources are listed, the size is either the number of nodes (for XML resources) or the number of bytes (for binary resources).
|-
| '''Errors'''
|The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason.
|}
==XQUERY==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|XQUERY [query]}}
|-
| '''XML Syntax'''
|<code><xquery>[query]</xquery></code><br/>
|-
| '''Permission'''
|''depends on query''
|-
| '''Summary'''
|Runs the specified {{Code|query}} and prints the result.
|-
| '''Errors'''
|The command fails if the specified query is invalid.
|-
| '''Examples'''
|
* <code>XQUERY 1 to 10</code><br/>returns the sequence {{Code|(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)}}.
* <code>SET RUNS 10; XQUERY 1 to 10</code><br/>returns the results after having run the query 10 times.
* <code>SET XMLPLAN true; XQUERY 1 to 10</code><br/>returns the result and prints the query plan as XML.
|}
==RETRIEVE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RETRIEVE [path]}}
|-
| '''XML Syntax'''
|<code><retrieve path='...'/></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Retrieves a [[Binary Data|raw file]] from the opened database at the specified {{Code|path}}.
|-
| '''Errors'''
|The command fails if no database is opened, if the source path is invalid or if the data cannot not be retrieved for some other reason.
|}
==FIND==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|FIND [query]}}
|-
| '''XML Syntax'''
|<code><find>[query]</find></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Builds and runs a query for the specified {{Code|query}} terms. Keywords can be enclosed in quotes to look for phrases. The following modifiers can be used to further limit search:
<code>=</code> looks for exact text nodes<br/><code>~</code> looks for approximate hits<br/><code>@=</code> looks for exact attribute values<br/><code>@</code> looks for attributes
|-
| '''Errors'''
|The command fails if no database is opened.
|}
==TEST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|TEST [path]}}
|-
| '''XML Syntax'''
|<code><test path='...'/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Runs all [[Unit Module|XQUnit tests]] in the specified {{Code|path}}. The path can point to a single file or a directory.<br/>Unit testing can also be triggered via {{Code|-t}} on [[Command-Line Options#BaseX Standalone|command line]].
|-
| '''Errors'''
|The command fails if at least one test fails.
|-
| '''Examples'''
|
* {{Code|TEST project/tests}}<br/>runs all tests in the directory {{Code|project/tests}}.
|}
==REPO INSTALL==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|REPO INSTALL [path]}}
|-
| '''XML Syntax'''
|<code><repo-install path='...'/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
| Installs the package with path {{Code|path}}.
|-
| '''Errors'''
| The command fails in the following cases:
* The package to be installed is not a xar file.
* The package to be installed does not exist or is already installed.
* The package descriptor is with invalid syntax.
* The package to be installed depends on a package which is not installed.
* The package is not supported by the current version of BaseX.
* A component of the package is already installed as part of another package.
|}
==REPO LIST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|REPO LIST}}
|-
| '''XML Syntax'''
|<code><repo-list/></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
| Lists all installed packages.
|}
==REPO DELETE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|REPO DELETE [name]}}
|-
| '''XML Syntax'''
|<code><repo-delete name='...'/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
| Deletes the package with name {{Code|name}}, optionally followed by a version.
|-
| '''Errors'''
| The command fails if the package to be deleted participates in a dependency.
|}
=Updates=
==ADD==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ADD (TO [path]) [input]}}
|-
| '''XML Syntax'''
|<code><add (path='...')>[input]</add></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|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, {{Command|REPLACE}} 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 [[Options#ADDCACHE|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.
|-
| '''Errors'''
|The command fails if no database is opened, if one of the documents to be added is not well-formed, or if it could not be parsed for some other reason.
|-
| '''Examples'''
|
* {{Code|ADD input.xml}}<br/>adds the file {{Code|input.xml}} to the database.
* {{Code|ADD TO temp/one.xml input.xml}}<br/>adds {{Code|input.xml}} to the database and moves it to {{Code|temp/one.xml}}.
* {{Code|ADD TO target/ xmldir}}<br/>adds all files from the {{Code|xmldir}} directory to the database in the {{Code|target}} path.
|}
==DELETE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DELETE [path]}}
|-
| '''XML Syntax'''
|<code><delete path='...'/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Deletes all documents from the currently opened database that start with the specified {{Code|path}}.
|-
| '''Errors'''
|The command fails if no database is opened.
|}
==RENAME==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RENAME [path] [newpath]}}
|-
| '''XML Syntax'''
|<code><rename path='...' newpath='...'/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Renames all document paths in the currently opened database that start with the specified {{Code|path}}. The command may be used to either rename single documents or directories.
|-
| '''Errors'''
|The command fails if no database is opened, or if the target path is empty.
|-
| '''Examples'''
|
* {{Code|RENAME one.xml two.xml}}<br/>renames the document {{Code|one.xml}} to {{Code|two.xml}}.
* {{Code|RENAME / TOP}}<br/>moves all documents to a {{Code|TOP}} root directory.
|}
==REPLACE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|REPLACE [path] [input]}}
|-
| '''XML Syntax'''
|<code><replace path='...'>[input]</replace></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Replaces a document in the currently opened database, addressed by {{Code|path}}, with the file or XML string specified by {{Code|input}}, or adds a new document if the resource does not exist yet.
|-
| '''Errors'''
|The command fails if no database is opened, if the specified path points to a database directory, or if the input is not found.
|-
| '''Examples'''
|
* {{Code|REPLACE one.xml input.xml}}<br/>replaces the document {{Code|one.xml}} with the contents of the file {{Code|input.xml}}.
* {{Code|REPLACE top.xml <xml/>}}<br/>replaces the document {{Code|top.xml}} with the document {{Code|<xml/>}}.
|}
==STORE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|STORE (TO [path]) [input]}}
|-
| '''XML Syntax'''
|<code><store (path='...')>[input]</store></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Stores a [[Binary Data|raw file]] in the opened database to the specified {{Code|path}}. {{Code|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|/}}).
|-
| '''Errors'''
|The command fails if no database is opened, if the specified resource is not found, if the target path is invalid or if the data cannot not be written for some other reason.
|}
==OPTIMIZE==
{{Mark|Updated with Version 8.4}}: adopt original index options.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|OPTIMIZE (ALL)}}
|-
| '''XML Syntax'''
|<code><optimize/></code><br/><code><optimize-all/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Optimizes the index structures, meta data and statistics of the currently opened database:
* If {{Code|ALL}} is specified, all database structures are completely reconstructed. The database size will be reduced, and all orphaned data will be deleted.
* Without {{Code|ALL}}, only the outdated index structures and database statistics will be updated. If the database is completely up-to-date, nothing will be done.
* Database options will be adopted from the original database. Only <code>[[Options#AUTOOPTIMIZE|AUTOOPTIMIZE]]</code> and (if {{Code|ALL}} is specified) <code>[[Options#UPDINDEX|UPDINDEX]]</code> will be adopted from the current options.
|-
| '''Errors'''
|The command fails if no database is opened, or if the currently opened database is a main-memory instance.
|}
==FLUSH==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|FLUSH}}
|-
| '''XML Syntax'''
|<code><flush/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Explicitly flushes the buffers of the currently opened database to disk. This command is applied if [[Options#AUTOFLUSH|AUTOFLUSH]] has been set to {{Code|false}}.
|-
| '''Errors'''
|The command fails if no database is opened.
|}
=Server 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.
|}
==SHOW USERS==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW USERS (ON [database])}}
|-
| '''XML Syntax'''
|<code><show-users (database='...')/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Shows all users that are registered in the database. If a {{Code|database}} is specified, all user will be shown for which a pattern was specified that matches the database name.
|-
| '''Errors'''
|The command fails if the optional database could not be opened.
|}
==KILL==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|KILL [target]}}
|-
| '''XML Syntax'''
|<code><kill target='...'/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Kills sessions of a user or an IP:port combination, specified by {{Code|target}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one user.
|-
| '''Errors'''
|The command fails if a user tried to kill his/her own session.
|}
=User Management=
==CREATE USER==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CREATE USER [name] ([password])}}
|-
| '''XML Syntax'''
|<code><create-user name='...'>([password])</create-user></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Creates a user with the specified {{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.
|}
==ALTER USER==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ALTER USER [name] ([newname])}}
|-
| '''XML Syntax'''
|<code><alter-user name='...' newname='...'/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Renames the user with the specified {{Code|name}} to {{Code|newname}}.
|-
| '''Errors'''
|The command fails if the specified user does not exist, or if the new user already exists.
|}
==ALTER PASSWORD==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ALTER PASSWORD [name] ([password])}}
|-
| '''XML Syntax'''
|<code><alter-password name='...'>([password])</alter-password></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Alters the {{Code|password}} of the user with the specified {{Code|name}}. If no password is specified, it is requested via the chosen frontend (GUI or bash).
|-
| '''Errors'''
|The command fails if the specified user does not exist.
|}
==DROP USER==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP USER [name] (ON [pattern])}}:
|-
| '''XML Syntax'''
|<code><drop-user name='...' (pattern='...')/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Drops the 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 pattern will be removed.
|-
| '''Errors'''
|The command fails if {{Code|admin}} is specified as user name, or if the specified user does not exist or is currently logged in.
|}
==GRANT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|GRANT [NONE|READ|WRITE|CREATE|ADMIN] (ON [pattern]) TO [user]}}
|-
| '''XML Syntax'''
|<code><grant name='...' permission='none|read|write|create|admin' (pattern='...')/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Grants the specified [[User_Management|permission]] to the specified {{Code|user}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one user. If a glob {{Code|pattern}} is specified, the permission will be applied to all databases that match this pattern.
|-
| '''Errors'''
|The command fails if {{Code|admin}} is specified as user name 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*}}.
|}
==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 requested via the chosen frontend (GUI or bash).
|}
=General Commands=
==RUN==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RUN [file]}}
|-
| '''XML Syntax'''
|<code><run file='...'/></code>
|-
| '''Permission'''
|''depends on input''
|-
| '''Summary'''
|Evaluates the contents of {{Code|file}} as XQuery expression. If the file ends with the suffix {{Code|.bxs}}, the file content will be evaluated as [[#Basics|command script]]. This command can be used to run several commands in a single transaction.
|-
| '''Errors'''
|The command fails if the specified file does not exist, or if the retrieved input is invalid. It will be canceled as soon as one of the executed commands fails.
|-
| '''Examples'''
|
* <code>RUN query.xq</code><br/>will evaluated the specified file as XQuery expression
* <code>RUN commands.bxs</code><br/>will evaluated the specified file as command script
|}
==EXECUTE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|EXECUTE [input]}}
|-
| '''XML Syntax'''
|<code><execute>[input]</execute></code>
|-
| '''Permission'''
|''depends on input''
|-
| '''Summary'''
|Evaluates the specified {{Code|input}} as [[#Basics|command script]]. This command can be used to run several commands in a single transaction.
|-
| '''Errors'''
|The command fails if the syntax of the specified input is invalid. It will be canceled as soon as one of the executed commands fails.
|-
| '''Examples'''
|
* <code>EXECUTE "create db db1; create db db2"</code><br/>
* <code>EXECUTE "<commands><create-db name='db1'/><create-db name='db2'/></commands>"</code><br/>both commands will create two databases {{Code|db1}} and {{Code|db2}} in a single transaction.
|}
==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.
|}
==SET==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SET [option] ([value])}}
|-
| '''XML Syntax'''
|<code><set option='...'>([value])</set></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Sets the [[Options|Option]] specified by {{Code|option}} to a new {{Code|value}}. Only local options can be modified. If no value is specified, and if the value is boolean, it will be inverted.
|-
| '''Errors'''
|The command fails if the specified option is unknown or if the specified value is invalid.
|}
==INFO==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO}}
|-
| '''XML Syntax'''
|<code><info/></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Shows global information.
|}
==HELP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|HELP ([command])}}
|-
| '''XML Syntax'''
|<code><help>([command])</help></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|If {{Code|command}} is specified, information on the specific command is printed; otherwise, all commands are listed.
|-
| '''Errors'''
|The command fails if the specified command is unknown.
|}
==EXIT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|EXIT }}
|-
| '''XML Syntax'''
|<code><exit/></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Exits the console mode.
|}
==QUIT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|QUIT }}
|-
| '''XML Syntax'''
|<code><quit/></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Exits the console mode (alias of {{Command|EXIT}}).
|}
=Changelog=
;Version 8.4
* Updated: {{Command|CREATE INDEX}}, {{Command|DROP INDEX}}, {{Command|INFO INDEX}}: token index added
* Updated: {{Command|INFO STORAGE}}: Query argument removed, start/end added to XML syntax.
* Updated: {{Command|INFO INDEX}}: Token index added; index {{Code|TAG}} renamed to {{Code|ELEMNAME}}; index {{Code|ATTNAME}} renamed to {{Code|ATTRNAME}}
* Updated: {{Command|OPTIMIZE}}: adopt original index options
;Version 8.2
* Removed: {{Code|CREATE EVENT}}, {{Code|DROP EVENT}} and {{Code|SHOW EVENTS}} command
;Version 8.0
* Updated: commands for [[#User Management|User Management]]
* Updated: {{Command|OPEN}}: path argument added
* Removed: {{Code|CS}} command
* Added: {{Command|QUIT}}
;Version 7.9
* Added: {{Command|TEST}} runs XQUnit tests.
;Version 7.7
* Updated: syntax of [[#Valid Names|valid names]].
;Version 7.5
* Added: {{Command|EXECUTE}} executes a command script.
* Added: {{Command|INSPECT}} performs integrity checks.
* Added: automatic detection of [[#Basics|Command Scripts]].
* Removed: {{Code|SHOW DATABASES}}; information is also returned by {{Command|SHOW SESSIONS}}.
* Removed: {{Command|OPEN}}: path argument.
;Version 7.3
* Added: [[#XML Syntax|XML Syntax]] added.
* Updated: {{Command|CHECK}} can now be used to create empty databases.
* Updated: Names and paths in {{Command|OPEN}} and {{Command|LIST}} are now specified as separate arguments.
;Version 7.2.1
* Updated: permissions for {{Command|GET}} and {{Command|SET}} changed from {{Code|READ}} to {{Code|NONE}}.
;Version 7.2
* Updated: {{Command|CREATE INDEX}}, {{Command|DROP INDEX}} ({{Code|PATH}} argument removed. Path summary is always available now and updated with [[#OPTIMIZE|OPTIMIZE]]).
* Updated: permissions for {{Command|REPO DELETE}}, {{Command|REPO INSTALL}} and {{Command|REPO LIST}}.
;Version 7.1
→SHOW USERS
This article is part of the [[Getting Started]] Section.
It lists all database commands supported by BaseX.
Commands can e.g. be executed from the [[Command-Line Options#BaseX_Standalone|Command Line]],as part of [[#Command Scripts|Scripts]], via the [[Clients]], [[REST]], the input field in the [[GUI]], and other ways. If the GUI is used, all commands that are triggered by the GUI itselfwill show up in the [[GUI#Visualizations|Info View]].The [[User_Management|Permission]] fields indicate whichrights are required by a user to perform a command in the client/server architecture.
=Basics=
==Command Scripts==
===String Syntax===
Lines starting with <code>#</code> are interpreted as comments and are skipped. The With the following script creates , a databaseis created, adds two documents are added to it , and performs a queryis performed:
<pre class="brush:xml">
CREATE DB test
ADD TO embedded.xml <root>embedded</root>
# run query
XQUERY <hits>{ count(//text())}</hits>CLOSE
</pre>
===XML Syntax===
The string syntax is limited when XML snippets need to be embedded in a command,or when complex queries are to be specified.
<pre class="brush:xml">
<commands>
<create-db name='test'/>
<add path='embedded.xml'><root>embedded</root></add>
<!-- run query --> <xquery><![CDATA[ <hits>{ count(//text())}</hits> ]]></xquery> <close/>
</commands>
</pre>
* <code>,?*</code>: [[#Glob Syntax|glob syntax]]
* <code>;</code>: Separator for multiple database commands on the This article is part of the [[Getting Started]] Section.It lists all database commands supported by BaseX.Commands can e.g. be executed from the [[Command-Line Options#BaseX_Standalone|Command Linecommand line]],[[#Command Scripts* <code>\/</code>: Directory path separators* <code>:*?\"<>|Scripts]], the [[Clients]], [[REST]], the input field in the [[GUI]]}</code>: invalid filename characters on Windowsand other ways* Names starting or ending with <code>.</code>: hidden folders (e.g. If the GUI is used, all commands that are triggered by the GUI itselfwill show up in the [[GUI#VisualizationsLogging|Info View]].The [[User_Management|Permissionlogs directory]] fields indicate whichrights are required by a user to perform a command in the client/server architecture.)
=Basics=Aliases==
===String Syntax=CREATE DB==
==Glob SyntaxCHECK==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CREATE DB [name] ([input])CLOSE }}
|-
| '''XML Syntax'''
|<code><create-db name='...'>([input])<close/create-db></code><br/>
|-
| '''Permission'''
|''CREATEREAD''
|-
| '''Summary'''
|Creates a new database with Closes the specified {{Code|name}} and, optionally, an initial {{Code|input}}, and opens it. An existing currently opened database will be overwritten.<br />The input may either be a reference to a single XML document, a directory, a remote URL, or a string containing XML:* {{Code|name}} must be a [[#Valid Names|valid database name]]* database creation can be controlled by setting [[Options#Create Options|Create Options]]
|-
| '''Errors'''
|The command fails if a the database with the specified name is currently used by another process, if one of the documents to be added is files could not well-formed or if it cannot be parsed closed for some other reason.|-| '''Examples'''|* {{Code|CREATE DB input}}<br/>creates an empty database {{Code|input}}.* {{Code|CREATE DB xmark http://files.basex.org/xml/xmark.xml}}<br/>creates the database {{Code|xmark}}, containing a single initial document called {{Code|xmark.xml}}.* {{Code|CREATE DATABASE coll /path/to/input}}<br/>creates the database {{Code|coll}} with all documents found in the {{Code|input}} directory.* {{Code|SET INTPARSE false; CREATE DB input input.xml}}<br/>creates a database {{Code|input}} with {{Code|input.xml}} as initial document, which will be parsed with Java's [[Parsers#XML Parsers|default XML parser]].* <code><create-db name='simple'><hello>Universe</hello></create-db></code><br/>creates a database named {{Code|simple}} with an initial document {{Code|<hello>Universe</hello>}}.
|}
==OPENEXPORT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|OPEN [name] (EXPORT [path])}}
|-
| '''XML Syntax'''
|<code><open name='...' (export path='...')/></code><br/>
|-
| '''Permission'''
|''READCREATE''
|-
| '''Summary'''
|Opens Exports all documents in the database to the specified by file {{Code|namepath}}. The documents to be opened can be , using the serializer options specified by the [path] argument{{Option|EXPORTER}} option.
|-
| '''Errors'''
|The command fails if the specified no database does not existis opened, if the target path points to a file or is currently being updated by another process invalid, if the serialization parameters are invalid, or if the documents cannot be opened serialized for some other reason.
|}
==CHECKCREATE INDEX== {{Mark|Updated with Version 8.4:}} Token index added.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CHECK CREATE INDEX [inputTEXT|ATTRIBUTE|TOKEN|FULLTEXT]}}
|-
| '''XML Syntax'''
|<code><check input<create-index type='...text|attribute|token|fulltext'/>></code><br/>
|-
| '''Permission'''
|''READ/CREATEWRITE''
|-
| '''Summary'''
|This convenience command combines {{Command|OPEN}} and {{Command|CREATE DB}}: if a database with Creates the name {{Codespecified [[Indexes#Value Indexes|input}} exists, it is openedValue Index]]. Otherwise, a new database is created; if The current [[Options#Indexing|Index Options]] will be considered when creating the specified input points to an existing resource, it is stored as initial contentindex.
|-
| '''Errors'''
|The command fails if the addressed no database could neither be is opened nor created, if the specified index is unknown, or if indexing fails for some other reason.
|}
==CLOSEDROP INDEX==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CLOSE DROP INDEX [TEXT|ATTRIBUTE|TOKEN|FULLTEXT]}}
|-
| '''XML Syntax'''
|<code><closedrop-index type='text|attribute|token|fulltext'/></code><br/>
|-
| '''Permission'''
|''READWRITE''
|-
| '''Summary'''
|Closes Drops the currently opened databasespecified [[Indexes#Value Indexes|Value Index]].
|-
| '''Errors'''
|The command fails if no database is opened, if the database files specified index is unknown, or if it could not be closed deleted for some other reason.
|}
=Administration=EXPORT ==ALTER DB==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|EXPORT ALTER DB [pathname] [newname]}}
|-
| '''XML Syntax'''
|<code><export pathalter-db name='...' newname='...'/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Exports all documents in Renames the database specified by {{Code|name}} to the specified file {{Code|pathnewname}}. {{Code|newname}}, using the serializer options specified by the <code>must be a [[Options#EXPORTERValid Names|EXPORTERvalid database name]]</code> option.
|-
| '''Errors'''
|The command fails if no the target database is openedalready exists, if the target path points to a file source database does not exist or is invalid, if the serialization parameters are invalidcurrently locked, or if the documents cannot it could not be serialized renamed for some other reason.|-| '''Examples'''|* {{Code|ALTER DB db tempdb}}<br/>renames the database {{Code|db}} into {{Code|tempdb}}.
|}
==CREATE INDEXDROP DB== {{Mark|Updated with Version 8.4:}} Token index added.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CREATE INDEX DROP DB [TEXT|ATTRIBUTE|TOKEN|FULLTEXTname]}}
|-
| '''XML Syntax'''
|<code><create<drop-index typedb name='text|attribute|token|fulltext...'/>></code><br/>
|-
| '''Permission'''
|''WRITECREATE''
|-
| '''Summary'''
|Creates Drops the database with the specified [[Indexes#Value Indexes{{Code|Value Index]]name}}. The current [[Options#IndexingGlob Syntax|Index OptionsGlob Syntax]] will can be considered when creating the indexused to address more than one database.
|-
| '''Errors'''
|The command fails if no database is opened, if the specified index database does not exist or is unknowncurrently locked, or if indexing fails the database could not be deleted for some other reason.
|}
==DROP INDEXCREATE BACKUP== {{Mark|Updated with Version 8.4:}} Token index added.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP INDEX CREATE BACKUP [TEXT|ATTRIBUTE|TOKEN|FULLTEXTname]}}
|-
| '''XML Syntax'''
|<code><dropcreate-index typebackup name='text|attribute|token|fulltext...'/></code><br/>
|-
| '''Permission'''
|''WRITECREATE''
|-
| '''Summary'''
|Drops Creates a zipped backup of the database specified by {{Code|name}}. The backup file will be suffixed with the current timestamp and stored in the database directory. The [[Indexes#Value IndexesGlob Syntax|Value IndexGlob Syntax]]can be used to address more than one database.
|-
| '''Errors'''
|The command fails if no database is opened, if the specified index is unknowndatabase does not exist, or if it could not be deleted zipped for some other reason.|-| '''Examples'''|* {{Code|BACKUP db}}<br/>creates a zip archive of the database {{Code|db}} (e.g. {{Code|db-2014-04-01-12-27-28.zip}}) in the [[Configuration#Database_Directory|database directory]].
|}
=Administration= ==ALTER DBRESTORE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ALTER DB RESTORE [name] [newname]}}
|-
| '''XML Syntax'''
|<code><alter-db restore name='...' newname='...'/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Renames Restores a database with the database specified by {{Code|name}} to {{Code|newname}}. {{Code|newname}} must be a [[#Valid Names|valid database The name]]may include the timestamp of the backup file.
|-
| '''Errors'''
|The command fails if the target database already existsspecified backup does not exist, if the source database does not exist or to be restored is currently locked, or if it could not be renamed restored for some other reason.|-| '''Examples'''|* {{Code|ALTER DB db tempdb}}<br/>renames the database {{Code|db}} into {{Code|tempdb}}.
|}
==DROP DBINSPECT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP DB [name]INSPECT}}
|-
| '''XML Syntax'''
|<code><drop-db name='...'inspect/></code><br/>
|-
| '''Permission'''
|''CREATEREAD''
|-
| '''Summary'''
|Drops the database with the specified {{Code|name}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.|-| '''Errors'''|The command fails if the specified database does not exist or is currently locked, or if Performs some integrity checks on the opened database could not be deleted for some other reasonand returns a brief summary.
|}
==CREATE DROP BACKUP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CREATE DROP BACKUP [name]}}
|-
| '''XML Syntax'''
|<code><createdrop-backup name='...'/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Creates a zipped backup Drops all backups of the database with the specified by {{Code|name}}. The backup file will be suffixed with the current timestamp and stored in the database directory. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
|-
|
* {{Code|DROP BACKUP dbabc*}}<br/>creates a zip archive deletes the backups of all databases starting with the database characters {{Code|dbabc}} (e.g. {{Code|db-2014-04-01-12-27-28.zip}}) in the [[Configuration#Database_Directory|database directory]].
|}
==RESTORESHOW BACKUPS==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RESTORE [name]SHOW BACKUPS}}
|-
| '''XML Syntax'''
|<code><restore name='...'show-backups/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Restores a Shows all database with the specified {{Code|name}}. The name may include the timestamp of the backup file.|-| '''Errors'''|The command fails if the specified backup does not exist, if the database to be restored is currently locked, or if it could not be restored for some other reasonbackups.
|}
==INSPECTCOPY==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INSPECTCOPY [name] [newname]}}
|-
| '''XML Syntax'''
|<code><inspectcopy name='...' newname='...'/></code><br/>
|-
| '''Permission'''
|''READCREATE''
|-
| '''Summary'''
|Performs some integrity checks on Creates a copy of the opened database and returns specified by {{Code|name}}. {{Code|newname}} must be a brief summary[[#Valid Names|valid database name]].|-| '''Errors'''|The command fails if the target database already exists, or if the source database does not exist.
|}
==DROP BACKUPINFO DB==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP BACKUP [name]INFO DB}}
|-
| '''XML Syntax'''
|<code><dropinfo-backup name='...'db/></code><br/>
|-
| '''Permission'''
|''CREATEREAD''
|-
| '''Summary'''
|Drops all backups of Shows general information and meta data on the database with the specified {{Code|name}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one currently opened database.
|-
| '''ExamplesErrors'''|* {{Code|DROP BACKUP abc*}}<br/>deletes the backups of all databases starting with the characters {{Code|abc}}The command fails if no database is opened.
|}
==SHOW BACKUPSINFO INDEX==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW BACKUPSINFO INDEX ([ELEMNAME|ATTRNAME|PATH|TEXT|ATTRIBUTE|TOKEN|FULLTEXT])}}
|-
| '''XML Syntax'''
|<code><showinfo-backupsindex type='elemname|attrname|path|text|attribute|token|fulltext'/></code><br/>
|-
| '''Permission'''
|''CREATEREAD''
|-
| '''Summary'''
|Shows all information on the existing [[Indexes|index]] structures. The output can be optionally limited to the specified index.|-| '''Errors'''|The command fails if no database backupsis opened, or if the specified index is unknown.|}
==COPYINFO STORAGE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|COPY INFO STORAGE [name] [newnamestart end]}}
|-
| '''XML Syntax'''
|<code><copy nameinfo-storage (start='...' newname) (end='...')/></code><br/>
|-
| '''Permission'''
|''CREATEREAD''
|-
| '''Summary'''
|Creates a copy Shows the internal main table of the currently opened database specified by {{Code|name}}. {{Code|newname}} must An integer range may be a [[#Valid Names|valid database name]]specified as argument.
|-
| '''Errors'''
|The command fails if the target no database already existsis opened, or if one of the source database does not existspecified arguments is invalid.
|}
=Querying =INFO DB ==LIST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO DBLIST ([name] ([path]))}}
|-
| '''XML Syntax'''
|<code><info-dblist (name='...' (path='...'))/></code><br/>
|-
| '''Permission'''
|''READNONE''
|-
| '''Summary'''
|Shows information on Lists all available databases. If {{Code|name}} is specified, the currently opened resources of a databaseare listed. The output can be further restricted to the resources matching the specified {{Code|path}}.<br/>If database resources are listed, the size is either the number of nodes (for XML resources) or the number of bytes (for binary resources).
|-
| '''Errors'''
|The command fails if no the optional database is cannot be opened, or if the existing databases cannot be listed for some other reason.
|}
==INFO INDEXXQUERY== {{Mark|Updated with Version 8.4:}} Token index added; index {{Code|TAG}} renamed to {{Code|ELEMNAME}}; index {{Code|ATTNAME}} renamed to {{Code|ATTRNAME}}.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO INDEX (XQUERY [ELEMNAME|ATTRNAME|PATH|TEXT|ATTRIBUTE|TOKEN|FULLTEXTquery])}}
|-
| '''XML Syntax'''
|<code><info-index type='elemname|attrname|path|text|attribute|token|fulltext'xquery>[query]</xquery></code><br/>
|-
| '''Permission'''
|''READdepends on query''
|-
| '''Summary'''
|Shows information on Runs the existing [[Indexesspecified {{Code|index]] structures. The output can be optionally limited to query}} and prints the specified indexresult.
|-
| '''Errors'''
|The command fails if no database the specified query is openedinvalid.|-| '''Examples'''|* <code>XQUERY 1 to 10</code><br/>returns the sequence {{Code|(1, 2, 3, 4, 5, 6, 7, 8, 9, or if 10)}}.* <code>SET RUNS 10; XQUERY 1 to 10</code><br/>returns the results after having run the query 10 times.* <code>SET XMLPLAN true; XQUERY 1 to 10</code><br/>returns the result and prints the specified index is unknownquery plan as XML.
|}
==INFO STORAGERETRIEVE== {{Mark|Updated with Version 8.4}}: Query argument removed, start/end added to XML syntax.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFO STORAGE RETRIEVE [start endpath]}}
|-
| '''XML Syntax'''
|<code><info-storage (startretrieve path='...') (end='...')/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Shows Retrieves a [[Binary Data|raw file]] from the internal main table of the currently opened database. An integer range may be at the specified as argument{{Code|path}}.
|-
| '''Errors'''
|The command fails if no database is opened, or if one of the specified arguments source path is invalidor if the data cannot not be retrieved for some other reason.
|}
= Querying = ==LISTFIND==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|LIST (FIND [namequery] ([path]))}}
|-
| '''XML Syntax'''
|<code><list (name='...' (path='...'))find>[query]</find></code><br/>
|-
| '''Permission'''
|''NONEREAD''
|-
| '''Summary'''
|Lists all available databases. If Builds and runs a query for the specified {{Code|namequery}} is specified, the resources of a database are listedterms. Keywords can be enclosed in quotes to look for phrases. The output following modifiers can be used to further restricted to the resources matching the specified {{Code|path}}.limit search:<code>=</code> looks for exact text nodes<br/><code>~</code> looks for approximate hits<br/>If database resources are listed, the size is either the number of nodes (<code>@=</code> looks for XML resources) or the number of bytes (exact attribute values<br/><code>@</code> looks for binary resources).attributes
|-
| '''Errors'''
|The command fails if the optional no database cannot be is opened, or if the existing databases cannot be listed for some other reason.
|}
==XQUERYTEST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|XQUERY TEST [querypath]}}
|-
| '''XML Syntax'''
|<code><xquery>[query]<test path='...'/xquery></code><br/>
|-
| '''Permission'''
|''depends on queryADMIN''
|-
| '''Summary'''
|Runs all [[Unit Module|XQUnit tests]] in the specified {{Code|querypath}} and prints the result. The path can point to a single file or a directory.<br/>Unit testing can also be triggered via {{Code|-t}} on [[Command-Line Options#BaseX Standalone|command line]].
|-
| '''Errors'''
|The command fails if the specified query is invalidat least one test fails.
|-
| '''Examples'''
|
* <code>XQUERY 1 to 10<{{Code|TEST project/code>tests}}<br/>returns runs all tests in the sequence directory {{Code|(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)project/tests}}.* <code>SET RUNS 10; XQUERY 1 to 10</code><br/>returns the results after having run the query 10 times.* <code>SET XMLPLAN true; XQUERY 1 to 10</code><br/>returns the result and prints the query plan as XML.
|}
==RETRIEVEREPO INSTALL==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RETRIEVE REPO INSTALL [path]}}
|-
| '''XML Syntax'''
|<code><retrieve repo-install path='...'/></code><br/>
|-
| '''Permission'''
|''READCREATE''
|-
| '''Summary'''
|Retrieves a [[Binary Data|raw file]] from Installs the opened database at the specified package with path {{Code|path}}.
|-
| '''Errors'''
|The command fails if no database in the following cases:* The package to be installed is opened, if the source path not a xar file.* The package to be installed does not exist or is already installed.* The package descriptor is with invalid or if syntax.* The package to be installed depends on a package which is not installed.* The package is not supported by the current version of BaseX.* A component of the data cannot not be retrieved for some other reasonpackage is already installed as part of another package.
|}
==FINDREPO LIST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|FIND [query]REPO LIST}}
|-
| '''XML Syntax'''
|<code><find>[query]<repo-list/find></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Builds and runs a query for the specified {{Code|query}} terms. Keywords can be enclosed in quotes to look for phrases. The following modifiers can be used to further limit search:<code>=</code> looks for exact text nodes<br/><code>~</code> looks for approximate hits<br/><code>@=</code> looks for exact attribute values<br/><code>@</code> looks for attributes|-| '''Errors'''|The command fails if no database is openedLists all installed packages.
|}
==TESTREPO DELETE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|TEST REPO DELETE [pathname]}}
|-
| '''XML Syntax'''
|<code><test pathrepo-delete name='...'/></code><br/>
|-
| '''Permission'''
|''ADMINCREATE''
|-
| '''Summary'''
|Runs all [[Unit Module|XQUnit tests]] in Deletes the specified package with the specified {{Code|pathname}}. The path What is called "name" can point to a single file also be the id (which is the name followed by the version) or a the directory.<br/>Unit testing can also be triggered via {{Code|-t}} on [[Command-Line Options#BaseX Standalone|command line]]of the package.
|-
| '''Errors'''
|The command fails if at least one test fails.|-| '''Examples'''|* {{Code|TEST project/tests}}<br/>runs all tests in the directory {{Code|project/tests}}package to be deleted is required by another package.
|}
=Updates=REPO INSTALL ==ADD==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|REPO INSTALL ADD (TO [path]) [input]}}
|-
| '''XML Syntax'''
|<code><repo-install add (path='...')>[input]</add></code><br/>
|-
| '''Permission'''
|''CREATEWRITE''
|-
| '''Summary'''
| Installs Adds a file, directory or XML string specified by {{Code|input}} to the currently opened database at the package with 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 pathmay occur than once in a database. If this is unwanted, the {{Command|REPLACE}}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.
|-
| '''Errors'''
| The command fails in if no database is opened, if one of the following cases:* The package documents to be installed added is not a xar filewell-formed, or if it could not be parsed for some other reason.|-| '''Examples'''|* The package {{Code|ADD input.xml}}<br/>adds the file {{Code|input.xml}} to be installed does not exist or is already installedthe database.* The package descriptor is with invalid syntax{{Code|ADD TO temp/one.xml input.xml}}<br/>adds {{Code|input.* The package xml}} to the database and moves it to be installed depends on a package which is not installed{{Code|temp/one.xml}}.* The package is not supported by {{Code|ADD TO target/ xmldir}}<br/>adds all files from the {{Code|xmldir}} directory to the current version of BaseX.* A component of database in the package is already installed as part of another package{{Code|target}} path.
|}
==REPO LISTDELETE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|REPO LISTDELETE [path]}}
|-
| '''XML Syntax'''
|<code><repo-listdelete path='...'/></code><br/>
|-
| '''Permission'''
|''READWRITE''
|-
| '''Summary'''
| Lists Deletes all installed packagesdocuments from the currently opened database that start with the specified {{Code|path}}.|-| '''Errors'''|The command fails if no database is opened.
|}
==REPO DELETERENAME==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|REPO DELETE RENAME [namepath] [newpath]}}
|-
| '''XML Syntax'''
|<code><repo-delete namerename path='...' newpath='...'/></code><br/>
|-
| '''Permission'''
|''CREATEWRITE''
|-
| '''Summary'''
| Deletes Renames all document paths in the package currently opened database that start with name the specified {{Code|namepath}}, optionally followed by a version. The command may be used to either rename single documents or directories.
|-
| '''Errors'''
| The command fails if no database is opened, or if the package target path is empty.|-| '''Examples'''|* {{Code|RENAME one.xml two.xml}}<br/>renames the document {{Code|one.xml}} to {{Code|two.xml}}.* {{Code|RENAME / TOP}}<br/>moves all documents to be deleted participates in a dependency{{Code|TOP}} root directory.
|}
=Updates= ==ADDREPLACE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ADD (TO REPLACE [path]) [input]}}
|-
| '''XML Syntax'''
|<code><add (replace path='...')>[input]</addreplace></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Adds Replaces a file, directory or XML string specified by {{Code|input}} to document in the currently opened database at the specified , addressed by {{Code|path}}:* , with the file or XML string specified by {{Code|input}} may either be a single XML document, a directory, a remote URL or adds a plain XML string.* A new document with the same path may occur than once in a database. If this is unwanted, {{Command|REPLACE}} 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 [[Options#ADDCACHE|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 if the initial input as argumentresource does not exist yet.
|-
| '''Errors'''
|The command fails if no database is opened, if one of the documents specified path points to be added is not well-formeda database directory, or if it could the input is not be parsed for some other reasonfound.
|-
| '''Examples'''
|
* {{Code|ADD input.xml}}<br/>adds the file {{Code|input.xml}} to the database.* {{Code|ADD TO temp/REPLACE one.xml input.xml}}<br/>adds replaces the document {{Code|inputone.xml}} to with the database and moves it to contents of the file {{Code|temp/oneinput.xml}}.* {{Code|ADD TO targetREPLACE top.xml <xml/ xmldir>}}<br/>adds all files from replaces the document {{Code|xmldirtop.xml}} directory to the database in with the document {{Code|target<xml/>}} path.
|}
==DELETESTORE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DELETE STORE (TO [path]) [input]}}
|-
| '''XML Syntax'''
|<code><delete store (path='...')>[input]</store></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Deletes all documents from Stores a [[Binary Data|raw file]] specified via {{Code|input}} in the currently opened database that start with 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|/}}).* An existing resource will be replaced.
|-
| '''Errors'''
|The command fails if no database is opened, if the specified resource is not found, if the target path is invalid or if the data cannot not be written for some other reason.
|}
==RENAMEOPTIMIZE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RENAME [path] [newpath]OPTIMIZE (ALL)}}
|-
| '''XML Syntax'''
|<code><rename path='...' newpath='...'optimize/></code><br/><code><optimize-all/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Renames all document paths in Optimizes the index structures, meta data and statistics of the currently opened database that start with the specified :* If {{Code|pathALL}}is specified, all database structures are completely reconstructed. The command may database size will be reduced, and all orphaned data will be deleted.* Without {{Code|ALL}}, only the outdated index structures and database statistics will be used updated. If the database is completely up-to either rename single documents or directories-date, nothing will be done.* Database options will be adopted from the original database. Only {{Option|AUTOOPTIMIZE}} and (if {{Code|ALL}} is specified) {{Option|UPDINDEX}} will be adopted from the current options.
|-
| '''Errors'''
|The command fails if no database is opened, or if the target path currently opened database is empty.|a main-| '''Examples'''|* {{Code|RENAME one.xml two.xml}}<br/>renames the document {{Code|one.xml}} to {{Code|two.xml}}.* {{Code|RENAME / TOP}}<br/>moves all documents to a {{Code|TOP}} root directorymemory instance.
|}
==REPLACEFLUSH==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|REPLACE [path] [input]FLUSH}}
|-
| '''XML Syntax'''
|<code><replace path='...'>[input]<flush/replace></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Replaces a document in Explicitly flushes the buffers of the currently opened database, addressed by to disk. This command is applied if {{CodeOption|pathAUTOFLUSH}}, with the file or XML string specified by has been set to {{Code|inputfalse}}, or adds a new document if the resource does not exist yet.
|-
| '''Errors'''
|The command fails if no database is opened, if the specified path points to a database directory, or if the input is not found.|-| '''Examples'''|* {{Code|REPLACE one.xml input.xml}}<br/>replaces the document {{Code|one.xml}} with the contents of the file {{Code|input.xml}}.* {{Code|REPLACE top.xml <xml/>}}<br/>replaces the document {{Code|top.xml}} with the document {{Code|<xml/>}}.
|}
=Monitoring=STORE ==SHOW SESSIONS==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|STORE (TO [path]) [input]SHOW SESSIONS}}
|-
| '''XML Syntax'''
|<code><store (path='...')>[input]<show-sessions/store></code><br/>
|-
| '''Permission'''
|''WRITEADMIN''
|-
| '''Summary'''
|Stores a [[Binary Data|raw file]] in the opened database to the specified {{Code|path}}. {{Code|input}} may either be a file reference, a remote URL, or a plain string. If the path denotes a directory, it needs Shows all sessions that are connected to be suffixed with a slash ({{Code|/}}).|-| '''Errors'''|The command fails if no database is opened, if the specified resource is not found, if the target path is invalid or if the data cannot not be written for some other reasoncurrent server instance.
|}
==OPTIMIZESHOW USERS==
{{Mark|Updated with Version 8.46}}: adopt original index options.If called by non-admins, will only return the current user
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|OPTIMIZE SHOW USERS (ALLON [database])}}
|-
| '''XML Syntax'''
|<code><optimize/></code><br/><code><optimizeshow-allusers (database='...')/></code><br/>
|-
| '''Permission'''
|''WRITEADMIN''
|-
| '''Summary'''
|Optimizes Shows all users that are visible to the index structures, meta data and statistics of the currently opened database:* current user. If a {{Code|ALLdatabase}} is specified, all database structures are completely reconstructed. The database size will be reduced, and all orphaned data will be deleted.* Without {{Code|ALL}}, only the outdated index structures and database statistics those users will be updated. If shown for which a pattern was specified that matches the database is completely up-to-date, nothing will be done.* Database options will be adopted from the original database. Only <code>[[Options#AUTOOPTIMIZE|AUTOOPTIMIZE]]</code> and (if {{Code|ALL}} is specified) <code>[[Options#UPDINDEX|UPDINDEX]]</code> will be adopted from the current optionsname.
|-
| '''Errors'''
|The command fails if no the optional database is opened, or if the currently could not be opened database is a main-memory instance.
|}
==FLUSHKILL==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|FLUSHKILL [target]}}
|-
| '''XML Syntax'''
|<code><flushkill target='...'/></code><br/>
|-
| '''Permission'''
|''WRITEADMIN''
|-
| '''Summary'''
|Explicitly flushes the buffers Kills sessions of the currently opened database to diska user or an IP:port combination, specified by {{Code|target}}. This command is applied if The [[Options#AUTOFLUSHGlob Syntax|AUTOFLUSHGlob Syntax]] has been set can be used to {{Code|false}}address more than one user.
|-
| '''Errors'''
|The command fails if no database is openeda user tried to kill his/her own session.
|}
=Server Administration= ==SHOW SESSIONSJOBS LIST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW SESSIONSJOBS LIST}}
|-
| '''XML Syntax'''
|<code><showjobs-sessionslist/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Shows Returns information on all sessions jobs that are connected to the current server instancecurrently queued or executed.
|}
==SHOW USERSJOBS RESULT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW USERS (ON JOBS RESULT [databaseid])}}
|-
| '''XML Syntax'''
|<code><showjobs-users (databaseresult id='...')/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Shows all users that are registered in Returns the database. If cached result of a {{Code|database}} is query with the specifiedjob id:* Results can only be retrieved once. After retrieval, all user the cached result will be shown for which a pattern was specified that matches dropped.* If the original query has raised an error, the database namecached error will be raised instead.
|-
| '''Errors'''
|The command fails if the optional database could not be openedaddressed job is still running or if the result has already been retrieved.
|}
==KILLJOBS STOP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|KILL JOBS STOP [targetid]}}
|-
| '''XML Syntax'''
|<code><kill targetjobs-stop id='...'/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Kills sessions Cancels the execution of a user job with the specified id, or an IP:port combination, specified by {{Code|target}}drops the cached result of a query. Unknown ids are ignored. The [[#Glob Syntax|Glob Syntax]] can be used All jobs are gracefully stopped; it is up to address more than one user.|-| '''Errors'''|The command fails if a user tried the process to decide when it is safe to kill his/her own sessionshut down.
|}
|-
| '''Summary'''
|Evaluates the contents of {{Code|file}} as XQuery expression. If the file ends with the suffix {{Code|.bxs}}, the file content contents will be evaluated as [[#Basics|command script]]. This command can be used to run several commands in a single row, with no other transactionintervening the execution.
|-
| '''Errors'''
| '''Examples'''
|
* <code>RUN query.xq</code><br/>will evaluated evaluate the specified file as XQuery expression* <code>RUN commands.bxs</code><br/>will evaluated evaluate the specified file as command script
|}
|-
| '''Summary'''
|Evaluates the specified {{Code|input}} as [[#Basics|command script]]. This command can be used to run several commands in a single row, with no other transactionintervening the execution.
|-
| '''Errors'''
=Changelog=
;Version 8.6
* Updated: {{Command|SHOW USERS}}: If called by non-admins, will only return the current user
;Version 8.5
* Added: {{Command|JOBS LIST}}, {{Command|JOBS RESULT}}, {{Command|JOBS STOP}}
* Updated: [[#Valid Names|Valid Names]]: allow dots (except as first and last character)
;Version 8.4
* Updated: {{Command|CREATE INDEX}}, {{Command|DROP INDEX}}, {{Command|INFO INDEX}}: token index added
* Updated: {{Command|INFO STORAGE}}: Query argument removed, start/end added to XML syntax.
* Updated: {{Command|INFO INDEX}}: Token index added; index {{Code|TAG}} renamed to {{Code|ELEMNAME}}; index {{Code|ATTNAME}} renamed to {{Code|ATTRNAME}}
* Updated: {{Command|OPTIMIZE}}: adopt original index options
;Version 8.2
* Removed: {{Code|CREATE EVENT}}, {{Code|DROP EVENT}} and {{Code|SHOW EVENTS}} command
;Version 8.0
* Updated: commands for [[#User Management|User Management]]
* Updated: {{Command|OPEN}}: path argument added
;Version 7.9
* Added: {{Command|TEST}} runs XQUnit tests.
;Version 7.7
* Updated: syntax of [[#Valid Names|valid names]].
;Version 7.5
* Added: {{Command|EXECUTE}} executes a command script.
* Added: {{Command|INSPECT}} performs integrity checks.
;Version 7.3
* Added: [[#XML Syntax|XML Syntax]] added.
* Updated: {{Command|CHECK}} can now be used to create empty databases.
;Version 7.2.1
* Updated: permissions for {{Command|GET}} and {{Command|SET}} changed from {{Code|READ}} to {{Code|NONE}}.
;Version 7.2
* Updated: {{Command|CREATE INDEX}}, {{Command|DROP INDEX}} ({{Code|PATH}} argument removed. Path summary is always available now and updated with {{Command|OPTIMIZE}}).
* Updated: permissions for {{Command|REPO DELETE}}, {{Command|REPO INSTALL}} and {{Command|REPO LIST}}.
;Version 7.1
* Updated: {{Command|KILL}} (killing sessions by specifying IP:port)
;Version 7.0
* Added: {{Command|FLUSH}}, {{Command|RETRIEVE}}, {{Command|STORE}}.
* Updated: {{Command|ADD}}: simplified arguments.
