Difference between revisions of "Options"

From BaseX Documentation
Jump to navigation Jump to search
(Undo revision 9232 by CG (talk))
 
(292 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
This page is linked from the [[Getting Started]] Section.
 
This page is linked from the [[Getting Started]] Section.
  
The options listed on this page influence the way how database [[Commands|commands]] are executed and XQuery expressions are evaluated. Options are divided into [[#Global Options|global options]], which are valid for all BaseX instances, and local options, which are specific to a client or session. Values of options are either ''strings'', ''numbers'' or ''booleans''.
+
The options listed on this page influence the way how database [[Commands|commands]] are executed and XQuery expressions are evaluated. Two kinds of options exist:
  
The {{Code|.basex}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance. It is used to store options to disk:
+
* '''[[#Global Options|Global Options]]''' are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/server architecture.
 +
* '''Local options''' (all remaining ones) are specific to a client or session.
  
* Global options can only be set via the configuration file or system properties (see below).
+
Values of options are either ''strings'', ''numbers'' or ''booleans''. Options are ''static'' and not bound to a single operation (for example, the next command). Various ways exist to access and change options:
* With {{Version|7.6}} and later, local options can also be specified in the configuration file after the {{Code|# Local Options}} comment.
 
  
Various ways exist to access and change options:
+
* The current value of an option can be requested with the {{Command|GET}} command. Local options can be changed via {{Command|SET}} (all global options, except for {{Option|DEBUG}}, can only be changed at startup time). If an option is of type ''boolean'', and if no value is specified, its current value will be inverted.
  
* The current value of an option can be requested with the [[Commands#GET|GET]] and changed with the [[Commands#SET|SET]] command. All values are ''static'': they stay valid until they are changed once again by another operation. If an option is of type ''boolean'', and if no value is specified, its existing value will be inverted.
+
* The {{Code|.basex}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance. It contains all global options. Local options can be specified at the end of the file after the {{Code|Local Options}} comment:
  
* Initial values for options can also be specified via system properties, which can e.g. be passed on with the [http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.html#options -D flag] on command line, or using [http://docs.oracle.com/javase/6/docs/api/java/lang/System.html#setProperty(java.lang.String,%20java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys needs to be prefixed with {{Code|org.basex.}}. An example:
+
<syntaxhighlight lang="perl">
 
+
# General Options
<pre class="brush:bash">
+
DEBUG = false
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
 
CHOP: false
 
</pre>
 
 
 
* Options can also be set in the prolog of an XQuery expression. In the option declaration, options need to be bound to the [[Database Module]] namespace. All values will be reset after the evaluation of a query:
 
 
 
<pre class="brush:xquery">
 
declare option db:chop 'false';
 
 
...
 
...
</pre>
 
  
<pre class="brush:xquery">
+
# Local Options
(# db:chop false #) { parse-xml('<xml> hi </xml>') }
+
CHOP = false
</pre>
+
</syntaxhighlight>
  
If options are implicitly changed by operations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/>
+
* Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on command line, or using [https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example:
  
=Global Options=
+
<syntaxhighlight lang="perl">
 +
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
 +
CHOP: false
 +
</syntaxhighlight>
  
This article is part of the [[Getting Started]] Section.
+
* If using the Mac OS X packaged application then global options can be set within the Info.plist file within the Contents folder of the application package. For example:
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=
+
<syntaxhighlight lang="xml">
 +
<key>JVMOptions</key>
 +
<array>
 +
  <string>-Dorg.basex.CHOP=false</string>
 +
</array>
 +
</syntaxhighlight>
  
==Command Scripts==
+
* In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:
  
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.
+
<syntaxhighlight lang="xml">
 +
<context-param>
 +
  <param-name>org.basex.chop</param-name>
 +
  <param-value>false</param-value>
 +
</context-param>
 +
</syntaxhighlight>
  
==String Syntax==
+
* In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]].
  
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:
+
If options are changed by operations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/>
  
<pre class="brush:xml">
+
=Global Options=
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.
+
Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception is the [[#debug|DEBUG]] option, which can also be changed at runtime by users with [[User Management|admin permissions]].
Multiple commands can be enclosed by a {{Code|<commands/>}} root element:
 
  
<pre class="brush:xml">
+
==General Options==
<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==
+
===DEBUG===
  
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==
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|CREATE DB [name] ([input])}}
+
|{{Code|DEBUG [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><create-db name='...'>([input])</create-db></code><br/>
+
|{{Code|false}}
|-
 
| '''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:
+
|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Command-Line Options#BaseX Standalone|command line]] via <code>-d</code>.
* {{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==
+
===DBPATH===
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|OPEN [name]}}
+
|{{Code|DBPATH [path]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><open name='...'/></code>
+
|<code><code>[[Configuration#Database Directory|{home}/data]]</code>
|-
 
| '''Permission'''
 
|''READ''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Opens the database specified by {{Code|[name]}}.
+
|Points to the directory in which all databases 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==
+
===LOGPATH===
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|CHECK [input]}}
+
|{{Code|LOGPATH [path]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><check input='...'/></code><br/>
+
|<code>.logs</code>
|-
 
| '''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.
+
|Points to the directory in which all [[Logging|log files]] are stored. Relative paths will be resolved against the {{Option|DBPATH}} directory.
|-
 
| '''Errors'''
 
|The command fails if the addressed database could neither be opened nor created.
 
 
|}
 
|}
  
==CLOSE==
+
===REPOPATH===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|CLOSE }}
+
|{{Code|REPOPATH [path]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><close/></code><br/>
+
|<code>[[Configuration#Database Directory|{home}/repo]]</code>
|-
 
| '''Permission'''
 
|''READ''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Closes the currently opened database.
+
|Points to the [[Repository]], in which all XQuery modules are located.
|-
 
| '''Errors'''
 
|The command fails if the database files could not be closed for some reason.
 
 
|}
 
|}
  
==EXPORT==
+
===LANG===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|EXPORT [path]}}
+
|{{Code|LANG [language]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><export path='...'/></code><br/>
+
|{{Code|English}}
|-
 
| '''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.
+
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.
|-
 
| '''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==
+
===LANGKEY===
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|CREATE INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXT]}}
+
|{{Code|LANGKEY [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code>&lt;create-index type='text&#x7c;attribute&#x7c;fulltext'/&gt;</code><br/>
+
|{{Code|false}}
|-
 
| '''Permission'''
 
|''WRITE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Creates the specified database [[Indexes|index]].
+
|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 specified index is unknown, or if indexing fails for some other reason.
 
 
|}
 
|}
  
==DROP INDEX==
+
===FAIRLOCK===
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|DROP INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXT]}}
+
|{{Code|FAIRLOCK [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><drop-index type='text&#x7c;attribute&#x7c;fulltext'/></code><br/>
+
|{{Code|false}}
|-
 
| '''Permission'''
 
|''WRITE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Drops the specified database [[Indexes|index]].
+
|Defines the locking strategy:
|-
+
* By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the limit of parallel transactions (specified via {{Option|PARALLEL}}) has been reached. This prevents update operations from blocking all other requests. For example, the DBA can further be used to see which jobs are running, even if the queue is full.
| '''Errors'''
+
* If fair locking is enabled, read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it should be used if the prompt evaluation of update operations is critical.
|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=
+
===CACHETIMEOUT===
  
==ALTER DB==
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|ALTER DB [name] [newname]}}
+
|{{Code|CACHETIMEOUT [seconds]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><alter-db name='...' newname='...'/></code><br/>
+
|{{Code|3600}}
|-
 
| '''Permission'''
 
|''CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Renames the database specified by {{Code|[name]}} to {{Code|[newname]}}. {{Code|[newname]}} must be a [[#Valid Names|valid database name]].
+
|Specifies how many seconds the results of queries, which have been queued by the [[Jobs Module|asynchronously executed]], will be cached in main memory.
|-
 
| '''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==
+
==Client/Server Architecture==
 +
 
 +
===HOST===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|DROP DB [name]}}
+
|{{Code|HOST [host]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><drop-db name='...'/></code><br/>
+
|{{Code|localhost}}
|-
 
| '''Permission'''
 
|''CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Drops the database with the specified {{Code|[name]}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.
+
|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
|-
 
| '''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==
+
===PORT===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|RESTORE [name]}}
+
|{{Code|PORT [port]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><restore name='...'/></code><br/>
+
|{{Code|1984}}
|-
 
| '''Permission'''
 
|''CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Restores a database with the specified {{Code|[name]}}. The name may include the timestamp of the backup file.
+
|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
|-
 
| '''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==
+
===SERVERPORT===
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|INSPECT}}
+
|{{Code|SERVERPORT [port]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><inspect/></code>
+
|{{Code|1984}}
|-
 
| '''Permission'''
 
|''READ''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Performs some integrity checks on the opened database and returns a brief summary.
+
|This is the port the database server will be listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-p</code>.
 
|}
 
|}
  
==DROP BACKUP==
+
===USER===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|SHOW BACKUPS}}
+
|{{Code|USER [name]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><show-backups/></code><br/>
+
|''empty''
|-
 
| '''Permission'''
 
|''CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Shows all database backups.
+
|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 Options#BaseX Client|command line]] via <code>-U</code>.
 
|}
 
|}
  
==COPY==
+
===PASSWORD===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|INFO DB}}
+
|{{Code|PASSWORD [password]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><info-db/></code><br/>
+
|''empty''
|-
 
| '''Permission'''
 
|''READ''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Shows information on the currently opened database.
+
|Represents a password, which is used for accessing the server:
|-
+
* The default value will be overwritten if a client specifies its own credentials.
| '''Errors'''
+
* If the default value is empty, login will only be possible if the client specifies credentials.
|The command fails if no database is opened.
+
* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>.
 +
* Please note that it is a security risk to specify your password in plain text.
 
|}
 
|}
  
==INFO INDEX==
+
===AUTHMETHOD===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|INFO STORAGE [start end] &#x7c; [query]}}
+
|{{Code|AUTHMETHOD [method]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><info-storage>([query])</info-storage></code><br/>
+
|''Basic''
|-
 
| '''Permission'''
 
|''READ''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Shows the internal main table of the currently opened database. An integer range or a query may be specified as argument.
+
|Specifies the default authentication method, which will be used by the [[Web Application|HTTP server]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}:<br/>
|-
+
* If basic access is chosen, the client can still request digest authentication.
| '''Errors'''
+
* This is different for digest access, which cannot be overwritten.
|The command fails if no database is opened, or if one of the specified arguments is invalid.
+
* With custom authentication, the server will not do any authentication.
 
|}
 
|}
  
= Querying =
+
===SERVERHOST===
 
 
==LIST==
 
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|LIST ([name] ([path]))}}
+
|{{Code|SERVERHOST [host&#x7c;ip]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><list (name='...' (path='...'))/></code><br/>
+
|''empty''
|-
 
| '''Permission'''
 
|''NONE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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]}}.
+
|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.
|-
 
| '''Errors'''
 
|The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason.
 
 
|}
 
|}
  
==XQUERY==
+
===PROXYHOST===
{| width='100%'
+
 
 +
{| width='100%' width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|XQUERY [query]}}
+
|{{Code|PROXYHOST [host]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><xquery>[query]</xquery></code><br/>
+
|''empty''  
|-
 
| '''Permission'''
 
|''depends on query''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Runs the specified {{Code|[query]}} and prints the result.
+
|This is the host name of a proxy server. If the value is an empty string, it will be ignored.
|-
 
| '''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==
+
===PROXYPORT===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|FIND [query]}}
+
|{{Code|PROXYPORT [port]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><find>[query]</find></code><br/>
+
|{{Code|0}}
|-
 
| '''Permission'''
 
|''READ''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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:
+
|This is the port number of a proxy server. If the value is set to {{Code|0}}, it will be ignored.
<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==
+
===NONPROXYHOSTS===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|REPO INSTALL [path]}}
+
|{{Code|NONPROXYHOSTS [hosts]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><repo-install path='...'/></code><br/>
+
|''empty''
|-
 
| '''Permission'''
 
|''CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
| Installs the package with path {{Code|[path]}}.
+
|This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored.
|-
 
| '''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==
+
===IGNOREHOSTNAME===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|REPO DELETE [name]}}
+
|{{Code|IGNOREHOSTNAME [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><repo-delete name='...'/></code><br/>
+
|{{Code|false}}
|-
 
| '''Permission'''
 
|''CREATE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
| Deletes the package with name {{Code|[name]}}, optionally followed by a version.
+
|If this option is enabled, hostnames of certificates will not be verified. Use {{Option|IGNORECERT}} to completely disable certificate verification.
|-
 
| '''Errors'''
 
| The command fails if the package to be deleted participates in a dependency.
 
 
|}
 
|}
  
=Updates=
+
===IGNORECERT===
  
==ADD==
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|ADD (TO [path]) [input]}}
+
|{{Code|IGNORECERT [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><add (path='...')>[input]</add></code><br/>
+
|{{Code|false}}
|-
 
| '''Permission'''
 
|''WRITE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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|/}}).
+
|This option can be turned on to ignore untrusted certificates when connecting to servers. Use {{Option|IGNOREHOSTNAME}} to suppress only the hostname verification.
|-
 
| '''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==
+
===TIMEOUT===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|RENAME [path] [newpath]}}
+
|{{Code|TIMEOUT [seconds]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><rename path='...' newpath='...'/></code><br/>
+
|{{Code|30}}
|-
 
| '''Permission'''
 
|''WRITE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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.
+
|Specifies the maximum time a transaction triggered by a client may take. If an operation takes longer than the specified number of seconds, it will be aborted. Active update operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to {{Code|0}}. It is ignored for operations with [[User Management|admin permissions]].
|-
 
| '''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==
+
===KEEPALIVE===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|STORE (TO [path]) [input]}}
+
|{{Code|KEEPALIVE [seconds]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><store (path='...')>[input]</store></code><br/>
+
|{{Code|600}}
|-
 
| '''Permission'''
 
|''WRITE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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|/}}).
+
|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.
|-
 
| '''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==
+
===PARALLEL===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|FLUSH}}
+
|{{Code|PARALLEL [number]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><flush/></code><br/>
+
|{{Code|8}}
|-
 
| '''Permission'''
 
|''WRITE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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}}.
+
|Denotes the maximum allowed number of parallel [[Transaction Management|transactions]]:
|-
+
* If {{Option|FAIRLOCK}} is enabled, the number of parallel transactions will never exceed the specified value.
| '''Errors'''
+
* If the option is disabled (which is the default), the limit only applies to transactions that access databases.
|The command fails if no database is opened.
+
* The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.
 
|}
 
|}
  
=Server Administration=
+
===LOG===
  
==SHOW SESSIONS==
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|SHOW SESSIONS}}
+
|{{Code|LOG [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><show-sessions/></code><br/>
+
|{{Code|true}}
|-
 
| '''Permission'''
 
|''ADMIN''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Shows all sessions that are connected to the current server instance.
+
|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.
 
|}
 
|}
  
==SHOW USERS==
+
===LOGMSGMAXLEN===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|SHOW USERS (ON [database])}}
+
|{{Code|LOGMSGMAXLEN [length]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><show-users (database='...')/></code><br/>
+
|{{Code|1000}}
|-
 
| '''Permission'''
 
|''ADMIN''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Shows all users that are registered in the database. If a {{Code|[database]}} is specified, local users are shown.
+
|Specifies the maximum length of a single [[Logging|log message]].
|-
 
| '''Errors'''
 
|The command fails if the optional database could not be opened.
 
 
|}
 
|}
  
==KILL==
+
===LOGTRACE===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|CREATE EVENT [NAME]}}
+
|{{Code|LOGTRACE [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><create-event name='...'/></code><br/>
+
|{{Code|true}}
|-
 
| '''Permission'''
 
|''ADMIN''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Creates the specified [[Events|event]].
+
|If BaseX is running as [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and similar functions) is written to the [[Logging|database logs]]. If this option is disabled, trace output will be redirected to standard error, as it is known from the standalone version of BaseX.
|-
 
| '''Errors'''
 
|The command fails if event already exists.
 
 
|}
 
|}
  
==SHOW EVENTS==
+
==HTTP Services==
{| 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==
+
Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that will be set before the web server is started:
{| 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=
+
===WEBPATH===
  
==CREATE USER==
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|CREATE USER [name] ([password])}}
+
|{{Code|WEBPATH [path]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><create-user name='...'>([password])</create-user></code><br/>
+
|<code>[[Configuration#Database Directory|{home}/webapp]]</code>
|-
 
| '''Permission'''
 
|''ADMIN''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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.
+
|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:
|-
+
* The option is ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].
| '''Errors'''
+
* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.
|The command fails if the specified user already exists, or if the password is no valid MD5 hash value.
 
 
|}
 
|}
  
==ALTER USER==
+
===GZIP===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|DROP USER [name] (ON [database])}}:
+
|{{Code|GZIP [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><drop-user name='...' (database='...')/></code><br/>
+
|<code>false</code>
|-
 
| '''Permission'''
 
|''ADMIN''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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.
+
|Jetty provides a [https://www.eclipse.org/jetty/documentation/current/gzip-filter.html Gzip handler] for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the [[Web Application|BaseX HTTP Server]]:
|-
+
* The option can also be enabled on [[Command-Line Options#HTTP Server|command line]] via <code>-g</code>.
| '''Errors'''
+
* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.
|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.
+
* The [https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 same defaults] of the web server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).
 
|}
 
|}
  
==GRANT==
+
===RESTXQPATH===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|PASSWORD ([password])}}
+
|{{Code|RESTXQPATH [path]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><password>([password])</password></code><br/>
+
|''empty''
|-
 
| '''Permission'''
 
|''NONE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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.
+
|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
|-
 
| '''Errors'''
 
|The command fails if the password is no valid MD5 hash value.
 
 
|}
 
|}
  
=General Commands=
+
===PARSERESTXQ===
  
==RUN==
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|RUN [file]}}
+
|{{Code|PARSERESTXQ}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><run file='...'/></code>
+
|{{Code|3}}
|-
 
| '''Permission'''
 
|''depends on input''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''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.
+
|Timeout after which the RESTXQ directory will be parsed for changes:
|-
+
* If {{Code|0}} is specified, the directory will be parsed every time a RESTXQ function is called.
| '''Errors'''
+
* A positive value defines the idle time in seconds after which parsing will be enforced. The default value is {{Code|3}}: Changes in the RESTXQ directory will be detected after 3 seconds without RESTXQ function calls.
|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.
+
* Monitoring is completely disabled if a negative value is specified.
|-
+
 
| '''Examples'''
+
See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details.
|
 
* <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==
+
===RESTXQERRORS===
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|EXECUTE [input]}}
+
|{{Code|RESTXQERRORS}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><execute>[input]</execute></code>
+
|{{Code|true}}
|-
 
| '''Permission'''
 
|''depends on input''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Evaluates the specified {{Code|[input]}} as [[#Basics|command script]]. This command can be used to run several commands in a single transaction.
+
|Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.
|-
 
| '''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==
+
===RESTPATH===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|GET [option]}}
+
|{{Code|RESTPATH [path]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><get option='...'/></code><br/>
+
|''empty''
|-
 
| '''Permission'''
 
|''NONE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns the current value of the [[Options|Option]] specified via {{Code|[option]}}. Global options can only be requested by users with ADMIN permissions.
+
|Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
|-
 
| '''Errors'''
 
|The command fails if the specified option is unknown.
 
 
|}
 
|}
  
==SET==
+
===HTTPLOCAL===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|INFO}}
+
|{{Code|HTTPLOCAL [boolean]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><info/></code><br/>
+
|{{Code|false}}
|-
 
| '''Permission'''
 
|''READ''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Shows global information.
+
|By default, if BaseX is run as [[Web Application]], the database server instance will be started in addition, which can then be addressed by [[Clients]] via the database port (see {{Option|PORT}}).<br/>If the option is set to {{Code|true}}, no database server will be launched.
 
|}
 
|}
  
==HELP==
+
===STOPPORT===
{| 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%'
 
|-
 
|-
|width='100'|'''Syntax'''
+
| width='120' | '''Signature'''
|{{Code|EXIT }}
+
|{{Code|STOPPORT [port]}}
 
|-
 
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
+
| '''Default'''
|<code><exit/></code><br/>
+
|{{Code|8985}}
|-
 
| '''Permission'''
 
|''NONE''
 
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Exits the console mode.
+
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:
 +
* The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}.
 +
* The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].
 +
* This option can also be changed when running the HTTP server on [[Command-Line Options#BaseX Server|command line]] via <code>-s</code>.
 
|}
 
|}
  
=Changelog=
+
=Create Options=
  
;Version 7.5
+
==General==
  
* Added: <code>[[#EXECUTE|EXECUTE]]</code> executes a command script.
+
===MAINMEM===
* 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==
 
  
===HOST===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|HOST [host]}}
+
|{{Code|MAINMEM [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|localhost}}
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Startup Options#BaseX Client|command line]] via <code>-n</code>.
+
|If this option is turned on, new databases will be created in main memory:
 +
* Most queries will be evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down.
 +
* It is not possible to store binary resources in a main-memory database.
 +
* A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new database from the exported file in a second step.
 +
* This option will not be available for [[Database Module#db:create|db:create]], because the database would not be accessible anymore after database creation, i. e., outside the query scope.
 
|}
 
|}
  
===PORT===
+
===ADDCACHE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|PORT [port]}}
+
|{{Code|ADDCACHE [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|1984}}
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Startup Options#BaseX Client|command line]] via <code>-p</code>.
+
|If this option is activated, data structures of documents will first be cached to disk before being added to the final database. This option is helpful when larger documents need to be added, and if the existing heuristics cannot estimate the input size (e.g. when adding directories or sending input streams).
 
|}
 
|}
  
===SERVERPORT===
+
==Parsing==
 +
 
 +
===CREATEFILTER===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|SERVERPORT [port]}}
+
|{{Code|CREATEFILTER [filter]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|1984}}
+
|{{Code|*.xml}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This is the port the database server will be listening to. This option can also be changed when running the server on [[Startup Options#BaseX Server|command line]] via <code>-p</code>.
+
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
 
|}
 
|}
  
===EVENTPORT===
+
===ADDARCHIVES===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|EVENTPORT [port]}}
+
|{{Code|ADDARCHIVES [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|1985}}
+
|{{Code|true}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This port is used by the client to listen for [[Events|server events]]. It will only be bound if a client attaches itself to a database event. This option can also be changed when running the server on [[Startup Options#BaseX Server|command line]] via <code>-e</code>.
+
|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc.) are parsed whenever new databases are created or resources are added to a database.
 
|}
 
|}
  
===USER===
+
===ARCHIVENAME===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|USER [name]}}
+
|{{Code|ARCHIVENAME [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|''empty''
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Represents a user name, which is used for accessing the server or an HTTP service:
+
|If this option is set to {{Code|true}}, the file name of parsed archives will be included in the document paths.
* 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 [[Startup Options#BaseX Client|command line]] via <code>-U</code>.
 
 
|}
 
|}
  
===PASSWORD===
+
===SKIPCORRUPT===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|PASSWORD [password]}}
+
|{{Code|SKIPCORRUPT [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|''empty''
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Represents a password, which is used for accessing the server or an HTTP service:
+
|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.
* 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 [[Startup Options#BaseX Client|command line]] via <code>-P</code>.
 
* Please note that it is a security risk to specify your password in plain text.
 
 
|}
 
|}
  
===SERVERHOST===
+
===ADDRAW===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|SERVERHOST [host&#x7c;ip]}}
+
|{{Code|ADDRAW [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|''empty''
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This is the host name or ip address the server is bound to. If the option is set to an empty string (which is the default), the server will be open to all clients.
+
|If this option is enabled, all resources that are filtered out by the {{Option|CREATEFILTER}} option while being added to a database will be stored as [[Binary Data|raw files]] instead (i.e., in their binary representation).
 
|}
 
|}
  
===PROXYHOST===
+
===PARSER===
{| width='100%' width='100%'
 
|-
 
| width='90' | '''Signature'''
 
|{{Code|PROXYHOST [host]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|This is the host name of a proxy server.
 
|}
 
  
===PROXYPORT===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|PROXYPORT [port]}}
+
|{{Code|PARSER [type]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|80}}
+
|{{Code|XML}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This is the port number of a proxy server.
+
|Defines a [[Parsers|parser]] for importing new files to the database. Available parsers are {{Code|XML}}, {{Code|JSON}}, {{Code|CSV}}, {{Code|TEXT}}, {{Code|HTML}}, and {{Code|RAW}}. HTML input will be parsed as XML documents if [[Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.
 
|}
 
|}
  
===NONPROXYHOSTS===
+
===CSVPARSER===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|NONPROXYHOSTS [hosts]}}
+
|{{Code|CSVPARSER [options]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,299: Line 699:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This is a list of hosts that should be directly accessed.
+
|Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]].
 +
|-
 +
| '''Examples'''
 +
|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.
 
|}
 
|}
  
===TIMEOUT===
+
===JSONPARSER===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|TIMEOUT [seconds]}}
+
|{{Code|JSONPARSER [options]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|30}}
+
|''empty''
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted. Write operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to {{Code|0}}. It is ignored for {{Code|ADMIN}} operations.
+
|Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]].
 +
|-
 +
| '''Examples'''
 +
|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.
 
|}
 
|}
  
===KEEPALIVE===
+
===HTMLPARSER===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|KEEPALIVE [seconds]}}
+
|{{Code|HTMLPARSER [options]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|600}}
+
|''empty''
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.
+
|Specifies the way how HTML data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are described in the [[Parsers#Options|Parsers]] article.
 +
|-
 +
| '''Examples'''
 +
|
 +
* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.
 +
* <code>lexical=true</code> preserves comments.
 
|}
 
|}
  
===PARALLEL===
+
===TEXTPARSER===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|PARALLEL [number]}}
+
|{{Code|TEXTPARSER [options]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|8}}
+
|''empty''
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Denotes the maximum allowed {{Code|number}} of parallel read [[Transaction Management|transactions]].
+
|Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are listed in the [[Parsers]] article.
 +
|-
 +
| '''Examples'''
 +
|<code>lines=true</code> creates a single element for each line of text.
 
|}
 
|}
  
===LOG===
+
==XML Parsing==
 +
 
 +
===CHOP===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|LOG [boolean]}}
+
|{{Code|CHOP [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,351: Line 771:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Startup Options#BaseX Server|command line]] via <code>-z</code>.
+
|Many XML documents include whitespaces that have been added to improve readability. This option controls the [https://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:
 +
* With the default value {{Code|true}}, leading and trailing whitespaces from text nodes will be chopped and all empty text nodes will be discarded.
 +
* The flag should be turned off if a document contains [[Full-Text#Mixed Content|mixed content]].
 +
* The flag can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>.
 +
* If the <code>xml:space="preserve"</code> attribute is attached to an element, chopping will be turned off for all descendant text nodes.
 +
 
 +
In the following example document, the whitespaces in the text nodes of the {{Code|text}} element will not be chopped:
 +
<syntaxhighlight lang="xml">
 +
<xml>
 +
  <title>
 +
    Demonstrating the CHOP flag
 +
  </title>
 +
  <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text>
 +
</xml>
 +
</syntaxhighlight>
 +
It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option; otherwise the serialized documents will automatically be indented.
 
|}
 
|}
  
===LOGMSGMAXLEN===
+
===STRIPNS===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|LOGMSGMAXLEN [length]}}
+
|{{Code|STRIPNS [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|1000}}
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Specifies the maximum length of a single [[Logging|log message]].
+
|Strips all namespaces from an XML document and all elements while parsing.
 
|}
 
|}
  
==HTTP Options==
+
===INTPARSE===
  
If BaseX is run as [[Web Application]], the HTTP options are either determined by the web server, or specified in the <code>[https://github.com/BaseXdb/basex-api/tree/master/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory and the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files.
 
 
===WEBPATH===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|WEBPATH [path]}}
+
|{{Code|INTPARSE [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code> or <code>[[Configuration#Database Directory|{home}/webapp]]</code>
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files.
+
|Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the internal parser:
 +
* Performance: Documents (in particular small ones) will be parsed faster
 +
* Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;)
 +
* Entities: around 250 HTML entities will be detected and decoded
 +
You will be able to correctly parse most XML documents with the internal parser. Java’s Xerces parser is still used as default, however, because it supports all features of the XML standard and advanced DTD features, such as recursive entity expansion.
 
|}
 
|}
  
===RESTXQPATH===
+
===DTD===
{| width='100%'
 
|-
 
| width='90' | '''Signature'''
 
|{{Code|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|WEBPATH]] directory.
 
|}
 
  
===HTTPLOCAL===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|HTTPLOCAL [boolean]}}
+
|{{Code|DTD [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,407: Line 832:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|By default, a database server instance will be opened along with the web server. If the flag is set to {{Code|true}}, all commands will be executed in an embedded database context.<br/>If BaseX is run as [[Web Application]], and if the flag is {{Code|false}}, the server will be started as soon as the first HTTP service is called.
+
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The {{Option|CATFILE}} option can be changed to locally resolve DTDs.
 
|}
 
|}
  
===STOPPORT===
+
===XINCLUDE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|STOPPORT [port]}}
+
|{{Code|XINCLUDE [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|8985}}
+
|{{Code|true}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:
+
|Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is switched to {{Code|true}}. This option is only available if the standard Java XML Parser is used (see {{Option|INTPARSE}}).
* The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}.
 
* The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].
 
* This option can also be changed when running the HTTP server on [[Startup Options#BaseX Server|command line]] via <code>-s</code>.
 
 
|}
 
|}
  
=Create Options=
+
===CATFILE===
 
 
==General==
 
  
===MAINMEM===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|MAINMEM [boolean]}}
+
|{{Code|CATFILE [path]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|''empty''
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|If this option is turned on, new databases will be exclusively created in main memory. Most queries will be evaluated faster in main memory mode, but all data is lost if BaseX is shut down. The value of this option will be assigned once to a new database, and cannot be changed after that.
+
|Semicolon-separated list of XML catalog files to resolve URIs. See [[Catalog Resolver]]s for more details.
 
|}
 
|}
  
===ADDCACHE===
+
==Indexing==
 +
 
 +
The following options control the creation of index structures. The current values will be considered if a new database is created. See [[Indexes]] for more details.
  
{{Mark|Introduced with Version 7.7:}}
+
===TEXTINDEX===
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|ADDCACHE [boolean]}}
+
|{{Code|TEXTINDEX [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|{{Code|true}}
 
|-
 
|-
 
| '''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).
+
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes. See [[Index#Text Index|Text Index]] for more details.
 
|}
 
|}
  
==Parsing==
+
===ATTRINDEX===
  
===CREATEFILTER===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|CREATEFILTER [filter]}}
+
|{{Code|ATTRINDEX [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|*.xml}}
+
|{{Code|true}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
+
|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[Index#Attribute Index|Attribute Index]] for more details.
 
|}
 
|}
  
===ADDARCHIVES===
+
===TOKENINDEX===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|ADDARCHIVES [boolean]}}
+
|{{Code|TOKENINDEX [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,484: Line 906:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a database.
+
|Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See [[Index#Token Index|Token Index]] for more details.
 
|}
 
|}
  
===SKIPCORRUPT===
+
===FTINDEX===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|SKIPCORRUPT [boolean]}}
+
|{{Code|FTINDEX [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,497: Line 920:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files will be parsed twice. Next, main memory consumption will be higher as parsed files will be cached in main memory.
+
|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions. See [[Index#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
|}
  
===ADDRAW===
+
===TEXTINCLUDE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|ADDRAW [boolean]}}
+
|{{Code|TEXTINCLUDE [names]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|''empty''
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|If this option is activated, and if new resources are added to a database, all files that are not filtered by the [[#CREATEFILTER|CREATEFILTER]] option will be added as ''raw'' files (i.e., in their binary representation).
+
|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
 
|}
 
|}
  
===PARSER===
+
===ATTRINCLUDE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|PARSER [type]}}
+
|{{Code|ATTRINCLUDE [names]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|XML}}
+
|''empty''
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is not found in the classpath.
+
|Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
 
|}
 
|}
  
===PARSEROPT===
+
===TOKENINCLUDE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|PARSEROPT [options]}}
+
|{{Code|TOKENINCLUDE [names]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,536: Line 962:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Defines parser-specific options; see [[Parsers]] for more information.
+
|Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
 
|}
 
|}
  
