Difference between revisions of "Commands"

From BaseX Documentation
Jump to navigation Jump to search
m (→‎Info: changed to info storage)
 
(496 intermediate revisions by 10 users not shown)
Line 1: Line 1:
+
This article is part of the [[Getting Started]] Section.
Here you find a description of all database commands
+
It lists all database commands supported by BaseX.
which you can enter in the console mode, in the Command
 
text field in the GUI, or send to the BaseX server:
 
 
==Database Commands==
 
===Create===
 
 
;<code>CREATE [DB|FS|INDEX|USER] [...]</code> 
 
:Creates a new database, index or user:
 
 
 
;<code>DB [name] ([input])</code>: 
 
:creates the database <code>[name]</code> with an optional <code>[input]</code>
 
 
;<code>INDEX [TEXT|ATTRIBUTE|FULLTEXT|PATH]</code>:   
 
:creates the specified index
 
 
;<code>FS [name] [path] ([mountpoint] [backingstore])</code>:   
 
:creates filesystem database <code>[name]</code> for <code>[path]</code> (using <code>[mountpoint]</code> and <code>[backingstore]</code> if FUSE is activated)
 
 
;<code>USER [name] ([password])</code>:   
 
:creates the specified user
 
 
 
 
===Open===
 
 
;<code>OPEN [name]</code> 
 
:Opens the specified database [name].
 
 
 
===Add===
 
 
;<code>ADD (AS [name]) (TO [target]) [input]</code> 
 
:Adds [input] as [name] to the database, using an optional [target] path.
 
 
 
===Delete===
 
 
;<code>DELETE [name]</code> 
 
:Deletes a document from the current database.
 
 
 
===Info===
 
 
;<code>INFO ([DB|INDEX|STORAGE])</code> 
 
;Shows information on the currently opened database:
 
 
* <code>no argument</code>:  show global information 
 
 
* <code>DB</code>:  shows database information 
 
 
* <code>INDEX</code>:  shows index information 
 
 
* <code>STORAGE [start end] | [query]</code>:  show internal database table
 
: '''what is start end?'''
 
  
===Close===
+
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.
 
;<code>CLOSE </code> 
 
:Closes the current database.
 
 
 
===List===
 
 
;<code>LIST </code> 
 
:Lists all available databases.
 
 
 
===Drop===
 
 
;<code>DROP [DB|INDEX|USER] [...]</code> 
 
:Drops a database, index or user:
 
  
;<code>DB [name]</code>:
+
=Basics=
: drops the database
 
 
;<code>INDEX [PATH|TEXT|ATTRIBUTE|FULLTEXT]</code>:
 
:drops the specified index
 
 
;<code>USER [name]</code>:
 
:drops the specified user
 
 
 
 
===Export===
 
 
;<code>EXPORT [path]</code>
 
:Exports the database to [path].
 
 
 
===Optimize===
 
 
;<code>OPTIMIZE </code>
 
:Optimizes the current database structures.
 
 
 
  
==[[Query Commands]]==
+
==Command Scripts==
Moved to own section.
 
  
==Admin Commands==
+
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.
===Show===
 
 
;<code>SHOW [DATABASES|SESSIONS|USERS|BACKUPS]</code> 
 
:Shows server information:
 
* <code>DATABASES</code>:  shows currently opened databases. 
 
* <code>SESSIONS</code>:  shows current database sessions. 
 
* <code>USERS (ON [db])</code>:  shows users (on a database).
 
* <code>BACKUPS</code>:  shows backups. 
 
 
 
 
===Grant===
 
 
;<code>GRANT [NONE|READ|WRITE|CREATE|ADMIN] (ON [db]) TO [user]</code> 
 
:Grants permissions (on a database) to a user.
 
 
 
===Alter===
 
 
;<code>ALTER [USER|DB] [...]</code> 
 
:Alters user password or database name:
 
 
; <code>USER [name] ([password])</code>: 
 
: alters the password of a user.
 
 
; <code>DB [name] [newname]</code>: 
 
: alters the name of a database.
 
 
 
 
===Kill===
 
 
;<code>KILL [name]</code> 
 
:Kills all sessions of the specified user.
 
 
 
===Backup===
 
 
;<code>BACKUP [name]</code> 
 
:Creates a backup of the specified database.
 
 
 
===Restore===
 
 
;<code>RESTORE [name]</code> 
 
:Restores a backup of the specified database.
 
 
 
  
==General Commands==  
+
===String Syntax===
===Set===
 
Have a look into [[Settings]] to find a complete list of available options.
 
 
;<code>SET [option] ([value])</code> 
 
