Changes

Jump to navigation Jump to search
22,317 bytes added ,  27 May
m
Fixed typo if should be is
This page is linked from the [[Getting Started]] Section.
The options listed on this page influence the way how database [[Commands|commands]] are executed and XQuery expressions are evaluated. Options are divided into [[#global options|global options]], which are valid for all BaseX instances, and local options, which are specific to a client or session. Values Two kinds of options are either ''strings'', ''numbers'' or ''booleans''.exist:
The {{Code|.basex}} * '''[[Configuration#Configuration FilesGlobal Options|configuration fileGlobal Options]] is parsed by every new local ''' are valid for all BaseX instanceinstances in the same JVM. It This is used to store particularly relevant if you are working with the client/server architecture.* '''Local options ''' (all remaining ones) are specific to disk:a client or session.
* Global Values of options can only be set via the configuration file are either ''strings'', ''numbers'' or system properties ''booleans''. Options are ''static'' and not bound to a single operation (see abovefor example, the next command).* With {{Version|7.6}} Various ways exist to access and later, local change options can be specified after the {{Code|# Local Options}} comment.:
Various ways exist to access * 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 change options:if no value is specified, its current value will be inverted.
* The current value of an option can be requested with the [[Commands#GET{{Code|GET]] and changed with the .basex}} [[CommandsConfiguration#SETConfiguration Files|SETconfiguration file]] commandis parsed by every new local BaseX instance. All values are ''static'': they stay valid until they are changed once again by another operationIt contains all global options. If an option is Local options can be specified at the end of type ''boolean'', and if no value is specified, its existing value will be inverted.the file after the {{Code|Local Options}} comment:
<syntaxhighlight lang="perl"># General OptionsDEBUG = false... # Local OptionsCHOP = false</syntaxhighlight> * Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [httphttps://docs.oracle.com/javaseen/1.4.2java/docsjavase/tooldocs11/windowstools/java.html#options -D flag] on command line, or using [httphttps://docs.oracle.com/en/java/javase/611/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,%20javajava.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys needs need to be prefixed with {{Code|org.basex.}}. An example:
<pre classsyntaxhighlight lang="brush:bashperl">
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
CHOP: false
</presyntaxhighlight> * 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: <syntaxhighlight lang="xml"><key>JVMOptions</key><array> <string>-Dorg.basex.CHOP=false</string></array></syntaxhighlight>
* Options can also be set in the prolog of an XQuery expression. In the option declaration, options need to be bound to the a [[Database ModuleWeb Application]] namespace. All values will , the default can be reset after adjusted in the evaluation of a query{{Code|web.xml}} file as follows:
<pre classsyntaxhighlight lang="brush:xqueryxml">declare option db:<context-param> <param-name>org.basex.chop '</param-name> <param-value>false';</param-value>...</context-param></presyntaxhighlight>
<pre class="brush:xquery">(* In XQuery, local options can be set via option declarations and [[XQuery Extensions# db:chop false #) { parse-xml('<xml> hi </xml>') }</pre>Pragmas|pragmas]].
If options are implicitly 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]]. ==GeneralOptions== ===DEBUG=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|DEBUG [boolean]}}|-| '''Default'''|{{Code|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 Options#BaseX Standalone|command line]] via <code>-d</code>.|}
===DBPATH===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|DBPATH [path]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> or <code>[[Configuration#Database Directory|{home}/data]]</code>
|-
| '''Summary'''
|Points to the directory in which all databases are located.<br/> '''Note:''' this option can only be changed if no database is currently opened.
|}
===REPOPATHLOGPATH=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|REPOPATH LOGPATH [path]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]].logs</code>
|-
| '''Summary'''
|Points to the directory in which all [[RepositoryLogging|log files]], in which all XQuery modules are locatedstored. Relative paths will be resolved against the {{Option|DBPATH}} directory.
|}
===DEBUGREPOPATH=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DEBUG REPOPATH [booleanpath]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{{Code|false}home}/repo]]</code>
|-
| '''Summary'''
|Sends internal debug info Points to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on the [[Startup Options#BaseX Standalone|command lineRepository]] via <code>-d</code>, in which all XQuery modules are located.
|}
===LANG===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LANG [language]}}
|-
===LANGKEY===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LANGKEY [boolean]}}
|-
|}
===GLOBALLOCKFAIRLOCK=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|FAIRLOCK [boolean]}}|-| '''Default'''|{{Code|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 {{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.|}
{{Mark|Introduced with Version 7.6:}}===CACHETIMEOUT===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|GLOBALLOCK CACHETIMEOUT [booleanseconds]}}
|-
| '''Default'''
|{{Code|false3600}}
|-
| '''Summary'''
|Controls if local (database) or global (process) locking will be used for managing read and write operations. The article on Specifies how many seconds the results of queries, which have been queued by the [[Transaction ManagementJobs Module|asynchronously executed]] provides more details on concurrency control, will be cached in main memory.
|}
===HOST===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|HOST [host]}}
|-
|-
| '''Summary'''
|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Startup Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
|}
===PORT===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|PORT [port]}}
|-
|-
| '''Summary'''
|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Startup Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
|}
===SERVERPORT===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|SERVERPORT [port]}}
|-
|-
| '''Summary'''
|This is the port the database server will be listening to. This option can also be changed when running the server on [[Startup Command-Line Options#BaseX Server|command line]] via <code>-p</code>.
|}
===EVENTPORTUSER==={| width='100%'|-| width='90' | '''Signature'''|{{Code|EVENTPORT [port]}}|-| '''Default'''|{{Code|1985}}|-| '''Summary'''|This port is used by the client to listen for [[Events|server events]]. It will only be bound if a client attaches itself to a database event. This option can also be changed when running the server on [[Startup Options#BaseX Server|command line]] via <code>-e</code>.|}
===USER===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|USER [name]}}
|-
* The default value will be overwritten if a client specifies its own credentials.
* If the default value is empty, login will only be possible if the client specifies credentials.
* The option can also be changed on [[Startup Command-Line Options#BaseX Client|command line]] via <code>-U</code>.
|}
===PASSWORD===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|PASSWORD [password]}}
|-
|-
| '''Summary'''
|Represents a password, which is used for accessing the server or an HTTP service:
* The default value will be overwritten if a client specifies its own credentials.
* If the default value is empty, login will only be possible if the client specifies credentials.
* The option can also be changed on [[Startup 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='90120' | '''Signature'''
|{{Code|SERVERHOST [host&#x7c;ip]}}
|-
===PROXYHOST===
 
{| width='100%' width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|PROXYHOST [host]}}
|-
|-
| '''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='90120' | '''Signature'''
|{{Code|PROXYPORT [port]}}
|-
| '''Default'''
|{{Code|800}}
|-
| '''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='90120' | '''Signature'''
|{{Code|NONPROXYHOSTS [hosts]}}
|-
|-
| '''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.|} ===IGNORECERT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|IGNORECERT [boolean]}}|-| '''Default'''|{{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===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|TIMEOUT [seconds]}}
|-
|-
| '''Summary'''
|Specifies the maximum time a read-only transaction triggered by a client may take. If an operation takes longer than the specified timeoutnumber of seconds, it will be aborted. Write 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 {{Codeoperations with [[User Management|ADMIN}} operationsadmin permissions]].
|}
===KEEPALIVE===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|KEEPALIVE [seconds]}}
|-
===PARALLEL===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|PARALLEL [number]}}
|-
|-
| '''Summary'''
|Denotes the maximum allowed {{Code|number}} of parallel read [[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='90120' | '''Signature'''
|{{Code|LOG [boolean]}}
|-
|-
| '''Summary'''
|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Startup Command-Line Options#BaseX Server|command line]] via <code>-z</code>.
|}
===LOGMSGMAXLEN===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LOGMSGMAXLEN [length]}}
|-
|}
===LOGTRACE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LOGTRACE [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|If BaseX is running as [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and similar functions) is written to the [[Logging|database logs]]. If this option is disabled, trace output will be redirected to standard error, as it is known from the standalone version of BaseX.|} ==HTTP OptionsServices==
If BaseX is run as [[Web Application]], the Most HTTP options are either determined by defined in the {{Code|jetty.xml}} and {{Code|web server, or specified .xml}} configuration files in the <code>[https://github.com/BaseXdb/basex-api/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory and . Some additional BaseX-specific options exist that will be set before the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files.server is started:
===WEBPATH===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|WEBPATH [path]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code> or <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=== {| 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 same defaults] of the web server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).
|}
===RESTXQPATH===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|RESTXQPATH [path]}}
|-
|-
| '''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|Updated with BaseX 9.5:}} Additionally suppress stack trace in HTTP response. {| width='100%'|-| width='120' | '''Signature'''|{{Code|RESTXQERRORS}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.|} ===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#WEBPATHGET Requests|WEBPATHREST run operation]] . Relative paths will be resolved against the {{Option|WEBPATH}} directory.
|}
===HTTPLOCAL===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|HTTPLOCAL [boolean]}}
|-
|-
| '''Summary'''
|By default, a if BaseX is run as [[Web Application]], the database server instance will be opened along with started in addition, which can then be addressed by [[Clients]] via the web server. If the flag is set to database port (see {{CodeOption|truePORT}}, all commands will be executed in an embedded database context).<br/>If BaseX is run as [[Web Application]], and if the flag option is set to {{Code|falsetrue}}, the no database server will be started as soon as the first HTTP service is calledlaunched.
|}
===STOPPORT===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|STOPPORT [port]}}
|-
* The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}.
* The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].
* This option can also be changed when running the HTTP server on [[Startup Command-Line Options#BaseX Server|command line]] via <code>-s</code>.
|}
===MAINMEM===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|MAINMEM [boolean]}}
|-
|-
| '''Summary'''
|If this option is turned on, new databases will be exclusively created in main memory. :* Most queries will be evaluated faster in main -memory mode, but all data is lost if the BaseX instance in which the database was created is shut down. The value of * 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.|} ===ADDCACHE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|ADDCACHE [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|If this option is activated, data structures of documents will first be assigned once cached to disk before being added to a new the final database. This option is helpful when larger documents need to be added, and if the existing heuristics cannot be changed after thatestimate the input size (e.g. when adding directories or sending input streams).
|}
===CREATEFILTER===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|CREATEFILTER [filter]}}
|-
===ADDARCHIVES===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|ADDARCHIVES [boolean]}}
|-
|-
| '''Summary'''
|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc.) are parsed whenever new database databases are created or resources are added to a database.|} ===ARCHIVENAME=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|ARCHIVENAME [boolean]}}|-| '''Default'''|{{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===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|SKIPCORRUPT [boolean]}}
|-
===ADDRAW===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|ADDRAW [boolean]}}
|-
|-
| '''Summary'''
|If this option is activatedenabled, and if new all resources are added to a database, all files that are not filtered out by the [[#CREATEFILTER{{Option|CREATEFILTER]] }} option while being added to a database will be added stored as ''[[Binary Data|raw'' files ]] instead (i.e., in their binary representation).
|}
===PARSER===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|PARSER [type]}}
|-
|-
| '''Summary'''
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'Available parsers are {{Code|XML'}}, '{{Code|JSON'}}, '{{Code|CSV'}}, '{{Code|TEXT'}}, '{{Code|HTML' are available as parsers}}, and {{Code|RAW}}. HTML input will be parsed as normal XML files documents if [http:[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>,</homecode>.ccilThe available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]].org|-| '''Examples'''|<code>encoding=CP1252,header=true</~cowancode> 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>=</XMLcode>, and multiple options are delimited with <code>,</tagsoupcode>. The available options (except for the additional <code>encoding</ Tagsoupcode> option) are described in the [[JSON Module#Options|JSON Module]] is not found in .|-| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the classpathinput as JSONML and uses lax parsing.
|}
===PARSEROPTHTMLPARSER=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARSEROPT HTMLPARSER [options]}}
|-
| '''Default'''
|-
| '''Summary'''
|Defines parser-specific 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; see are described in the [[Parsers#Options|Parsers]] for more informationarticle.|-| '''Examples'''|* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.* <code>lexical=true</code> preserves comments.
|}
===HTMLOPTTEXTPARSER=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTMLOPT TEXTPARSER [options]}}
|-
| '''Default'''
|-
| '''Summary'''
|Allows to specify TagSoup Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options for HTML parsing; see are delimited with <code>,</code>. The available options are listed in the [[Parsers#HTML Parser|HTML Parser]] article.|-| '''Examples'''|<code>lines=true</code> creates a single element for more informationeach line of text.
|}
===CHOP===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|CHOP [boolean]}}
|-
|-
| '''Summary'''
|Chops all Many XML documents include whitespaces that have been added to improve readability. This option controls the [https://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:* With the default value {{Code|true}}, leading and trailing whitespaces from text nodes while building a database, will be chopped and discards all empty text nodeswill be discarded. By default, this option is set to {{Code* The flag should be turned off if a document contains [[Full-Text#Mixed Content|true}}, as it often reduces the database size by up to 50%mixed content]]. It * The flag can also be turned off on [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>.* If the <code>xml:space="preserve"</code> attribute is attached to an element, chopping will be turned off for all descendant text nodes.  In the following example document, the whitespaces in the text nodes of the {{Code|text}} element will not be chopped:<syntaxhighlight lang="xml"><xml> <title> Demonstrating the CHOP flag </title> <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text></xml></syntaxhighlight>It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option; otherwise the serialized documents will automatically be indented.|} ===STRIPNS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|STRIPNS [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Strips all namespaces from an XML document and all elements while parsing.
|}
===INTPARSE===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|INTPARSE [boolean]}}
|-
| '''Default'''
|{{Code|truefalse}}
|-
| '''Summary'''
|Uses the internal XML parser instead of the standard Java XML parser. The Here are some reasons for using the internal parser is :* Performance: Documents (in particular small ones) will be parsed faster, more fault tolerant and supports common * Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;)* Entities: around 250 HTML entities out-of-will be detected and decodedYou will be able to correctly parse most XML documents with the-boxinternal parser. Java’s Xerces parser is still used as default, but however, because it does not support supports all features needed for parsing DTDsof the XML standard and advanced DTD features, such as recursive entity expansion.
|}
===DTD===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|DTD [boolean]}}
|-
|-
| '''Summary'''
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The [[#CATFILE{{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='90120' | '''Signature'''
|{{Code|CATFILE [path]}}
|-
|-
| '''Summary'''
|Specifies a Semicolon-separated list of XML catalog file files to locally resolve DTDs; see the entry on URIs. See [[Catalog Resolver]]s for more details.
|}
==Indexing==
The following options control the creation of index structures. The current index and full-text index options values will be stored in considered if a new database, and take effect if indexes are rebuilt via the is created. See [[Commands#OPTIMIZE|OPTIMIZEIndexes]]for more details.
===TEXTINDEX===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|TEXTINDEX [boolean]}}
|-
|-
| '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see . See [[IndexesIndex#Text Index|Text Index]] for more details.
|}
===ATTRINDEX===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|ATTRINDEX [boolean]}}
|-
|-
| '''Summary'''
|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values; see . See [[IndexesIndex#Attribute Index|Attribute Index]] for more details.|} ===TOKENINDEX=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TOKENINDEX [boolean]}}|-| '''Default'''|{{Code|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 [[Index#Token Index|Token Index]] for more details.
|}
===FTINDEX===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|FTINDEX [boolean]}}
|-
|-
| '''Summary'''
|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions; see . See [[Index#Full-Text Index|Full-Text Index]] for more details.|} ===TEXTINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|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.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===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='90120' | '''Signature'''
|{{Code|MAXLEN [int]}}
|-
|-
| '''Summary'''
|Specifies the maximum length of for strings that are to be indexed by the name, path, value, and full-text stored in [[Indexes|index structures]]. The value of this option will be assigned once to a new database, and cannot can only be changed after thatby creating a new database or doing a [[Commands#OPTIMIZE|full optimization]].
|}
===MAXCATS===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|MAXCATS [int]}}
|-
===UPDINDEX===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|UPDINDEX [boolean]}}
|-
|-
| '''Summary'''
|If turned on, incremental indexing will be activatedenabled: all update operations will also update the value index structures (texts and attribute values). * The current value of this option will be assigned once to a new database, and cannot databases. It can be changed after thatfor existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or [[Database_Module#db:optimize|db:optimize($db, true())]]. The advantage of incremental indexes is that * After each update, the value index structures indexes will always be uprefreshed as well. Incremental updates are currently not available for the full-to-datetext index and database statistics. The downside is that updates will take a little bit longer* 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]].|} ===SPLITSIZE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|SPLITSIZE [num]}}|-| '''Default'''|{{Code|0}}|-| '''Summary'''|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-TextIndexing==
===STEMMING===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|STEMMING [boolean]}}
|-
|-
| '''Summary'''
|A new If {{Code|true}}, all tokens will be stemmed during full-text index indexing, using a language-specific stemmer implementation. By default, tokens will stem all tokens and speed up queries on not be stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this indexSee [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===CASESENS===
 
{| width='100%'
|-| width='90120' | '''Signature'''
|{{Code|CASESENS [boolean]}}
|-
|-
| '''Summary'''
|A new full-text index will preserve If {{Code|true}}, the case of all tokenswill be preserved during full-text indexing. The same By default, case normalization will be applied to ignored (all query tokens that are checked against tokens will be indexed in this indexlower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===DIACRITICS===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|DIACRITICS [boolean]}}
|-
|-
| '''Summary'''
|A new If set to {{Code|true}}, diacritics will be preserved during full-text index will preserve the diacritics of all tokensindexing. The same By default, diacritics normalization will be applied to all query tokens that are checked against tokens in this indexremoved. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===LANGUAGE===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LANGUAGE [lang]}}
|-
|-
| '''Summary'''
|A new full-text index The specified language will use influence the given language to normalize all tokensway how texts will be tokenized and stemmed. This option is mainly important if tokens are to It can be stemmed, or if the tokenization name of a language differs from Western languagesor a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===STOPWORDS===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|STOPWORDS [path]}}
|-
|-
| '''Summary'''
|A new If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index will drop tokens that are listed in the specified stopword listis created. A stopword list may decrease the size of the full text indexand speed up your queries. A standard stopword list See [[Indexes#Full-Text Index|Full-Text Index]] for English texts is provided in the directory {{Code|etc/stopwords.txt}} in the official releasesmore details.
|}
===QUERYINFO===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|QUERYINFO [boolean]}}
|-
|-
| '''Summary'''
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.
|}
===XQUERY3MIXUPDATES=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|XQUERY3MIXUPDATES}}
|-
| '''Default'''
|{{Code|truefalse}}
|-
| '''Summary'''
|Enables all [[XQuery 3Allows queries to both contain updating and non-updating expressions.0]] features supported All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by BaseXan updating expression. If By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}, the . See [[XQuery parser will only accept expressions of the XQuery 1.0 specificationUpdate#Returning Results|Returning Results]] for more details.
|}
===BINDINGS===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|BINDINGS [vars]}}
|-
|-
| '''Summary'''
|Contains external variables to be bound to a query. The string must comply with the following rules:* Variable names and values are must be separated by equality signs, and multiple .* Multiple variables are must be delimited by commas.* Commas in values must be duplicated.
* Variables may optionally be introduced with a leading dollar sign.
* Commas that occur in the value itself are encoded by duplication.* If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [httphttps://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].* This option can also be used on [[Startup 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<br/>* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a<br/>* <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.* In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable {{Code|$GREETING}}:<syntaxhighlight lang="xquery">SET BINDINGS GREETING="hello world!"XQUERY declare variable $GREETING external; $GREETING</syntaxhighlight>
|}
===QUERYPATHINLINELIMIT=== {{Mark|Updated with Version 9.5:}} default reduced to 50. 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|QUERYPATH [path]INLINELIMIT}}
|-
| '''Default'''
|''empty''{{Code|50}}
|-
| '''Summary'''
|Contains the path (''base URI'') This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to the executed speed up query evaluation.* Inlining will only take place if a function body is not too large (default: ''empty''i.e., if it does not contain too many expressions). This directory will * With this option, this maximum number of expressions can be specified.* Function inlining can be used turned off by setting the value to resolve relative paths {{Code|0}}.* The limit can be locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (follow the link to documents, query modules, and other resources addressed in a queryget more information on function inlining).
|}
===CACHEQUERYUNROLLLIMIT=== {{Mark|Introduced with Version 9.6:}} 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CACHEQUERY [boolean]UNROLLLIMIT}}
|-
| '''Default'''
|{{Code|false5}}
|-
| '''Summary'''
|Caches This option controls the query results before returning them to unroll limit:* Loops with few iterations are ''unrolled'' by the client. This option may be set XQuery compiler to {{Code|true}} if the whole result is needed for enable further operations (such as is e.goptimizations. * If the case in limit is increased, more optimizations will take place, but the GUI of BaseX)memory consumption and compile time will increase.* See [[XQuery Optimizations#Loop Unrolling|Loop Unrolling]] for more details.
|}
===FORCECREATEENFORCEINDEX=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|FORCECREATE ENFORCEINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|By activating this option, the XQuery {{CodeEnforces index rewritings in path expressions. See [[Indexes#Enforce Rewritings|doc()}} and {{Code|collection()}} functions will create database instances Enforce Rewritings]] for the addressed input filesdetails.
|}
===LSERRORCOPYNODE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|LSERROR COPYNODE [errorboolean]}}
|-
| '''Default'''
|{{Code|0true}}
|-
| '''Summary'''
|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 specifies the maximum Levenshtein error for should be used carefully, as it changes the BaseX-specific fuzzy match optionstandard behavior of XQuery. See the page on It should preferrably be used in [[Full-TextXQuery Extensions#Fuzzy_QueryingDatabase Pragmas|Full-TextsPragmas]] for more information on fuzzy querying.
|}
===RUNSTAILCALLS=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|RUNS [num]TAILCALLS}}
|-
| '''Default'''
|{{Code|1256}}
|-
| '''Summary'''
|Specify number Specifies how many stack frames of runs a query is executed by the [[Commands#XQUERY|XQUERYhttps://en.wikipedia.org/wiki/Tail_call tail-calls]] commandare allowed on the stack at any time. The result When this limit is only serialized oncereached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the measured times are averages of all runsvalue to {{Code|-1}}.
|}
=Serialization Options==WITHDB===
===SERIALIZE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERIALIZE [boolean]WITHDB}}
|-
| '''Default'''
|-
| '''Summary'''
|Results of XQuery expressions will be serialized if this option is turned onBy default, resources specified via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] are looked up both in the database and in the file system. For debugging purposes and performance measurements, this option can be set to If you always use {{CodeFunction|falseDatabase|db:open}}. It can also to access databases, it is recommendable to disable this option:* No locks will be turned off on created for the two functions (see [[Startup OptionsTransaction Management#BaseX StandaloneLimitations|command linelimitations of database locking]] via <code>-z</code>for more details).* Access to local and external resources will be faster, as the database lookup will be skipped.
|}
===SERIALIZERDEFAULTDB=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|DEFAULTDB}}|-| '''Default'''|{{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]].|} ===FORCECREATE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERIALIZER FORCECREATE [paramsboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Contains parameters for By activating this option, database instances will be created with the XQuery functions [[SerializationDatabases#XML Documents|serializingfn:doc]] query results:* Keys and values are separated by equality signs.* Multiple parameters are delimited by commas.* The option can also be used on [[Startup OptionsDatabases#BaseX StandaloneXML Documents|command linefn:collection]] with the flag <code>.|} ===CHECKSTRINGS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CHECKSTRINGS [boolean]}}|-s</code>.| '''Default'''|{{Code|true}}
|-
| '''ExampleSummary'''|By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>encoding=US-ASCII,omit-xml-declaration=nothese 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: sets the encoding to {{Codecreate]], [[Archive Module#archive:extract-text|USarchive:extract-ASCII}} text]], [[Archive Module#archive:update|archive:update]], and prints the XML declaration[[ZIP Module#zip:text-entry|zip:text-entry]].
|}
===EXPORTERLSERROR=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LSERROR [error]}}|-| '''Default'''|{{Code|0}}|-| '''Summary'''|This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if {{Code|0}} is assigned, the error value is calculated dynamically. See [[Full-Text#Fuzzy_Querying|Fuzzy Querying]] for more details.|} ===RUNQUERY=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|EXPORTER RUNQUERY [paramsboolean]}}
|-
| '''Default'''
|''empty''{{Code|true}}
|-
| '''Summary'''
|Contains parameters for exporting all resources of Specifies if a database; see query will be executed or parsed only. This option can also be changed on [[SerializationCommand-Line Options#BaseX Standalone|command line]] for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commasvia <code>-R</code>.
|}
===XMLPLANRUNS=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|XMLPLAN RUNS [booleannum]}}
|-
| '''Default'''
|{{Code|false1}}
|-
| '''Summary'''
|Prints Specifies how often a query will be evaluated. The result is serialized only once, and the execution plan measured times are averages of an XQuery expression in its XML representationall runs. This option can also be activated changed on [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-xr</code>.
|}
=Serialization Options= =COMPPLAN==SERIALIZE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|COMPPLAN SERIALIZE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>. |} ===SERIALIZER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|SERIALIZER [params]}}|-| '''Default'''|''empty''|-| '''Summary'''|Parameters for [[Serialization|serializing]] query results. The string must comply with the query plan before or after 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 compilation stepflag <code>-s</code>.|-| '''Examples'''|* <code>indent=no</code> : disables automatic indentation of XML nodes. Query plans might change due 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 optimizations{{Code|US-ASCII}} and prints the XML declaration.* <code>item-separator=,,</code> : separates serialized items by a single comma.
|}
===DOTPLANEXPORTER=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTPLAN EXPORTER [booleanparams]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|Visualizes Contains parameters for exporting resources of a database and writing files after updates via the execution plan of an XQuery expression with [http://www{{Option|WRITEBACK}} option.graphvizKeys and values are separated by equality signs, multiple parameters are delimited by commas.org dottySee [[Serialization]] and saves its dot file in for more details.|-| '''Examples'''|* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the query directoryXML declaration.
|}
===DOTCOMPACTXMLPLAN=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTCOMPACT XMLPLAN [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Chooses a compact dot 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>.
|}
===DOTDISPLAYCOMPPLAN=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTDISPLAY COMPPLAN [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Visualizes Generates the dot representation query plan, which can be activated via {{Option|XMLPLAN}}, before or after the query executioncompilation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>.
|}
===DOTTYFULLPLAN=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTTY FULLPLAN [pathboolean]}}
|-
| '''Default'''
|{{Code|dottyfalse}}
|-
| '''Summary'''
|Location Attaches the file path, line and column of the {{Code|dotty}} executableexpressions in the original query string to the query plan. Values (items and sequences) have no input information attached.
|}
===AUTOFLUSH===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|AUTOFLUSH [boolean]}}
|-
|-
| '''Summary'''
|Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the [[Commands#FLUSH{{Command|FLUSH]] }} command.
|}
===WRITEBACK===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|WRITEBACK [boolean]}}
|-
|-
| '''Summary'''
|Updates Propagates updates on main-memory instances of files that have been retrieved via [[Databases#XML nodes are written Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] back to the input files. No backups of your original files will be created if this option is turned on. disk:* This option can also be activated on [[Startup 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===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|MAXSTAT [num]}}
|-
|-
| '''Summary'''
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO{{Command|INFO INDEX]]</code> }} command.
|}
=Changelog=
 
