Difference between revisions of "Options"

From BaseX Documentation
Jump to navigation Jump to search
m (Reverted edits by CG (talk) to last revision by Arve)
Line 34: Line 34:
 
=Global Options=
 
=Global Options=
  
This article is part of the [[Getting Started]] Section.
+
==General==
It lists all database commands supported by BaseX.
 
Commands can e.g. be executed from the [[Startup_Options#BaseX_Standalone|Command Line]],
 
[[#Command Scripts|Scripts]], 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.
 
 
 
=Basics=
 
 
 
==Command Scripts==
 
 
 
Database commands in both the string and XML syntax can be placed in a text file and stored on disk. The default extension for BaseX command scripts is {{Code|.bxs}}. If the path to a command script is passed on to BaseX, it will automatically be recognized and evaluated as such.
 
 
 
==String Syntax==
 
 
 
Multiple commands can be written in a single line and separated by semicolons, or stored as command script. Lines starting with <code>#</code> are interpreted as comments and are skipped. The following script creates a database, adds two documents to it and performs a query:
 
 
 
<pre class="brush:xml">
 
CREATE DB test
 
ADD input.xml
 
ADD TO embedded.xml <root>embedded</root>
 
# run query
 
XQUERY count(//text())
 
</pre>
 
 
 
==XML Syntax==
 
 
 
The string syntax is limited when XML snippets need to be embedded in a command,
 
or when complex queries are to be specified.
 
 
 
This is why database commands can also be specified in XML.
 
Multiple commands can be enclosed by a {{Code|<commands/>}} root element:
 
 
 
<pre class="brush:xml">
 
<commands>
 
  <create-db name='test'/>
 
  <add>input.xml</add>
 
  <add path='embedded.xml'><root>embedded</root></add>
 
  <xquery>count(//text())</xquery>
 
</commands>
 
</pre>
 
 
 
==Glob Syntax==
 
 
 
Some commands support the glob syntax to address more than one database or user. Question marks and asterisks can be used to match one or more characters, and commas can be used to separate multiple patterns. Some examples:
 
 
 
* {{Code|AB?}} addresses all names with the characters {{Code|AB}} and one more character.
 
* {{Code|*AB}} addresses all names ending with the characters {{Code|AB}}.
 
* {{Code|X*,Y*,Z*}} addresses all names starting with the characters {{Code|X}}, {{Code|Y}}, or {{Code|Z}}.
 
 
 
==Valid Names==
 
 
 
Both database and user names must follow the same naming constraints. Valid names may contain letters, numbers, underscores and dashes. Names must have at least one character; they also should not be longer than 128 characters, although this is not enforced. A regular expression matching valid names is <code>[-_a-zA-Z0-9]{1,128}</code>.
 
 
 
==Aliases==
 
 
 
In all commands, the {{Code|DB}} keyword can be replaced by {{Code|DATABASE}}.
 
 
 
=Database Operations=
 
  
==CREATE DB==
+
===DBPATH===
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='90' | '''Signature'''
|{{Code|CREATE DB [name] ([input])}}
+
|{{Code|DBPATH [path]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><create-db name='...'>([input])</create-db></code><br/>
+
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> or <code>[[Configuration#Database Directory|{home}/data]]</code>
|-
 
| '''Permission'''
 
|''CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Creates the database {{Code|[name]}} with an optional {{Code|[input]}} and opens it.<br />The input may either be a reference to a single XML document, a directory, a remote URL, or a string containing XML:
+
|Points to the directory in which all databases are located.<br/> '''Note:''' this option can only be changed if no database is currently opened.
* {{Code|[name]}} must be a [[#Valid Names|valid database name]]
 
* several additional [[Options#Create Options|Create Options]] can be set to influence the creation process.
 
|-
 
| '''Errors'''
 
|The command fails if a database with the specified name is currently used by another process, if one of the documents to be added is not well-formed or if it cannot be parsed for some other reason.
 
|-
 
| '''Examples'''
 
|
 
* {{Code|CREATE DB input}}<br/>creates an empty database {{Code|input}}.
 
* {{Code|CREATE DB xmark http://files.basex.org/xml/xmark.xml}}<br/>creates the database {{Code|xmark}}, containing a single initial document called {{Code|xmark.xml}}.
 
* {{Code|CREATE DATABASE coll /path/to/input}}<br/>creates the database {{Code|coll}} with all documents found in the {{Code|input}} directory.
 
* {{Code|SET INTPARSE false; CREATE DB input input.xml}}<br/>creates a database {{Code|input}} with {{Code|input.xml}} as initial document, which will be parsed with Java's [[Parsers#XML Parsers|default XML parser]].
 
* <code><create-db name='simple'><hello>Universe</hello></create-db></code><br/>creates a database named {{Code|simple}} with an initial document {{Code|<hello>Universe</hello>}}.
 
 
|}
 
|}
  
==OPEN==
+
===REPOPATH===
 
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='90' | '''Signature'''
|{{Code|OPEN [name]}}
+
|{{Code|REPOPATH [path]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><open name='...'/></code>
+
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>
|-
 
| '''Permission'''
 
|''READ''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Opens the database specified by {{Code|[name]}}.
+
|Points to the [[Repository]], in which all XQuery modules are located.
|-
 
| '''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==
+
===DEBUG===
 
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='90' | '''Signature'''
|{{Code|CHECK [input]}}
+
|{{Code|DEBUG [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><check input='...'/></code><br/>
+
|{{Code|false}}
|-
 
| '''Permission'''
 
|''READ/CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This convenience command combines [[#OPEN|OPEN]] and [[#CREATE DB|CREATE DB]]: if a database with the name {{Code|[input]}} exists, it is opened. Otherwise, a new database is created; if the specified input points to an existing resource, it is stored as initial content.
+
|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Startup Options#BaseX Standalone|command line]] via <code>-d</code>.
|-
 
| '''Errors'''
 
|The command fails if the addressed database could neither be opened nor created.
 
 
|}
 
|}
  
==CLOSE==
+
===LANG===
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='90' | '''Signature'''
|{{Code|CLOSE }}
+
|{{Code|LANG [language]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><close/></code><br/>
+
|{{Code|English}}
|-
 
| '''Permission'''
 
|''READ''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Closes the currently opened database.
+
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.
|-
 
| '''Errors'''
 
|The command fails if the database files could not be closed for some reason.
 
 
|}
 
|}
  
==EXPORT==
+
===LANGKEY===
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='90' | '''Signature'''
|{{Code|EXPORT [path]}}
+
|{{Code|LANGKEY [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><export path='...'/></code><br/>
+
|{{Code|false}}
|-
 
| '''Permission'''
 
|''CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Exports all documents in the database to the specified {{Code|[path]}}, using the serializer options specified by the <code>[[Options#EXPORTER|EXPORTER]]</code> option.
+
|Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed.
|-
 
| '''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==
+
===GLOBALLOCK===
  
{| width='100%'
+
{{Mark|Introduced with Version 7.6:}}
|-
 
|width='100'|'''Syntax'''
 
|{{Code|CREATE INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXT]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code>&lt;create-index type='text&#x7c;attribute&#x7c;fulltext'/&gt;</code><br/>
 
|-
 
| '''Permission'''
 
|''WRITE''
 
|-
 
| '''Summary'''
 
|Creates the specified database [[Indexes|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==
 
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='90' | '''Signature'''
|{{Code|DROP INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXT]}}
+
|{{Code|GLOBALLOCK [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><drop-index type='text&#x7c;attribute&#x7c;fulltext'/></code><br/>
+
|{{Code|false}}
|-
 
| '''Permission'''
 
|''WRITE''
 
|-
 
| '''Summary'''
 
|Drops the specified database [[Indexes|index]].
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened, if the specified index is unknown, or if it could not be deleted for some other reason.
 
|}
 
 
 
=Administration=
 
 
 
==ALTER DB==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|ALTER DB [name] [newname]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><alter-db name='...' newname='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''CREATE''
 
|-
 
| '''Summary'''
 
|Renames the database specified by {{Code|[name]}} to {{Code|[newname]}}. {{Code|[newname]}} must be a [[#Valid Names|valid database name]].
 
|-
 
| '''Errors'''
 
|The command fails if the target database already exists, if the source database does not exist or is currently locked, or if it could not be renamed for some other reason.
 
|-
 
| '''Examples'''
 
|
 
* {{Code|ALTER DB db tempdb}}<br/>renames the database {{Code|db}} into {{Code|tempdb}}.
 
|}
 
 
 
==DROP DB==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|DROP DB [name]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><drop-db name='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''CREATE''
 
|-
 
| '''Summary'''
 
|Drops the database with the specified {{Code|[name]}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
 
|-
 
| '''Errors'''
 
|The command fails if the specified database does not exist or is currently locked, or if the database could not be deleted for some other reason.
 
|}
 
 
 
==CREATE BACKUP==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|CREATE BACKUP [name]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><create-backup name='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''CREATE''
 
|-
 
| '''Summary'''
 
|Creates a zipped backup of the database specified by {{Code|[name]}}. The backup file will be suffixed with the current timestamp and stored in the database directory. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.<br/>Please note that Java 7 is required to handle ''ZIP files larger than 4 GB''.
 
|-
 
| '''Errors'''
 
|The command fails if the specified database does not exist, or if it could not be zipped for some other reason.
 
|-
 
| '''Examples'''
 
|
 
* {{Code|BACKUP db}}<br/>creates a zip archive of the database {{Code|db}} (e.g. {{Code|db-2011-04-01-12-27-28.zip}}) in the [[Configuration#Database_Directory|database directory]].
 
|}
 
 
 
==RESTORE==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|RESTORE [name]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><restore name='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''CREATE''
 
|-
 
| '''Summary'''
 
|Restores a database with the specified {{Code|[name]}}. The name may include the timestamp of the backup file.
 
|-
 
| '''Errors'''
 
|The command fails if the specified backup does not exist, if the database to be restored is currently locked, or if it could not be restored for some other reason.
 
|}
 
 
 
==INSPECT==
 
 
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|INSPECT}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><inspect/></code>
 
|-
 
| '''Permission'''
 
|''READ''
 
|-
 
| '''Summary'''
 
|Performs some integrity checks on the opened database and returns a brief summary.
 
|}
 
 
 
==DROP BACKUP==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|DROP BACKUP [name]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><drop-backup name='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''CREATE''
 
|-
 
| '''Summary'''
 
|Drops all backups of the database with the specified {{Code|[name]}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
 
|-
 
| '''Examples'''
 
|
 
* {{Code|DROP BACKUP abc*}}<br/>deletes the backups of all databases starting with the characters {{Code|abc}}.
 
|}
 
 
 
==SHOW BACKUPS==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|SHOW BACKUPS}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><show-backups/></code><br/>
 
|-
 
| '''Permission'''
 
|''CREATE''
 
|-
 
| '''Summary'''
 
|Shows all database backups.
 
|}
 
 
 
==COPY==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|COPY [name] [newname]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><copy name='...' newname='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''CREATE''
 
|-
 
| '''Summary'''
 
|Creates a copy of the database specified by {{Code|[name]}}. {{Code|[newname]}} must be a [[#Valid Names|valid database name]].
 
|-
 
| '''Errors'''
 
|The command fails if the target database already exists, or if the source database does not exist.
 
|}
 
 
 
==INFO DB==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|INFO DB}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><info-db/></code><br/>
 
|-
 
| '''Permission'''
 
|''READ''
 
|-
 
| '''Summary'''
 
|Shows information on the currently opened database.
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened.
 
|}
 
 
 
==INFO INDEX==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|INFO INDEX ([TAG&#x7c;ATTNAME&#x7c;PATH&#x7c;TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXT])}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><info-index type='tag&#x7c;attname&#x7c;path&#x7c;text&#x7c;attribute&#x7c;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='100'|'''Syntax'''
 
|{{Code|INFO STORAGE [start end] &#x7c; [query]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><info-storage>([query])</info-storage></code><br/>
 
|-
 
| '''Permission'''
 
|''READ''
 
|-
 
| '''Summary'''
 
|Shows the internal main table of the currently opened database. An integer range or a query may be specified as argument.
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened, or if one of the specified arguments is invalid.
 
|}
 
 
 
= Querying =
 
 
 
==LIST==
 
 
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|LIST ([name] ([path]))}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<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]}}.
 
|-
 
| '''Errors'''
 
|The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason.
 
|}
 
 
 
==XQUERY==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|XQUERY [query]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><xquery>[query]</xquery></code><br/>
 
|-
 
| '''Permission'''
 
|''depends on query''
 
|-
 
| '''Summary'''
 
|Runs the specified {{Code|[query]}} and prints the result.
 
|-
 
| '''Errors'''
 
|The command fails if the specified query is invalid.
 
|-
 
| '''Examples'''
 
|
 
* {{Code|XQUERY 1 to 10}}<br/>returns the sequence {{Code|(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)}}.
 
* {{Code|SET RUNS 10; XQUERY 1 to 10}}<br/>runs the query 10 times, returns the result and prints the average execution time.
 
* {{Code|SET XMLPLAN true; XQUERY 1 to 10}}<br/>returns the result and prints the query plan as XML.
 
|}
 
 
 
==RETRIEVE==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|RETRIEVE [path]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><retrieve path='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''READ''
 
|-
 
| '''Summary'''
 
|Retrieves a raw file from the opened database at the specified {{Code|[path]}}.
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened, if the source path is invalid or if the data cannot not be retrieved for some other reason.
 
|}
 
 
 
==FIND==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|FIND [query]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><find>[query]</find></code><br/>
 
|-
 
| '''Permission'''
 
|''READ''
 
|-
 
| '''Summary'''
 
|Builds and runs a query for the specified {{Code|[query]}} terms. Keywords can be enclosed in quotes to look for phrases. The following modifiers can be used to further limit search:
 
<code>=</code> looks for exact text nodes<br/><code>~</code> looks for approximate hits<br/><code>@=</code> looks for exact attribute values<br/><code>@</code> looks for attributes
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened.
 
|}
 
 
 
==CS==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|CS [query]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><cs>[query]</cs></code><br/>
 
|-
 
| '''Permission'''
 
|''depends on query''
 
|-
 
| '''Summary'''
 
|Evaluates the specified {{Code|[query]}} and declares the resulting nodes as new ''context set''. In subsequent queries, the context set will be available via the context item expression of XQuery ({{Code|.}}).
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened, if the specified query is invalid or if it does not return nodes of the currently opened database.
 
|}
 
 
 
==REPO INSTALL==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|REPO INSTALL [path]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><repo-install path='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
| Installs the package with path {{Code|[path]}}.
+
|Controls if local (database) or global (process) locking will be used for managing read and write operations. The article on [[Transaction Management]] provides more details on concurrency control.
|-
 
| '''Errors'''
 
| The command fails in the following cases:
 
* The package to be installed is not a xar file.
 
* The package to be installed does not exist or is already installed.
 
* The package descriptor is with invalid syntax.
 
* The package to be installed depends on a package which is not installed.
 
* The package is not supported by the current version of BaseX.
 
* A component of the package is already installed as part of another package.
 
 
|}
 
|}
 
==REPO LIST==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|REPO LIST}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><repo-list/></code><br/>
 
|-
 
| '''Permission'''
 
|''READ''
 
|-
 
| '''Summary'''
 
| Lists all installed packages.
 
|}
 
 
==REPO DELETE==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|REPO DELETE [name]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><repo-delete name='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''CREATE''
 
|-
 
| '''Summary'''
 
| Deletes the package with name {{Code|[name]}}, optionally followed by a version.
 
|-
 
| '''Errors'''
 
| The command fails if the package to be deleted participates in a dependency.
 
|}
 
 
=Updates=
 
 
==ADD==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|ADD (TO [path]) [input]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><add (path='...')>[input]</add></code><br/>
 
|-
 
| '''Permission'''
 
|''WRITE''
 
|-
 
| '''Summary'''
 
|Adds a file, directory or XML string specified by {{Code|[input]}} to the currently opened database at the specified {{Code|[path]}}.<br/>{{Code|[input]}} may either be a single XML document, a directory, a remote URL or a plain XML string. If the path denotes a directory, it needs to be suffixed with a slash ({{Code|/}}).
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened, if one of the documents to be added is not well-formed, or if it could not be parsed for some other reason.
 
|-
 
| '''Examples'''
 
|
 
* {{Code|ADD input.xml}}<br/>adds the file {{Code|input.xml}} to the database.
 
* {{Code|ADD TO temp/one.xml input.xml}}<br/>adds {{Code|input.xml}} to the database and moves it to {{Code|temp/one.xml}}.
 
* {{Code|ADD TO target/ xmldir}}<br/>adds all files from the {{Code|xmldir}} directory to the database in the {{Code|target}} path.
 
|}
 
 
==DELETE==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|DELETE [path]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><delete path='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''WRITE''
 
|-
 
| '''Summary'''
 
|Deletes all documents from the currently opened database that start with the specified {{Code|[path]}}.
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened.
 
|}
 
 
==RENAME==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|RENAME [path] [newpath]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><rename path='...' newpath='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''WRITE''
 
|-
 
| '''Summary'''
 
|Renames all document paths in the currently opened database that start with the specified {{Code|[path]}}. The command may be used to either rename single documents or directories.
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened, or if the target path is empty.
 
|-
 
| '''Examples'''
 
|
 
* {{Code|RENAME one.xml two.xml}}<br/>renames the document {{Code|one.xml}} to {{Code|two.xml}}.
 
* {{Code|RENAME / TOP}}<br/>moves all documents to a {{Code|TOP}} root directory.
 
|}
 
 
==REPLACE==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|REPLACE [path] [input]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><replace path='...'>[input]</replace></code><br/>
 
|-
 
| '''Permission'''
 
|''WRITE''
 
|-
 
| '''Summary'''
 
|Replaces a document in the currently opened database, addressed by {{Code|[path]}}, with the file or XML string specified by {{Code|[input]}}, or adds it as a new document.
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened, if the specified path points to a database directory, or if the input is not found.
 
|-
 
| '''Examples'''
 
|
 
* {{Code|REPLACE one.xml input.xml}}<br/>replaces the document {{Code|one.xml}} with the contents of the file {{Code|input.xml}}.
 
* {{Code|REPLACE top.xml &lt;xml/&gt;}}<br/>replaces the document {{Code|top.xml}} with the document {{Code|&lt;xml/&gt;}}.
 
|}
 
 
==STORE==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|STORE (TO [path]) [input]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><store (path='...')>[input]</store></code><br/>
 
|-
 
| '''Permission'''
 
|''WRITE''
 
|-
 
| '''Summary'''
 
|Stores a raw file in the opened database to the specified {{Code|[path]}}. {{Code|[input]}} may either be a file reference, a remote URL, or a plain string. If the path denotes a directory, it needs to be suffixed with a slash ({{Code|/}}).
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened, if the specified resource is not found, if the target path is invalid or if the data cannot not be written for some other reason.
 
|}
 
 
==OPTIMIZE==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|OPTIMIZE (ALL)}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><optimize/></code><br/><code><optimize-all/></code><br/>
 
