Difference between revisions of "Commands"

From BaseX Documentation
Jump to navigation Jump to search
(Add example on how to bind and use a variable for a Command Script)
m (Text replacement - "syntaxhighlight" to "pre")
 
(149 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
This page is linked from the [[Getting Started]] Section.
+
This article is part of the [[Getting Started]] Section.
 +
It lists all database commands supported by BaseX.
  
−
The options listed on this page influence the way how database [[Commands|commands]] are executed and XQuery expressions are evaluated. Options are divided into [[#Global Options|'''global options''']], which are valid for all BaseX instances, and '''local options''', which are specific to a client or session. Values of options are either ''strings'', ''numbers'' or ''booleans''.
+
Commands can 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 itself will show up in the [[GUI#Visualizations|Info View]]. The [[User_Management|Permission]] fields indicate which rights are required by a user to perform a command in the client/server architecture.
  
−
The {{Code|.basex}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance. It contains all global options and, optionally, local options at the end of the file.
+
=Basics=
  
−
Various ways exist to access and change options:
+
==Command Scripts==
  
−
* The current value of an option can be requested with the [[Commands#GET|GET]] and changed with the [[Commands#SET|SET]] command. All values are ''static'': they stay valid until they are changed once again by another operation. If an option is of type ''boolean'', and if no value is specified, its existing value will be inverted.
+
On command line, multiple commands can be written down in a single line (separated by semicolons). 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 be recognized and evaluated as such.
  
−
* Initial values for options can also be specified via system properties, which can e.g. be passed on with the [http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.html#options -D flag] on command line, or using [http://docs.oracle.com/javase/6/docs/api/java/lang/System.html#setProperty(java.lang.String,%20java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys needs to be prefixed with {{Code|org.basex.}}. An example:
+
===String Syntax===
  
−
<pre class="brush:bash">
+
Lines starting with <code>#</code> are interpreted as comments and are skipped. With the following script, a database is created, two documents are added to it, and a query is performed:
−
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
+
 
−
CHOP: false
+
<pre lang="xml">
 +
CREATE DB test
 +
ADD TO embedded.xml <root>embedded</root>
 +
# run query
 +
XQUERY <hits>{ count(//text()) }</hits>
 +
CLOSE
 
</pre>
 
</pre>
  
−
* Options can also be set in the prolog of an XQuery expression. In the option declaration, options need to be bound to the [[Database Module]] namespace. All values will be reset after the evaluation of a query:
+
===XML Syntax===
  
−
<pre class="brush:xquery">
+
The string syntax is limited when XML snippets need to be embedded in a command, or when complex queries are to be specified.
−
declare option db:chop 'false';
 
−
...
 
−
</pre>
 
  
−
* Options can also be applied locally by using pragmas:
+
The XML syntax 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:
  
−
<pre class="brush:xquery">
+
<pre lang="xml">
−
(# db:chop false #) { parse-xml('<xml> hi </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>
 
</pre>
  
−
If options are implicitly changed by operations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/>
+
==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:
  
−
=Global Options=
+
* {{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}}.
  
−
Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception (since {{Version|7.8}}) is the [[#debug|DEBUG]] option, which can also be changed at runtime by users with [[User Management|admin permissions]].
+
==Valid Names==
  
−
==General==
+
Names of databases and users follow the same constraints: Names must at least have one printable character, including letters, numbers, and any of the special characters <code>!#$%&'()+-=@[]^_`{}~</code>. The following characters are disallowed:
  
−
===DEBUG===
+
* <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>: invalid filename characters on Windows
 +
* Names starting or ending with <code>.</code>: hidden folders (e.g. the [[Logging|.logs directory]])
  
−
{| width='100%'
+
==Aliases==
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|DEBUG [boolean]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|false}}
 
−
|-
 
−
| '''Summary'''
 
−
|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Command-Line Options#BaseX Standalone|command line]] via <code>-d</code>.
 
−
|}
 
  
−
===DBPATH===
+
In all commands, the {{Code|DB}} keyword can be replaced by {{Code|DATABASE}}.
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|DBPATH [path]}}
 
−
|-
 
−
| '''Default'''
 
−
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> or <code>[[Configuration#Database Directory|{home}/data]]</code>
 
−
|-
 
−
| '''Summary'''
 
−
|Points to the directory in which all databases are located.
 
−
|}
 
  
−
===REPOPATH===
+
=Database Operations=
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|REPOPATH [path]}}
 
−
|-
 
−
| '''Default'''
 
−
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>
 
−
|-
 
−
| '''Summary'''
 
−
|Points to the [[Repository]], in which all XQuery modules are located.
 
−
|}
 
  
−
===LANG===
+
==CREATE DB==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|LANG [language]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|English}}
 
−
|-
 
−
| '''Summary'''
 
−
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.
 
−
|}
 
  
−
===LANGKEY===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|LANGKEY [boolean]}}
+
|{{Code|CREATE DB [name] ([input])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><create-db name='...'>([input])</create-db></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed.
+
|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 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}}.
 +
|- valign="top"
 +
| '''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.
 +
|- valign="top"
 +
| '''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}} and {{Code|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>}}.
 
|}
 
|}
  
−
===GLOBALLOCK===
+
==OPEN==
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|GLOBALLOCK [boolean]}}
+
|{{Code|OPEN [name]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><open name='...'/></code>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Controls if local (database) or global (process) locking will be used for managing read and write operations. The article on [[Transaction Management]] provides more details on concurrency control.
+
|Opens the database specified by {{Code|name}}.
 +
|- valign="top"
 +
| '''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.
 
|}
 
|}
  
−
==Client/Server Architecture==
+
==CHECK==
  
−
===HOST===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|HOST [host]}}
+
|{{Code|CHECK [input]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|localhost}}
+
|<code><check input='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ/CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
+
|This convenience command combines {{Command|OPEN}} and {{Command|CREATE DB}}: If a database with the name {{Code|input}} exists, 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.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the addressed database could neither be opened nor created.
 
|}
 
|}
  
−
===PORT===
+
==CLOSE==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|PORT [port]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|1984}}
 
−
|-
 
−
| '''Summary'''
 
−
|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
 
−
|}
 
  
−
===SERVERPORT===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|SERVERPORT [port]}}
+
|{{Code|CLOSE }}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|1984}}
+
|<code><close/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|This is the port the database server will be listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-p</code>.
+
|Closes the currently opened database.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the database files could not be closed for some reason.
 
|}
 
|}
  
−
===EVENTPORT===
+
==LIST==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|EVENTPORT [port]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|1985}}
 
−
|-
 
−
| '''Summary'''
 
−
|This port is used by the client to listen for [[Events|server events]]. It will only be bound if a client attaches itself to a database event. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-e</code>.
 
−
|}
 
  
−
===USER===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|USER [name]}}
+
|{{Code|LIST ([name] ([path]))}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><list (name='...' (path='...'))/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Represents a user name, which is used for accessing the server or an HTTP service:
+
|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).
−
* The default value will be overwritten if a client specifies its own credentials.
+
|- valign="top"
−
* If the default value is empty, login will only be possible if the client specifies credentials.
+
| '''Errors'''
−
* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-U</code>.
+
|The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason.
 
|}
 
|}
  
−
===PASSWORD===
+
==DIR==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|PASSWORD [password]}}
 
−
|-
 
−
| '''Default'''
 
−
|''empty''
 
−
|-
 
−
| '''Summary'''
 
−
|Represents a password, which is used for accessing the server or an HTTP service:
 
−
* The default value will be overwritten if a client specifies its own credentials.
 
−
* If the default value is empty, login will only be possible if the client specifies credentials.
 
−
* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>.
 
−
* Please note that it is a security risk to specify your password in plain text.
 
−
|}
 
  
−
===SERVERHOST===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|SERVERHOST [host&#x7c;ip]}}
+
|{{Code|DIR ([path]))}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><dir (path='...')/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|This is the host name or ip address the server is bound to. If the option is set to an empty string (which is the default), the server will be open to all clients.
+
|Lists directories and resources of the currently opened database and 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).
 
|}
 
|}
  
−
===PROXYHOST===
+
==EXPORT==
−
{| width='100%' width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|PROXYHOST [host]}}
 
−
|-
 
−
| '''Default'''
 
−
|''empty''
 
−
|-
 
−
| '''Summary'''
 
−
|This is the host name of a proxy server.
 
−
|}
 
  
−
===PROXYPORT===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|PROXYPORT [port]}}
+
|{{Code|EXPORT [path]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|80}}
+
|<code><export path='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|This is the port number of a proxy server.
+
|Exports all documents in the database to the specified file {{Code|path}}, using the serializer options specified by the {{Option|EXPORTER}} option.
 +
|- valign="top"
 +
| '''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.
 
|}
 
|}
  