===HTMLOPT===
+
===FTINCLUDE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|HTMLOPT [options]}}
+
|{{Code|FTINCLUDE [names]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,549: Line 976:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Allows to specify TagSoup options for HTML parsing; see [[Parsers#HTML Parser|HTML Parser]] for more information.
+
|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
 
|}
 
|}
  
==XML Parsing==
+
===MAXLEN===
  
===CHOP===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|CHOP [boolean]}}
+
|{{Code|MAXLEN [int]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|true}}
+
|{{Code|96}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. By default, this option is set to {{Code|true}}, as it often reduces the database size by up to 50%. It can also be turned off on [[Startup Options#BaseX Standalone|command line]] via <code>-w</code>.  
+
|Specifies the maximum length for strings to be stored in [[Indexes|index structures]]. The value of this option will be assigned once to a new database, and can only be changed by creating a new database or doing a [[Commands#OPTIMIZE|full optimization]].
 
|}
 
|}
  
===INTPARSE===
+
===MAXCATS===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|INTPARSE [boolean]}}
+
|{{Code|MAXCATS [int]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|true}}
+
|{{Code|100}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Uses the internal XML parser instead of the standard Java XML parser. The internal parser is faster, more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for parsing DTDs.
+
|Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that.
 
|}
 
|}
  
