Difference between revisions of "Options"

From BaseX Documentation
Jump to navigation Jump to search
(497 intermediate revisions by 10 users not shown)
Line 1: Line 1:
The options listed on this page can be requested with the [[Commands#GET|GET]] command and changed with the [[Commands#SET|SET]] command. Three data types exist: strings, numbers, and booleans, which can be turned ON and OFF. If options are internally changed by the [[GUI_Tutorial|GUI]] of BaseX, they will be listed in the [[GUI_Views|Info View]].
+
This page is linked from the [[Getting Started]] Section.
 
A [[Options_(Snapshot)|preview page]] contains all options offered by the [http://files.basex.org/releases/latest/ latest stable snapshot].
 
  
=Main Options=
+
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 main options are only available in the [[Standalone Tutorial|standalone]] and [[Server Tutorial|server]] instance of BaseX; they cannot be changed by database clients:
+
* '''[[#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.
  
===LANG===
+
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 {{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 {{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:
 +
 
 +
<pre class="brush:perl">
 +
# General Options
 +
DEBUG = false
 +
...
 +
 
 +
# Local Options
 +
CHOP = false
 +
</pre>
 +
 
 +
* Initial values for global 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 need to be prefixed with {{Code|org.basex.}}. An example:
 +
 
 +
<pre class="brush:xquery">
 +
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
 +
CHOP: false
 +
</pre>
 +
 
 +
* 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:
 +
 
 +
<pre class="brush:xml">
 +
<key>JVMOptions</key>
 +
<array>
 +
  <string>-Dorg.basex.CHOP=false</string>
 +
</array>
 +
</pre>
 +
 
 +
* In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:
 +
 
 +
<pre class="brush:xml">
 +
<context-param>
 +
  <param-name>org.basex.chop</param-name>
 +
  <param-value>false</param-value>
 +
</context-param>
 +
</pre>
 +
 
 +
* In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]].
 +
 
 +
If options are changed by operations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/>
 +
 
 +
=Global Options=
 +
 
 +
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]].
 +
 
 +
==General Options==
 +
 
 +
===DEBUG===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|DEBUG [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>LANG [language]</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Set the interface language. Currently, seven languages are available 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese' (default: <code>English</code>). BaseX needs to be restarted in order to activate the new language.
+
|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>.
 
|}
 
|}
  
===LANGKEY===
+
===DBPATH===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|DBPATH [path]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>LANGKEY</code>
+
|<code><code>[[Configuration#Database Directory|{home}/data]]</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Prefix all texts with the internal language keys. This option is helpful for creating new translations. BaseX needs to be restarted in order to activate this option.
+
|Points to the directory in which all databases are located.
 
|}
 
|}
  
===DBPATH===
+
===LOGPATH===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|LOGPATH [path]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>DBPATH [path]</code>
+
|<code>.logs</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Set a new database path (default: <code>[[Configuration#Database Directory|{home}/BaseXData]]</code>). Note: if the database path is changed, existing databases have to be manually moved to the new location.
+
|Points to the directory in which all [[Logging|log files]] are stored. Relative paths will be resolved against the {{Option|DBPATH}} directory.
 
|}
 
|}
  
 
===REPOPATH===
 
===REPOPATH===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>REPOPATH [path]</code>
+
|{{Code|REPOPATH [path]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|this <code>path</code> points to the XQuery package repository (default: <code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>).
+
|<code>[[Configuration#Database Directory|{home}/repo]]</code>
 +
|-
 +
| '''Summary'''
 +
|Points to the [[Repository]], in which all XQuery modules are located.
 
|}
 
|}
  
===PARALLEL===
+
===LANG===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|LANG [language]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|English}}
 +
|-
 +
| '''Summary'''
 +
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.
 +
|}
 +
 
 +
===LANGKEY===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|LANGKEY [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>PARALLEL [number]</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Set the maximum <code>number</code> of parallel readers (default: <code>8</code>).
+
|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.
 
|}
 
|}
  
===DEBUG===
+
===FAIRLOCK===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|FAIRLOCK [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>DEBUG</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Show internal debug info, usually used for development of new features (default: <code>false</code>).
+
|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.
 +
* 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===
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|CACHETIMEOUT [seconds]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|3600}}
 +
|-
 +
| '''Summary'''
 +
|Specifies how many seconds the results of queries, which have been queued by the [[Jobs Module|asynchronously executed]], will be cached in main memory.
 +
|}
  
 
==Client/Server Architecture==
 
==Client/Server Architecture==
  
 
===HOST===
 
===HOST===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|HOST [host]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>HOST [host]</code>
+
|{{Code|localhost}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Used by the client to connect the server (default: <code>localhost</code>).
+
|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>.
 
|}
 
|}
  
 
===PORT===
 
===PORT===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|PORT [port]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>PORT [port]</code>
+
|{{Code|1984}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Used by the client to connect the server (default: <code>1984</code>).
+
|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
 
|}
 
|}
  
 
===SERVERPORT===
 
===SERVERPORT===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>SERVERPORT [port]</code>
+
|{{Code|SERVERPORT [port]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Port of the database server (default: <code>1984</code>).
+
|{{Code|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 Options#BaseX Server|command line]] via <code>-p</code>.
 
|}
 
|}
  
===EVENTPORT===
+
===USER===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>EVENTPORT [port]</code>
+
|{{Code|USER [name]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Port of the client, listening for server events. This port is only used if a client attaches itself to a database event (default: <code>1985</code>).
+
|''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 Options#BaseX Client|command line]] via <code>-U</code>.
 
|}
 
|}
  
===JAXRXPORT===
+
===PASSWORD===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>JAXRXPORT [port]</code>
+
|{{Code|PASSWORD [password]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Port of the JAX-RX web server, usually Jetty (default: <code>8984</code>).
+
|''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 Options#BaseX Client|command line]] via <code>-P</code>.
 +
* Please note that it is a security risk to specify your password in plain text.
 +
|}
 +
 
 +
===AUTHMETHOD===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|AUTHMETHOD [method]}}
 +
|-
 +
| '''Default'''
 +
|''Basic''
 +
|-
 +
| '''Summary'''
 +
|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.
 +
* This is different for digest access, which cannot be overwritten.
 +
* With custom authentication, the server will not do any authentication.
 +
|}
 +
 
 +
===SERVERHOST===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|SERVERHOST [host&#x7c;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===
 +
 
 +
{| width='100%' width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|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===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|PROXYPORT [port]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|0}}
 +
|-
 +
| '''Summary'''
 +
|This is the port number of a proxy server. If the value is set to {{Code|0}}, it will be ignored.
 +
|}
 +
 
 +
===NONPROXYHOSTS===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|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===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|IGNOREHOSTNAME [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|If this option is enabled, hostnames of certificates will not be verified. Use {{Option|IGNORECERT}} to completely disable certificate verification.
 
|}
 
|}
  
===JAXRXPATH===
+
===IGNORECERT===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>JAXRXPATH [path]</code>
+
|{{Code|IGNORECERT [boolean]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|This local <code>path</code> points to the JAX-RX web directory (default: <code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code>).
+
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|This option can be turned on to ignore untrusted certificates when connecting to servers. Use {{Option|IGNOREHOSTNAME}} to suppress only the hostname verification.
 
|}
 
|}
  
 
===TIMEOUT===
 
===TIMEOUT===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|TIMEOUT [seconds]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|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 {{Code|0}}. It is ignored for operations with [[User Management|admin permissions]].
 +
|}
 +
 
 +
===KEEPALIVE===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|KEEPALIVE [seconds]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|600}}
 +
|-
 +
| '''Summary'''
 +
|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.
 +
|}
 +
 
 +
===PARALLEL===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|PARALLEL [number]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|8}}
 +
|-
 +
| '''Summary'''
 +
|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.
 +
* 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===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|LOG [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>TIMEOUT [time]</code>
+
|{{Code|true}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Server timeout in seconds. The timeout describes the maximum execution time of a client query. The timeout is deactivated if <code>time</code> is set to <code>0</code> (default: no timeout (<code>0</code>)).
+
|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.
 
|}
 
|}
  
 +
===LOGMSGMAXLEN===
  
=Database Options=
+
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|LOGMSGMAXLEN [length]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|1000}}
 +
|-
 +
| '''Summary'''
 +
|Specifies the maximum length of a single [[Logging|log message]].
 +
|}
  
===CHOP===
+
==HTTP Services==
{|
+
 
 +
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:
 +
 
 +
===WEBPATH===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|WEBPATH [path]}}
 +
|-
 +
| '''Default'''
 +
|<code>[[Configuration#Database Directory|{home}/webapp]]</code>
 +
|-
 +
| '''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 Application#Servlet_Container|web servlet]].
 +
* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.
 +
|}
 +
 
 +
===GZIP===
 +
 
 +
{{Mark|Introduced with Version 9.3:}}
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|GZIP [boolean]}}
 +