:Available options [option] with value [value] = on/off:
 
* <code>QUERYINFO</code>:  Display of query info 
 
* <code>DEBUG</code>:  Display of debug info 
 
* <code>SERIALIZE</code>:  Serialization of query results
 
* <code>CHOP</code>:  Chopping of XML whitespaces
 
* <code>ENTITY</code>:  Parsing of XML entities 
 
* <code>TEXTINDEX</code>:  Text indexing 
 
* <code>ATTRINDEX</code>:  Attribute value indexing 
 
* <code>FTINDEX</code>:  Full-text indexing 
 
* <code>PATHINDEX</code>:  Path indexing 
 
* <code>WRITEBACK</code>:  Propagating changes to input file
 
  
===Password===
+
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:
 
;<code>PASSWORD ([password])</code>
 
:Changes the user's password.
 
  
===Help===
+
<syntaxhighlight lang="xml">
+
CREATE DB test
;<code>HELP ([command])</code>
+
ADD TO embedded.xml <root>embedded</root>
:If [command] is specified, information on the specific command is printed; otherwise, all commands are listed.
+
# run query
 +
XQUERY <hits>{ count(//text()) }</hits>
 +
CLOSE
 +
</syntaxhighlight>
  
===Exit===  
+
===XML Syntax===
 
;<code>EXIT </code> 
 
:Exits BaseX.
 
  
[[Category:Commands]]
+
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 {{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:
 +
 
 +
<syntaxhighlight lang="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>
 +
</syntaxhighlight>
 +
 
 +
==Glob Syntax==
 +
 
 +
Some commands support the glob syntax to address more than one database or user. Question marks and asterisks can be used to match one or more characters, and commas can be used to separate multiple patterns. Some examples:
 +
 
 +
* {{Code|AB?}} addresses all names with the characters {{Code|AB}} and one more character.
 +
* {{Code|*AB}} addresses all names ending with the characters {{Code|AB}}.
 +
* {{Code|X*,Y*,Z*}} addresses all names starting with the characters {{Code|X}}, {{Code|Y}}, or {{Code|Z}}.
 +
 
 +
==Valid Names==
 +
 
 +
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:
 +
 
 +
* <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]])
 +
 
 +
==Aliases==
 +
 
 +
In all commands, the {{Code|DB}} keyword can be replaced by {{Code|DATABASE}}.
 +
 
 +
=Database Operations=
 +
 
 +
==CREATE DB==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|CREATE DB [name] ([input])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><create-db name='...'>([input])</create-db></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Creates a new database with the specified {{Code|name}} and, optionally, an initial {{Code|input}}, and opens it. An existing database will be overwritten.<br />The input 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>}}.
 +
|}
 +
 
 +
==OPEN==
 +
 
 +
{{Announce|Updated with Version 10:}} {{Code|path}} argument dropped.
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|OPEN [name]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><open name='...'/></code>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==CHECK==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|CHECK [input]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><check input='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ/CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==CLOSE==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|CLOSE }}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><close/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Closes the currently opened database.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the database files could not be closed for some reason.
 +
|}
 +
 
 +
==LIST==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|LIST ([name] ([path]))}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><list (name='...' (path='...'))/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Lists all available databases. If {{Code|name}} is specified, the resources of a database are listed. The output can be further restricted to the resources matching the specified {{Code|path}}.<br/>If database resources are listed, the size is either the number of nodes (for XML resources) or the number of bytes (for binary resources).
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason.
 +
|}
 +
 
 +
==DIR==
 +
 
 +
{{Announce|Introduced with Version 10.}}
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|DIR ([path]))}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><dir (path='...')/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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).
 +
|}
 +
 
 +
==EXPORT==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|EXPORT [path]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><export path='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==CREATE INDEX==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|CREATE INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;TOKEN&#x7c;FULLTEXT]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code>&lt;create-index type='text&#x7c;attribute&#x7c;token&#x7c;fulltext'/&gt;</code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==DROP INDEX==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|DROP INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;TOKEN&#x7c;FULLTEXT]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><drop-index type='text&#x7c;attribute&#x7c;token&#x7c;fulltext'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==ALTER DB==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|ALTER DB [name] [newname]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><alter-db name='...' newname='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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}}.
 +
|}
 +
 
 +
==DROP DB==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|DROP DB [name]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><drop-db name='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==COPY==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|COPY [name] [newname]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><copy name='...' newname='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==INSPECT==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|INSPECT}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><inspect/></code>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Performs some integrity checks on the opened database and returns a brief summary.
 +
|}
 +
 
 +