|-
 
| '''Permission'''
 
|''WRITE''
 
|-
 
| '''Summary'''
 
|Optimizes the index structures, meta data and statistics of the currently opened database. If the {{Code|ALL}} flag is specified, the internal database structures are completely rebuilt; this often leads to a reduction of the total database size.
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened, or if the currently opened database is a main-memory instance.
 
|}
 
 
==FLUSH==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|FLUSH}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><flush/></code><br/>
 
|-
 
| '''Permission'''
 
|''WRITE''
 
|-
 
| '''Summary'''
 
|Explicitly flushes the buffers of the currently opened database to disk. This command is applied if [[Options#AUTOFLUSH|AUTOFLUSH]] has been set to {{Code|false}}.
 
|-
 
| '''Errors'''
 
|The command fails if no database is opened.
 
|}
 
 
=Server Administration=
 
 
==SHOW SESSIONS==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|SHOW SESSIONS}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><show-sessions/></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Shows all sessions that are connected to the current server instance.
 
|}
 
 
==SHOW USERS==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|SHOW USERS (ON [database])}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><show-users (database='...')/></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Shows all users that are registered in the database. If a {{Code|[database]}} is specified, local users are shown.
 
|-
 
| '''Errors'''
 
|The command fails if the optional database could not be opened.
 