|-
 +
| '''Default'''
 +
|<code>false</code>
 +
|-
 +
| '''Summary'''
 +
|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>.
 +
* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.
 +
* The [https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 sane defaults] of the web server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).
 +
|}
 +
 
 +
===RESTXQPATH===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''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 {{Option|WEBPATH}} directory.
 +
|}
 +
 
 +
===PARSERESTXQ===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|PARSERESTXQ}}
 +
|-
 +
| '''Default'''
 +
|{{Code|3}}
 +
|-
 +
| '''Summary'''
 +
|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.
 +
* 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.
 +
* Monitoring is completely disabled if a negative value is specified.
 +
 
 +
See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details.
 +
|}
 +
 
 +
===RESTXQERRORS===
 +
 
 +
{{Mark|Introduced with Version 9.2.}}
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|RESTXQERRORS}}
 +
|-
 +
| '''Default'''
 +
|{{Code|true}}
 +
|-
 +
| '''Summary'''
 +
|Reports parsing errors in XQuery modules in the RESTXQ directory back to the client. By default, this option is enabled. On productive systems, it can be disabled in order to suppress errors that should not be seen by the client.
 +
|}
 +
 
 +
===RESTPATH===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|RESTPATH [path]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 +
|-
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
===HTTPLOCAL===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|HTTPLOCAL [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>CHOP</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Chop all leading and trailing whitespaces from text nodes while building a database, and discard empty text nodes. This option often reduces the database size by up to 50% (default: <code>true</code>).
+
|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.
 
|}
 