−
===NONPROXYHOSTS===
+
==CREATE INDEX==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|NONPROXYHOSTS [hosts]}}
 
−
|-
 
−
| '''Default'''
 
−
|''empty''
 
−
|-
 
−
| '''Summary'''
 
−
|This is a list of hosts that should be directly accessed.
 
−
|}
 
  
−
===TIMEOUT===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|TIMEOUT [seconds]}}
+
|{{Code|CREATE INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;TOKEN&#x7c;FULLTEXT]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|30}}
+
|<code>&lt;create-index type='text&#x7c;attribute&#x7c;token&#x7c;fulltext'/&gt;</code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted. Write operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to {{Code|0}}. It is ignored for {{Code|ADMIN}} operations.
+
|Creates the specified [[Indexes#Value Indexes|Value Index]]. The current [[Options#Indexing|Index Options]] will be considered when creating the index.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened, if the specified index is unknown, or if indexing fails for some other reason.
 
|}
 
|}
  
−
===KEEPALIVE===
+
==DROP INDEX==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|KEEPALIVE [seconds]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|600}}
 
−
|-
 
−
| '''Summary'''
 
−
|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.
 
−
|}
 
  
−
===PARALLEL===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|PARALLEL [number]}}
+
|{{Code|DROP INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;TOKEN&#x7c;FULLTEXT]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|8}}
+
|<code><drop-index type='text&#x7c;attribute&#x7c;token&#x7c;fulltext'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Denotes the maximum allowed {{Code|number}} of parallel [[Transaction Management|transactions]].<br/>Note that a higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.
+
|Drops the specified [[Indexes#Value Indexes|Value Index]].
 +
|- valign="top"
 +
| '''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.
 
|}
 
|}
  
−
===LOG===
+
==ALTER DB==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|LOG [boolean]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|true}}
 
−
|-
 
−
| '''Summary'''
 
−
|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.
 
−
|}
 
  
−
===LOGMSGMAXLEN===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|LOGMSGMAXLEN [length]}}
+
|{{Code|ALTER DB [name] [newname]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|1000}}
+
|<code><alter-db name='...' newname='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies the maximum length of a single [[Logging|log message]].
+
|Renames the database specified by {{Code|name}} to {{Code|newname}}. {{Code|newname}} must be a [[#Valid Names|valid database name]].
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the source database does not exist or is currently locked, or if it could not be renamed for some other reason.
 +
|- valign="top"
 +
| '''Examples'''
 +
|
 +
* {{Code|ALTER DB db tempdb}}<br/>renames the database {{Code|db}} into {{Code|tempdb}}.
 
|}
 
|}
  
−
==HTTP Options==
+
==DROP DB==
−
 
 
−
If BaseX is run as [[Web Application]], the HTTP options are either determined by the web server, or specified in the <code>[https://github.com/BaseXdb/basex-api/tree/master/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory and the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files.
 
  
−
===WEBPATH===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|WEBPATH [path]}}
+
|{{Code|DROP DB [name]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|<code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code> or <code>[[Configuration#Database Directory|{home}/webapp]]</code>
+
|<code><drop-db name='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files.
+
|Drops the database with the specified {{Code|name}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
 +
|- valign="top"
 +
| '''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.
 
|}
 
|}
  
−
===RESTXQPATH===
+
==COPY==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|RESTXQPATH [path]}}
+
|{{Code|COPY [name] [newname]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><copy name='...' newname='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the [[#WEBPATH|WEBPATH]] directory.
+
|Creates a copy of the database specified by {{Code|name}}. {{Code|newname}} must be a [[#Valid Names|valid database name]].
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the source database does not exist.
 
|}
 
|}
  
−
===HTTPLOCAL===
+
==INSPECT==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|HTTPLOCAL [boolean]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|false}}
 
−
|-
 
−
| '''Summary'''
 
−
|By default, a database server instance will be opened along with the web server. If the flag is set to {{Code|true}}, all commands will be executed in an embedded database context.<br/>If BaseX is run as [[Web Application]], and if the flag is {{Code|false}}, the server will be started as soon as the first HTTP service is called.
 
−
|}
 
  
−
===STOPPORT===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|STOPPORT [port]}}
+
|{{Code|INSPECT}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|8985}}
+
|<code><inspect/></code>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:
+
|Performs some integrity checks on the opened database and returns a brief summary.
−
* The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}.
 
−
* The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].
 
−
* This option can also be changed when running the HTTP server on [[Command-Line Options#BaseX Server|command line]] via <code>-s</code>.
 
 
|}
 
|}
  
−
=Create Options=
+
=Backups=
  
−
==General==
+
==CREATE BACKUP==
  
−
===MAINMEM===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|MAINMEM [boolean]}}
+
|{{Code|CREATE BACKUP ([name] ([comment]))}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><create-backup (name='...') (comment='...')/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|If this option is turned on, new databases will be exclusively created in main memory. Most queries will be evaluated faster in main memory mode, but all data is lost if BaseX is shut down. The value of this option will be assigned once to a new database, and cannot be changed after that.
+
|Creates a backup of the database specified by {{Code|name}}, with an optional {{Code|comment}}. If no name is supplied, general data will be backed up. 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.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified database does not exist, or if it could not be zipped for some other reason.
 +
|- valign="top"
 +
| '''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]].
 
|}
 
|}
  
−
===ADDCACHE===
+
==DROP BACKUP==
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|ADDCACHE [boolean]}}
+
|{{Code|DROP BACKUP ([name])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><drop-backup (name='...')/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|If this option is activated, documents that are added via [[Commands#ADD|ADD]] will first be cached to disk before being added to the final database. This option is helpful when larger documents are to be imported, and if the existing heuristics cannot estimate the size of the input (e.g. when adding directories).
+
|Drops all backups of the database with the specified {{Code|name}}, or a specific backup file if the name ends with its timestamp. If no name is supplied, backups with general data are addressed. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
 +
|- valign="top"
 +
| '''Examples'''
 +
|
 +
* {{Code|DROP BACKUP abc*}}<br/>deletes the backups of all databases starting with the characters {{Code|abc}}.
 +
* {{Code|DROP BACKUP factbook-2021-05-16-13-13-10}}<br/>deletes a specific backup file.
 
|}
 
|}
  
−
==Parsing==
+
==ALTER BACKUP==
  
−
===CREATEFILTER===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|CREATEFILTER [filter]}}
+
|{{Code|ALTER BACKUP [name] [newname]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|*.xml}}
+
|<code><alter-backup name='...' newname='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
+
|Renames all backups of the database with the specified {{Code|name}} to {{Code|newname}}. If the name ends with a timestamp, only the specified backup file will be renamed. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
 +
|- valign="top"
 +
| '''Examples'''
 +
|
 +
* {{Code|ALTER BACKUP logs logs-backup}}<br/>renames the backups of the {{Code|logs}} database to {{Code|logs-backup}}.
 
|}
 
|}
  
−
===ADDARCHIVES===
+
==RESTORE==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|ADDARCHIVES [boolean]}}
+
|{{Code|RESTORE ([name])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|true}}
+
|<code><restore (name='...')/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a database.
+
|Restores a database with the specified {{Code|name}}. The name may include the timestamp of the backup file. If no name is supplied, general data will be restored. If general data is restored, it will only be available after BaseX has been restarted.
 +
|- valign="top"
 +
| '''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.
 
|}
 
|}
  