===DTD===
+
===UPDINDEX===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|DTD [boolean]}}
+
|{{Code|UPDINDEX [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,590: Line 1,018:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The [[#CATFILE|CATFILE]] option can be changed to locally resolve DTDs.
+
|If turned on, incremental indexing will be enabled:
 +
* The current value of this option will be assigned to new databases. It can be changed for existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or [[Database_Module#db:optimize|db:optimize($db, true())]].
 +
* After each update, the value indexes will be refreshed as well. Incremental updates are currently not available for the full-text index and database statistics.
 +
* Find more details in the article on [[Index#Updates|Index Structures]].
 
|}
 
|}
  
===CATFILE===
+
===AUTOOPTIMIZE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|CATFILE [path]}}
+
|{{Code|AUTOOPTIMIZE [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|''empty''
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Specifies a catalog file to locally resolve DTDs; see the entry on [[Catalog Resolver]]s for more details.
+
|If turned on, auto optimization will be applied to new databases:
 +
* With each update, outdated indexes and database statistics will be recreated.
 +
* As a result, the index structures will always be up-to-date.
 +
* However, updates can take much longer, so this option should only be activated for medium-sized databases.
 +
* The value of this option will be assigned once to a new database. It can be reassigned by running {{Command|OPTIMIZE}} or [[Database_Module#db:optimize|db:optimize]].
 
|}
 
|}
  
==Indexing==
+
===SPLITSIZE===
 
 
The current index and full-text index options will be stored in a new database, and take effect if indexes are rebuilt via the [[Commands#OPTIMIZE|OPTIMIZE]].
 
  
===TEXTINDEX===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|TEXTINDEX [boolean]}}
+
|{{Code|SPLITSIZE [num]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|true}}
+
|{{Code|0}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see [[Indexes]] for more details.
+
|This option affects the [[Indexes#Performance|construction]] of new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk:
 +
* By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption. Usually, this works fine.
 +
* If explicit garbage collection is disabled when running Java (e.g. via the JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to choose a custom split size.
 +
* You can e. g. start with {{Code|1000000}} (one million) index operations and adjust this value in the next steps.
 +
* The larger the assigned value is, the less splits will take place, and the more main memory will be required.
 
|}
 
|}
  
===ATTRINDEX===
+
==Full-Text Indexing==
 +
 
 +
===STEMMING===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|ATTRINDEX [boolean]}}
+
|{{Code|STEMMING [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|true}}
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values; see [[Indexes]] for more details.
+
|If {{Code|true}}, all tokens will be stemmed during full-text indexing, using a language-specific stemmer implementation. By default, tokens will not be stemmed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
|}
  
===FTINDEX===
+
===CASESENS===
 +
 
 
{| width='100%'
 
{| width='100%'
|-
+
 
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|FTINDEX [boolean]}}
+
|{{Code|CASESENS [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,646: Line 1,087:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions; see [[Indexes]] for more details.
+
|If {{Code|true}}, the case of tokens will be preserved during full-text indexing. By default, case will be ignored (all tokens will be indexed in lower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
|}
  
===MAXLEN===
+
===DIACRITICS===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|MAXLEN [int]}}
+
|{{Code|DIACRITICS [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|96}}
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Specifies the maximum length of strings that are to be indexed by the name, path, value, and full-text index structures. The value of this option will be assigned once to a new database, and cannot be changed after that.
+
|If set to {{Code|true}}, diacritics will be preserved during full-text indexing. By default, diacritics will be removed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
|}
  
===MAXCATS===
+
===LANGUAGE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|MAXCATS [int]}}
+
|{{Code|LANGUAGE [lang]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|100}}
+
|{{Code|en}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that.
+
|The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
|}
  
===UPDINDEX===
+
===STOPWORDS===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|UPDINDEX [boolean]}}
+
|{{Code|STOPWORDS [path]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|''empty''
 
|-
 
|-
 
| '''Summary'''
 
| '''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#Updates|Index Structures]] includes additional details.
+
|If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index is created. A stopword list may decrease the size of the full text index and speed up your queries. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
|}
  
===INDEXSPLITSIZE===
+
=Query Options=
  
{{Mark|Introduced with Version 7.7:}}
+
===QUERYINFO===
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|INDEXSPLITSIZE [num]}}
+
|{{Code|QUERYINFO [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|0}}
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This option affects the [[Indexes#Index Construction|construction]] of new text and attribute indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied.
+
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.  
 
|}
 
|}
  
===FTINDEXSPLITSIZE===
+
===MIXUPDATES===
 
 
{{Mark|Introduced with Version 7.7:}}
 
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|FTINDEXSPLITSIZE [num]}}
+
|{{Code|MIXUPDATES}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|0}}
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This option affects the [[Indexes#Index Construction|construction]] of new full-text indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied.
+
|Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for more details.
 
|}
 
|}
  
==Full-Text==
+
===BINDINGS===
  
===STEMMING===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|STEMMING [boolean]}}
+
|{{Code|BINDINGS [vars]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|''empty''
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|A new full-text index will stem all tokens and speed up queries on stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this index.
+
|Contains external variables to be bound to a query. The string must comply with the following rules:
 +
* Variable names and values must be separated by equality signs.
 +
* Multiple variables must be delimited by commas.
 +
* Commas in values must be duplicated.
 +
* Variables may optionally be introduced with a leading dollar sign.
 +
* If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [https://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].
 +
This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>.
 +
|-
 +
| '''Examples'''
 +
|
 +
* <code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b
 +
* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a
 +
* <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.
 +
* In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable {{Code|$GREETING}}:
 +
<syntaxhighlight lang="xquery">
 +
SET BINDINGS GREETING="hello world!"
 +
XQUERY declare variable $GREETING external; $GREETING
 +
</syntaxhighlight>
 
|}
 
|}
  
===CASESENS===
+
===INLINELIMIT===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|CASESENS [boolean]}}
+
|{{Code|INLINELIMIT}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|{{Code|50}}
 
|-
 
|-
 
| '''Summary'''
 
| '''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.
+
|This option controls inlining of XQuery functions:
 +
* The XQuery compiler inlines functions to speed up query evaluation.
 +
* Inlining will only take place if a function body is not too large (i.e., if it does not contain too many expressions).
 +
* With this option, this maximum number of expressions can be specified.
 +
* Function inlining can be turned off by setting the value to {{Code|0}}.
 +
* The limit can be locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (follow the link to get more information on function inlining).
 
|}
 
|}
  
===DIACRITICS===
+
===UNROLLLIMIT===
 +
 
 +
{{Mark|Introduced with Version 9.6:}}
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|DIACRITICS [boolean]}}
+
|{{Code|UNROLLLIMIT}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|{{Code|5}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|A new full-text index will preserve the diacritics of all tokens. The same diacritics normalization will be applied to all query tokens that are checked against tokens in this index.
+
|This option controls the unroll limit:
 +
* Loops with few iterations are ''unrolled'' by the XQuery compiler to enable further optimizations.
 +
* If the limit is increased, more optimizations will take place, but the memory consumption and compile time will increase.
 +
* See [[XQuery Optimizations#Loop Unrolling|Loop Unrolling]] for more details.
 
|}
 
|}
  
===LANGUAGE===
+
===ENFORCEINDEX===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|LANGUAGE [lang]}}
+
|{{Code|ENFORCEINDEX [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|en}}
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''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.
+
|Enforces index rewritings in path expressions. See [[Indexes#Enforce Rewritings|Enforce Rewritings]] for details.
 
|}
 
|}
  
===STOPWORDS===
+
===COPYNODE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|STOPWORDS [path]}}
+
|{{Code|COPYNODE [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|''empty''
+
|{{Code|true}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. A standard stopword list for English texts is provided in the directory {{Code|etc/stopwords.txt}} in the official releases.
+
|When creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], all enclosed nodes will be copied, and all resulting nodes will get new node identities. This step can be very expensive, and it can be disabled with this option. The option should be used carefully, as it changes the standard behavior of XQuery. It should preferrably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].
 
|}
 
|}
  
=Query Options=
+
===TAILCALLS===
  
===QUERYINFO===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|QUERYINFO [boolean]}}
+
|{{Code|TAILCALLS}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|{{Code|256}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Startup Options#BaseX Standalone|command line]] via <code>-V</code>.  
+
|Specifies how many stack frames of [https://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1}}.
 
|}
 
|}
  
===XQUERY3===
+
===WITHDB===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|XQUERY3}}
+
|{{Code|WITHDB}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 1,812: Line 1,284:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Enables all [[XQuery 3.0]] features supported by BaseX. If this option is set to {{Code|false}}, the XQuery parser will only accept expressions of the XQuery 1.0 specification.
+
|By default, resources specified via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] are looked up both in the database and in the file system. If you always use {{Function|Database|db:open}} to access databases, it is recommendable to disable this option:
 +