|}
  
===INTPARSE===
+
===STOPPORT===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|STOPPORT [port]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>INTPARSE</code>
+
|{{Code|8985}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Use 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. (default: <code>false</code>).
+
|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>.
 
|}
 
|}
  
===DTD===
+
=Create Options=
{|
+
 
 +
==General==
 +
 
 +
===MAINMEM===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|MAINMEM [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>DTD</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Parse referenced DTDs and resolve XML entities (default: <code>false</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.
 
|}
 
|}
  
===CATFILE===
+
===ADDCACHE===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|ADDCACHE [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>CATFILE [path]</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Specify a catalog file to locally resolve DTDs; see the Wikipedia entry on [http://en.wikipedia.org/wiki/XML_Catalog XML Catalogs] for more details (default: ''empty'').
+
|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==
  
 
===CREATEFILTER===
 
===CREATEFILTER===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|CREATEFILTER [filter]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>CREATEFILTER [filter]</code>
+
|{{Code|*.xml}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Globbing syntax for filtering input documents (default: <code>*.xml</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.
 
|}
 
|}
  
 
===ADDARCHIVES===
 
===ADDARCHIVES===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|ADDARCHIVES [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|true}}
 +
|-
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
===ARCHIVENAME===
 +
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>ADDARCHIVES</code>
+
|{{Code|ARCHIVENAME [boolean]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents (default: <code>true</code>).
+
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|If this option is set to {{Code|true}}, the file name of parsed archives will be included in the document paths.
 
|}
 
|}
  
 
===SKIPCORRUPT===
 
===SKIPCORRUPT===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|SKIPCORRUPT [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|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===
 +
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>SKIPCORRUPT</code>
+
|{{Code|ADDRAW [boolean]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Skip corrupt (i.e., non-well-formed) files while creating a database or adding new documents. If this option is used, database creation is 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 (default: <code>false</code>).
+
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|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).
 
|}
 
|}
  
 
===PARSER===
 
===PARSER===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|PARSER [type]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|XML}}
 +
|-
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
===CSVPARSER===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|CSVPARSER [options]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 +
|-
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
===JSONPARSER===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|JSONPARSER [options]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 +
|-
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
===HTMLPARSER===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|HTMLPARSER [options]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 +
|-
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
===TEXTPARSER===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|TEXTPARSER [options]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Summary'''
|<code>PARSER [type]</code>
+
|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.
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Examples'''
|Define import [[Parsers|parser]]. As <code>TYPE</code> are available 'XML', 'CSV' or 'TEXT'. If [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is found in the classpath, 'HTML' is also available (default: <code>XML</code>).
+
|<code>lines=true</code> creates a single element for each line of text.
 
|}
 