|}
 
 
==KILL==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|KILL [target]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><kill target='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Kills sessions of a user or an IP:port combination, specified by {{Code|[target]}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one user.
 
|-
 
| '''Errors'''
 
|The command fails if a user tried to kill his/her own session.
 
|}
 
 
==CREATE EVENT==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|CREATE EVENT [NAME]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><create-event name='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Creates the specified [[Events|event]].
 
|-
 
| '''Errors'''
 
|The command fails if event already exists.
 
|}
 
 
==SHOW EVENTS==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|SHOW EVENTS}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><show-events/></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Shows all [[Events|events]] that have been registered in the database.
 
|}
 
 
==DROP EVENT==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|DROP EVENT [NAME]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><drop-event name='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Drops the specified [[Events|event]].
 
|-
 
| '''Errors'''
 
|The command fails if the event doesn't exist.
 
|}
 
 
=User Management=
 
 
==CREATE USER==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|CREATE USER [name] ([password])}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><create-user name='...'>([password])</create-user></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Creates a user with the specified {{Code|[name]}} and {{Code|[password]}}. {{Code|[name]}} must be a [[#Valid Names|valid user name]]. The password must be a valid MD5 hash value. If no password is specified in the console mode, it is requested via standard input.
 
|-
 
| '''Errors'''
 
|The command fails if the specified user already exists, or if the password is no valid MD5 hash value.
 
|}
 
 
==ALTER USER==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|ALTER USER [name] ([password])}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><alter-user name='...'>([password])</alter-user></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Alters the {{Code|[password]}} of the user specified by {{Code|[name]}}. The password must be a valid MD5 hash value. If no password is specified in the console mode, it is requested via standard input.
 