* No locks will be created for the two functions (see [[Transaction Management#Limitations|limitations of database locking]] for more details).
 +
* Access to local and external resources will be faster, as the database lookup will be skipped.
 
|}
 
|}
  
===BINDINGS===
+
===DEFAULTDB===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|BINDINGS [vars]}}
+
|{{Code|DEFAULTDB}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|''empty''
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Contains external variables to be bound to a query:
+
|If this option is turned on, paths specified in the [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the {{Command|OPEN}} command). If the path does not match any existing resources, it will be resolved as described in the article on [[Databases#Access Resources|accessing database resources]].
* 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 [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [http://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].
 
* This option can also be used on [[Startup Options#BaseX Standalone|command line]] with the flag <code>-b</code>.
 
|-
 
| '''Examples'''
 
|<code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b<br/><code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a<br/><code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.
 
 
|}
 
|}
  
===QUERYPATH===
+
===FORCECREATE===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|QUERYPATH [path]}}
+
|{{Code|FORCECREATE [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|''empty''
+
|{{Code|false}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Contains the path (''base URI'') to the executed query (default: ''empty''). This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a query.
+
|By activating this option, database instances will be created with the XQuery functions [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]].
 
|}
 
|}
  
===CACHEQUERY===
+
===CHECKSTRINGS===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|CACHEQUERY [boolean]}}
+
|{{Code|CHECKSTRINGS [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|{{Code|true}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Caches the query results before returning them to the client. This option may be set to {{Code|true}} if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX).
+
|By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;). The option affects [[Java Bindings]] and string conversion and input functions such as [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], [[Archive Module#archive:update|archive:update]], and [[ZIP Module#zip:text-entry|zip:text-entry]].
 
|}
 
|}
  
===FORCECREATE===
+
===WRAPJAVA===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|FORCECREATE [boolean]}}
+
|{{Code|WRAPJAVA [mode]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|false}}
+
|{{Code|some}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|By activating this option, the XQuery {{Code|doc()}} and {{Code|collection()}} functions will create database instances for the addressed input files.
+
|Defines the way how values that result from Java code invocation will be converted to XQuery items. Allowed values: {{Code|none}}, {{Code|all}}, {{Code|some}}, {{Code|instance}}, and {{Code|void}}. See [[Java_Bindings#Conversion to XQuery|Java Bindings]] for further details.
 
|}
 
|}
  
===CHECKSTRINGS===
+
===LSERROR===
  
{{Mark|Introduced with Version 7.7:}}
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|CHECKSTRINGS [boolean]}}
+
|{{Code|LSERROR [error]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|true}}
+
|{{Code|0}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|If this option is turned off, strings from external sources will be adopted as is, i. e., without being checked for valid XML characters:
+
|This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if {{Code|0}} is assigned, the error value is calculated dynamically. See [[Full-Text#Fuzzy_Querying|Fuzzy Querying]] for more details.
* 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.
 
 
|}
 
|}
  
===LSERROR===
+
===RUNQUERY===
 +
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|LSERROR [error]}}
+
|{{Code|RUNQUERY [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
|{{Code|0}}
+
|{{Code|true}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option.  See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information on fuzzy querying.
+
|Specifies if a query will be executed or parsed only. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>.
 
|}
 
|}
  
 
===RUNS===
 
===RUNS===
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
 
|{{Code|RUNS [num]}}
 
|{{Code|RUNS [num]}}
 
|-
 
|-
Line 1,915: Line 1,384:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Specify number of runs a query is executed by the [[Commands#XQUERY|XQUERY]] command. The result is only serialized once, and the measured times are averages of all runs.
+
|Specifies how often a query will be evaluated. The result is serialized only once, and the measured times are averages of all runs. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-r</code>.
 
|}
 
|}
  
Line 1,921: Line 1,390:
  
 
===SERIALIZE===
 
===SERIALIZE===
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
 
|{{Code|SERIALIZE [boolean]}}
 
|{{Code|SERIALIZE [boolean]}}
 
|-
 
|-
Line 1,930: Line 1,400:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Startup Options#BaseX Standalone|command line]] via <code>-z</code>.  
+
|Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.  
 
|}
 
|}
  
 
===SERIALIZER===
 