|}
  
===PARSEROPT===
+
==XML Parsing==
{|
+
 
 +
===CHOP===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|CHOP [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>PARSEROPT [options]</code>
+
|{{Code|true}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Define parser-specific options (default: ''empty''). See [[Parsers|parsers]] page for more information.
+
|Many XML documents include whitespaces that have been added to improve readability. This option controls the [http://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:
 +
<pre class="brush: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>
 +
</pre>
 +
It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option; otherwise the serialized documents will automatically be indented.
 
|}
 
|}
  
===PATHINDEX===
+
===STRIPNS===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|STRIPNS [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>PATHINDEX</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Create index for paths and speedup path based queries (default: <code>true</code>).
+
|Strips all namespaces from an XML document and all elements while parsing.
 
|}
 
|}
 +
 +
===INTPARSE===
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|INTPARSE [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|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 <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.
 +
|}
 +
 +
===DTD===
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|DTD [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The {{Option|CATFILE}} option can be changed to locally resolve DTDs.
 +
|}
 +
 +
===XINCLUDE===
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|XINCLUDE [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|true}}
 +
|-
 +
| '''Summary'''
 +
|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}}).
 +
|}
 +
 +
===CATFILE===
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|CATFILE [path]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 +
|-
 +
| '''Summary'''
 +
|Semicolon-separated list of XML catalog files to resolve URIs. See [[Catalog Resolver]]s for more details.
 +
|}
 +
 +
==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.
  
 
===TEXTINDEX===
 
===TEXTINDEX===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|TEXTINDEX [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>TEXTINDEX</code>
+
|{{Code|true}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Create index for text nodes and speedup queries querying the entire text of a node (default: <code>true</code>).
+
|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.
 
|}
 
|}
  
 
===ATTRINDEX===
 
===ATTRINDEX===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|ATTRINDEX [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|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 [[Index#Attribute Index|Attribute Index]] for more details.
 +
|}
 +
 
 +
===TOKENINDEX===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|TOKENINDEX [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>ATTRINDEX</code>
+
|{{Code|true}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Create index for attribute values and speedup queries querying attribute values (default: <code>true</code>).
+
|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.
 
|}
 
|}
  
 
===FTINDEX===
 
===FTINDEX===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|FTINDEX [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|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 [[Index#Full-Text Index|Full-Text Index]] for more details.
 +
|}
 +
 
 +
===TEXTINCLUDE===
 +
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>FTINDEX</code>
+
|{{Code|TEXTINCLUDE [names]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Create index for fulltext and speedup queries querying full text (default: <code>false</code>).
+
|''empty''
 +
|-
 +
| '''Summary'''
 +
|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.
 
|}
 
|}
  
===WRITEBACK===
+
===ATTRINCLUDE===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|ATTRINCLUDE [names]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 +
|-
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
===TOKENINCLUDE===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|TOKENINCLUDE [names]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 +
|-
 +
| '''Summary'''
 +
|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.
 +
|}
 +
 
 +
===FTINCLUDE===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|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.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
 +
|}
 +
 
 +
===MAXLEN===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|MAXLEN [int]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>WRITEBACK</code>
+
|{{Code|96}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Write original files back after updates. As this will alter your input file make sure you have a backup before you use this option (default: <code>false</code>).
+
|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.
 
|}
 
|}
  
===MAINMEM===
+
===MAXCATS===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|MAXCATS [int]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>MAINMEM</code>
+
|{{Code|100}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Use main-memory mode. Now all data is exclusively stored in main memory. Some queries will be evaluated even faster, but the data is lost if BaseX is shut down (default: <code>false</code>).
+
|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.
 
|}
 
|}
  
===FORCECREATE===
+
===UPDINDEX===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|UPDINDEX [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>FORCECREATE</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Force database creation for unknown documents specified in XQuery expressions (default: <code>false</code>).
+
|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]].
 
|}
 
|}
  
 +