|-
 
| '''Errors'''
 
|The command fails if the specified user does not exist, or if the password is no valid MD5 hash value.
 
|}
 
 
==DROP USER==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|DROP USER [name] (ON [database])}}:
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><drop-user name='...' (database='...')/></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Drops the user with the specified {{Code|[name]}}. If a {{Code|[database]}} is specified, the user is only dropped locally. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database or user.
 
|-
 
| '''Errors'''
 
|The command fails if {{Code|admin}} is specified as user name, if the specified user does not exist or is logged in, or if the optional database could not be opened for modification.
 
|}
 
 
==GRANT==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|GRANT [NONE&#x7c;READ&#x7c;WRITE&#x7c;CREATE&#x7c;ADMIN] (ON [database]) TO [user]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><grant name='...' permission='none&#x7c;read&#x7c;write&#x7c;create&#x7c;admin' (database='...')/></code><br/>
 
|-
 
| '''Permission'''
 
|''ADMIN''
 
|-
 
| '''Summary'''
 
|Grants the specified [[User_Management|permission]] to the specified {{Code|[user]}}. If a {{Code|[database]}} is specified, the permissions are only granted locally. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database or user.
 
|-
 
| '''Errors'''
 
|The command fails if {{Code|admin}} is specified as user name, if the specified user does not exist, or if the optional database could not be opened for modification.
 
|-
 
| '''Examples'''
 
|
 
* {{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission to the user {{Code|JoeWinson}}.
 
* {{Code|GRANT WRITE ON Wiki TO editor*}}<br/>grants {{Code|WRITE}} permissions on the {{Code|Wiki}} database to all users starting with the characters {{Code|editor*}}.
 
|}
 
 
==PASSWORD==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|PASSWORD ([password])}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><password>([password])</password></code><br/>
 
|-
 
| '''Permission'''
 
|''NONE''
 
|-
 
| '''Summary'''
 
|Changes the {{Code|[password]}} of the current user. The password must be a valid MD5 hash value. If no password is specified in the console mode, it is requested via standard input.
 
|-
 
| '''Errors'''
 
|The command fails if the password is no valid MD5 hash value.
 
|}
 
 
=General Commands=
 
 
==RUN==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|RUN [file]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><run file='...'/></code>
 