=Backups=
 +
 
 +
{{Announce|Introduced with Version 10:}} Support for general data ([[User Management|registered users]], [[Job Module#Services|scheduled services]] and [[Store Module|key-value stores]]).
 +
 
 +
==CREATE BACKUP==
 +
 
 +
{{Announce|Updated with Version 10:}} Support for comments.
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|CREATE BACKUP ([name] ([comment]))}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><create-backup (name='...') (comment='...')/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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]].
 +
|}
 +
 
 +
==DROP BACKUP==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|DROP BACKUP ([name])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><drop-backup (name='...')/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==ALTER BACKUP==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|ALTER BACKUP [name] [newname]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><alter-backup name='...' newname='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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}}.
 +
|}
 +
 
 +
==RESTORE==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|RESTORE ([name])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><restore (name='...')/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==SHOW BACKUPS==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|SHOW BACKUPS}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><show-backups/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Shows all database backups.
 +
|}
 +
 
 +
= Querying =
 +
 
 +
==XQUERY==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|XQUERY [query]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><xquery>[query]</xquery></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''depends on query''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==GET==
 +
 
 +
{{Announce|Introduced with Version 10.}} The old {{Code|GET}} command has been renamed to {{Command|SHOW OPTIONS}}.
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|GET [path]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><get path='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==BINARY GET==
 +
 
 +
{{Announce|Updated with Version 10:}} Renamed (before: {{Code|RETRIEVE}}).
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|BINARY GET [path]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><binary-get path='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==FIND==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|FIND [query]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><find>[query]</find></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Builds and runs a query for the specified {{Code|query}} terms. Keywords can be enclosed in quotes to look for phrases. The following modifiers can be used to further limit search:
 +
<code>=</code> looks for exact text nodes<br/><code>~</code> looks for approximate hits<br/><code>@=</code> looks for exact attribute values<br/><code>@</code> looks for attributes
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened.
 +
|}
 +
 
 +
==TEST==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|TEST [path]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><test path='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Runs all [[Unit Module|XQUnit tests]] in the specified {{Code|path}}. The path can point to a single file or a directory.<br/>Unit testing can also be triggered via {{Code|-t}} on [[Command-Line Options#BaseX Standalone|command line]].
 +
|- 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}}.
 +
|}
 +
 
 +
==REPO INSTALL==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|REPO INSTALL [path]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><repo-install path='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
| 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.
 +
|}
 +
 
 +
==REPO LIST==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|REPO LIST}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><repo-list/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
| Lists all installed packages.
 +
|}
 +
 
 +
==REPO DELETE==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|REPO DELETE [name]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><repo-delete name='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''CREATE''
 +
|- valign="top"
 +
| '''Summary'''
 +
| 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.
 +
|}
 +
 
 +
=Updates=
 +
 
 +
==ADD==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|ADD (TO [path]) [input]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><add (path='...')>[input]</add></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Adds a file, directory or XML string specified by {{Code|input}} to the currently opened database at the specified {{Code|path}}:
 +
* {{Code|input}} may either be a single XML document, a directory, a remote URL or a plain XML string.
 +
* A document with the same path may occur than once in a database. If this is unwanted, 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.
 +
|}
 +
 
 +
==DELETE==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|DELETE [path]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><delete path='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==RENAME==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|RENAME [path] [newpath]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><rename path='...' newpath='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Renames all document paths in the currently opened database that start with the specified {{Code|path}}. The command may be used to either rename single documents or directories.
 +
|- 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.
 +
|}
 +
 
 +
==PUT==
 +
 
 +
{{Announce|Updated with Version 10:}} Renamed (before: {{Code|REPLACE}}).
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|PUT [path] [input]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><put path='...'>[input]</put></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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;}}.
 +
|}
 +
 
 +
==BINARY PUT==
 +
 
 +
{{Announce|Updated with Version 10:}} Renamed (before: {{Code|STORE}}).
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|BINARY PUT (TO [path]) [input]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><binary-put (path='...')>[input]</store></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Stores a [[Binary Data|binary resource]] specified via {{Code|input}} in the opened database to the specified {{Code|path}}:
 +
* The input may either be a file reference, a remote URL, or a plain string.
 +
* If the path denotes a directory, it needs to be suffixed with a slash ({{Code|/}}).
 +
* An existing resource will be replaced.
 +
|- 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.
 +
|}
 +
 
 +
==OPTIMIZE==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|OPTIMIZE (ALL)}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><optimize/></code><br/><code><optimize-all/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==FLUSH==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|FLUSH}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><flush/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''WRITE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
=User Management=
 +
 
 +