===AUTOOPTIMIZE===
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|AUTOOPTIMIZE [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|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 {{Command|OPTIMIZE}} or [[Database_Module#db:optimize|db:optimize]].
 +
|}
  
=Full-Text Options=
+
===SPLITSIZE===
  
===WILDCARDS===
+
{| width='100%'
{|
+
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|SPLITSIZE [num]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>WILDCARDS</code>
+
|{{Code|0}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions (default: <code>false</code>).
+
|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.
 
|}
 
|}
 +
 +
==Full-Text Indexing==
  
 
===STEMMING===
 
===STEMMING===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>STEMMING</code>
+
|{{Code|STEMMING [boolean]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Stemm full text tokens before indexing and decrease index size. Should only be assigned for full text queries using stemming, otherwise the full text index could not be assigned for query speedups (default: <code>false</code>).
+
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|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.
 
|}
 
|}
  
 
===CASESENS===
 
===CASESENS===
{|
+
 
 +
{| width='100%'
 +
 
 +
| width='120' | '''Signature'''
 +
|{{Code|CASESENS [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>CASESENS</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Case sensitive full text indexing, i.e. full text tokens are stored case sensitive and enables the assignment of the full text index for case sensitive queries (default: <code>false</code>).
+
|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.
 
|}
 
|}
  
 
===DIACRITICS===
 
===DIACRITICS===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|DIACRITICS [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>DIACRITICS</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Diacritic sensitive full text indexing, i.e. full text tokens are stored with diacritics and enables the assignment of the full text index for diacritic queries (default: <code>false</code>).
+
|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.
 
|}
 
|}
  
 
===LANGUAGE===
 
===LANGUAGE===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|LANGUAGE [lang]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|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 [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 +
|}
 +
 
 +
===STOPWORDS===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|STOPWORDS [path]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 +
|-
 +
| '''Summary'''
 +
|A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 +
|}
 +
 
 +
=Query Options=
 +
 
 +
===QUERYINFO===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|QUERYINFO [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.
 +
|}
 +
 
 +
===MIXUPDATES===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|MIXUPDATES}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>LANGUAGE [lang]</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Language for full-text search index, e.g. <code>LANG</code> can be set to <code>English</code> or <code>German</code> (default: ''empty'').
+
|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.
 
|}
 
|}
  
===SCORING===
+
===BINDINGS===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>SCORING [mode]</code>
+
|{{Code|BINDINGS [vars]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Precalculation of full text scores and storage within the full text index structure. Enables TF/IDF based scores in full text queries and increases memory consumption while indexing. <code>MODE</code> can be set to <code>1</code> for document based scoring, <code>2</code> for text node based scoring and <code>0</code> for non scoring (default: <code>0</code>).
+
|''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 [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 [[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 $GREETING:
 +
<pre class="brush:xml">
 +
SET BINDINGS GREETING="hello world!"
 +
XQUERY declare variable $GREETING external; $GREETING
 +
</pre>
 
|}
 
|}
  
===STOPWORDS===
+
===INLINELIMIT===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|INLINELIMIT}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>STOPWORDS [path]</code>
+
|{{Code|100}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Specify stop word list at <code>PATH</code>, that could be used e.g. to decrease the full text index size. The standard stopword list (english) is provided at <code>'etc/xml/stopWords'</code> (default: ''empty'').
+
|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).
 
|}
 
|}
  
===LSERROR===
+
===TAILCALLS===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|TAILCALLS}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>LSERROR [error]</code>
+
|{{Code|256}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOption, e.g. error could be <code>2</code> (default: <code>0</code>).
+
|Specifies how many stack frames of [http://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1}}.
 
|}
 
|}
  
 +
===WITHDB===
  
=Query Options=
+
{{Mark|Introduced with Version 9.3.}}
  
===QUERYINFO===
+
{| width='100%'
{|
+
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|WITHDB}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>QUERYINFO</code>
+
|{{Code|true}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Show (all) process info (default: <code>false</code>).
+
|By default, URIs specified in the [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] functions will also be resolved against existing databases. If {{Function|Database|db:open}} is consistently used to access database documents, it is recommendable to disable this option:
 +
* Access to local and external resources will be faster, as the database lookup will be skipped.
 +
* No locks will be created by the two functions (see [[Transaction Management#Limitations|limitations of database locking]] for more details).
 
|}
 
|}
  
===QUERY3===
+
===DEFAULTDB===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>QUERY3</code>
+
|{{Code|DEFAULTDB}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Enable/disable [http://www.w3.org/TR/xquery-30/ XQuery 3.0] functions (default: <code>true</code>).
+
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|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]].
 
|}
 
|}
  
===SERIALIZE===
+
===FORCECREATE===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|FORCECREATE [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>SERIALIZE</code>
+
|{{Code|false}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Flag for serialization of query results. I.e. there are any results printed if serialization is turned off (default: <code>true</code>).
+
|By activating this option, database instances will be created with the XQuery functions [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]].
 
|}
 
|}
  