|-
 
| '''Permission'''
 
|''depends on input''
 
|-
 
| '''Summary'''
 
|Evaluates the contents of {{Code|[file]}} as XQuery expression. If the file ends with the suffix {{Code|.bxs}}, the file content will be evaluated as [[#Basics|command script]]. This command can be used to run several commands in a single transaction.
 
|-
 
| '''Errors'''
 
|The command fails if the specified file does not exist, or if the retrieved input is invalid. It will be canceled as soon as one of the executed commands fails.
 
|-
 
| '''Examples'''
 
|
 
* <code>RUN query.xq</code><br/>will evaluated the specified file as XQuery expression
 
* <code>RUN commands.bxs</code><br/>will evaluated the specified file as command script
 
|}
 
 
==EXECUTE==
 
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|EXECUTE [input]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><execute>[input]</execute></code>
 
|-
 
| '''Permission'''
 
|''depends on input''
 
|-
 
| '''Summary'''
 
|Evaluates the specified {{Code|[input]}} as [[#Basics|command script]]. This command can be used to run several commands in a single transaction.
 
|-
 
| '''Errors'''
 
|The command fails if the syntax of the specified input is invalid. It will be canceled as soon as one of the executed commands fails.
 
|-
 
| '''Examples'''
 
|
 
* <code>EXECUTE "create db db1; create db db2"</code><br/>
 
* <code>EXECUTE "<commands><create-db name='db1'/><create-db name='db2'/></commands>"</code><br/>both commands will create two databases {{Code|db1}} and {{Code|db2}} in a single transaction.
 
|}
 
 
==GET==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|GET [option]}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><get option='...'/></code><br/>
 
|-
 
| '''Permission'''
 
|''NONE''
 
|-
 
| '''Summary'''
 
|Returns the current value of the [[Options|Option]] specified via {{Code|[option]}}. Global options can only be requested by users with ADMIN permissions.
 
|-
 
| '''Errors'''
 
|The command fails if the specified option is unknown.
 
|}
 
 
==SET==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|SET [option] ([value])}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><set option='...'>([value])</set></code><br/>
 
|-
 
| '''Permission'''
 
|''NONE''
 
|-
 
| '''Summary'''
 
|Sets the [[Options|Option]] specified by {{Code|[option]}} to a new {{Code|[value]}}. Only local options can be modified. If no value is specified, and if the value is boolean, it will be inverted.
 
|-
 
| '''Errors'''
 
|The command fails if the specified option is unknown or if the specified value is invalid.
 
|}
 
 
==INFO==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|INFO}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><info/></code><br/>
 
|-
 
| '''Permission'''
 
|''READ''
 
|-
 
| '''Summary'''
 
|Shows global information.
 
|}
 
 
==HELP==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|HELP ([command])}}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><help>([command])</help></code><br/>
 
|-
 
| '''Permission'''
 
|''NONE''
 
|-
 
| '''Summary'''
 
|If {{Code|[command]}} is specified, information on the specific command is printed; otherwise, all commands are listed.
 
|-
 
| '''Errors'''
 
|The command fails if the specified command is unknown.
 
|}
 
 
==EXIT==
 