−
===SKIPCORRUPT===
+
==SHOW BACKUPS==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|SKIPCORRUPT [boolean]}}
+
|{{Code|SHOW BACKUPS}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><show-backups/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files will be parsed twice. Next, main memory consumption will be higher as parsed files will be cached in main memory.
+
|Shows all database backups.
 
|}
 
|}
  
−
===ADDRAW===
+
= Querying =
 +
 
 +
==XQUERY==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|ADDRAW [boolean]}}
+
|{{Code|XQUERY [query]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><xquery>[query]</xquery></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''depends on query''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|If this option is activated, and if new resources are added to a database, all files that are not filtered by the [[#CREATEFILTER|CREATEFILTER]] option will be added as ''raw'' files (i.e., in their binary representation).
+
|Runs the specified {{Code|query}} and prints the result.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified query is invalid.
 +
|- valign="top"
 +
| '''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</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.
 
|}
 
|}
  
−
===PARSER===
+
==GET==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|PARSER [type]}}
+
|{{Code|GET [path]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|XML}}
+
|<code><get path='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is not found in the classpath.
+
|Retrieves an XML document from the opened database at the specified {{Code|path}}.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened or if the source path is invalid.
 
|}
 
|}
  
−
===CSVPARSER===
+
==BINARY GET==
−
 
 
−
Introduced with {{Mark|Version 7.8:}}
 
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|CSVPARSER [options]}}
+
|{{Code|BINARY GET [path]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><binary-get path='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies the way how CSV data is to be parsed. The available options are listed in the [[CSV Module#Options|CSV Module]].
+
|Retrieves a [[Binary Data|binary resource]] from the opened database at the specified {{Code|path}}.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened or if the source path is invalid.
 
|}
 
|}
  
−
===JSONPARSER===
+
==FIND==
−
 
 
−
Introduced with {{Mark|Version 7.8:}}
 
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|JSONPARSER [options]}}
+
|{{Code|FIND [query]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><find>[query]</find></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies the way how JSON data is to be parsed. The available options are listed in the [[JSON Module#Options|JSON Module]].
+
|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
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened.
 
|}
 
|}
  
−
===TEXTPARSER===
+
==TEST==
−
 
 
−
Introduced with {{Mark|Version 7.8:}}
 
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|TEXTPARSER [options]}}
+
|{{Code|TEST [path]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><test path='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies the way how TEXT data is to be parsed. Available options are listed in the article on [[Parsers]].
+
|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]].
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if at least one test fails.
 +
|- valign="top"
 +
| '''Examples'''
 +
|
 +
* {{Code|TEST project/tests}}<br/>runs all tests in the directory {{Code|project/tests}}.
 
|}
 
|}
  
−
==XML Parsing==
+
==REPO INSTALL==
  
−
===CHOP===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|CHOP [boolean]}}
+
|{{Code|REPO INSTALL [path]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|true}}
+
|<code><repo-install path='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. By default, this option is set to {{Code|true}}, as it often reduces the database size by up to 50%. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>.  
+
| Installs the package with path {{Code|path}}.
 +
|- valign="top"
 +
| '''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.
 
|}
 
|}
  
−
===INTPARSE===
+
==REPO LIST==
−
 
 
−
{{Mark|Updated with Version 7.8}}: default is now {{Code|false}}.
 
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|INTPARSE [boolean]}}
+
|{{Code|REPO LIST}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><repo-list/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Uses the internal XML parser instead of the standard Java XML parser. The internal parser is faster, more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for parsing DTDs.
+
| Lists all installed packages.
 
|}
 
|}
  
−
===DTD===
+
==REPO DELETE==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|DTD [boolean]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|false}}
 
−
|-
 
−
| '''Summary'''
 
−
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The [[#CATFILE|CATFILE]] option can be changed to locally resolve DTDs.
 
−
|}
 
  
−
===CATFILE===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|CATFILE [path]}}
+
|{{Code|REPO DELETE [name]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><repo-delete name='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies a catalog file to locally resolve DTDs; see the entry on [[Catalog Resolver]]s for more details.
+
| Deletes the specified package with the specified {{Code|name}}. What is called "name" can also be the id (which is the name followed by the version) or the directory of the package.
 +
|- valign="top"
 +
| '''Errors'''
 +
| The command fails if the package to be deleted is required by another package.
 
|}
 
|}
  
−
==Indexing==
+
=Updates=
  
−
The current index and full-text index options will be stored in a new database, and take effect if indexes are rebuilt via the [[Commands#OPTIMIZE|OPTIMIZE]].
+
==ADD==
  
−
===TEXTINDEX===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|TEXTINDEX [boolean]}}
+
|{{Code|ADD (TO [path]) [input]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|true}}
+
|<code><add (path='...')>[input]</add></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see [[Indexes]] for more details.
+
|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|PUT}} 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.
 +
|- valign="top"
 +
| '''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.
 +
|- valign="top"
 +
| '''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.
 
|}
 
|}
  
−
===ATTRINDEX===
+
==DELETE==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|ATTRINDEX [boolean]}}
+
|{{Code|DELETE [path]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|true}}
+
|<code><delete path='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values; see [[Indexes]] for more details.
+
|Deletes all documents from the currently opened database that start with the specified {{Code|path}}.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened.
 
|}
 
|}
  
−
===FTINDEX===
+
==RENAME==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|FTINDEX [boolean]}}
+
|{{Code|RENAME [path] [newpath]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><rename path='...' newpath='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions; see [[Indexes]] for more details.
+
|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.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened, or if the target path is empty.
 +
|- valign="top"
 +
| '''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.
 
|}
 
|}
  
−
===MAXLEN===
+
==PUT==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|MAXLEN [int]}}
+
|{{Code|PUT [path] [input]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|96}}
+
|<code><put path='...'>[input]</put></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies the maximum length of strings that are to be indexed by the name, path, value, and full-text index structures. The value of this option will be assigned once to a new database, and cannot be changed after that.
+
|Adds or replaces resources in the currently opened database, addressed by {{Code|path}}, with the file, directory or XML string specified by {{Code|input}}.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened or if the specified path is invalid.
 +
|- valign="top"
 +
| '''Examples'''
 +
|
 +
* {{Code|PUT one.xml input.xml}}<br/>replaces {{Code|one.xml}} with the contents of the file {{Code|input.xml}}.
 +
* {{Code|PUT top.xml &lt;xml/&gt;}}<br/>replaces {{Code|top.xml}} with the XML document {{Code|&lt;xml/&gt;}}.
 
|}
 
|}
  
−
===MAXCATS===
+
==BINARY PUT==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|MAXCATS [int]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|100}}
 
−
|-
 
−
| '''Summary'''
 
−
|Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that.
 
−
|}
 
  
−
===UPDINDEX===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|UPDINDEX [boolean]}}
+
|{{Code|BINARY PUT (TO [path]) [input]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><binary-put (path='...')>[input]</store></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|If turned on, incremental indexing will be activated:
+
|Stores a [[Binary Data|binary resource]] specified via {{Code|input}} in the opened database to the specified {{Code|path}}:
−
* with each update, the text and attribute value indexes will be updated as well.
+
* The input may either be a file reference, a remote URL, or a plain string.
−
* The value of this option will be assigned once to a new database, and cannot be changed after that.
+
* If the path denotes a directory, it needs to be suffixed with a slash ({{Code|/}}).
−
* The advantage of incremental indexes is that the value index structures will always be up-to-date.
+
* An existing resource will be replaced.
−
* The downside is that updates will take longer. The article on [[Index#Updates|Index Structures]] includes additional details.
+
|- valign="top"
 +
| '''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.
 
|}
 
|}
  
−
===INDEXSPLITSIZE===
+
==OPTIMIZE==
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|INDEXSPLITSIZE [num]}}
+
|{{Code|OPTIMIZE (ALL)}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|0}}
+
|<code><optimize/></code><br/><code><optimize-all/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|This option affects the [[Indexes#Index Construction|construction]] of new text and attribute indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied.
+
|Optimizes the index structures, metadata 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 {{Option|AUTOOPTIMIZE}} and (if {{Code|ALL}} is specified) {{Option|UPDINDEX}} will be adopted from the current options.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened, or if the currently opened database is a main-memory instance.
 
|}
 
|}
  
