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]]If you need to add initial resources, it is always faster to supply them at creation time than adding them in a subsequent step via {{Command|ADD}}.|-| '''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="brush:xml"br/>creates an empty database {{Code|input}}.* {{Code|CREATE DB testADD inputxmark http://files.basex.org/xmlADD TO embedded/xmark.xml }}<root>embedded<br/root>creates the database {{Code|xmark}}, containing a single initial document called {{Code|xmark.xml}}.# run queryXQUERY count(* {{Code|CREATE DATABASE coll /path/to/text())input}}<br/pre> ===XML Syntax=== The string syntax is limited when XML snippets need to be embedded creates the database {{Code|coll}} with all documents found in a command,the {{Code|input}} directory.or when complex queries are to be specified* {{Code|SET INTPARSE false}} and {{Code|CREATE DB input input. This is why xml}}<br/>creates a database commands can also {{Code|input}} with {{Code|input.xml}} as initial document, which will be specified in parsed with Java's [[Parsers#XML Parsers|default XMLparser]].Multiple commands can be enclosed by * <code><create-db name='simple'><hello>Universe</hello></create-db></code><br/>creates a database named {{Code|simple}} with an initial document {{Code|<commandshello>Universe</hello>}} root element:.|}
<pre class="brush:xml"><commands> <create-db name='test'/> <add>input.xml</add> <add pathOPEN=='embedded.xml'><root>embedded</root></add> <xquery>count(//text())</xquery></commands></pre>
==Glob Syntax== 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: * {{Code|AB?}} addresses all names with the characters {{Code|AB}} and one more character.* {{Code|*AB}} addresses all names ending with the characters {{Code|AB}}.* {{Code|X*,Y*,Z*}} addresses all names starting with the characters {{Code|X}}, {{Code|Y}}, or {{Code|Z}}. ==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 DB== {| width='100%'|-|width='130'|'''Syntax'''|{{Code|CREATE DB OPEN [name] ([inputpath])}}
|<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>
{{Mark|Updated with Version 8.4:}} Token index added.
=Administration=
{{Mark|Updated with Version 8.4:}} Token index added; index {{Code|TAG}} renamed to {{Code|ELEMNAME}}; index {{Code|ATTNAME}} renamed to {{Code|ATTRNAME}}.
{{Mark|Updated with Version 8.4}}: Query argument removed, start/end added to XML syntax.
{{Mark|Updated with Version 8.4}}: adopt original index options.
* Updated: ==EXIT=={{Command|CREATE INDEX}}, width='100%'|-|width='130'|'''Syntax'''|{{CommandCode|DROP INDEXEXIT }}, {{Command|INFO INDEX}}: token index added-* Updated: {{Command|INFO STORAGE}}: Query argument removed, start/end added to '''XML syntax. Syntax''' * Updated: {{Command|INFO INDEX}}: Token index added; index {{Code<code><exit/></code><br/>|TAG}} renamed to {{Code-|ELEMNAME}}; index {{Code'''Permission'''|ATTNAME}} renamed to {{Code''NONE''|ATTRNAME}}-* Updated: {{Command|OPTIMIZE}}: adopt original index options'''Summary''';Version 8|Exits the console mode.2|}
* Removed: {{Code|CREATE EVENT}}, {{Code|DROP EVENT}} and {{Code|SHOW EVENTS}} command==QUIT==
* 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
no edit summary
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 classsyntaxhighlight lang="brush:xml">
CREATE DB test
ADD TO embedded.xml <root>embedded</root>
# run query
XQUERY <hits>{ count(//text())}</hits>CLOSE</presyntaxhighlight>
===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 classsyntaxhighlight lang="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>
</presyntaxhighlight>
==Glob Syntax==
* <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==
|-
| '''XML Syntax'''
|-
| '''Permission'''
|-
| '''Summary'''
|This convenience command combines {{Command|OPEN}} and {{Command|CREATE DB}}: if If a database with the name {{Code|input}} exists, it and if there is no existing file or directory with the same name that has a newer timestamp, the database is opened. Otherwise, a new database is created; if the specified input points to an existing resource, it is stored as initial content.
|-
| '''Errors'''
|-
| '''Summary'''
|Exports all documents in the database to the specified file {{Code|path}}, using the serializer options specified by the <code>[[Options#EXPORTER{{Option|EXPORTER]]</code> }} option.
|-
| '''Errors'''
==DROP INDEX==
{| width='100%'
|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.
|}
==ALTER DB==
|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.
|}
==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.
|}
=Administration=
==CREATE BACKUP==
|}
==RESTOREDROP BACKUP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RESTORE DROP BACKUP [name]}}
|-
| '''XML Syntax'''
|<code><restore drop-backup name='...'/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Restores a Drops all backups of the database with the specified {{Code|name}}. The name may include the timestamp of the backup file[[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
|-
| '''ErrorsExamples'''|The command fails if * {{Code|DROP BACKUP abc*}}<br/>deletes the specified backup does not exist, if backups of all databases starting with the database to be restored is currently locked, or if it could not be restored for some other reasoncharacters {{Code|abc}}.
|}
==INSPECTALTER BACKUP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INSPECTALTER BACKUP [name] [newname]}}
|-
| '''XML Syntax'''
|<code><inspectalter-backup name='...' newname='...'/></code><br/>
|-
| '''Permission'''
|''READCREATE''
|-
| '''Summary'''
|Performs some integrity checks on Renames all backups of the opened database and returns a brief summarywith the specified {{Code|name}} to {{Code|new-name}}. The directory inside the archive will be renamed as well. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.|-| '''Examples'''|* {{Code|ALTER BACKUP logs logs-backup}}<br/>renames the backups of the {{Code|logs}} database to {{Code|logs-backup}}.
|}
==DROP BACKUPSHOW BACKUPS==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP BACKUP [name]SHOW BACKUPS}}
|-
| '''XML Syntax'''
|<code><dropshow-backup name='...'backups/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Drops Shows 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 BACKUPSRESTORE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW BACKUPSRESTORE [name]}}
|-
| '''XML Syntax'''
|<code><show-backupsrestore name='...'/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Shows all Restores a database backupswith 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.
|}
==COPYINSPECT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|COPY [name] [newname]INSPECT}}
|-
| '''XML Syntax'''
|<code><copy name='...' newname='...'inspect/></code><br/>
|-
| '''Permission'''
|''CREATEREAD''
|-
| '''Summary'''
|Creates a copy of Performs some integrity checks on the opened database specified by {{Code|name}}. {{Code|newname}} must be and returns a [[#Valid Names|valid database name]].|-| '''Errors'''|The command fails if the target database already exists, or if the source database does not existbrief summary.
|}
|-
| '''Summary'''
|Shows general information and meta data on the currently opened database.
|-
| '''Errors'''
==INFO INDEX==
{| width='100%'
==INFO STORAGE==
{| width='100%'
|
* <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; </code> and <code>XQUERY 1 to 10</code><br/>returns the results after having run the query 10 times.* <code>SET XMLPLAN true; </code> and <code>XQUERY 1 to 10</code><br/>returns the result and prints the query plan as XML.
|}
|-
| '''Summary'''
| Deletes the specified package with name the specified {{Code|name}}, optionally . What is called "name" can also be the id (which is the name followed by a the version) or the directory of the package.
|-
| '''Errors'''
| The command fails if the package to be deleted participates in a dependencyis required by another package.
|}
|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|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 [[Options#ADDCACHE{{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.
|-
|-
| '''Summary'''
|Replaces a document resources in the currently opened database, addressed by {{Code|path}}, with the file , directory or XML string specified by {{Code|input}}, or adds a new document documents if no resource exists at the resource does not exist yetspecified path.
|-
| '''Errors'''
|The command fails if no database is opened, or if the specified path points to a database directory, or if the input is not foundinvalid.
|-
| '''Examples'''
|-
| '''Summary'''
|Stores a [[Binary Data|raw file]] specified via {{Code|input}} in the opened database to the specified {{Code|path}}. {{Code|:* 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'''
==OPTIMIZE==
{| width='100%'
* 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{{Option|AUTOOPTIMIZE]]</code> }} and (if {{Code|ALL}} is specified) <code>[[Options#UPDINDEX{{Option|UPDINDEX]]</code> }} will be adopted from the current options.
|-
| '''Errors'''
|-
| '''Summary'''
|Explicitly flushes the buffers of the currently opened database to disk. This command is applied if [[Options#AUTOFLUSH{{Option|AUTOFLUSH]] }} has been set to {{Code|false}}.
|-
| '''Errors'''
|}
=Server AdministrationMonitoring=
==SHOW SESSIONS==
|-
| '''Summary'''
|Shows all users that are registered in visible to the databasecurrent user. If a {{Code|database}} is specified, all user only those users will be shown for which a pattern was specified that matches the database name.
|-
| '''Errors'''
|}
=User Management= ==CREATE USERJOBS LIST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|CREATE USER [name] ([password])JOBS LIST}}
|-
| '''XML Syntax'''
|<code><createjobs-user name='...'>([password])<list/create-user></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Creates a user with the specified Returns information on all jobs that are currently queued or executed. See {{CodeFunction|name}} and {{CodeJobs|passwordjobs:list-details}}. If no password is specified, it is requested via the chosen frontend (GUI or bash).|-| '''Errors'''|The command fails if for more details on the specified user already existsreturned table entries.
|}
==ALTER USERJOBS RESULT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ALTER USER JOBS RESULT [nameid] ([newname])}}
|-
| '''XML Syntax'''
|<code><alterjobs-user name='...' newnameresult id='...'/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Renames Returns the user cached result of a query with the specified {{Code|name}} to {{Code|newname}}job id:* Results can only be retrieved once. After retrieval, the cached result will be dropped.* If the original query has raised an error, the cached error will be raised instead.
|-
| '''Errors'''
|The command fails if the specified user does not exist, addressed job is still running or if the new user result has already existsbeen retrieved.
|}
==ALTER PASSWORDJOBS STOP==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ALTER PASSWORD JOBS STOP [nameid] ([password])}}
|-
| '''XML Syntax'''
|<code><alterjobs-password namestop id='...'>([password])</alter-password></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Alters Cancels the {{Code|password}} execution of the user a job with the specified {{Code|name}}id, or drops the cached result of a query. Unknown ids are ignored. If no password All jobs are gracefully stopped; it is specified, up to the process to decide when it is requested via the chosen frontend (GUI or bash).|-| '''Errors'''|The command fails if the specified user does not existsafe to shut down.
|}
=User Management=DROP ==CREATE USER==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|DROP CREATE USER [name] (ON [patternpassword])}}:
|-
| '''XML Syntax'''
|<code><dropcreate-user name='...' >(pattern='...'[password])</create-user></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Drops the Creates a 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 and {{Code|patternpassword}} . If no password is specified, only it is requested via the pattern will be removedchosen frontend (GUI or bash).
|-
| '''Errors'''
|The command fails if {{Code|admin}} is specified as user name, or if the specified user does not exist or is currently logged inalready exists.
|}
==GRANTALTER USER==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|GRANT ALTER USER [NONE|READ|WRITE|CREATE|ADMINname] (ON [patternnewname]) TO [user]}}
|-
| '''XML Syntax'''
|<code><grant alter-user name='...' permission='none|read|write|create|admin' (patternnewname='...')/></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Grants Renames the specified [[User_Management|permission]] to user with the specified {{Code|username}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one user. If a glob {{Code|patternnewname}} 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 , or if the new 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*}}already exists.
|}
==ALTER PASSWORD==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|ALTER PASSWORD [name] ([password])}}
|-
| '''XML Syntax'''
|<code><alter-passwordname='...'>([password])</alter-password></code><br/>
|-
| '''Permission'''
|''NONEADMIN''
|-
| '''Summary'''
|Changes Alters the {{Code|password}} of the current userwith 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.
|}
=General Commands= ==RUNDROP USER==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|RUN DROP USER [filename](ON [pattern])}}:
|-
| '''XML Syntax'''
|<code><run filedrop-user name='...'(pattern='...')/></code><br/>
|-
| '''Permission'''
|''depends on inputADMIN''
|-
| '''Summary'''
|Evaluates Drops the contents of {{Code|file}} as XQuery expression. If the file ends user with the suffix specified {{Code|.bxsname}}, the file content will be evaluated as . The [[#BasicsGlob Syntax|command scriptGlob Syntax]]. This command can be used to run several commands in address more than one database or user. If a single transactionglob {{Code|pattern}} is specified, only the assigned database pattern will be removed.
|-
| '''Errors'''
|The command fails if {{Code|admin}} is specified as user name, or if the specified file user does not exist, or if the retrieved input is invalidcurrently logged in. 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
|}
==EXECUTEGRANT==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|EXECUTE GRANT [inputNONE|READ|WRITE|CREATE|ADMIN] (ON [pattern]) TO [user]}}
|-
| '''XML Syntax'''
|<code><executegrant name='...' permission='none|read|write|create|admin' (pattern='...')/>[input]</executecode><br/code>
|-
| '''Permission'''
|''depends on inputADMIN''
|-
| '''Summary'''
|Evaluates Grants the specified [[User_Management|permission]] to the specified {{Code|inputuser}} as . The [[#BasicsGlob Syntax|command scriptGlob Syntax]]. This command can be used to run several commands in address more than one user. If a single transactionglob {{Code|pattern}} is specified, the permission will be applied to all databases that match this pattern.
|-
| '''Errors'''
|The command fails if the syntax of the {{Code|admin}} is specified input is invalid. It will be canceled as soon as one of user name or if the executed commands failsspecified user does not exist.
|-
| '''Examples'''
|
* <code>EXECUTE "create db db1; create db db2"</code>{{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission to the user {{Code|JoeWinson}}.* <code>EXECUTE "<commands><create-db name='db1'/><create-db name='db2'/></commands>"</code>{{Code|GRANT WRITE ON Wiki TO editor*}}<br/>both commands will create two databases grants {{Code|db1WRITE}} and permissions on the {{Code|db2Wiki}} database to all users starting with the characters {{Code|editor*}} in a single transaction.
|}
==GETPASSWORD==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|GET PASSWORD ([optionpassword])}}
|-
| '''XML Syntax'''
|<code><get password>(option='...'[password])</password></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Returns Changes the current value of the [[Options|Option]] specified via {{Code|optionpassword}}of the current user. Global options can only be If no password is specified, it is requested by users with ADMIN permissions.|-| '''Errors'''|The command fails if via the specified option is unknownchosen frontend (GUI or bash).
|}
=General Commands=SET ==RUN==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SET RUN [optionfile] ([value])}}
|-
| '''XML Syntax'''
|<code><set optionrun file='...'>([value])</set></code><br/>
|-
| '''Permission'''
|''NONEdepends on input''
|-
| '''Summary'''
|Sets Evaluates the [[Options|Option]] specified by contents of {{Code|optionfile}} to a new as XQuery expression. If the file ends with the suffix {{Code|value.bxs}}, the file contents will be evaluated as [[#Basics|command script]]. Only local options This command can be modified. If used to run several commands in a row, with no value is specified, and if other transaction intervening the value is boolean, it will be invertedexecution.
|-
| '''Errors'''
|The command fails if the specified option is unknown file does not exist, or if the specified value 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 evaluate the specified file as XQuery expression* <code>RUN commands.bxs</code><br/>will evaluate the specified file as command script
|}
==INFOEXECUTE==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|INFOEXECUTE [input]}}
|-
| '''XML Syntax'''
|<code><info/execute>[input]</codeexecute><br/code>
|-
| '''Permission'''
|''READdepends on input''
|-
| '''Summary'''
|Shows global informationEvaluates the specified {{Code|input}} as [[#Basics|command script]]. This command can be used to run several commands in a row, with no other transaction intervening the execution.|-| '''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 "<commands><create-db name='db1'/><create-db name='db2'/></commands>"</code><br/>Two databases will be created in a single transaction.
|}
==HELPGET==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|HELP (GET [commandoption])}}
|-
| '''XML Syntax'''
|<code><help>get ([command]option='...')</help></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|If Returns the current value of the [[Options|Option]] specified via {{Code|commandoption}} is specified, information on the specific command is printed; otherwise, all commands are listed. Global options can only be requested by users with ADMIN permissions.
|-
| '''Errors'''
|The command fails if the specified command option is unknown.
|}
==EXITSET==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|EXIT SET [option] ([value])}}
|-
| '''XML Syntax'''
|<code><exitset option='...'>([value])</set></code><br/>
|-
| '''Permission'''
|-
| '''Summary'''
|Exits Sets the console mode[[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.
|}
==QUITINFO==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|QUIT INFO}}
|-
| '''XML Syntax'''
|<code><quitinfo/></code><br/>
|-
| '''Permission'''
|''NONEREAD''
|-
| '''Summary'''
|Exits the console mode (alias of {{Command|EXIT}})Shows global information.
|}
=Changelog=HELP==
{| width='100%'|-|width='130'|'''Syntax'''|{{Code|HELP ([command])}}|-| '''XML Version 8Syntax''' |<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.4|}
{| width='100%'|-|width='130'|'''Syntax'''|{{Code|QUIT }}|-| '''XML Version 8Syntax''' |<code><quit/></code><br/>|-| '''Permission'''|''NONE''|-| '''Summary'''|Exits the console mode (alias of {{Command|EXIT}}).0|}
=Changelog= ;Version 9.3* Added: {{Command|ALTER BACKUP}} ;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
* Removed: {{Code|CS}} command
;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.