===SERIALIZER===
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
 
|{{Code|SERIALIZER [params]}}
 
|{{Code|SERIALIZER [params]}}
 
|-
 
|-
Line 1,943: Line 1,414:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Contains parameters for [[Serialization|serializing]] query results:
+
|Parameters for [[Serialization|serializing]] query results. The string must comply with the following rules:
* Keys and values are separated by equality signs.
+
* Variable names and values must be separated by equality signs.
* Multiple parameters are delimited by commas.
+
* Multiple variables must be delimited by commas.
* The option can also be used on [[Startup Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
+
* Commas in values must be duplicated.
 +
The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
 
|-
 
|-
| '''Example'''
+
| '''Examples'''
|<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.
+
|
 +
* <code>indent=no</code> : disables automatic indentation of XML nodes. This is usually a good choice when working with [[Full-Text#Mixed Content|Mixed-Content Data]].
 +
* <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.
 +
* <code>item-separator=,,</code> : separates serialized items by a single comma.
 
|}
 
|}
  
 
===EXPORTER===
 
===EXPORTER===
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
 
|{{Code|EXPORTER [params]}}
 
|{{Code|EXPORTER [params]}}
 
|-
 
|-
Line 1,962: Line 1,438:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Contains parameters for exporting all resources of a database; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas.
+
|Contains parameters for exporting resources of a database and writing files after updates via the {{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[Serialization]] for more details.
 +
|-
 +
| '''Examples'''
 +
|
 +
* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
 
|}
 
|}
  
 
===XMLPLAN===
 
===XMLPLAN===
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
 
|{{Code|XMLPLAN [boolean]}}
 
|{{Code|XMLPLAN [boolean]}}
 
|-
 
|-
Line 1,975: Line 1,456:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Startup Options#BaseX Standalone|command line]] via <code>-x</code>.  
+
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.  
 
|}
 
|}
  
 
===COMPPLAN===
 
===COMPPLAN===
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
 
|{{Code|COMPPLAN [boolean]}}
 
|{{Code|COMPPLAN [boolean]}}
 
|-
 
|-
Line 1,988: Line 1,470:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Creates the query plan before or after the compilation step. Query plans might change due to optimizations.
+
|Generates the query plan, which can be activated via {{Option|XMLPLAN}}, before or after query compilation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>.  
 
|}
 
|}
  