−
===FTINDEXSPLITSIZE===
+
==FLUSH==
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|FTINDEXSPLITSIZE [num]}}
+
|{{Code|FLUSH}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|0}}
+
|<code><flush/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|This option affects the [[Indexes#Index Construction|construction]] of new full-text indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied.
+
|Explicitly flushes the buffers of the currently opened database to disk. This command is applied if {{Option|AUTOFLUSH}} has been set to {{Code|false}}.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened.
 
|}
 
|}
  
−
==Full-Text==
+
=User Management=
 +
 
 +
==CREATE USER==
  
−
===STEMMING===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|STEMMING [boolean]}}
+
|{{Code|CREATE USER [name] ([password])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><create-user name='...'>([password])</create-user></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|A new full-text index will stem all tokens and speed up queries on stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this index.
+
|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).
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified user already exists.
 
|}
 
|}
  
−
===CASESENS===
+
==ALTER USER==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|CASESENS [boolean]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|false}}
 
−
|-
 
−
| '''Summary'''
 
−
|A new full-text index will preserve the case of all tokens. The same case normalization will be applied to all query tokens that are checked against tokens in this index.
 
−
|}
 
  
−
===DIACRITICS===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|DIACRITICS [boolean]}}
+
|{{Code|ALTER USER [name] ([newname])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><alter-user name='...' newname='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|A new full-text index will preserve the diacritics of all tokens. The same diacritics normalization will be applied to all query tokens that are checked against tokens in this index.
+
|Renames the user with the specified {{Code|name}} to {{Code|newname}}.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified user does not exist, or if the new user already exists.
 
|}
 
|}
  
−
===LANGUAGE===
+
==ALTER PASSWORD==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|LANGUAGE [lang]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|en}}
 
−
|-
 
−
| '''Summary'''
 
−
|A new full-text index will use the given language to normalize all tokens. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages.
 
−
|}
 
  
−
===STOPWORDS===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|STOPWORDS [path]}}
+
|{{Code|ALTER PASSWORD [name] ([password])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><alter-password name='...'>([password])</alter-password></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. A standard stopword list for English texts is provided in the directory {{Code|etc/stopwords.txt}} in the official releases.
+
|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).
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified user does not exist.
 
|}
 
|}
  
−
=Query Options=
+
==DROP USER==
  
−
===QUERYINFO===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|QUERYINFO [boolean]}}
+
|{{Code|DROP USER [name] (ON [pattern])}}:
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><drop-user name='...' (pattern='...')/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.  
+
|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 assigned database pattern will be removed.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if {{Code|admin}} is specified as username, or if the specified user does not exist or is currently logged in.
 
|}
 
|}
  
−
===XQUERY3===
+
==GRANT==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|XQUERY3}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|true}}
 
−
|-
 
−
| '''Summary'''
 
−
|Enables all [[XQuery 3.0]] features supported by BaseX. If this option is set to {{Code|false}}, the XQuery parser will only accept expressions of the XQuery 1.0 specification.
 
−
|}
 
  
−
===BINDINGS===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|BINDINGS [vars]}}
+
|{{Code|GRANT [NONE&#x7c;READ&#x7c;WRITE&#x7c;CREATE&#x7c;ADMIN] (ON [pattern]) TO [user]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><grant name='...' permission='none&#x7c;read&#x7c;write&#x7c;create&#x7c;admin' (pattern='...')/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Contains external variables to be bound to a query:
+
|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.
−
* Variable names and values are separated by equality signs, and multiple variables are delimited by commas.
+
|- valign="top"
−
* Variables may optionally be introduced with a leading dollar sign.
+
| '''Errors'''
−
* Commas that occur in the value itself are encoded by duplication.
+
|The command fails if {{Code|admin}} is specified as username or if the specified user does not exist.
−
* If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [http://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].
+
|- valign="top"
−
* This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>.
 
−
|-
 
 
| '''Examples'''
 
| '''Examples'''
−
|<code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b<br/> <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a<br/> <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}. <pre class="brush:xml">
+
|
−
SET BINDINGS BIND-VAR="hello world!"
+
* {{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission to the user {{Code|JoeWinson}}.
−
XQUERY declare variable $BIND-VAR external; $BIND-VAR
+
* {{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*}}.
−
</pre> &nbsp; binds the value {{Code|hello world!}} to the variable $BIND-VAR and shows how it can be used in a [[Commands#Command_Scripts| Command Script]].
+
|}
  
−
|}
+
==PASSWORD==
  
−
===QUERYPATH===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|QUERYPATH [path]}}
+
|{{Code|PASSWORD ([password])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><password>([password])</password></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Contains the path (''base URI'') to the executed query (default: ''empty''). This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a query.
+
|Changes the {{Code|password}} of the current user. If the command is run on command-line or in the GUI, the password can be omitted and entered interactively.
 
|}
 
|}
  
−
===INLINELIMIT===
+
=Administration=
  
−
{{Mark|Introduced with Version 7.8:}}
+
==SHOW OPTIONS==
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|INLINELIMIT}}
+
|{{Code|SHOW OPTIONS [name]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|100}}
+
|<code><show-options (name='...')/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies the maximum size the body of a function may have in order to be inlined. Function inlining can be turned off by setting this value to {{Code|-1}}.
+
|Returns the current values of all [[Options]], or a single option with the specified {{Code|name}}. Global options can only be requested by users with ADMIN permissions.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified option is unknown.
 
|}
 
|}
  
−
===TAILCALLS===
+
==SHOW SESSIONS==
−
 
 
−
{{Mark|Introduced with Version 7.8:}}
 
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|TAILCALLS}}
+
|{{Code|SHOW SESSIONS}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|256}}
+
|<code><show-sessions/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies how many stack frames of [http://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1}}.
+
|Shows all sessions that are connected to the current server instance.
 
|}
 
|}
  
−
===DEFAULTDB===
+
==SHOW USERS==
−
 
 
−
{{Mark|Introduced with Version 7.8:}}
 
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|DEFAULTDB}}
+
|{{Code|SHOW USERS (ON [database])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><show-users (database='...')/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|If this option is turned on, paths specified in the {{Code|fn:doc}} and {{Code|fn:collections}} functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the [[Commands#OPEN|OPEN]] command). If the path does not match any existing resources, it will be resolved as described in the article on [[Databases#Access Resources|accessing database resources]].
+
|Shows all users that are visible to the current user. If a {{Code|database}} is specified, only those users will be shown for which a pattern was specified that matches the database name.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the optional database could not be opened.
 
|}
 
|}
  
−
===CACHEQUERY===
+
==KILL==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|CACHEQUERY [boolean]}}
+
|{{Code|KILL [target]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><kill target='...'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Caches the query results before returning them to the client. This option may be set to {{Code|true}} if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX).
+
|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.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if a user tried to kill his/her own session.
 
|}
 
|}
  
−
===FORCECREATE===
+
==INFO DB==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|FORCECREATE [boolean]}}
+
|{{Code|INFO DB}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><info-db/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|By activating this option, the XQuery {{Code|doc()}} and  {{Code|collection()}} functions will create database instances for the addressed input files.
+
|Shows general information and metadata on the currently opened database.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened.
 
|}
 
|}
  