===BINDINGS===
+
===CHECKSTRINGS===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|CHECKSTRINGS [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>BINDINGS [vars]</code>
+
|{{Code|true}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Contains external variables to be bound to the query. Keys and values are separated by equality signs, multiple variables are separated by commas (default: ''empty'').
+
|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]].
 
|}
 
|}
  
===SERIALIZER===
+
===LSERROR===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|LSERROR [error]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>SERIALIZER [params]</code>
+
|{{Code|0}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Parameters for serializing queries; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are separated by commas (default: ''empty'').
+
|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.
 
|}
 
|}
  
===EXPORTER===
+
===RUNQUERY===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|RUNQUERY [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>EXPORTER [params]</code>
+
|{{Code|true}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Parameters for exporting the documents; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are separated by commas (default: ''empty'').
+
|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='120' | '''Signature'''
 +
|{{Code|RUNS [num]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>RUNS [num]</code>
+
|{{Code|1}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Specify number of runs a query is executed. Results are printed a single time and evaluation times are averages of all runs (default: <code>1</code>).
+
|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>.
 
|}
 
|}
  
 +
===ENFORCEINDEX===
  
=Serialization Options=
+
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|ENFORCEINDEX [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|Enforces index rewritings in path expressions (see [[Indexes#Enforce Rewritings|Enforce Rewritings]] for details).
 +
|}
 +
 
 +
===COPYNODE===
  
===DOTPLAN===
+
{| width='100%'
{|
+
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|COPYNODE [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>DOTPLAN</code>
+
|{{Code|true}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Create query plans visualized with [http://www.graphviz.org dotty], see <code>'plan.dot'</code> file in your project folder (default: <code>false</code>).
+
|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]].
 
|}
 
|}
  
===DOTCOMPACT===
+
=Serialization Options=
{|
+
 
 +
===SERIALIZE===
 +
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>DOTCOMPACT</code>
+
|{{Code|SERIALIZE [boolean]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Compact dot representation (default: <code>false</code>).
+
|{{Code|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 {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.  
 
|}
 
|}
  
===DOTDISPLAY===
+
===SERIALIZER===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|SERIALIZER [params]}}
 +
|-
 +
| '''Default'''
 +
|''empty''
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Summary'''
|<code>DOTDISPLAY</code>
+
|Parameters for [[Serialization|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 Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Examples'''
|Display dot representation after query execution (default: <code>true</code>).
+
|
 +
* <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.
 
|}
 
|}
  
===DOTTY===
+
===EXPORTER===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>DOTTY [path]</code>
+
|{{Code|EXPORTER [params]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Program <code>PATH</code> of dotty executable (default: <code>dotty</code>).
+
|''empty''
 +
|-
 +
| '''Summary'''
 +
|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%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>XMLPLAN</code>
+
|{{Code|XMLPLAN [boolean]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Print query plan as xml document (default: <code>false</code>).
+
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.  
 
|}
 
|}
  
 
===COMPPLAN===
 
===COMPPLAN===
{|
+
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|COMPPLAN [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|true}}
 +
|-
 +
| '''Summary'''
 +
|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>.
 +
|}
 +
 
 +
===FULLPLAN===
 +
 
 +
{{Mark|Introduced with Version 9.2:}}
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|FULLPLAN [boolean]}}
 +
|-
 +
| '''Default'''
 +
|{{Code|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=
 +
 
 +
===AUTOFLUSH===
 +
 
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signature'''
 +
|{{Code|AUTOFLUSH [boolean]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>COMPPLAN</code>
+
|{{Code|true}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Create query plan before or after compilation - query plan might change due to optimizations (default: <code>true</code>).
+
|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.
 
|}
 
|}
  
===CACHEQUERY===
+
===WRITEBACK===
{|
+
 
 +
{| width='100%'
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| width='120' | '''Signature'''
|<code>CACHEQUERY</code>
+
|{{Code|WRITEBACK [boolean]}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Default'''
|Cache the query results (default: <code>false</code>).
+
|{{Code|false}}
 +
|-
 +
| '''Summary'''
 +
|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='120' | '''Signature'''
 +
|{{Code|MAXSTAT [num]}}
 
|-
 
|-
| valign='top' width='90' | '''Signature'''
+
| '''Default'''
|<code>MAXSTAT [num]</code>
+
|{{Code|30}}
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
|Set maximum number of index occurrences to print through the command <code>info index</code> (default: <code>15</code>).
+
|Specifies the maximum number of index occurrences printed by the {{Command|INFO INDEX}} command.
 
|}
 
|}
 +
 +
=Changelog=
 +
 +
;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
 +
 +
* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}}
 +
 +
;Version 7.6
 +
 +
* Added: {{Option|GLOBALLOCK}}
 +
* Added: store local options in configuration file after {{Code|# 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: {{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: global options cannot be changed anymore during the lifetime of a BaseX instance
 +
 +
;Version 7.3
 +
 +
* Updated: {{Option|KEEPALIVE}}, {{Option|TIMEOUT}}: default values changed
 +
* 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
 +
 +
;Version 7.2
 +
 +
* Added: {{Option|PROXYHOST}}, {{Option|PROXYPORT}}, {{Option|NONPROXYHOSTS}}, {{Option|HTMLOPT}}
 +
* Updated: {{Option|TIMEOUT}}: ignore timeout for admin users
 +
 +
;Version 7.1
 +
 +
* Added: {{Option|ADDRAW}}, {{Option|MAXLEN}}, {{Option|MAXCATS}}, {{Option|UPDINDEX}}
 +
* Updated: {{Option|BINDINGS}}
 +
 +
;Version 7.0
 +
 +
* Added: {{Option|SERVERHOST}}, {{Option|KEEPALIVE}}, {{Option|AUTOFLUSH}}, {{Option|QUERYPATH}}

Revision as of 14:50, 12 November 2019

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

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

DEBUG

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

DBPATH

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

LOGPATH

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

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

LANG

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

LANGKEY

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

FAIRLOCK

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

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

HOST

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

PORT

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

SERVERPORT

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

USER

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

PASSWORD

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

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

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

PROXYHOST

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

PROXYPORT

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

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

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

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

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

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

PARALLEL

Signature PARALLEL [number]
Default 8
Summary Denotes the maximum allowed number of parallel 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

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

LOGMSGMAXLEN

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

HTTP Services

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

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

Template:Mark

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 sane defaults of the web server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).

RESTXQPATH

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

PARSERESTXQ

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

Template:Mark

Signature RESTXQERRORS
Default true
Summary Reports parsing errors in XQuery modules in the RESTXQ directory back to the client. By default, this option is enabled. On productive systems, it can be disabled in order to suppress errors that should not be seen by the client.

RESTPATH

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

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

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

Create Options

General

MAINMEM

Signature MAINMEM [boolean]
Default false
Summary If this option is turned on, new databases will be 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

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

CREATEFILTER

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

ADDARCHIVES

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

ARCHIVENAME

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

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

ADDRAW

Signature ADDRAW [boolean]
Default false
Summary If this option is 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

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

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

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

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

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

CHOP

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

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

INTPARSE

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

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

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

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

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.

TEXTINDEX

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

ATTRINDEX

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

TOKENINDEX

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

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

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

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

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

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

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

MAXCATS

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

UPDINDEX

Signature UPDINDEX [boolean]
Default false
Summary If turned on, incremental indexing will be 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

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

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

STEMMING

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

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

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

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

Signature STOPWORDS [path]
Default empty
Summary A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. See Full-Text Index for more details.

Query Options

QUERYINFO

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

MIXUPDATES

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

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

Signature INLINELIMIT
Default 100
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).

TAILCALLS

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

Template:Mark

Signature WITHDB
Default true
Summary By default, URIs specified in the fn:doc and fn:collection functions will also be resolved against existing databases. If db:open is consistently used to access database documents, it is recommendable to disable this option:
  • Access to local and external resources will be faster, as the database lookup will be skipped.
  • No locks will be created by the two functions (see limitations of database locking for more details).

DEFAULTDB

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

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

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.

LSERROR

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

RUNQUERY

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

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.

ENFORCEINDEX

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

COPYNODE

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.

Serialization Options

SERIALIZE

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

SERIALIZER

Signature SERIALIZER [params]
Default empty
Summary 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

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

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

COMPPLAN

Signature COMPPLAN [boolean]
Default true
Summary 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

Template:Mark

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

AUTOFLUSH

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

WRITEBACK

Signature WRITEBACK [boolean]
Default false
Summary 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

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

Changelog

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