===DOTPLAN===
+
===FULLPLAN===
{| width='100%'
 
|-
 
| width='90' | '''Signature'''
 
|{{Code|DOTPLAN [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file in the query directory.
 
|}
 
  
===DOTCOMPACT===
 
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|{{Code|DOTCOMPACT [boolean]}}
+
|{{Code|FULLPLAN [boolean]}}
 
|-
 
|-
 
| '''Default'''
 
| '''Default'''
Line 2,014: Line 1,484:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Chooses a compact dot representation.
+
|Attaches the file path, line and column of the expressions in the original query string to the query plan. Values (items and sequences) have no input information attached.
|}
 
 
 
===DOTDISPLAY===
 
{| width='100%'
 
|-
 
| width='90' | '''Signature'''
 
|{{Code|DOTDISPLAY [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Visualizes the dot representation after the query execution.
 
|}
 
 
 
===DOTTY===
 
{| width='100%'
 
|-
 
| width='90' | '''Signature'''
 
|{{Code|DOTTY [path]}}
 
|-
 
| '''Default'''
 
|{{Code|dotty}}
 
|-
 
| '''Summary'''
 
|Location of the {{Code|dotty}} executable.
 
 
|}
 
|}
  
Line 2,046: Line 1,490:
  
 
===AUTOFLUSH===
 
===AUTOFLUSH===
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
 
|{{Code|AUTOFLUSH [boolean]}}
 
|{{Code|AUTOFLUSH [boolean]}}
 
|-
 
|-
Line 2,055: Line 1,500:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the [[Commands#FLUSH|FLUSH]] command.
+
|Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the {{Command|FLUSH}} command.
 
|}
 
|}
  
 
===WRITEBACK===
 
===WRITEBACK===
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
 
|{{Code|WRITEBACK [boolean]}}
 
|{{Code|WRITEBACK [boolean]}}
 
|-
 
|-
Line 2,068: Line 1,514:
 
|-
 
|-
 
| '''Summary'''
 
| '''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 [[Startup Options#BaseX Standalone|command line]] via <code>-u</code>.
+
|Propagates updates on main-memory instances of files that have been retrieved via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] back to disk:
 +
* This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>.
 +
* Please take in mind that no backup will be created from your original files.
 +
* The serialization options can be controlled via the {{Option|EXPORTER}} option.
 
|}
 
|}
  
 
===MAXSTAT===
 
===MAXSTAT===
 +
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
| width='90' | '''Signature'''
+
| width='120' | '''Signature'''
 
|{{Code|MAXSTAT [num]}}
 
|{{Code|MAXSTAT [num]}}
 
|-
 
|-
Line 2,081: Line 1,531:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO|INFO INDEX]]</code> command.
+
|Specifies the maximum number of index occurrences printed by the {{Command|INFO INDEX}} command.
 
|}
 
|}
  
 
=Changelog=
 
=Changelog=
 +
 +
;Version 9.6
 +
* Added: {{Option|UNROLLLIMIT}}, {{Option|WRAPJAVA}}
 +
 +
;Version 9.5
 +
* Updated: {{Option|INLINELIMIT}}: default reduced to 50.
 +
* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response
 +
 +
;Version 9.4
 +
* Added: {{Option|LOGTRACE}}
 +
 +
;Version 9.3
 +
* Added: {{Option|WITHDB}}, {{Option|GZIP}}
 +
 +
;Version 9.2
 +
* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}
 +
* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
 +
 +
;Version 9.0
 +
* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
 +
 +
;Version 8.6
 +
* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}
 +
* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)
 +
* Removed: {{Code|QUERYPATH}} (will now be internally assigned)
 +
* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ)
 +
 +
;Version 8.5
 +
* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}
 +
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added.
 +
 +
;Version 8.4
 +
* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}
 +
* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)
 +
* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code>
 +
 +
;Version 8.3
 +
* Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}}
 +
 +
;Version 8.2
 +
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
 +
 +
;Version 8.1
 +
* Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}}
 +
 +
;Version 8.0
 +
* Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}}
 +
* Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored.
 +
 +
;Version 7.8.1
 +
* Updated: {{Option|ADDARCHIVES}}: parsing of TAR and TGZ files.
 +
 +
;Version 7.8
 +
 +
* Added: {{Option|CSVPARSER}}, {{Option|JSONPARSER}}, {{Option|TEXTPARSER}}, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}}
 +
* Updated: {{Option|WRITEBACK}} only applies to main-memory document instances.
 +
* Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions.
 +
* Updated: default of {{Option|INTPARSE}} is now {{Code|false}}.
 +
* Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
  
 
;Version 7.7
 
;Version 7.7
 
+
* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}}
* Added: <code>[[#ADDCACHE|ADDCACHE]]</code>, <code>[[#FTINDEXSPLITSIZE|FTINDEXSPLITSIZE]]</code>, <code>[[#INDEXSPLITSIZE|INDEXSPLITSIZE]]</code>, <code>[[#CHECKSTRINGS|CHECKSTRINGS]]</code>
 
  
 
;Version 7.6
 
;Version 7.6
 
+
* Added: {{Option|GLOBALLOCK}}
* Added: <code>[[#GLOBALLOCK|GLOBALLOCK]]</code>
 
 
* Added: store local options in configuration file after {{Code|# Local Options}} comments.
 
* Added: store local options in configuration file after {{Code|# Local Options}} comments.
  
 
;Version 7.5
 
;Version 7.5
 
 
* Added: options can now be set via system properties
 
* Added: options can now be set via system properties
 
* Added: a pragma expression can be used to locally change database options
 
* Added: a pragma expression can be used to locally change database options
* Added: <code>[[#USER|USER]]</code>, <code>[[#PASSWORD|PASSWORD]]</code>, <code>[[#LOG|LOG]]</code>, <code>[[#LOGMSGMAXLEN|LOGMSGMAXLEN]]</code>, <code>[[#WEBPATH|WEBPATH]]</code>, <code>[[#RESTXQPATH|RESTXQPATH]]</code><code>[[#HTTPLOCAL|HTTPLOCAL]]</code>, <code>[[#CREATEONLY|CREATEONLY]]</code>, <code>[[#STRIPNS|STRIPNS]]</code>
+
* Added: {{Option|USER}}, {{Option|PASSWORD}}, {{Option|LOG}}, {{Option|LOGMSGMAXLEN}}, {{Option|WEBPATH}}, {{Option|RESTXQPATH}}{{Option|HTTPLOCAL}}, {{Option|CREATEONLY}}, {{Option|STRIPNS}}
 
* Removed: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: {{Code|jetty.xml}} configuration file is used instead
 
* Removed: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: {{Code|jetty.xml}} configuration file is used instead
 
* Removed: global options cannot be changed anymore during the lifetime of a BaseX instance
 
* Removed: global options cannot be changed anymore during the lifetime of a BaseX instance
  
 
;Version 7.3
 
;Version 7.3
 
+
* Updated: {{Option|KEEPALIVE}}, {{Option|TIMEOUT}}: default values changed
* Updated: <code>[[#KEEPALIVE|KEEPALIVE]]</code>, <code>[[#TIMEOUT|TIMEOUT]]</code>: default values changed
 
 
* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries
 
* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries
 
* Removed: {{Code|SCORING}}; new scoring model will focus on lengths of text nodes and match options
 
* Removed: {{Code|SCORING}}; new scoring model will focus on lengths of text nodes and match options
  
 
;Version 7.2
 
;Version 7.2
 
+
* Added: {{Option|PROXYHOST}}, {{Option|PROXYPORT}}, {{Option|NONPROXYHOSTS}}, {{Option|HTMLOPT}}
* Added: <code>[[#PROXYHOST|PROXYHOST]]</code>, <code>[[#PROXYPORT|PROXYPORT]]</code>, <code>[[#NONPROXYHOSTS|NONPROXYHOSTS]]</code>, <code>[[#HTMLOPT|HTMLOPT]]</code>
+
* Updated: {{Option|TIMEOUT}}: ignore timeout for admin users
* Updated: <code>[[#TIMEOUT|TIMEOUT]]</code>: ignore timeout for admin users
 
  
 
;Version 7.1
 
;Version 7.1
 
+
* Added: {{Option|ADDRAW}}, {{Option|MAXLEN}}, {{Option|MAXCATS}}, {{Option|UPDINDEX}}
* Added: <code>[[#ADDRAW|ADDRAW]]</code>, <code>[[#MAXLEN|MAXLEN]]</code>, <code>[[#MAXCATS|MAXCATS]]</code>, <code>[[#UPDINDEX|UPDINDEX]]</code>
+
* Updated: {{Option|BINDINGS}}
* Updated: <code>[[#BINDINGS|BINDINGS]]</code>
 
  
 
;Version 7.0
 
;Version 7.0
 
+
* Added: {{Option|SERVERHOST}}, {{Option|KEEPALIVE}}, {{Option|AUTOFLUSH}}, {{Option|QUERYPATH}}
* Added: <code>[[#SERVERHOST|SERVERHOST]]</code>, <code>[[#KEEPALIVE|KEEPALIVE]]</code>, <code>[[#AUTOFLUSH|AUTOFLUSH]]</code>, <code>[[#QUERYPATH|QUERYPATH]]</code>
 

Latest revision as of 13:47, 19 August 2021

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. Two kinds of options exist:

  • Global Options are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/server architecture.
  • Local options (all remaining ones) are specific to a client or session.

Values of options are either strings, numbers or booleans. Options are static and not bound to a single operation (for example, the next command). Various ways exist to access and change options:

  • The current value of an option can be requested with the GET command. Local options can be changed via SET (all global options, except for DEBUG, can only be changed at startup time). If an option is of type boolean, and if no value is specified, its current value will be inverted.
  • The .basex configuration file is parsed by every new local BaseX instance. It contains all global options. Local options can be specified at the end of the file after the Local Options comment:
# General Options
DEBUG = false
...

# Local Options
CHOP = false
  • Initial values for global 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 need to be prefixed with org.basex.. An example:
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
CHOP: false
  • If using the Mac OS X packaged application then global options can be set within the Info.plist file within the Contents folder of the application package. For example:
<key>JVMOptions</key>
<array>
  <string>-Dorg.basex.CHOP=false</string>
</array>
  • In a Web Application, the default can be adjusted in the web.xml file as follows:
<context-param>
  <param-name>org.basex.chop</param-name>
  <param-value>false</param-value>
</context-param>
  • In XQuery, local options can be set via option declarations and pragmas.

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

Contents

Global Options[edit]

Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception is the DEBUG option, which can also be changed at runtime by users with admin permissions.

General Options[edit]

DEBUG[edit]

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.

DBPATH[edit]

Signature DBPATH [path]
Default {home}/data
Summary Points to the directory in which all databases are located.

LOGPATH[edit]

Signature LOGPATH [path]
Default .logs
Summary Points to the directory in which all log files are stored. Relative paths will be resolved against the DBPATH directory.

REPOPATH[edit]

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

LANG[edit]

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

LANGKEY[edit]

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.

FAIRLOCK[edit]

Signature FAIRLOCK [boolean]
Default false
Summary Defines the locking strategy:
  • By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the limit of parallel transactions (specified via PARALLEL) has been reached. This prevents update operations from blocking all other requests. For example, the DBA can further be used to see which jobs are running, even if the queue is full.
  • If fair locking is enabled, read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it should be used if the prompt evaluation of update operations is critical.

CACHETIMEOUT[edit]

Signature CACHETIMEOUT [seconds]
Default 3600
Summary Specifies how many seconds the results of queries, which have been queued by the asynchronously executed, will be cached in main memory.

Client/Server Architecture[edit]

HOST[edit]

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[edit]

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[edit]

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.

USER[edit]

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[edit]

Signature PASSWORD [password]
Default empty
Summary Represents a password, which is used for accessing the server:
  • 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.

AUTHMETHOD[edit]

Signature AUTHMETHOD [method]
Default Basic
Summary Specifies the default authentication method, which will be used by the HTTP server for negotiating credentials. Allowed values are Basic, Digest, and Custom:
  • If basic access is chosen, the client can still request digest authentication.
  • This is different for digest access, which cannot be overwritten.
  • With custom authentication, the server will not do any authentication.

SERVERHOST[edit]

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[edit]

Signature PROXYHOST [host]
Default empty
Summary This is the host name of a proxy server. If the value is an empty string, it will be ignored.

PROXYPORT[edit]

Signature PROXYPORT [port]
Default 0
Summary This is the port number of a proxy server. If the value is set to 0, it will be ignored.

NONPROXYHOSTS[edit]

Signature NONPROXYHOSTS [hosts]
Default empty
Summary This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored.

IGNOREHOSTNAME[edit]

Signature IGNOREHOSTNAME [boolean]
Default false
Summary If this option is enabled, hostnames of certificates will not be verified. Use IGNORECERT to completely disable certificate verification.

IGNORECERT[edit]

Signature IGNORECERT [boolean]
Default false
Summary This option can be turned on to ignore untrusted certificates when connecting to servers. Use IGNOREHOSTNAME to suppress only the hostname verification.

TIMEOUT[edit]

Signature TIMEOUT [seconds]
Default 30
Summary Specifies the maximum time a transaction triggered by a client may take. If an operation takes longer than the specified number of seconds, it will be aborted. Active update 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 operations with admin permissions.

KEEPALIVE[edit]

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[edit]

Signature PARALLEL [number]
Default 8
Summary Denotes the maximum allowed number of parallel transactions:
  • If FAIRLOCK is enabled, the number of parallel transactions will never exceed the specified value.
  • If the option is disabled (which is the default), the limit only applies to transactions that access databases.
  • The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.

LOG[edit]

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[edit]

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

LOGTRACE[edit]

Signature LOGTRACE [boolean]
Default true
Summary If BaseX is running as Web Application, trace output (generated via fn:trace, prof:dump and similar functions) is written to the database logs. If this option is disabled, trace output will be redirected to standard error, as it is known from the standalone version of BaseX.

HTTP Services[edit]

Most HTTP options are defined in the jetty.xml and web.xml configuration files in the webapp/WEB-INF directory. Some additional BaseX-specific options exist that will be set before the web server is started:

WEBPATH[edit]

Signature WEBPATH [path]
Default {home}/webapp
Summary Points to the directory in which all the Web Application contents are stored, including XQuery, Script, RESTXQ and configuration files:
  • The option is ignored if BaseX is deployed as web servlet.
  • It cannot be assigned via the web.xml file, as it will be evaluated before the configuration files are parsed.

GZIP[edit]

Signature GZIP [boolean]
Default false
Summary Jetty provides a Gzip handler for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the BaseX HTTP Server:
  • The option can also be enabled on command line via -g.
  • It cannot be assigned via the web.xml file, as it will be evaluated before the configuration files are parsed.
  • The same defaults of the web server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).

RESTXQPATH[edit]

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.

PARSERESTXQ[edit]

Signature PARSERESTXQ
Default 3
Summary Timeout after which the RESTXQ directory will be parsed for changes:
  • If 0 is specified, the directory will be parsed every time a RESTXQ function is called.
  • A positive value defines the idle time in seconds after which parsing will be enforced. The default value is 3: Changes in the RESTXQ directory will be detected after 3 seconds without RESTXQ function calls.
  • Monitoring is completely disabled if a negative value is specified.

See RESTXQ Preliminaries for more details.

RESTXQERRORS[edit]

Signature RESTXQERRORS
Default true
Summary Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See RESTXQ Error Handling for more details.

RESTPATH[edit]

Signature RESTPATH [path]
Default empty
Summary Points to the directory which contains XQuery files and command scripts, which can be evaluated via the REST run operation. Relative paths will be resolved against the WEBPATH directory.

HTTPLOCAL[edit]

Signature HTTPLOCAL [boolean]
Default false
Summary By default, if BaseX is run as Web Application, the database server instance will be started in addition, which can then be addressed by Clients via the database port (see PORT).
If the option is set to true, no database server will be launched.

STOPPORT[edit]

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[edit]

General[edit]

MAINMEM[edit]

Signature MAINMEM [boolean]
Default false
Summary If this option is turned on, new databases will be created in main memory:
  • Most queries will be evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down.
  • It is not possible to store binary resources in a main-memory database.
  • A main-memory database will have no disk representation. However, it is possible to export the database via the EXPORT command, and create a new database from the exported file in a second step.
  • This option will not be available for db:create, because the database would not be accessible anymore after database creation, i. e., outside the query scope.

ADDCACHE[edit]

Signature ADDCACHE [boolean]
Default false
Summary If this option is activated, data structures of documents will first be cached to disk before being added to the final database. This option is helpful when larger documents need to be added, and if the existing heuristics cannot estimate the input size (e.g. when adding directories or sending input streams).

Parsing[edit]

CREATEFILTER[edit]

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[edit]

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

ARCHIVENAME[edit]

Signature ARCHIVENAME [boolean]
Default false
Summary If this option is set to true, the file name of parsed archives will be included in the document paths.

SKIPCORRUPT[edit]

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[edit]

Signature ADDRAW [boolean]
Default false
Summary If this option is enabled, all resources that are filtered out by the CREATEFILTER option while being added to a database will be stored as raw files instead (i.e., in their binary representation).

PARSER[edit]

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

CSVPARSER[edit]

Signature CSVPARSER [options]
Default empty
Summary Specifies the way how CSV data will be parsed. Keys and values are delimited with =, and multiple options are delimited with ,. The available options (except for the additional encoding option) are described in the CSV Module.
Examples encoding=CP1252,header=true parses the input as CP1252 and the first line as header.

JSONPARSER[edit]

Signature JSONPARSER [options]
Default empty
Summary Specifies the way how JSON data will be parsed. Keys and values are delimited with =, and multiple options are delimited with ,. The available options (except for the additional encoding option) are described in the JSON Module.
Examples format=jsonml,lax=yes interprets the input as JSONML and uses lax parsing.

HTMLPARSER[edit]

Signature HTMLPARSER [options]
Default empty
Summary Specifies the way how HTML data will be parsed. Keys and values are delimited with =, and multiple options are delimited with ,. The available options are described in the Parsers article.
Examples
  • encoding=Shift-JIS,nons=true parses the input as Sihft-JIS and suppresses namespaces.
  • lexical=true preserves comments.

TEXTPARSER[edit]

Signature TEXTPARSER [options]
Default empty
Summary Specifies the way how TEXT data will be parsed. Keys and values are delimited with =, and multiple options are delimited with ,. The available options are listed in the Parsers article.
Examples lines=true creates a single element for each line of text.

XML Parsing[edit]

CHOP[edit]

Signature CHOP [boolean]
Default true
Summary Many XML documents include whitespaces that have been added to improve readability. This option controls the white-space processing mode of the XML parser:
  • With the default value true, leading and trailing whitespaces from text nodes will be chopped and all empty text nodes will be discarded.
  • The flag should be turned off if a document contains mixed content.
  • The flag can also be turned off on command line via -w.
  • If the xml:space="preserve" attribute is attached to an element, chopping will be turned off for all descendant text nodes.

In the following example document, the whitespaces in the text nodes of the text element will not be chopped:

<xml>
  <title>
    Demonstrating the CHOP flag
  </title>
  <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text>
</xml>

It is recommendable to additionally assign indent=no to the SERIALIZER option; otherwise the serialized documents will automatically be indented.

STRIPNS[edit]

Signature STRIPNS [boolean]
Default false
Summary Strips all namespaces from an XML document and all elements while parsing.

INTPARSE[edit]

Signature INTPARSE [boolean]
Default false
Summary Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the internal parser:
  • Performance: Documents (in particular small ones) will be parsed faster
  • Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character FFFD (�)
  • Entities: around 250 HTML entities will be detected and decoded

You will be able to correctly parse most XML documents with the internal parser. Java’s Xerces parser is still used as default, however, because it supports all features of the XML standard and advanced DTD features, such as recursive entity expansion.

DTD[edit]

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.

XINCLUDE[edit]

Signature XINCLUDE [boolean]
Default true
Summary Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is switched to true. This option is only available if the standard Java XML Parser is used (see INTPARSE).

CATFILE[edit]

Signature CATFILE [path]
Default empty
Summary Semicolon-separated list of XML catalog files to resolve URIs. See Catalog Resolvers for more details.

Indexing[edit]

The following options control the creation of index structures. The current values will be considered if a new database is created. See Indexes for more details.

TEXTINDEX[edit]

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 Text Index for more details.

ATTRINDEX[edit]

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 Attribute Index for more details.

TOKENINDEX[edit]

Signature TOKENINDEX [boolean]
Default true
Summary Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See Token Index for more details.

FTINDEX[edit]

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 Full-Text Index for more details.

TEXTINCLUDE[edit]

Signature TEXTINCLUDE [names]
Default empty
Summary Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.
Name patterns are separated by commas. See Selective Indexing for more details.

ATTRINCLUDE[edit]

Signature ATTRINCLUDE [names]
Default empty
Summary Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.
Name patterns are separated by commas. See Selective Indexing for more details.

TOKENINCLUDE[edit]

Signature TOKENINCLUDE [names]
Default empty
Summary Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes will be indexed.
Name patterns are separated by commas. See Selective Indexing for more details.

FTINCLUDE[edit]

Signature FTINCLUDE [names]
Default empty
Summary Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.
Name patterns are separated by commas. See Selective Indexing for more details.

MAXLEN[edit]

Signature MAXLEN [int]
Default 96
Summary Specifies the maximum length for strings to be stored in index structures. The value of this option will be assigned once to a new database, and can only be changed by creating a new database or doing a full optimization.

MAXCATS[edit]

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[edit]

Signature UPDINDEX [boolean]
Default false
Summary If turned on, incremental indexing will be enabled:
  • The current value of this option will be assigned to new databases. It can be changed for existing databases by running OPTIMIZE with the ALL keyword or db:optimize($db, true()).
  • After each update, the value indexes will be refreshed as well. Incremental updates are currently not available for the full-text index and database statistics.
  • Find more details in the article on Index Structures.

AUTOOPTIMIZE[edit]

Signature AUTOOPTIMIZE [boolean]
Default false
Summary If turned on, auto optimization will be applied to new databases:
  • With each update, outdated indexes and database statistics will be recreated.
  • As a result, the index structures will always be up-to-date.
  • However, updates can take much longer, so this option should only be activated for medium-sized databases.
  • The value of this option will be assigned once to a new database. It can be reassigned by running OPTIMIZE or db:optimize.

SPLITSIZE[edit]

Signature SPLITSIZE [num]
Default 0
Summary This option affects the construction of new value indexes. It controls 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 heuristics are applied, based on the current memory consumption. Usually, this works fine.
  • If explicit garbage collection is disabled when running Java (e.g. via the JVM option -XX:+DisableExplicitGC), you may need to choose a custom split size.
  • You can e. g. start with 1000000 (one million) index operations and adjust this value in the next steps.
  • The larger the assigned value is, the less splits will take place, and the more main memory will be required.

Full-Text Indexing[edit]

STEMMING[edit]

Signature STEMMING [boolean]
Default false
Summary If true, all tokens will be stemmed during full-text indexing, using a language-specific stemmer implementation. By default, tokens will not be stemmed. See Full-Text Index for more details.

CASESENS[edit]

Signature CASESENS [boolean]
Default false
Summary If true, the case of tokens will be preserved during full-text indexing. By default, case will be ignored (all tokens will be indexed in lower case). See Full-Text Index for more details.

DIACRITICS[edit]

Signature DIACRITICS [boolean]
Default false
Summary If set to true, diacritics will be preserved during full-text indexing. By default, diacritics will be removed. See Full-Text Index for more details.

LANGUAGE[edit]

Signature LANGUAGE [lang]
Default en
Summary The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See Full-Text Index for more details.

STOPWORDS[edit]

Signature STOPWORDS [path]
Default empty
Summary If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index is created. A stopword list may decrease the size of the full text index and speed up your queries. See Full-Text Index for more details.

Query Options[edit]

QUERYINFO[edit]

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.

MIXUPDATES[edit]

Signature MIXUPDATES
Default false
Summary Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to false. See Returning Results for more details.

BINDINGS[edit]

Signature BINDINGS [vars]
Default empty
Summary Contains external variables to be bound to a query. The string must comply with the following rules:
  • Variable names and values must be separated by equality signs.
  • Multiple variables must be delimited by commas.
  • Commas in values must be duplicated.
  • Variables may optionally be introduced with a leading dollar sign.
  • 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.
  • In the following Command Script, the value hello world! is bound to the variable $GREETING:
SET BINDINGS GREETING="hello world!"
XQUERY declare variable $GREETING external; $GREETING

INLINELIMIT[edit]

Signature INLINELIMIT
Default 50
Summary This option controls inlining of XQuery functions:
  • The XQuery compiler inlines functions to speed up query evaluation.
  • Inlining will only take place if a function body is not too large (i.e., if it does not contain too many expressions).
  • With this option, this maximum number of expressions can be specified.
  • Function inlining can be turned off by setting the value to 0.
  • The limit can be locally overwritten via the %basex:inline annotation (follow the link to get more information on function inlining).

UNROLLLIMIT[edit]

Introduced with Version 9.6:

Signature UNROLLLIMIT
Default 5
Summary This option controls the unroll limit:
  • Loops with few iterations are unrolled by the XQuery compiler to enable further optimizations.
  • If the limit is increased, more optimizations will take place, but the memory consumption and compile time will increase.
  • See Loop Unrolling for more details.

ENFORCEINDEX[edit]

Signature ENFORCEINDEX [boolean]
Default false
Summary Enforces index rewritings in path expressions. See Enforce Rewritings for details.

COPYNODE[edit]

Signature COPYNODE [boolean]
Default true
Summary When creating new nodes in XQuery via Node Constructors, all enclosed nodes will be copied, and all resulting nodes will get new node identities. This step can be very expensive, and it can be disabled with this option. The option should be used carefully, as it changes the standard behavior of XQuery. It should preferrably be used in Pragmas.

TAILCALLS[edit]

Signature TAILCALLS
Default 256
Summary Specifies how many stack frames of tail-calls are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to -1.

WITHDB[edit]

Signature WITHDB
Default true
Summary By default, resources specified via fn:doc and fn:collection are looked up both in the database and in the file system. If you always use db:open to access databases, it is recommendable to disable this option:
  • No locks will be created for the two functions (see limitations of database locking for more details).
  • Access to local and external resources will be faster, as the database lookup will be skipped.

DEFAULTDB[edit]

Signature DEFAULTDB
Default false
Summary If this option is turned on, paths specified in the fn:doc and fn:collection functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the OPEN command). If the path does not match any existing resources, it will be resolved as described in the article on accessing database resources.

FORCECREATE[edit]

Signature FORCECREATE [boolean]
Default false
Summary By activating this option, database instances will be created with the XQuery functions fn:doc and fn:collection.

CHECKSTRINGS[edit]

Signature CHECKSTRINGS [boolean]
Default true
Summary By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to false, these characters will be replaced with the Unicode replacement character FFFD (�). The option affects Java Bindings and string conversion and input functions such as archive:create, archive:extract-text, archive:update, and zip:text-entry.

WRAPJAVA[edit]

Signature WRAPJAVA [mode]
Default some
Summary Defines the way how values that result from Java code invocation will be converted to XQuery items. Allowed values: none, all, some, instance, and void. See Java Bindings for further details.

LSERROR[edit]

Signature LSERROR [error]
Default 0
Summary This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if 0 is assigned, the error value is calculated dynamically. See Fuzzy Querying for more details.

RUNQUERY[edit]

Signature RUNQUERY [boolean]
Default true
Summary Specifies if a query will be executed or parsed only. This option can also be changed on command line via -R.

RUNS[edit]

Signature RUNS [num]
Default 1
Summary Specifies how often a query will be evaluated. The result is serialized only once, and the measured times are averages of all runs. This option can also be changed on command line via -r.

Serialization Options[edit]

SERIALIZE[edit]

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[edit]

Signature SERIALIZER [params]
Default empty
Summary Parameters for serializing query results. The string must comply with the following rules:
  • Variable names and values must be separated by equality signs.
  • Multiple variables must be delimited by commas.
  • Commas in values must be duplicated.

The option can also be used on command line with the flag -s.

Examples
  • indent=no : disables automatic indentation of XML nodes. This is usually a good choice when working with Mixed-Content Data.
  • encoding=US-ASCII,omit-xml-declaration=no : sets the encoding to US-ASCII and prints the XML declaration.
  • item-separator=,, : separates serialized items by a single comma.

EXPORTER[edit]

Signature EXPORTER [params]
Default empty
Summary Contains parameters for exporting resources of a database and writing files after updates via the WRITEBACK option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See Serialization for more details.
Examples
  • indent=no,omit-xml-declaration=no : disables automatic indentation of XML nodes, outputs the XML declaration.

XMLPLAN[edit]

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[edit]

Signature COMPPLAN [boolean]
Default true
Summary Generates the query plan, which can be activated via XMLPLAN, before or after query compilation. This option can also be activated on command line via -X.

FULLPLAN[edit]

Signature FULLPLAN [boolean]
Default false
Summary Attaches the file path, line and column of the expressions in the original query string to the query plan. Values (items and sequences) have no input information attached.

Other Options[edit]

AUTOFLUSH[edit]

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[edit]

Signature WRITEBACK [boolean]
Default false
Summary Propagates updates on main-memory instances of files that have been retrieved via fn:doc and fn:collection back to disk:
  • This option can also be activated on command line via -u.
  • Please take in mind that no backup will be created from your original files.
  • The serialization options can be controlled via the EXPORTER option.

MAXSTAT[edit]

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

Changelog[edit]

Version 9.6
Version 9.5
  • Updated: INLINELIMIT: default reduced to 50.
  • Updated: RESTXQERRORS: additionally suppress stack trace in HTTP response
Version 9.4
Version 9.3
Version 9.2
Version 9.0
Version 8.6
  • Added: FAIRLOCK, PARSERESTXQ
  • Removed: GLOBALLOCK (exclusive use of database lock)
  • Removed: QUERYPATH (will now be internally assigned)
  • Removed: CACHERESTXQ (replaced with PARSERESTXQ)
Version 8.5
Version 8.4
Version 8.3
Version 8.2
  • Removed: EVENTPORT, CACHEQUERY
Version 8.1
Version 8.0
Version 7.8.1
Version 7.8
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