−
===CHECKSTRINGS===
+
==INFO INDEX==
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|CHECKSTRINGS [boolean]}}
+
|{{Code|INFO INDEX ([ELEMNAME&#x7c;ATTRNAME&#x7c;PATH&#x7c;TEXT&#x7c;ATTRIBUTE&#x7c;TOKEN&#x7c;FULLTEXT])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|true}}
+
|<code><info-index type='elemname&#x7c;attrname&#x7c;path&#x7c;text&#x7c;attribute&#x7c;token&#x7c;fulltext'/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|If this option is turned off, strings from external sources will be adopted as is, i. e., without being checked for valid XML characters:
+
|Shows information on the existing [[Indexes|index]] structures. The output can be optionally limited to the specified index.
−
* This option affects [[Java Bindings]] and the string conversion and input functions [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], [[Archive Module#archive:update|archive:update]], [[Conversion Module#convert:binary-to-string|convert:binary-to-string]], [[Fetch Module#fetch:text|fetch:text]], [[File Module#file:read-text|file:read-text]], and [[ZIP Module#zip:text-entry|zip:text-entry]].
+
|- valign="top"
−
* Please be aware that an inconsiderate use of this option may cause unexpected behavior when storing or outputting strings.
+
| '''Errors'''
 +
|The command fails if no database is opened, or if the specified index is unknown.
 
|}
 
|}
  
−
===LSERROR===
+
==INFO STORAGE==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|LSERROR [error]}}
+
|{{Code|INFO STORAGE [start end]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|0}}
+
|<code><info-storage (start='...') (end='...')/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option. See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information on fuzzy querying.
+
|Shows the internal main table of the currently opened database. An integer range may be specified as argument.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened, or if one of the specified arguments is invalid.
 
|}
 
|}
  
−
===RUNQUERY===
+
=General Commands=
  
−
{{Mark|Introduced with Version 7.8:}}
+
==RUN==
  
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|RUNQUERY [boolean]}}
+
|{{Code|RUN [file]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|true}}
+
|<code><run file='...'/></code>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''depends on input''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies if a query will be executed or parsed only. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>.
+
|Evaluates the contents of {{Code|file}} as XQuery expression. If the file ends with the suffix {{Code|.bxs}}, the file contents will be evaluated as [[#Basics|command script]]. This command can be used to run several commands in a row, with no other transaction intervening the execution.
 +
|- valign="top"
 +
| '''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.
 +
|- valign="top"
 +
| '''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
 
|}
 
|}
  
−
===RUNS===
+
==EXECUTE==
 +
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|RUNS [num]}}
+
|{{Code|EXECUTE [input]}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|1}}
+
|<code><execute>[input]</execute></code>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''depends on input''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Specifies how often a query will be evaluated. The result is serialized only once, and the measured times are averages of all runs. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-r</code>.
+
|Evaluates 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.
 +
|- valign="top"
 +