;Version 9.6
* Added: {{Option|UNROLLLIMIT}}
 
;Version 9.5
* Updated: {{Option|INLINELIMIT}}: default reduced to 50.
* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response
 
;Version 9.4
* Added: {{Option|LOGTRACE}}
 
;Version 9.3
* Added: {{Option|WITHDB}}, {{Option|GZIP}}
 
;Version 9.2
* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}
* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
 
;Version 9.0
* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
 
;Version 8.6
* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}
* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)
* Removed: {{Code|QUERYPATH}} (will now be internally assigned)
* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ)
 
;Version 8.5
* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added.
 
;Version 8.4
* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}
* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)
* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code>
 
;Version 8.3
* Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}}
 
;Version 8.2
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
 
;Version 8.1
* Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}}
 
;Version 8.0
* Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}}
* Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored.
 
;Version 7.8.1
* Updated: {{Option|ADDARCHIVES}}: parsing of TAR and TGZ files.
 
;Version 7.8
 
* Added: {{Option|CSVPARSER}}, {{Option|JSONPARSER}}, {{Option|TEXTPARSER}}, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}}
* Updated: {{Option|WRITEBACK}} only applies to main-memory document instances.
* Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions.
* Updated: default of {{Option|INTPARSE}} is now {{Code|false}}.
* Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
 