==CREATE USER==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|CREATE USER [name] ([password])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><create-user name='...'>([password])</create-user></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Creates a user with the specified {{Code|name}} and {{Code|password}}. If no password is specified, it is requested via the chosen frontend (GUI or bash).
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified user already exists.
 +
|}
 +
 
 +
==ALTER USER==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|ALTER USER [name] ([newname])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><alter-user name='...' newname='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==ALTER PASSWORD==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|ALTER PASSWORD [name] ([password])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><alter-password name='...'>([password])</alter-password></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Alters the {{Code|password}} of the user with the specified {{Code|name}}. If no password is specified, it is requested via the chosen frontend (GUI or bash).
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified user does not exist.
 +
|}
 +
 
 +
==DROP USER==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|DROP USER [name] (ON [pattern])}}:
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><drop-user name='...' (pattern='...')/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Drops the user with the specified {{Code|name}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database or user. If a glob {{Code|pattern}} is specified, only the 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.
 +
|}
 +
 
 +
==GRANT==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|GRANT [NONE&#x7c;READ&#x7c;WRITE&#x7c;CREATE&#x7c;ADMIN] (ON [pattern]) TO [user]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><grant name='...' permission='none&#x7c;read&#x7c;write&#x7c;create&#x7c;admin' (pattern='...')/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Grants the specified [[User_Management|permission]] to the specified {{Code|user}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one user. If a glob {{Code|pattern}} is specified, the permission will be applied to all databases that match this pattern.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if {{Code|admin}} is specified as username or if the specified user does not exist.
 +
|- valign="top"
 +
| '''Examples'''
 +
|
 +
* {{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission to the user {{Code|JoeWinson}}.
 +
* {{Code|GRANT WRITE ON Wiki TO editor*}}<br/>grants {{Code|WRITE}} permissions on the {{Code|Wiki}} database to all users starting with the characters {{Code|editor*}}.
 +
|}
 +
 
 +
==PASSWORD==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|PASSWORD ([password])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><password>([password])</password></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
=Administration=
 +
 
 +
==SHOW OPTIONS==
 +
 
 +
{{Announce|Updated with Version 10:}} Renamed (before: {{Code|GET}}).
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|SHOW OPTIONS [name]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><show-options (name='...')/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==SHOW SESSIONS==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|SHOW SESSIONS}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><show-sessions/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Shows all sessions that are connected to the current server instance.
 +
|}
 +
 
 +
==SHOW USERS==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|SHOW USERS (ON [database])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><show-users (database='...')/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==KILL==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|KILL [target]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><kill target='...'/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''ADMIN''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Kills sessions of a user or an IP:port combination, specified by {{Code|target}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one user.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if a user tried to kill his/her own session.
 +
|}
 +
 
 +
==INFO DB==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|INFO DB}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><info-db/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Shows general information and metadata on the currently opened database.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened.
 +
|}
 +
 
 +
==INFO INDEX==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|INFO INDEX ([ELEMNAME&#x7c;ATTRNAME&#x7c;PATH&#x7c;TEXT&#x7c;ATTRIBUTE&#x7c;TOKEN&#x7c;FULLTEXT])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<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'''
 +
|Shows information on the existing [[Indexes|index]] structures. The output can be optionally limited to the specified index.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if no database is opened, or if the specified index is unknown.
 +
|}
 +
 
 +
==INFO STORAGE==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|INFO STORAGE [start end]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><info-storage (start='...') (end='...')/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
=General Commands=
 +
 
 +
==RUN==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|RUN [file]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><run file='...'/></code>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''depends on input''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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
 +
|}
 +
 
 +
==EXECUTE==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|EXECUTE [input]}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><execute>[input]</execute></code>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''depends on input''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==SET==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|SET [option] ([value])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><set option='...'>([value])</set></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Sets the [[Options|Option]] specified by {{Code|option}} to a new {{Code|value}}. Only local options can be modified. If no value is specified, and if the value is boolean, it will be inverted.
 +
|- valign="top"
 +
| '''Errors'''
 +
|The command fails if the specified option is unknown or if the specified value is invalid.
 +
|}
 +
 
 +
==INFO==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|INFO}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><info/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''READ''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Shows global information.
 +
|}
 +
 
 +
==HELP==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|HELP ([command])}}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><help>([command])</help></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
==EXIT==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|EXIT }}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><exit/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Exits the console mode.
 +
|}
 +
 
 +