| '''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.
 +
|- valign="top"
 +
| '''Examples'''
 +
|
 +
* <code>EXECUTE "<commands><create-db name='db1'/><create-db name='db2'/></commands>"</code><br/>Two databases will be created in a single transaction.
 
|}
 
|}
  
−
=Serialization Options=
+
==SET==
  
−
===SERIALIZE===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|SERIALIZE [boolean]}}
+
|{{Code|SET [option] ([value])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|true}}
+
|<code><set option='...'>([value])</set></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.  
+
|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.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified option is unknown or if the specified value is invalid.
 
|}
 
|}
  
−
===SERIALIZER===
+
==INFO==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|SERIALIZER [params]}}
 
−
|-
 
−
| '''Default'''
 
−
|''empty''
 
−
|-
 
−
| '''Summary'''
 
−
|Contains parameters for [[Serialization|serializing]] query results:
 
−
* Keys and values are separated by equality signs.
 
−
* Multiple parameters are delimited by commas.
 
−
* The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
 
−
|-
 
−
| '''Example'''
 
−
|<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.
 
−
|}
 
  
−
===EXPORTER===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|EXPORTER [params]}}
+
|{{Code|INFO}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|''empty''
+
|<code><info/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Contains parameters for exporting all resources of a database; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas.
+
|Shows global information.
 
|}
 
|}
  
−
===XMLPLAN===
+
==HELP==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|XMLPLAN [boolean]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|false}}
 
−
|-
 
−
| '''Summary'''
 
−
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.
 
−
|}
 
  
−
===COMPPLAN===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|COMPPLAN [boolean]}}
+
|{{Code|HELP ([command])}}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|true}}
+
|<code><help>([command])</help></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Creates the query plan before or after query compilation. Query plans might change due to optimizations.
+
|If {{Code|command}} is specified, information on the specific command is printed; otherwise, all commands are listed.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified command is unknown.
 
|}
 
|}
  
−
===DOTPLAN===
+
==EXIT==
−
{| width='100%'
 
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|DOTPLAN [boolean]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|false}}
 
−
|-
 
−
| '''Summary'''
 
−
|Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file in the query directory.
 
−
|}
 
  
−
===DOTCOMPACT===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|DOTCOMPACT [boolean]}}
+
|{{Code|EXIT }}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|false}}
+
|<code><exit/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Chooses a compact dot representation.
+
|Exits the console mode.
 
|}
 
|}
  
−
=Other Options=
+
==QUIT==
  
−
===AUTOFLUSH===
 
 
{| width='100%'
 
{| width='100%'
−
|-
+
|- valign="top"
−
| width='120' | '''Signature'''
+
|width='130'|'''Syntax'''
−
|{{Code|AUTOFLUSH [boolean]}}
+
|{{Code|QUIT }}
−
|-
+
|- valign="top"
−
| '''Default'''
+
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
−
|{{Code|true}}
+
|<code><quit/></code><br/>
−
|-
+
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
−
|Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the [[Commands#FLUSH|FLUSH]] command.
+
|Exits the console mode (alias of {{Command|EXIT}}).
 
|}
 
|}
  
−
===WRITEBACK===
+
=Changelog=
  
−
{{Mark|Updated with Version 7.8:}} only applies to main-memory document instances.
+
;Version 10
 +
* Added: [[#Backups|Backups]]: Support for general data ([[User Management|registered users]], [[Job Module#Services|scheduled services]] and [[Store Module|key-value stores]]).
 +
* Added: {{Command|DIR}}, {{Command|GET}}
 +
* Updated: {{Command|SHOW OPTIONS}}: Renamed (before: {{Code|GET}}).
 +
* Updated: {{Command|BINARY GET}}: Renamed (before: {{Code|RETRIEVE}}).
 +
* Updated: {{Command|BINARY PUT}}: Renamed (before: {{Code|STORE}}).
 +
* Updated: {{Command|PUT}}: Renamed (before: {{Code|REPLACE}}).
 +
* Updated: {{Command|CREATE BACKUP}}: Support for comments.
 +
* Updated: {{Command|OPEN}}: {{Code|path}} argument dropped.
 +
* Removed: {{Code|JOBS LIST}}, {{Code|JOBS RESULT}}, {{Code|JOBS STOP}}
  
−
{| width='100%'
+
;Version 9.7
−
|-
+
* Updated: {{Command|ALTER DB}}, {{Command|COPY}}: Overwrite existing databases.
−
| width='120' | '''Signature'''
 
−
|{{Code|WRITEBACK [boolean]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|false}}
 
−
|-
 
−
| '''Summary'''
 
−
|Propagates updates on main-memory instances of files that have been retrieved via {{Code|fn:doc}} or {{Code|fn:collection}} back to disk. No backups of your original files will be created if this option is turned on. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>.
 
−
|}
 
  
−
===MAXSTAT===
+
;Version 9.3
−
{| width='100%'
+
* Added: {{Command|ALTER BACKUP}}
−
|-
 
−
| width='120' | '''Signature'''
 
−
|{{Code|MAXSTAT [num]}}
 
−
|-
 
−
| '''Default'''
 
−
|{{Code|30}}
 
−
|-
 
−
| '''Summary'''
 
−
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO|INFO INDEX]]</code> command.
 
−
|}
 
  
−
=Changelog=
+
;Version 8.6
 +
* Updated: {{Command|SHOW USERS}}: If called by non-admins, will only return the current user
  
−
;Version 7.8
+
;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)
  
−
* Added: <code>[[#CSVPARSER|CSVPARSER]]</code>, <code>[[#JSONPARSER|JSONPARSER]]</code>, <code>[[#TEXTPARSER|TEXTPARSER]]</code>, <code>[[#HTMLPARSER|HTMLPARSER]]</code>, <code>[[#INLINELIMIT|INLINELIMIT]]</code>, <code>[[#TAILCALLS|TAILCALLS]]</code>, <code>[[#DEFAULTDB|DEFAULTDB]]</code>, <code>[[#RUNQUERY|RUNQUERY]]</code>
+
;Version 8.4
−
* Updated: <code>[[#WRITEBACK|WRITEBACK]]</code> only applies to main-memory document instances.
+
* Updated: {{Command|CREATE INDEX}}, {{Command|DROP INDEX}}, {{Command|INFO INDEX}}: token index added
−
* Updated: <code>[[#DEBUG|DEBUG]]</code> option can be changed at runtime by users with admin permissions.
+
* Updated: {{Command|INFO STORAGE}}: Query argument removed, start/end added to XML syntax.
−
* Updated: default of <code>[[#INTPARSE|INTPARSE]]</code> is now {{Code|false}}.
+
* Updated: {{Command|INFO INDEX}}: Token index added; index {{Code|TAG}} renamed to {{Code|ELEMNAME}}; index {{Code|ATTNAME}} renamed to {{Code|ATTRNAME}}
−
* Removed: <code>HTMLOPT</code> (replaced with <code>[[#HTMLPARSER|HTMLPARSER]]</code>), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
+
* Updated: {{Command|OPTIMIZE}}: adopt original index options
  
−
;Version 7.7
+
;Version 8.2
 +
* Removed: {{Code|CREATE EVENT}}, {{Code|DROP EVENT}} and {{Code|SHOW EVENTS}} command
  
−
* Added: <code>[[#ADDCACHE|ADDCACHE]]</code>, <code>[[#CHECKSTRINGS|CHECKSTRINGS]]</code>, <code>[[#FTINDEXSPLITSIZE|FTINDEXSPLITSIZE]]</code>, <code>[[#INDEXSPLITSIZE|INDEXSPLITSIZE]]</code>
+
;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.6
+
;Version 7.9
 +
* Added: {{Command|TEST}} runs XQUnit tests.
  
−
* Added: <code>[[#GLOBALLOCK|GLOBALLOCK]]</code>
+
;Version 7.7
−
* Added: store local options in configuration file after {{Code|# Local Options}} comments.
+
* Updated: syntax of [[#Valid Names|valid names]].
  
 
;Version 7.5
 
;Version 7.5
−
 
+
* Added: {{Command|EXECUTE}} executes a command script.
−
* Added: options can now be set via system properties
+
* Added: {{Command|INSPECT}} performs integrity checks.
−
* Added: a pragma expression can be used to locally change database options
+
* Added: automatic detection of [[#Basics|Command Scripts]].
−
* Added: <code>[[#USER|USER]]</code>, <code>[[#PASSWORD|PASSWORD]]</code>, <code>[[#LOG|LOG]]</code>, <code>[[#LOGMSGMAXLEN|LOGMSGMAXLEN]]</code>, <code>[[#WEBPATH|WEBPATH]]</code>, <code>[[#RESTXQPATH|RESTXQPATH]]</code><code>[[#HTTPLOCAL|HTTPLOCAL]]</code>, <code>[[#CREATEONLY|CREATEONLY]]</code>, <code>[[#STRIPNS|STRIPNS]]</code>
+
* Removed: {{Code|SHOW DATABASES}}; information is also returned by {{Command|SHOW SESSIONS}}.
−
* Removed: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: {{Code|jetty.xml}} configuration file is used instead
+
* Removed: {{Command|OPEN}}: path argument.
−
* Removed: global options cannot be changed anymore during the lifetime of a BaseX instance
 
  
 
;Version 7.3
 
;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.
  
−
* Updated: <code>[[#KEEPALIVE|KEEPALIVE]]</code>, <code>[[#TIMEOUT|TIMEOUT]]</code>: default values changed
+
;Version 7.2.1
−
* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries
+
* Updated: permissions for {{Code|GET}} and {{Command|SET}} changed from {{Code|READ}} to {{Code|NONE}}.
−
* Removed: {{Code|SCORING}}; new scoring model will focus on lengths of text nodes and match options
 
  
 
;Version 7.2
 
;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}}).
−
* Added: <code>[[#PROXYHOST|PROXYHOST]]</code>, <code>[[#PROXYPORT|PROXYPORT]]</code>, <code>[[#NONPROXYHOSTS|NONPROXYHOSTS]]</code>, <code>[[#HTMLOPT|HTMLOPT]]</code>
+
* Updated: permissions for {{Command|REPO DELETE}}, {{Command|REPO INSTALL}} and {{Command|REPO LIST}}.
−
* Updated: <code>[[#TIMEOUT|TIMEOUT]]</code>: ignore timeout for admin users
 
  
 
;Version 7.1
 
;Version 7.1
−
 
+
* Updated: {{Command|KILL}} (killing sessions by specifying IP:port)
−
* Added: <code>[[#ADDRAW|ADDRAW]]</code>, <code>[[#MAXLEN|MAXLEN]]</code>, <code>[[#MAXCATS|MAXCATS]]</code>, <code>[[#UPDINDEX|UPDINDEX]]</code>
 
−
* Updated: <code>[[#BINDINGS|BINDINGS]]</code>
 
  
 
;Version 7.0
 
;Version 7.0
−
 
+
* Added: {{Command|FLUSH}}, {{Code|RETRIEVE}}, {{Code|STORE}}.
−
* Added: <code>[[#SERVERHOST|SERVERHOST]]</code>, <code>[[#KEEPALIVE|KEEPALIVE]]</code>, <code>[[#AUTOFLUSH|AUTOFLUSH]]</code>, <code>[[#QUERYPATH|QUERYPATH]]</code>
+
* Updated: {{Command|ADD}}: simplified arguments.

Latest revision as of 18:39, 1 December 2023

This article is part of the Getting Started Section. It lists all database commands supported by BaseX.

Commands can be executed from the Command Line, as part of 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 itself will show up in the Info View. The Permission fields indicate which rights are required by a user to perform a command in the client/server architecture.

Basics[edit]

Command Scripts[edit]

On command line, multiple commands can be written down in a single line (separated by semicolons). 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 .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 be recognized and evaluated as such.

String Syntax[edit]

Lines starting with # are interpreted as comments and are skipped. With the following script, a database is created, two documents are added to it, and a query is performed: 

CREATE DB test
ADD TO embedded.xml <root>embedded</root>
# run query
XQUERY <hits>{ count(//text()) }</hits>
CLOSE

XML Syntax[edit]

The string syntax is limited when XML snippets need to be embedded in a command, or when complex queries are to be specified.

The XML syntax provides more flexibility here. Multiple commands can be enclosed by a <commands/> root element. Some commands, such as ADD, allow you to directly embed XML documents. If you want to embed XML in XQuery expressions, entities should be encoded, or the CDATA syntax should be used: 

<commands>
  <create-db name='test'/>
  <add path='embedded.xml'><root>embedded</root></add>
  <!-- run query -->
  <xquery><![CDATA[
    <hits>{ count(//text()) }</hits>
  ]]></xquery>
  <close/>
</commands>

Glob Syntax[edit]

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:

  • AB? addresses all names with the characters AB and one more character.
  • *AB addresses all names ending with the characters AB.
  • X*,Y*,Z* addresses all names starting with the characters X, Y, or Z.

Valid Names[edit]

Names of databases and users follow the same constraints: Names must at least have one printable character, including letters, numbers, and any of the special characters !#$%&'()+-=@[]^_`{}~. The following characters are disallowed:

  • ,?*: glob syntax
  • ;: Separator for multiple database commands on the command line
  • \/: Directory path separators
  • :"<>|: invalid filename characters on Windows
  • Names starting or ending with .: hidden folders (e.g. the .logs directory)

Aliases[edit]

In all commands, the DB keyword can be replaced by DATABASE.

Database Operations[edit]

CREATE DB[edit]

Syntax CREATE DB [name] ([input])
XML Syntax    <create-db name='...'>([input])</create-db>
Permission CREATE
Summary Creates a new database with the specified name and, optionally, an initial input, and opens it. An existing database will be overwritten.
The input can be a file or directory path to XML documents, a remote URL, or a string containing XML:

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 ADD.

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
  • CREATE DB input
    creates an empty database input.
  • CREATE DB xmark http://files.basex.org/xml/xmark.xml
    creates the database xmark, containing a single initial document called xmark.xml.
  • CREATE DATABASE coll /path/to/input
    creates the database coll with all documents found in the input directory.
  • SET INTPARSE false and CREATE DB input input.xml
    creates a database input with input.xml as initial document, which will be parsed with Java's default XML parser.
  • <create-db name='simple'><hello>Universe</hello></create-db>
    creates a database named simple with an initial document <hello>Universe</hello>.

OPEN[edit]

Syntax OPEN [name]
XML Syntax    <open name='...'/>
Permission READ
Summary Opens the database specified by name.
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[edit]

Syntax CHECK [input]
XML Syntax    <check input='...'/>
Permission READ/CREATE
Summary This convenience command combines OPEN and CREATE DB: If a database with the name input exists, 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 The command fails if the addressed database could neither be opened nor created.

CLOSE[edit]

Syntax CLOSE
XML Syntax    <close/>
Permission READ
Summary Closes the currently opened database.
Errors The command fails if the database files could not be closed for some reason.

LIST[edit]

Syntax LIST ([name] ([path]))
XML Syntax    <list (name='...' (path='...'))/>
Permission NONE
Summary Lists all available databases. If name is specified, the resources of a database are listed. The output can be further restricted to the resources matching the specified path.
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.

DIR[edit]

Syntax DIR ([path]))
XML Syntax    <dir (path='...')/>
Permission READ
Summary Lists directories and resources of the currently opened database and the specified path.
If database resources are listed, the size is either the number of nodes (for XML resources) or the number of bytes (for binary resources).

EXPORT[edit]

Syntax EXPORT [path]
XML Syntax    <export path='...'/>
Permission CREATE
Summary Exports all documents in the database to the specified file path, using the serializer options specified by the EXPORTER 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[edit]

Syntax CREATE INDEX [TEXT|ATTRIBUTE|TOKEN|FULLTEXT]
XML Syntax    <create-index type='text|attribute|token|fulltext'/>
Permission WRITE
Summary Creates the specified Value Index. The current 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[edit]

Syntax DROP INDEX [TEXT|ATTRIBUTE|TOKEN|FULLTEXT]
XML Syntax    <drop-index type='text|attribute|token|fulltext'/>
Permission WRITE
Summary Drops the specified 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.

ALTER DB[edit]

Syntax ALTER DB [name] [newname]
XML Syntax    <alter-db name='...' newname='...'/>
Permission CREATE
Summary Renames the database specified by name to newname. newname must be a valid database name.
Errors The command fails if the source database does not exist or is currently locked, or if it could not be renamed for some other reason.
Examples
  • ALTER DB db tempdb
    renames the database db into tempdb.

DROP DB[edit]

Syntax DROP DB [name]
XML Syntax    <drop-db name='...'/>
Permission CREATE
Summary Drops the database with the specified name. The 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.

COPY[edit]

Syntax COPY [name] [newname]
XML Syntax    <copy name='...' newname='...'/>
Permission CREATE
Summary Creates a copy of the database specified by name. newname must be a valid database name.
Errors The command fails if the source database does not exist.

INSPECT[edit]

Syntax INSPECT
XML Syntax    <inspect/>
Permission READ
Summary Performs some integrity checks on the opened database and returns a brief summary.

Backups[edit]

CREATE BACKUP[edit]

Syntax CREATE BACKUP ([name] ([comment]))
XML Syntax    <create-backup (name='...') (comment='...')/>
Permission CREATE
Summary Creates a backup of the database specified by name, with an optional comment. If no name is supplied, general data will be backed up. The backup file will be suffixed with the current timestamp and stored in the database directory. The 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
  • BACKUP db
    creates a zip archive of the database db (e.g. db-2014-04-01-12-27-28.zip) in the database directory.

DROP BACKUP[edit]

Syntax DROP BACKUP ([name])
XML Syntax    <drop-backup (name='...')/>
Permission CREATE
Summary Drops all backups of the database with the specified name, or a specific backup file if the name ends with its timestamp. If no name is supplied, backups with general data are addressed. The Glob Syntax can be used to address more than one database.
Examples
  • DROP BACKUP abc*
    deletes the backups of all databases starting with the characters abc.
  • DROP BACKUP factbook-2021-05-16-13-13-10
    deletes a specific backup file.

ALTER BACKUP[edit]

Syntax ALTER BACKUP [name] [newname]
XML Syntax    <alter-backup name='...' newname='...'/>
Permission CREATE
Summary Renames all backups of the database with the specified name to newname. If the name ends with a timestamp, only the specified backup file will be renamed. The Glob Syntax can be used to address more than one database.
Examples
  • ALTER BACKUP logs logs-backup
    renames the backups of the logs database to logs-backup.

RESTORE[edit]

Syntax RESTORE ([name])
XML Syntax    <restore (name='...')/>
Permission CREATE
Summary Restores a database with the specified name. The name may include the timestamp of the backup file. If no name is supplied, general data will be restored. If general data is restored, it will only be available after BaseX has been restarted.
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.

SHOW BACKUPS[edit]

Syntax SHOW BACKUPS
XML Syntax    <show-backups/>
Permission CREATE
Summary Shows all database backups.

Querying[edit]

XQUERY[edit]

Syntax XQUERY [query]
XML Syntax    <xquery>[query]</xquery>
Permission depends on query
Summary Runs the specified query and prints the result.
Errors The command fails if the specified query is invalid.
Examples
  • XQUERY 1 to 10
    returns the sequence (1, 2, 3, 4, 5, 6, 7, 8, 9, 10).
  • SET RUNS 10 and XQUERY 1 to 10
    returns the results after having run the query 10 times.
  • SET XMLPLAN true and XQUERY 1 to 10
    returns the result and prints the query plan as XML.

GET[edit]

Syntax GET [path]
XML Syntax    <get path='...'/>
Permission READ
Summary Retrieves an XML document from the opened database at the specified path.
Errors The command fails if no database is opened or if the source path is invalid.

BINARY GET[edit]

Syntax BINARY GET [path]
XML Syntax    <binary-get path='...'/>
Permission READ
Summary Retrieves a binary resource from the opened database at the specified path.
Errors The command fails if no database is opened or if the source path is invalid.

FIND[edit]

Syntax FIND [query]
XML Syntax    <find>[query]</find>
Permission READ
Summary Builds and runs a query for the specified query terms. Keywords can be enclosed in quotes to look for phrases. The following modifiers can be used to further limit search:

= looks for exact text nodes
~ looks for approximate hits
@= looks for exact attribute values
@ looks for attributes

Errors The command fails if no database is opened.

TEST[edit]

Syntax TEST [path]
XML Syntax    <test path='...'/>
Permission ADMIN
Summary Runs all XQUnit tests in the specified path. The path can point to a single file or a directory.
Unit testing can also be triggered via -t on command line.
Errors The command fails if at least one test fails.
Examples
  • TEST project/tests
    runs all tests in the directory project/tests.

REPO INSTALL[edit]

Syntax REPO INSTALL [path]
XML Syntax    <repo-install path='...'/>
Permission CREATE
Summary Installs the package with path 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[edit]

Syntax REPO LIST
XML Syntax    <repo-list/>
Permission READ
Summary Lists all installed packages.

REPO DELETE[edit]

Syntax REPO DELETE [name]
XML Syntax    <repo-delete name='...'/>
Permission CREATE
Summary Deletes the specified package with the specified name. What is called "name" can also be the id (which is the name followed by the version) or the directory of the package.
Errors The command fails if the package to be deleted is required by another package.

Updates[edit]

ADD[edit]

Syntax ADD (TO [path]) [input]
XML Syntax    <add (path='...')>[input]</add>
Permission WRITE
Summary Adds a file, directory or XML string specified by input to the currently opened database at the specified path:
  • 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 PUT 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 ADDCACHE option on.

If files are to be added to an empty database, it is usually faster to use the 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
  • ADD input.xml
    adds the file input.xml to the database.
  • ADD TO temp/one.xml input.xml
    adds input.xml to the database and moves it to temp/one.xml.
  • ADD TO target/ xmldir
    adds all files from the xmldir directory to the database in the target path.

DELETE[edit]

Syntax DELETE [path]
XML Syntax    <delete path='...'/>
Permission WRITE
Summary Deletes all documents from the currently opened database that start with the specified path.
Errors The command fails if no database is opened.

RENAME[edit]

Syntax RENAME [path] [newpath]
XML Syntax    <rename path='...' newpath='...'/>
Permission WRITE
Summary Renames all document paths in the currently opened database that start with the specified 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
  • RENAME one.xml two.xml
    renames the document one.xml to two.xml.
  • RENAME / TOP
    moves all documents to a TOP root directory.

PUT[edit]

Syntax PUT [path] [input]
XML Syntax    <put path='...'>[input]</put>
Permission WRITE
Summary Adds or replaces resources in the currently opened database, addressed by path, with the file, directory or XML string specified by input.
Errors The command fails if no database is opened or if the specified path is invalid.
Examples
  • PUT one.xml input.xml
    replaces one.xml with the contents of the file input.xml.
  • PUT top.xml <xml/>
    replaces top.xml with the XML document <xml/>.

BINARY PUT[edit]

Syntax BINARY PUT (TO [path]) [input]
XML Syntax    <binary-put (path='...')>[input]</store>
Permission WRITE
Summary Stores a binary resource specified via input in the opened database to the specified 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 (/).
  • 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.

OPTIMIZE[edit]

Syntax OPTIMIZE (ALL)
XML Syntax    <optimize/>
<optimize-all/>
Permission WRITE
Summary Optimizes the index structures, metadata and statistics of the currently opened database:
  • If ALL is specified, all database structures are completely reconstructed. The database size will be reduced, and all orphaned data will be deleted.
  • Without 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 AUTOOPTIMIZE and (if ALL is specified) UPDINDEX 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[edit]

Syntax FLUSH
XML Syntax    <flush/>
Permission WRITE
Summary Explicitly flushes the buffers of the currently opened database to disk. This command is applied if AUTOFLUSH has been set to false.
Errors The command fails if no database is opened.

User Management[edit]

CREATE USER[edit]

Syntax CREATE USER [name] ([password])
XML Syntax    <create-user name='...'>([password])</create-user>
Permission ADMIN
Summary Creates a user with the specified name and 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[edit]

Syntax ALTER USER [name] ([newname])
XML Syntax    <alter-user name='...' newname='...'/>
Permission ADMIN
Summary Renames the user with the specified name to newname.
Errors The command fails if the specified user does not exist, or if the new user already exists.

ALTER PASSWORD[edit]

Syntax ALTER PASSWORD [name] ([password])
XML Syntax    <alter-password name='...'>([password])</alter-password>
Permission ADMIN
Summary Alters the password of the user with the specified 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[edit]

Syntax DROP USER [name] (ON [pattern]):
XML Syntax    <drop-user name='...' (pattern='...')/>
Permission ADMIN
Summary Drops the user with the specified name. The Glob Syntax can be used to address more than one database or user. If a glob pattern is specified, only the assigned database pattern will be removed.
Errors The command fails if admin is specified as username, or if the specified user does not exist or is currently logged in.

GRANT[edit]

Syntax GRANT [NONE|READ|WRITE|CREATE|ADMIN] (ON [pattern]) TO [user]
XML Syntax    <grant name='...' permission='none|read|write|create|admin' (pattern='...')/>
Permission ADMIN
Summary Grants the specified permission to the specified user. The Glob Syntax can be used to address more than one user. If a glob pattern is specified, the permission will be applied to all databases that match this pattern.
Errors The command fails if admin is specified as username or if the specified user does not exist.
Examples
  • GRANT READ TO JoeWinson
    grants READ permission to the user JoeWinson.
  • GRANT WRITE ON Wiki TO editor*
    grants WRITE permissions on the Wiki database to all users starting with the characters editor*.

PASSWORD[edit]

Syntax PASSWORD ([password])
XML Syntax    <password>([password])</password>
Permission NONE
Summary Changes the password of the current user. If the command is run on command-line or in the GUI, the password can be omitted and entered interactively.

Administration[edit]

SHOW OPTIONS[edit]

Syntax SHOW OPTIONS [name]
XML Syntax    <show-options (name='...')/>
Permission NONE
Summary Returns the current values of all Options, or a single option with the specified name. Global options can only be requested by users with ADMIN permissions.
Errors The command fails if the specified option is unknown.

SHOW SESSIONS[edit]

Syntax SHOW SESSIONS
XML Syntax    <show-sessions/>
Permission ADMIN
Summary Shows all sessions that are connected to the current server instance.

SHOW USERS[edit]

Syntax SHOW USERS (ON [database])
XML Syntax    <show-users (database='...')/>
Permission ADMIN
Summary Shows all users that are visible to the current user. If a database is specified, only those users 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[edit]

Syntax KILL [target]
XML Syntax    <kill target='...'/>
Permission ADMIN
Summary Kills sessions of a user or an IP:port combination, specified by target. The 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.

INFO DB[edit]

Syntax INFO DB
XML Syntax    <info-db/>
Permission READ
Summary Shows general information and metadata on the currently opened database.
Errors The command fails if no database is opened.

INFO INDEX[edit]

Syntax INFO INDEX ([ELEMNAME|ATTRNAME|PATH|TEXT|ATTRIBUTE|TOKEN|FULLTEXT])
XML Syntax    <info-index type='elemname|attrname|path|text|attribute|token|fulltext'/>
Permission READ
Summary Shows information on the existing 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[edit]

Syntax INFO STORAGE [start end]
XML Syntax    <info-storage (start='...') (end='...')/>
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.

General Commands[edit]

RUN[edit]

Syntax RUN [file]
XML Syntax    <run file='...'/>
Permission depends on input
Summary Evaluates the contents of file as XQuery expression. If the file ends with the suffix .bxs, the file contents will be evaluated as 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 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
  • RUN query.xq
    will evaluate the specified file as XQuery expression
  • RUN commands.bxs
    will evaluate the specified file as command script

EXECUTE[edit]

Syntax EXECUTE [input]
XML Syntax    <execute>[input]</execute>
Permission depends on input
Summary Evaluates the specified input as 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
  • EXECUTE "<commands><create-db name='db1'/><create-db name='db2'/></commands>"
    Two databases will be created in a single transaction.

SET[edit]

Syntax SET [option] ([value])
XML Syntax    <set option='...'>([value])</set>
Permission NONE
Summary Sets the Option specified by option to a new 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[edit]

Syntax INFO
XML Syntax    <info/>
Permission READ
Summary Shows global information.

HELP[edit]

Syntax HELP ([command])
XML Syntax    <help>([command])</help>
Permission NONE
Summary If 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[edit]

Syntax EXIT
XML Syntax    <exit/>
Permission NONE
Summary Exits the console mode.

QUIT[edit]

Syntax QUIT
XML Syntax    <quit/>
Permission NONE
Summary Exits the console mode (alias of EXIT).

Changelog[edit]

Version 10
Version 9.7
Version 9.3
Version 8.6
  • Updated: SHOW USERS: If called by non-admins, will only return the current user
Version 8.5
Version 8.4
Version 8.2
  • Removed: CREATE EVENT, DROP EVENT and SHOW EVENTS command
Version 8.0
Version 7.9
  • Added: TEST runs XQUnit tests.
Version 7.7
Version 7.5
  • Added: EXECUTE executes a command script.
  • Added: INSPECT performs integrity checks.
  • Added: automatic detection of Command Scripts.
  • Removed: SHOW DATABASES; information is also returned by SHOW SESSIONS.
  • Removed: OPEN: path argument.
Version 7.3
  • Added: XML Syntax added.
  • Updated: CHECK can now be used to create empty databases.
  • Updated: Names and paths in OPEN and LIST are now specified as separate arguments.
Version 7.2.1
  • Updated: permissions for GET and SET changed from READ to NONE.
Version 7.2
Version 7.1
  • Updated: KILL (killing sessions by specifying IP:port)
Version 7.0
  • Added: FLUSH, RETRIEVE, STORE.
  • Updated: ADD: simplified arguments.
Retrieved from "http://docs.basex.org/index.php?title=Commands&oldid=16889"