;Version 7.7
* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}}
;Version 7.6
 * Added: <code>[[#GLOBALLOCK{{Option|GLOBALLOCK]]</code>}}
* 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: <code>[[#USER{{Option|USER]]</code>}}, <code>[[#PASSWORD{{Option|PASSWORD]]</code>}}, <code>[[#LOG{{Option|LOG]]</code>}}, <code>[[#LOGMSGMAXLEN{{Option|LOGMSGMAXLEN]]</code>}}, <code>[[#WEBPATH{{Option|WEBPATH]]</code>}}, <code>[[#RESTXQPATH{{Option|RESTXQPATH]]</code><code>[[#HTTPLOCAL}}{{Option|HTTPLOCAL]]</code>}}, <code>[[#CREATEONLY{{Option|CREATEONLY]]</code>}}, <code>[[#STRIPNS{{Option|STRIPNS]]</code>}}
* 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: <code>[[#KEEPALIVE{{Option|KEEPALIVE]]</code>}}, <code>[[#TIMEOUT{{Option|TIMEOUT]]</code>}}: 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: <code>[[#PROXYHOST{{Option|PROXYHOST]]</code>}}, <code>[[#PROXYPORT{{Option|PROXYPORT]]</code>}}, <code>[[#NONPROXYHOSTS{{Option|NONPROXYHOSTS]]</code>}}, <code>[[#HTMLOPT{{Option|HTMLOPT]]</code>}}* Updated: <code>[[#TIMEOUT{{Option|TIMEOUT]]</code>}}: ignore timeout for admin users
;Version 7.1
 * Added: <code>[[#ADDRAW{{Option|ADDRAW]]</code>}}, <code>[[#MAXLEN{{Option|MAXLEN]]</code>}}, <code>[[#MAXCATS{{Option|MAXCATS]]</code>}}, <code>[[#UPDINDEX{{Option|UPDINDEX]]</code>}}* Updated: <code>[[#BINDINGS{{Option|BINDINGS]]</code>}}
;Version 7.0
 * Added: <code>[[#SERVERHOST{{Option|SERVERHOST]]</code>}}, <code>[[#KEEPALIVE{{Option|KEEPALIVE]]</code>}}, <code>[[#AUTOFLUSH{{Option|AUTOFLUSH]]</code>}}, <code>[[#QUERYPATH{{Option|QUERYPATH]]</code>}}
administrator, editor
4

edits

Navigation menu