==QUIT==
 +
 
 +
{| width='100%'
 +
|- valign="top"
 +
|width='130'|'''Syntax'''
 +
|{{Code|QUIT }}
 +
|- valign="top"
 +
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 +
|<code><quit/></code><br/>
 +
|- valign="top"
 +
| '''Permission'''
 +
|''NONE''
 +
|- valign="top"
 +
| '''Summary'''
 +
|Exits the console mode (alias of {{Command|EXIT}}).
 +
|}
 +
 
 +
=Changelog=
 +
 
 +
;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}}
 +
 
 +
;Version 9.7
 +
* Updated: {{Command|ALTER DB}}, {{Command|COPY}}: Overwrite existing databases.
 +
 
 +
;Version 9.3
 +
* Added: {{Command|ALTER BACKUP}}
 +
 
 +
;Version 8.6
 +
* Updated: {{Command|SHOW USERS}}: If called by non-admins, will only return the current user
 +
 
 +
;Version 8.5
 +
* Added: {{Command|JOBS LIST}}, {{Command|JOBS RESULT}}, {{Command|JOBS STOP}}
 +
* Updated: [[#Valid Names|Valid Names]]: allow dots (except as first and last character)
 +
 
 +
;Version 8.4
 +
* Updated: {{Command|CREATE INDEX}}, {{Command|DROP INDEX}}, {{Command|INFO INDEX}}: token index added
 +
* Updated: {{Command|INFO STORAGE}}: Query argument removed, start/end added to XML syntax.
 +
* Updated: {{Command|INFO INDEX}}: Token index added; index {{Code|TAG}} renamed to {{Code|ELEMNAME}}; index {{Code|ATTNAME}} renamed to {{Code|ATTRNAME}}
 +
* Updated: {{Command|OPTIMIZE}}: adopt original index options
 +
 
 +
;Version 8.2
 +
* Removed: {{Code|CREATE EVENT}}, {{Code|DROP EVENT}} and {{Code|SHOW EVENTS}} command
 +
 
 +
;Version 8.0
 +
* Updated: commands for [[#User Management|User Management]]
 +
* Updated: {{Command|OPEN}}: path argument added
 +
* Removed: {{Code|CS}} command
 +
* Added: {{Command|QUIT}}
 +
 
 +
;Version 7.9
 +
* Added: {{Command|TEST}} runs XQUnit tests.
 +
 
 +
;Version 7.7
 +
* Updated: syntax of [[#Valid Names|valid names]].
 +
 
 +
;Version 7.5
 +
* Added: {{Command|EXECUTE}} executes a command script.
 +
* Added: {{Command|INSPECT}} performs integrity checks.
 +
* Added: automatic detection of [[#Basics|Command Scripts]].
 +
* Removed: {{Code|SHOW DATABASES}}; information is also returned by {{Command|SHOW SESSIONS}}.
 +
* Removed: {{Command|OPEN}}: path argument.
 +
 
 +
;Version 7.3
 +
* Added: [[#XML Syntax|XML Syntax]] added.
 +
* Updated: {{Command|CHECK}} can now be used to create empty databases.
 +
* Updated: Names and paths in {{Command|OPEN}} and {{Command|LIST}} are now specified as separate arguments.
 +
 
 +
;Version 7.2.1
 +
* Updated: permissions for {{Code|GET}} and {{Command|SET}} changed from {{Code|READ}} to {{Code|NONE}}.
 +
 
 +
;Version 7.2
 +
* Updated: {{Command|CREATE INDEX}}, {{Command|DROP INDEX}} ({{Code|PATH}} argument removed. Path summary is always available now and updated with {{Command|OPTIMIZE}}).
 +
* Updated: permissions for {{Command|REPO DELETE}}, {{Command|REPO INSTALL}} and {{Command|REPO LIST}}.
 +
 
 +
;Version 7.1
 +
* Updated: {{Command|KILL}} (killing sessions by specifying IP:port)
 +
 
 +
;Version 7.0
 +
* Added: {{Command|FLUSH}}, {{Code|RETRIEVE}}, {{Code|STORE}}.
 +
* Updated: {{Command|ADD}}: simplified arguments.

Latest revision as of 12:42, 1 August 2022

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]

Updated with Version 10: path argument dropped.

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]

Introduced with Version 10.

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]

Introduced with Version 10: Support for general data (registered users, scheduled services and key-value stores).

CREATE BACKUP[edit]

Updated with Version 10: Support for comments.

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]

Introduced with Version 10. The old GET command has been renamed to SHOW OPTIONS.

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]

Updated with Version 10: Renamed (before: RETRIEVE).

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]

Updated with Version 10: Renamed (before: REPLACE).

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]

Updated with Version 10: Renamed (before: STORE).

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]

Updated with Version 10: Renamed (before: GET).

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.