Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
Database Names of databases and user names users follow the same naming constraints: Names are restricted to ASCII characters. They must at least have one printable character, and they may contain including letters, numbers , and any of the special characters <code>!#$%&'()+-=@[]^_`{}~</code>. The following characters are disallowed:
{{Mark|Updated with Version 8.4:}} Token index added.
{{Mark|Updated with BaseX 9.7:}} Overwrite existing databases.
{{Mark|Updated with BaseX 9.7:}} Overwrite existing databases.
|}
==SHOW BACKUPS==
{{Mark|Updated with Version 10:}} Support for comments.
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|SHOW BACKUPS}}
|-
| '''XML Syntax'''
|<code><show-backups/></code><br/>
|-
| '''Permission'''
|''CREATE''
|-
| '''Summary'''
|Shows all database backups.
|Performs some integrity checks on the opened database and returns a brief summary.|} ==INFO DB== {| width='100%'|-|width='130'|'''Syntax'''|{{Code|INFO DB}}|-| '''XML Syntax''' |<code><info-db/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Shows general information and meta data on the currently opened database.|-| '''Errors'''|The command fails if no database is opened.|} ==INFO INDEX== {| width='100%'|-|width='130'|'''Syntax'''|{{Code|INFO INDEX ([ELEMNAME|ATTRNAME|PATH|TEXT|ATTRIBUTE|TOKEN|FULLTEXT])}}|-| '''XML Syntax''' |<code><info-index type='elemname|attrname|path|text|attribute|token|fulltext'/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Shows information on the existing [[Indexes|index]] structures. The output can be optionally limited to the specified index.|-| '''Errors'''|The command fails if no database is opened, or if the specified index is unknown.|} ==INFO STORAGE== {| width='100%'|-|width='130'|'''Syntax'''|{{Code|INFO STORAGE [start end]}}|-| '''XML Syntax''' |<code><info-storage (start='...') (end='...')/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Shows the internal main table of the currently opened database. An integer range may be specified as argument.|-| '''Errors'''|The command fails if no all database is opened, or if one of the specified arguments is invalidbackups.
==LIST==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|LIST ([name] ([path]))}}
|-
| '''XML Syntax'''
|<code><list (name='...' (path='...'))/></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Lists all available databases. If {{Code|name}} is specified, the resources of a database are listed. The output can be further restricted to the resources matching the specified {{Code|path}}.<br/>If database resources are listed, the size is either the number of nodes (for XML resources) or the number of bytes (for binary resources).
|-
| '''Errors'''
|The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason.
|}
|}
==GET==
{| width='100%'
|-
|width='130'|'''Syntax'''
|{{Code|GET [option]}}
|-
| '''XML Syntax'''
|<code><get (option='...')/></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Returns the current value of the [[Options|Option]] specified via {{Code|option}}. Global options can only be requested by users with ADMIN permissions.
|-
| '''Errors'''
|The command fails if the specified option is unknown.
→Changelog
==Valid Names==
* <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%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|CREATE DB [name] ([input])}}
|-valign="top"
| '''XML Syntax'''
|<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:
* 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'''
|
==OPEN==
{{MarkAnnounce|Updated with Version 10:}} {{Code|path}} argument dropped.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|OPEN [name]}}
|-valign="top"
| '''XML Syntax'''
|<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.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|CHECK [input]}}
|-valign="top"
| '''XML Syntax'''
|<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.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|CLOSE }}
|-valign="top"
| '''XML Syntax'''
|<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 Syntax'''
|<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 Syntax'''
|<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).
|}
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|EXPORT [path]}}
|-valign="top"
| '''XML Syntax'''
|<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|ATTRIBUTE|TOKEN|FULLTEXT]}}
|-valign="top"
| '''XML Syntax'''
|<code><create-index type='text|attribute|token|fulltext'/></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.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|DROP INDEX [TEXT|ATTRIBUTE|TOKEN|FULLTEXT]}}
|-valign="top"
| '''XML Syntax'''
|<code><drop-index type='text|attribute|token|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 Syntax'''
|<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'''
|
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|DROP DB [name]}}
|-valign="top"
| '''XML Syntax'''
|<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 Syntax'''
|<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.
|}
=Administration=INSPECT== {| width='100%'|- valign="top"|width='130'|'''Syntax'''|{{Code|INSPECT}}|- valign="top"| '''XML Syntax''' |<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==
{{MarkAnnounce|Updated with Version 10:}} Support for comments.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|CREATE BACKUP ([name] ([comment]))}}|-valign="top"
| '''XML Syntax'''
|<code><create-backup (name='...' ) (comment='...')/></code><br/>|-valign="top"
| '''Permission'''
|''CREATE''
|-valign="top"
| '''Summary'''
|Creates a zipped backup of the database specified by {{Code|name}} and , 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'''
|
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|DROP BACKUP ([name])}}|-valign="top"
| '''XML Syntax'''
|<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.
|}
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|ALTER BACKUP [name] [newname]}}
|-valign="top"
| '''XML Syntax'''
|<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|new-namenewname}}. The directory inside If the name ends with a timestamp, only the archive specified backup file will be renamed as well. 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}}.
|}
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|RESTORE ([name])}}|-valign="top"
| '''XML Syntax'''
|<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.
|}
==INSPECTSHOW BACKUPS==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|INSPECTSHOW BACKUPS}}|-valign="top"
| '''XML Syntax'''
|<code><inspectshow-backups/></code><br/>|-valign="top"
| '''Permission'''
|''READCREATE''|-valign="top"
| '''Summary'''
|}
= Querying =
==XQUERY==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|XQUERY [query]}}
|-valign="top"
| '''XML Syntax'''
|<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'''
|
|}
==RETRIEVEGET== {{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|RETRIEVE GET [path]}}|-valign="top"
| '''XML Syntax'''
|<code><retrieve get path='...'/></code><br/>|-valign="top"
| '''Permission'''
|''READ''
|-valign="top"
| '''Summary'''
|Retrieves a [[Binary Data|raw file]] 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 Syntax''' |<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 data cannot not be retrieved for some other reasonsource path is invalid.
|}
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|FIND [query]}}
|-valign="top"
| '''XML Syntax'''
|<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.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|TEST [path]}}
|-valign="top"
| '''XML Syntax'''
|<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'''
|
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|REPO INSTALL [path]}}
|-valign="top"
| '''XML Syntax'''
|<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:
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|REPO LIST}}
|-valign="top"
| '''XML Syntax'''
|<code><repo-list/></code><br/>
|-valign="top"
| '''Permission'''
|''READ''
|-valign="top"
| '''Summary'''
| Lists all installed packages.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|REPO DELETE [name]}}
|-valign="top"
| '''XML Syntax'''
|<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.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|ADD (TO [path]) [input]}}
|-valign="top"
| '''XML Syntax'''
|<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|REPLACEPUT}} command can be used.
* If a file is too large to be added in one go, its data structures will be cached to disk first. Caching can be enforced by turning the {{Option|ADDCACHE}} option on.
If files are to be added to an empty database, it is usually faster to use the {{Command|CREATE DB}} command and specify the initial input as argument.
|-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'''
|
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|DELETE [path]}}
|-valign="top"
| '''XML Syntax'''
|<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.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|RENAME [path] [newpath]}}
|-valign="top"
| '''XML Syntax'''
|<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'''
|
|}
==REPLACEPUT== {{Announce|Updated with Version 10:}} Renamed (before: {{Code|REPLACE}}).
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|REPLACE PUT [path] [input]}}|-valign="top"
| '''XML Syntax'''
|<code><replace put path='...'>[input]</replaceput></code><br/>|-valign="top"
| '''Permission'''
|''WRITE''
|-valign="top"
| '''Summary'''
|Replaces Adds or replaces resources in the currently opened database, addressed by {{Code|path}}, with the file, directory or XML string specified by {{Code|input}}, or adds new documents if no resource exists at the specified path.|-valign="top"
| '''Errors'''
|The command fails if no database is opened or if the specified path is invalid.
|-valign="top"
| '''Examples'''
|
* {{Code|REPLACE PUT one.xml input.xml}}<br/>replaces the document {{Code|one.xml}} with the contents of the file {{Code|input.xml}}.* {{Code|REPLACE PUT top.xml <xml/>}}<br/>replaces the document {{Code|top.xml}} with the XML document {{Code|<xml/>}}.
|}
==STOREBINARY PUT== {{Announce|Updated with Version 10:}} Renamed (before: {{Code|STORE}}).
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|STORE BINARY PUT (TO [path]) [input]}}|-valign="top"
| '''XML Syntax'''
|<code><store binary-put (path='...')>[input]</store></code><br/>|-valign="top"
| '''Permission'''
|''WRITE''
|-valign="top"
| '''Summary'''
|Stores a [[Binary Data|raw filebinary resource]] specified via {{Code|input}} in the opened database to the specified {{Code|path}}:
* The input may either be a file reference, a remote URL, or a plain string.
* If the path denotes a directory, it needs to be suffixed with a slash ({{Code|/}}).
* 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.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|OPTIMIZE (ALL)}}
|-valign="top"
| '''XML Syntax'''
|<code><optimize/></code><br/><code><optimize-all/></code><br/>
|-valign="top"
| '''Permission'''
|''WRITE''
|-valign="top"
| '''Summary'''
|Optimizes the index structures, meta data 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.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|FLUSH}}
|-valign="top"
| '''XML Syntax'''
|<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.
|}
=MonitoringUser Management=
==SHOW SESSIONSCREATE USER==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|SHOW SESSIONSCREATE USER [name] ([password])}}|-valign="top"
| '''XML Syntax'''
|<code><showcreate-sessionsuser name='...'>([password])</create-user></code><br/>|-valign="top"
| '''Permission'''
|''ADMIN''
|-valign="top"
| '''Summary'''
|Shows all sessions that are connected to Creates a user with the current server instancespecified {{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.
|}
==SHOW USERSALTER USER==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|SHOW USERS ALTER USER [name] (ON [databasenewname])}}|-valign="top"
| '''XML Syntax'''
|<code><showalter-users (databaseuser name='...' newname='...')/></code><br/>|-valign="top"
| '''Permission'''
|''ADMIN''
|-valign="top"
| '''Summary'''
|Shows all users that are visible to Renames the current user. If a with the specified {{Code|name}} to {{Code|databasenewname}} 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 specified user does not be openedexist, or if the new user already exists.
|}
==KILLALTER PASSWORD==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|KILL ALTER PASSWORD [targetname]([password])}}|-valign="top"
| '''XML Syntax'''
|<code><kill targetalter-password name='...'>([password])</alter-password></code><br/>|-valign="top"
| '''Permission'''
|''ADMIN''
|-valign="top"
| '''Summary'''
|Kills sessions Alters the {{Code|password}} of a the user or an IP:port combination, with the specified by {{Code|targetname}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one userIf no password is specified, it is requested via the chosen frontend (GUI or bash).|-valign="top"
| '''Errors'''
|The command fails if a the specified user tried to kill his/her own sessiondoes not exist.
|}
==JOBS LISTDROP USER==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|JOBS LISTDROP USER [name] (ON [pattern])}}:|-valign="top"
| '''XML Syntax'''
|<code><jobsdrop-listuser name='...' (pattern='...')/></code><br/>|-valign="top"
| '''Permission'''
|''ADMIN''
|-valign="top"
| '''Summary'''
|Returns information on all jobs that are currently queued Drops the user with the specified {{Code|name}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database or executeduser. See If a glob {{FunctionCode|Jobspattern}} is specified, only the assigned database pattern will be removed.|jobs:list-detailsvalign="top"| '''Errors'''|The command fails if {{Code|admin}} for more details on is specified as username, or if the returned table entriesspecified user does not exist or is currently logged in.
|}
==JOBS RESULTGRANT==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|JOBS RESULT GRANT [idNONE|READ|WRITE|CREATE|ADMIN] (ON [pattern]) TO [user]}}|-valign="top"
| '''XML Syntax'''
|<code><jobs-result idgrant name='...' permission='none|read|write|create|admin' (pattern='...')/></code><br/>|-valign="top"
| '''Permission'''
|''ADMIN''
|-valign="top"
| '''Summary'''
|Returns Grants the cached result of a query with specified [[User_Management|permission]] to the specified job id:* Results {{Code|user}}. The [[#Glob Syntax|Glob Syntax]] can only be retrieved onceused to address more than one user. After retrieval, the cached result will be dropped.* If the original query has raised an errora glob {{Code|pattern}} is specified, the cached error permission will be raised insteadapplied to all databases that match this pattern.|-valign="top"
| '''Errors'''
|The command fails if the addressed job {{Code|admin}} is still running specified as username or if the result has already been retrievedspecified 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*}}.
|}
==JOBS STOPPASSWORD==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|JOBS STOP PASSWORD ([idpassword])}}|-valign="top"
| '''XML Syntax'''
|<code><jobs-stop id='...'password>([password])</password></code><br/>|-valign="top"
| '''Permission'''
|''ADMINNONE''|-valign="top"
| '''Summary'''
|Cancels Changes the execution {{Code|password}} of a job with the specified id, current user. If the command is run on command-line or drops in the cached result of a query. Unknown ids are ignored. All jobs are gracefully stopped; it is up to GUI, the process to decide when it is safe to shut downpassword can be omitted and entered interactively.
|}
=User ManagementAdministration= ==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 Syntax''' |<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.|}
==CREATE USERSHOW SESSIONS==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|CREATE USER [name] ([password])SHOW SESSIONS}}|-valign="top"
| '''XML Syntax'''
|<code><createshow-user name='...'>([password])<sessions/create-user></code><br/>|-valign="top"
| '''Permission'''
|''ADMIN''
|-valign="top"
| '''Summary'''
|Creates a user with Shows all sessions that are connected to the specified {{Code|name}} and {{Code|password}}. If no password is specified, it is requested via the chosen frontend (GUI or bash).|-| '''Errors'''|The command fails if the specified user already existscurrent server instance.
|}
==ALTER USERSHOW USERS==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|ALTER USER [name] SHOW USERS (ON [newnamedatabase])}}|-valign="top"
| '''XML Syntax'''
|<code><altershow-user name='...' newnameusers (database='...')/></code><br/>|-valign="top"
| '''Permission'''
|''ADMIN''
|-valign="top"
| '''Summary'''
|Renames Shows all users that are visible to the current user with the specified . If a {{Code|name}} to {{Code|newnamedatabase}}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 specified user does optional database could not exist, or if the new user already existsbe opened.
|}
==ALTER PASSWORDKILL==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|ALTER PASSWORD KILL [nametarget] ([password])}}|-valign="top"
| '''XML Syntax'''
|<code><alter-password namekill target='...'>([password])</alter-password></code><br/>|-valign="top"
| '''Permission'''
|''ADMIN''
|-valign="top"
| '''Summary'''
|Alters the {{Code|password}} Kills sessions of the a user with the or an IP:port combination, specified by {{Code|nametarget}}. If no password is specified, it is requested via the chosen frontend (GUI or bash)The [[#Glob Syntax|Glob Syntax]] can be used to address more than one user.|-valign="top"
| '''Errors'''
|The command fails if the specified a user does not existtried to kill his/her own session.
|}
==DROP USERINFO DB==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|DROP USER [name] (ON [pattern])INFO DB}}:|-valign="top"
| '''XML Syntax'''
|<code><dropinfo-user name='...' (pattern='...')db/></code><br/>|-valign="top"
| '''Permission'''
|''ADMINREAD''|-valign="top"
| '''Summary'''
|Drops Shows general information and metadata on 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 currently opened database pattern will be removed.|-valign="top"
| '''Errors'''
|The command fails if {{Code|admin}} no database is specified as user name, or if the specified user does not exist or is currently logged inopened.
|}
==GRANTINFO INDEX==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|GRANT INFO INDEX ([NONEELEMNAME|ATTRNAME|PATH|READTEXT|WRITEATTRIBUTE|CREATETOKEN|ADMIN] (ON [patternFULLTEXT]) TO [user]}}|-valign="top"
| '''XML Syntax'''
|<code><grant nameinfo-index type='...' permission='noneelemname|attrname|path|readtext|writeattribute|createtoken|admin' (pattern='...fulltext')/></code><br/>|-valign="top"
| '''Permission'''
|''ADMINREAD''|-valign="top"
| '''Summary'''
|Grants Shows information on the specified existing [[User_ManagementIndexes|permissionindex]] to the specified {{Code|user}}structures. The [[#Glob Syntax|Glob Syntax]] output can be used optionally limited to address more than one user. If a glob {{Code|pattern}} is the specified, the permission will be applied to all databases that match this patternindex.|-valign="top"
| '''Errors'''
|The command fails if {{Code|admin}} no database is specified as user name opened, or if the specified user does not exist.|-| '''Examples'''|* {{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission to the user {{Code|JoeWinson}}.* {{Code|GRANT WRITE ON Wiki TO editor*}}<br/>grants {{Code|WRITE}} permissions on the {{Code|Wiki}} database to all users starting with the characters {{Code|editor*}}index is unknown.
|}
==PASSWORDINFO STORAGE==
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|PASSWORD (INFO STORAGE [passwordstart end])}}|-valign="top"
| '''XML Syntax'''
|<code><password>info-storage (start='...') ([password]end='...')</password></code><br/>|-valign="top"
| '''Permission'''
|''NONEREAD''|-valign="top"
| '''Summary'''
|Changes Shows the {{Code|password}} internal main table of the current usercurrently opened database. An integer range may be specified as argument. If |- valign="top"| '''Errors'''|The command fails if no password database is opened, or if one of the specified, it arguments is requested via the chosen frontend (GUI or bash)invalid.
|}
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|RUN [file]}}
|-valign="top"
| '''XML Syntax'''
|<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'''
|
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|EXECUTE [input]}}
|-valign="top"
| '''XML Syntax'''
|<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.
|}
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|SET [option] ([value])}}
|-valign="top"
| '''XML Syntax'''
|<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.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|INFO}}
|-valign="top"
| '''XML Syntax'''
|<code><info/></code><br/>
|-valign="top"
| '''Permission'''
|''READ''
|-valign="top"
| '''Summary'''
|Shows global information.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|HELP ([command])}}
|-valign="top"
| '''XML Syntax'''
|<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 Syntax'''
|<code><exit/></code><br/>
|-valign="top"
| '''Permission'''
|''NONE''
|-valign="top"
| '''Summary'''
|Exits the console mode.
{| width='100%'
|-valign="top"
|width='130'|'''Syntax'''
|{{Code|QUIT }}
|-valign="top"
| '''XML Syntax'''
|<code><quit/></code><br/>
|-valign="top"
| '''Permission'''
|''NONE''
|-valign="top"
| '''Summary'''
|Exits the console mode (alias of {{Command|EXIT}}).
;Version 10
* UpdatedAdded: [[#Backups|Backups]]: Support for general data ([[User Management|registered users]], [[Job Module#Services|scheduled services]] and [[Store Module|key-value stores]]).* Added: {{Command|CREATE BACKUPDIR}}, {{Command|GET}}* Updated: {{Command|SHOW BACKUPSOPTIONS}}: 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
;Version 7.2.1
* Updated: permissions for {{CommandCode|GET}} and {{Command|SET}} changed from {{Code|READ}} to {{Code|NONE}}.
;Version 7.2
;Version 7.0
* Added: {{Command|FLUSH}}, {{CommandCode|RETRIEVE}}, {{CommandCode|STORE}}.
* Updated: {{Command|ADD}}: simplified arguments.