{| width='100%'
 
|-
 
|width='100'|'''Syntax'''
 
|{{Code|EXIT }}
 
|-
 
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
 
|<code><exit/></code><br/>
 
|-
 
| '''Permission'''
 
|''NONE''
 
|-
 
| '''Summary'''
 
|Exits the console mode.
 
|}
 
 
=Changelog=
 
 
;Version 7.5
 
 
* Added: <code>[[#EXECUTE|EXECUTE]]</code> executes a command script.
 
* Added: <code>[[#INSPECT|INSPECT]]</code> performs integrity checks.
 
* Added: automatic detection of [[#Basics|Command Scripts]].
 
* Removed: {{Code|SHOW DATABASES}}; information is also returned by <code>[[#SHOW SESSIONS|SHOW SESSIONS]]</code>.
 
* Removed: <code>[[#OPEN|OPEN]]</code>: path argument.
 
 
;Version 7.3
 
 
* Added: [[#XML Syntax|XML Syntax]] added
 
* Updated: <code>[[#CHECK|CHECK]]</code> can now be used to create empty databases.
 
* Updated: Names and paths in <code>[[#OPEN|OPEN]]</code> and <code>[[#LIST|LIST]]</code> are now specified as separate arguments.
 
 
;Version 7.2.1
 
 
* Updated: permissions for <code>[[#GET|GET]]</code> and <code>[[#SET|SET]]</code> changed from {{Code|READ}} to {{Code|NONE}}
 
 
;Version 7.2
 
 
* Updated: <code>[[#CREATE INDEX|CREATE INDEX]]</code>, <code>[[#DROP INDEX|DROP INDEX]]</code> ({{Code|PATH}} argument removed. Path summary is always available now and updated with [[#OPTIMIZE|OPTIMIZE]])
 
* Updated: permissions for <code>[[#REPO DELETE|REPO DELETE]]</code>, <code>[[#REPO INSTALL|REPO INSTALL]]</code> and <code>[[#REPO LIST|REPO LIST]]</code>
 
 
;Version 7.1
 
 
* Updated: <code>[[#KILL|KILL]]</code> (killing sessions by specifying IP:port)
 
 
;Version 7.0
 
 
* Added: <code>[[#FLUSH|FLUSH]]</code>, <code>[[#RETRIEVE|RETRIEVE]]</code>, <code>[[#STORE|STORE]]</code>
 
* Updated: <code>[[#ADD|ADD]]</code>: simplified arguments
 
 
[[Category:Beginner]]
 
[[Category:Server]]
 
  
 
==Client/Server Architecture==
 
==Client/Server Architecture==
Line 1,456: Line 410:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|If this option is activated, documents that are added via [[Commands#ADD|ADD]] will first be cached to disk before being added to the final database. This option is helpful when larger documents are to be imported, and if the existing heuristics cannot estimate the size of the input (e.g. when adding directories).
+
|If this option is activated, documents that are added via [Commands#ADD|ADD] will first be cached to disk before being added to the final database. This option is helpful when larger documents are to be imported, and if the existing heuristics cannot estimate the size of the input (e.g. when adding directories).
 
|}
 
|}
  
Line 1,873: Line 827:
 
| '''Summary'''
 
| '''Summary'''
 
|By activating this option, the XQuery {{Code|doc()}} and  {{Code|collection()}} functions will create database instances for the addressed input files.
 
|By activating this option, the XQuery {{Code|doc()}} and  {{Code|collection()}} functions will create database instances for the addressed input files.
|}
 
 
===CHECKSTRINGS===
 
 
{{Mark|Introduced with Version 7.7:}}
 
{| width='100%'
 
|-
 
| width='90' | '''Signature'''
 
|{{Code|CHECKSTRINGS [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|If this option is turned off, strings from external sources will be adopted as is, i. e., without being checked for valid XML characters:
 
* This option affects [[Java Bindings]] and the string conversion and input functions [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], [[Archive Module#archive:update|archive:update]], [[Conversion Module#convert:binary-to-string|convert:binary-to-string]], [[Fetch Module#fetch:text|fetch:text]], [[File Module#file:read-text|file:read-text]], and [[ZIP Module#zip:text-entry|zip:text-entry]].
 
* Please be aware that an inconsiderate use of this option may cause unexpected behavior when storing or outputting strings.
 
 
|}
 
|}
  
Line 2,088: Line 1,025:
 
;Version 7.7
 
;Version 7.7
  
* Added: <code>[[#ADDCACHE|ADDCACHE]]</code>, <code>[[#FTINDEXSPLITSIZE|FTINDEXSPLITSIZE]]</code>, <code>[[#INDEXSPLITSIZE|INDEXSPLITSIZE]]</code>, <code>[[#CHECKSTRINGS|CHECKSTRINGS]]</code>
+
* Added: <code>[[#ADDCACHE|ADDCACHE]]</code>, <code>[[#INDEXSPLITSIZE|INDEXSPLITSIZE]]</code>, <code>[[#FTINDEXSPLITSIZE|FTINDEXSPLITSIZE]]</code>
  
 
;Version 7.6
 
;Version 7.6

Revision as of 11:43, 20 May 2013

This page is linked from the Getting Started Section.

The options listed on this page influence the way how database commands are executed and XQuery expressions are evaluated. Options are divided into global options, which are valid for all BaseX instances, and local options, which are specific to a client or session. Values of options are either strings, numbers or booleans.

The .basex configuration file is parsed by every new local BaseX instance. It is used to store options to disk:

  • Global options can only be set via the configuration file or system properties (see below).
  • With Version 7.6 and later, local options can also be specified in the configuration file after the # Local Options comment.

Various ways exist to access and change options:

  • The current value of an option can be requested with the GET and changed with the SET command. All values are static: they stay valid until they are changed once again by another operation. If an option is of type boolean, and if no value is specified, its existing value will be inverted.
  • Initial values for options can also be specified via system properties, which can e.g. be passed on with the -D flag on command line, or using System.setProperty() before creating a BaseX instance. The specified keys needs to be prefixed with org.basex.. An example:
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
CHOP: false
  • Options can also be set in the prolog of an XQuery expression. In the option declaration, options need to be bound to the Database Module namespace. All values will be reset after the evaluation of a query:
declare option db:chop 'false';
...
(# db:chop false #) { parse-xml('<xml> hi </xml>') }

If options are implicitly changed by operations in the GUI, the underlying commands will be listed in the Info View.

Global Options

General

DBPATH

Signature DBPATH [path]
Default {home}/BaseXData or {home}/data
Summary Points to the directory in which all databases are located.
Note: this option can only be changed if no database is currently opened.

REPOPATH

Signature REPOPATH [path]
Default {home}/BaseXRepo
Summary Points to the Repository, in which all XQuery modules are located.

DEBUG

Signature DEBUG [boolean]
Default false
Summary Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on command line via -d.

LANG

Signature LANG [language]
Default English
Summary Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.

LANGKEY

Signature LANGKEY [boolean]
Default false
Summary Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed.

GLOBALLOCK

Introduced with Version 7.6:

Signature GLOBALLOCK [boolean]
Default false
Summary Controls if local (database) or global (process) locking will be used for managing read and write operations. The article on Transaction Management provides more details on concurrency control.

Client/Server Architecture

HOST

Signature HOST [host]
Default localhost
Summary This host name is used by the client when connecting to a server. This option can also be changed when running the client on command line via -n.

PORT

Signature PORT [port]
Default 1984
Summary This port is used by the client when connecting to a server. This option can also be changed when running the client on command line via -p.

SERVERPORT

Signature SERVERPORT [port]
Default 1984
Summary This is the port the database server will be listening to. This option can also be changed when running the server on command line via -p.

EVENTPORT

Signature EVENTPORT [port]
Default 1985
Summary This port is used by the client to listen for server events. It will only be bound if a client attaches itself to a database event. This option can also be changed when running the server on command line via -e.

USER

Signature USER [name]
Default empty
Summary Represents a user name, which is used for accessing the server or an HTTP service:
  • The default value will be overwritten if a client specifies its own credentials.
  • If the default value is empty, login will only be possible if the client specifies credentials.
  • The option can also be changed on command line via -U.

PASSWORD

Signature PASSWORD [password]
Default empty
Summary Represents a password, which is used for accessing the server or an HTTP service:
  • The default value will be overwritten if a client specifies its own credentials.
  • If the default value is empty, login will only be possible if the client specifies credentials.
  • The option can also be changed on command line via -P.
  • Please note that it is a security risk to specify your password in plain text.

SERVERHOST

Signature SERVERHOST [host|ip]
Default empty
Summary This is the host name or ip address the server is bound to. If the option is set to an empty string (which is the default), the server will be open to all clients.

PROXYHOST

Signature PROXYHOST [host]
Default empty
Summary This is the host name of a proxy server.

PROXYPORT

Signature PROXYPORT [port]
Default 80
Summary This is the port number of a proxy server.

NONPROXYHOSTS

Signature NONPROXYHOSTS [hosts]
Default empty
Summary This is a list of hosts that should be directly accessed.

TIMEOUT

Signature TIMEOUT [seconds]
Default 30
Summary Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted. Write operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to 0. It is ignored for ADMIN operations.

KEEPALIVE

Signature KEEPALIVE [seconds]
Default 600
Summary Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to 0.

PARALLEL

Signature PARALLEL [number]
Default 8
Summary Denotes the maximum allowed number of parallel read transactions.

LOG

Signature LOG [boolean]
Default true
Summary Turns Logging of server operations and HTTP requests on/off. This option can also be changed when running the server on command line via -z.

LOGMSGMAXLEN

Signature LOGMSGMAXLEN [length]
Default 1000
Summary Specifies the maximum length of a single log message.

HTTP Options

If BaseX is run as Web Application, the HTTP options are either determined by the web server, or specified in the webapp/WEB-INF directory and the jetty.xml and web.xml configuration files.

WEBPATH

Signature WEBPATH [path]
Default {home}/BaseXWeb or {home}/webapp
Summary Points to the directory in which all the Web Application contents are stored, including XQuery, Script, RESTXQ and configuration files.

RESTXQPATH

Signature RESTXQPATH [path]
Default empty
Summary Points to the directory which contains the RESTXQ modules of a web application. Relative paths will be resolved against the WEBPATH directory.

HTTPLOCAL

Signature HTTPLOCAL [boolean]
Default false
Summary By default, a database server instance will be opened along with the web server. If the flag is set to true, all commands will be executed in an embedded database context.
If BaseX is run as Web Application, and if the flag is false, the server will be started as soon as the first HTTP service is called.

STOPPORT

Signature STOPPORT [port]
Default 8985
Summary This is the port on which the HTTP Server can be locally closed:
  • The listener for stopping the web server will only be started if the specified value is greater than 0.
  • The option is ignored if BaseX is used as a Web Application or started via Maven.
  • This option can also be changed when running the HTTP server on command line via -s.

Create Options

General

MAINMEM

Signature MAINMEM [boolean]
Default false
Summary If this option is turned on, new databases will be exclusively created in main memory. Most queries will be evaluated faster in main memory mode, but all data is lost if BaseX is shut down. The value of this option will be assigned once to a new database, and cannot be changed after that.

ADDCACHE

Introduced with Version 7.7:

Signature ADDCACHE [boolean]
Default false
Summary ADD] will first be cached to disk before being added to the final database. This option is helpful when larger documents are to be imported, and if the existing heuristics cannot estimate the size of the input (e.g. when adding directories).

Parsing

CREATEFILTER

Signature CREATEFILTER [filter]
Default *.xml
Summary File filter in the Glob Syntax, which is applied whenever new databases are created, or resources are added to a database.

ADDARCHIVES

Signature ADDARCHIVES [boolean]
Default true
Summary If this option is set to true, files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a database.

SKIPCORRUPT

Signature SKIPCORRUPT [boolean]
Default false
Summary Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files will be parsed twice. Next, main memory consumption will be higher as parsed files will be cached in main memory.

ADDRAW

Signature ADDRAW [boolean]
Default false
Summary If this option is activated, and if new resources are added to a database, all files that are not filtered by the CREATEFILTER option will be added as raw files (i.e., in their binary representation).

PARSER

Signature PARSER [type]
Default XML
Summary Defines a parser for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if Tagsoup is not found in the classpath.

PARSEROPT

Signature PARSEROPT [options]
Default empty
Summary Defines parser-specific options; see Parsers for more information.

HTMLOPT

Signature HTMLOPT [options]
Default empty
Summary Allows to specify TagSoup options for HTML parsing; see HTML Parser for more information.

XML Parsing

CHOP

Signature CHOP [boolean]
Default true
Summary Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. By default, this option is set to true, as it often reduces the database size by up to 50%. It can also be turned off on command line via -w.

INTPARSE

Signature INTPARSE [boolean]
Default true
Summary Uses the internal XML parser instead of the standard Java XML parser. The internal parser is faster, more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for parsing DTDs.

DTD

Signature DTD [boolean]
Default false
Summary Parses referenced DTDs and resolves XML entities. By default, this option is switched to false, as many DTDs are located externally, which may completely block the process of creating new databases. The CATFILE option can be changed to locally resolve DTDs.

CATFILE

Signature CATFILE [path]
Default empty
Summary Specifies a catalog file to locally resolve DTDs; see the entry on Catalog Resolvers for more details.

Indexing

The current index and full-text index options will be stored in a new database, and take effect if indexes are rebuilt via the OPTIMIZE.

TEXTINDEX

Signature TEXTINDEX [boolean]
Default true
Summary Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see Indexes for more details.

ATTRINDEX

Signature ATTRINDEX [boolean]
Default true
Summary Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values; see Indexes for more details.

FTINDEX

Signature FTINDEX [boolean]
Default false
Summary Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions; see Indexes for more details.

MAXLEN

Signature MAXLEN [int]
Default 96
Summary Specifies the maximum length of strings that are to be indexed by the name, path, value, and full-text index structures. The value of this option will be assigned once to a new database, and cannot be changed after that.

MAXCATS

Signature MAXCATS [int]
Default 100
Summary Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the Name Index or Path Index. The value of this option will be assigned once to a new database, and cannot be changed after that.

UPDINDEX

Signature UPDINDEX [boolean]
Default false
Summary If turned on, incremental indexing will be activated: all update operations will also update the value index structures (texts and attribute values). The value of this option will be assigned once to a new database, and cannot be changed after that. The advantage of incremental indexes is that the value index structures will always be up-to-date. The downside is that updates will take a little bit longer. The article on Index Structures includes additional details.

INDEXSPLITSIZE

Introduced with Version 7.7:

Signature INDEXSPLITSIZE [num]
Default 0
Summary This option affects the construction of new text and attribute indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied.

FTINDEXSPLITSIZE

Introduced with Version 7.7:

Signature FTINDEXSPLITSIZE [num]
Default 0
Summary This option affects the construction of new full-text indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied.

Full-Text

STEMMING

Signature STEMMING [boolean]
Default false
Summary A new full-text index will stem all tokens and speed up queries on stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this index.

CASESENS

Signature CASESENS [boolean]
Default false
Summary A new full-text index will preserve the case of all tokens. The same case normalization will be applied to all query tokens that are checked against tokens in this index.

DIACRITICS

Signature DIACRITICS [boolean]
Default false
Summary A new full-text index will preserve the diacritics of all tokens. The same diacritics normalization will be applied to all query tokens that are checked against tokens in this index.

LANGUAGE

Signature LANGUAGE [lang]
Default en
Summary A new full-text index will use the given language to normalize all tokens. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages.

STOPWORDS

Signature STOPWORDS [path]
Default empty
Summary A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. A standard stopword list for English texts is provided in the directory etc/stopwords.txt in the official releases.

Query Options

QUERYINFO

Signature QUERYINFO [boolean]
Default false
Summary Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the Info View in the GUI. It can also be activated on command line via -V.

XQUERY3

Signature XQUERY3
Default true
Summary Enables all XQuery 3.0 features supported by BaseX. If this option is set to false, the XQuery parser will only accept expressions of the XQuery 1.0 specification.

BINDINGS

Signature BINDINGS [vars]
Default empty
Summary Contains external variables to be bound to a query:
  • Variable names and values are separated by equality signs, and multiple variables are delimited by commas.
  • Variables may optionally be introduced with a leading dollar sign.
  • Commas that occur in the value itself are encoded by duplication.
  • If a variable uses a namespace different to the default namespace, it can be specified with the Clark Notation or Expanded QName Notation.
  • This option can also be used on command line with the flag -b.
Examples $a=1,$b=2   binds the values 1 and 2 to the variables $a and $b
a=1,,2   binds the value 1,2 to the variable $a
{URI}a=x   binds the value x to the variable $a with the namespace URI.

QUERYPATH

Signature QUERYPATH [path]
Default empty
Summary Contains the path (base URI) to the executed query (default: empty). This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a query.

CACHEQUERY

Signature CACHEQUERY [boolean]
Default false
Summary Caches the query results before returning them to the client. This option may be set to true if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX).

FORCECREATE

Signature FORCECREATE [boolean]
Default false
Summary By activating this option, the XQuery doc() and collection() functions will create database instances for the addressed input files.

LSERROR

Signature LSERROR [error]
Default 0
Summary This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option. See the page on Full-Texts for more information on fuzzy querying.

RUNS

Signature RUNS [num]
Default 1
Summary Specify number of runs a query is executed by the XQUERY command. The result is only serialized once, and the measured times are averages of all runs.

Serialization Options

SERIALIZE

Signature SERIALIZE [boolean]
Default true
Summary Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to false. It can also be turned off on command line via -z.

SERIALIZER

Signature SERIALIZER [params]
Default empty
Summary Contains parameters for serializing query results:
  • Keys and values are separated by equality signs.
  • Multiple parameters are delimited by commas.
  • The option can also be used on command line with the flag -s.
Example encoding=US-ASCII,omit-xml-declaration=no : sets the encoding to US-ASCII and prints the XML declaration.

EXPORTER

Signature EXPORTER [params]
Default empty
Summary Contains parameters for exporting all resources of a database; see Serialization for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas.

XMLPLAN

Signature XMLPLAN [boolean]
Default false
Summary Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on command line via -x.

COMPPLAN

Signature COMPPLAN [boolean]
Default true
Summary Creates the query plan before or after the compilation step. Query plans might change due to optimizations.

DOTPLAN

Signature DOTPLAN [boolean]
Default false
Summary Visualizes the execution plan of an XQuery expression with dotty and saves its dot file in the query directory.

DOTCOMPACT

Signature DOTCOMPACT [boolean]
Default false
Summary Chooses a compact dot representation.

DOTDISPLAY

Signature DOTDISPLAY [boolean]
Default true
Summary Visualizes the dot representation after the query execution.

DOTTY

Signature DOTTY [path]
Default dotty
Summary Location of the dotty executable.

Other Options

AUTOFLUSH

Signature AUTOFLUSH [boolean]
Default true
Summary Flushes database buffers to disk after each update. If this option is set to false, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the FLUSH command.

WRITEBACK

Signature WRITEBACK [boolean]
Default false
Summary Updates on XML nodes are written back to the input files. No backups of your original files will be created if this option is turned on. This option can also be activated on command line via -u.

MAXSTAT

Signature MAXSTAT [num]
Default 30
Summary Specifies the maximum number of index occurrences printed by the INFO INDEX command.

Changelog

Version 7.7
Version 7.6
  • Added: GLOBALLOCK
  • Added: store local options in configuration file after # Local Options comments.
Version 7.5
  • Added: options can now be set via system properties
  • Added: a pragma expression can be used to locally change database options
  • Added: USER, PASSWORD, LOG, LOGMSGMAXLEN, WEBPATH, RESTXQPATHHTTPLOCAL, CREATEONLY, STRIPNS
  • Removed: HTTPPATH; HTTPPORT: jetty.xml configuration file is used instead
  • Removed: global options cannot be changed anymore during the lifetime of a BaseX instance
Version 7.3
  • Updated: KEEPALIVE, TIMEOUT: default values changed
  • Removed: WILDCARDS; new index supports both fuzzy and wildcard queries
  • Removed: SCORING; new scoring model will focus on lengths of text nodes and match options
Version 7.2
Version 7.1
Version 7.0