Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
m
The {{Code|.basex}} * '''[[Configuration#Configuration FilesGlobal Options|configuration fileGlobal Options]] ''' are valid for all BaseX instances in the same JVM. This is parsed by every new local BaseX instanceparticularly relevant if you are working with the client/server architecture. It contains * '''Local options''' (all global options and, optionally, local options at the end of the fileremaining ones) are specific to a client or session.
* If using the Mac OS X packaged application then global options can be set within the Info# Local OptionsCATALOG = etc/w3-catalog.plist file within the Contents folder of the application package. For example:xml</syntaxhighlight>
<key>JVMOptions<* Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [https://docs.oracle.com/en/java/javase/11/key> <array> <string>tools/java.html -DorgD flag] on command line, or using [https://docs.basexoracle.com/en/java/javase/11/docs/api/java.CHOP=false<base/string> <java/array>lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example:
* In XQuery, local options can be set via option declarations and pragmas (see [[XQuery Extensions]])<syntaxhighlight lang="perl">java -Dorg.basex.CATALOG=etc/w3-catalog.xml -cp basex.jar org.basex.BaseX -c"SHOW OPTIONS catalog"CATALOG: etc/w3-catalog.xml</syntaxhighlight>
If BaseX is run as web servlet, the Most HTTP options must be specified 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 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:
{{Mark|Introduced with Version 8.4:}}
{{Mark|Introduced with Version 8.4:}}
|}
===XQUERY3===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|XQUERY3}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Enables all [[XQuery 3.0]] features supported by BaseX. If this option is set to {{Code|false}}, the XQuery parser will only accept expressions of the XQuery 1.0 specification.
Text replacement - "[[Jobs Module" to "[[Job Module"
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:
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 [[Commands#GET{{Command|GET]] SHOW OPTIONS}} command. Local options can be changed via [[Commands#{{Command|SET}} (all global options, except for {{Option|SET]]. All values are ''static'': They stay valid until they are DEBUG}}, can only be changed once again by another operationat startup time). If an option is of type ''boolean'', and if no value is specified, its current value will be inverted.
* Initial values for global options can also be specified via system properties, which can eThe {{Code|.g. be passed on with the basex}} [[http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.htmlConfiguration#options -D flagConfiguration Files|configuration file] 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 is parsed by every new local BaseX instance. The It contains all global options. Local options can be specified keys need to be prefixed with at the end of the file after the {{Code|org.basex.Local Options}}. An examplecomment:
<pre classsyntaxhighlight lang="brush:bashperl">java -Dorg.basex.CHOP# General OptionsDEBUG =false -cp basex.jar org.basex.BaseX -c"get chop"CHOP: false</pre>
* If the Mac OS X packaged application is used, 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.CATALOG=etc/w3-catalog.xml</string></array></syntaxhighlight> * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows: <syntaxhighlight lang="xml"><context-param> <param-name>org.basex.catalog</param-name> <param-value>etc/w3-catalog.xml</param-value></context-param></syntaxhighlight> * In XQuery, local options can be set via option declarations and [[XQuery Extensions#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=
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DEBUG [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DBPATH [path]}}
|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> or <code>[[Configuration#Database Directory|{home}/data]]</code>|-valign="top"
| '''Summary'''
|Points to the directory in which all databases are located.
|}
===LOGPATH===
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|LOGPATH [path]}}
|- valign="top"
| '''Default'''
|<code>.logs</code>
|- valign="top"
| '''Summary'''
|Points to the directory in which all [[Logging|log files]] are stored. Relative paths will be resolved against the {{Option|DBPATH}} directory.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|REPOPATH [path]}}
|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXReporepo]]</code>|-valign="top"
| '''Summary'''
|Points to the [[Repository]], in which all XQuery modules are located.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LANG [language]}}
|-valign="top"
| '''Default'''
|{{Code|English}}
|-valign="top"
| '''Summary'''
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LANGKEY [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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.
|}
===GLOBALLOCKFAIRLOCK===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|GLOBALLOCK FAIRLOCK [boolean]}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"| '''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.|} ===CACHETIMEOUT=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|CACHETIMEOUT [seconds]}}|- valign="top"| '''Default'''|{{Code|3600}}|- valign="top"
| '''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 ManagementJob Module|asynchronously executed]] provides more details on concurrency control, will be cached in main memory.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|HOST [host]}}
|-valign="top"
| '''Default'''
|{{Code|localhost}}
|-valign="top"
| '''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 Options#BaseX Client|command line]] via <code>-n</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|1984}}
|-valign="top"
| '''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 Options#BaseX Client|command line]] via <code>-p</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SERVERPORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|1984}}
|-valign="top"
| '''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>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|USER [name]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Represents a user nameusername, 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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PASSWORD [password]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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 authentication will only be possible if the client specifies supplies 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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|AUTHMETHOD [method]}}
|-valign="top"
| '''Default'''
|''Basic''
|-valign="top"
| '''Summary'''
|Specifies the HTTP Authenticationdefault authentication method, which will be proposed used by the [[Web Application|HTTP server]] if a client sends an unauthorized requestfor negotiating credentials. Allowed values are {{Code|Basic}} , {{Code|Digest}}, and {{Code|DigestCustom}}:<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.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SERVERHOST [host|ip]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|This is the host name or ip 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.
|}
{| width='100%' width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PROXYHOST [host]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|This is the host name of a proxy server. If the value is an empty string, it will be ignored.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PROXYPORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|0}}
|-valign="top"
| '''Summary'''
|This is the port number of a proxy server. If the value is set to {{Code|0}}, it will be ignored.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|NONPROXYHOSTS [hosts]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored.
===IGNORECERT===
{{Announce|Updated with Version 10}}: Additionally disable hostname verification.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|IGNORECERT [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|This option can be turned on to Disable SSL hostname verification and ignore untrusted certificates when connecting to servers. Please use this option carefully.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TIMEOUT [seconds]}}
|-valign="top"
| '''Default'''
|{{Code|30}}
|-valign="top"
| '''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]].
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|KEEPALIVE [seconds]}}
|-valign="top"
| '''Default'''
|{{Code|600}}
|-valign="top"
| '''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}}.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PARALLEL [number]}}
|-valign="top"
| '''Default'''
|{{Code|8}}
|-valign="top"
| '''Summary'''
|Denotes the maximum allowed {{Code|number}} of parallel [[Transaction Management|transactions]]:* If {{Option|FAIRLOCK}} is enabled, the number of parallel transactions will never exceed the specified value.<br/>Note * If the option is disabled (which is the default), the limit only applies to transactions that a 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. The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LOG [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|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>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LOGMSGMAXLEN [length]}}
|-valign="top"
| '''Default'''
|{{Code|1000}}
|-valign="top"
| '''Summary'''
|Specifies the maximum length of a single [[Logging|log message]].
|}
===LOGTRACE===
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|LOGTRACE [boolean]}}
|- valign="top"
| '''Default'''
|{{Code|true}}
|- valign="top"
| '''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 Services==
===WEBPATH===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|WEBPATH [path]}}
|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code> or <code>[[Configuration#Database Directory|{home}/webapp]]</code>|-valign="top"
| '''Summary'''
|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files. This :* 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%'|- valign="top"| width='120' | '''Signature'''|{{Code|GZIP [boolean]}}|- valign="top"| '''Default'''|<code>false</code>|- valign="top"| '''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.* In addition to the [https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 Jetty defaults] (GET requests, exclusion of binaries, MSIE 6.0, etc.), POST and PUT requests are supported.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|RESTXQPATH [path]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the [[#WEBPATH{{Option|WEBPATH]] }} directory.
|}
===CACHERESTXQPARSERESTXQ===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CACHERESTXQPARSERESTXQ}}|-valign="top"
| '''Default'''
|{{Code|false3}}|-valign="top"| '''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=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|RESTXQERRORS}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"
| '''Summary'''
|Caches [[Reports parsing errors in XQuery modules in the RESTXQ]] modules once when starting directory and returns the full error message and stack trace to the web applicationclient.<br/>The By default, this option is helpful in productive environments with enabled. In a high loadproduction environment, but files it can be disabled to suppress errors that should not be replaced while seen by the user of an API (the web server is runningfull error information can still be looked up in the database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|RESTPATH [path]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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 [[#WEBPATH{{Option|WEBPATH]] }} directory.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|HTTPLOCAL [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|By default, if BaseX is run as [[Web Application]], a the database server instance will be started as soon as the first HTTP service is called. The server in addition, which can then be addressed by other BaseX clients in parallel to [[Clients]] via the HTTP servicesdatabase port (see {{Option|PORT}}).<br/>If the option is set to {{Code|falsetrue}}, the no database server will be disabledlaunched.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|STOPPORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|89858081}}|-valign="top"
| '''Summary'''
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MAINMEM [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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 this option * It is not possible to store binary resources in a main-memory database.* A main-memory database will be assigned once have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new databasefrom the exported file in a second step.* This option will not be available for {{Function|Database|db:create}}, and cannot because the database would not be changed accessible anymore after thatdatabase creation, i. e., outside the query scope.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ADDCACHE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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).
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CREATEFILTER [filter]}}
|-valign="top"
| '''Default'''
|{{Code|*.xml}}
|-valign="top"
| '''Summary'''
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ADDARCHIVES [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ARCHIVENAME [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If this option is set to {{Code|true}}, the file name of parsed archives will be included in the document paths.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SKIPCORRUPT [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ADDRAW [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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).
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PARSER [type]}}
|-valign="top"
| '''Default'''
|{{Code|XML}}
|-valign="top"
| '''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://home.ccil.org/~cowan/XML/tagsoup/ [Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CSVPARSER [options]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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 listed described in the [[CSV Module#Options|CSV Module]].|- valign="top"| '''Examples'''|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|JSONPARSER [options]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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 listed described in the [[JSON Module#Options|JSON Module]].|- valign="top"| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|HTMLPARSER [options]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Specifies the way how HTML data will be parsed. Available Keys and values are delimited with <code>=</code>, and multiple options are listed delimited with <code>,</code>. The available options are described in the [[Parsers#Options|Parsers]] article.|- valign="top"| '''Examples'''|* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.* <code>lexical=true</code> preserves comments.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TEXTPARSER [options]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Specifies the way how TEXT data will be parsed. Available 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"| '''Examples'''|<code>lines=true</code> creates a single element for each line of text.
|}
==XML Parsing==
===CHOPSTRIPWS=== {{Announce|Updated with Version 10:}} Renamed (before: {{Code|CHOP}}), new default: {{Code|false}}.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CHOP STRIPWS [boolean]}}|-valign="top"
| '''Default'''
|{{Code|truefalse}}|-valign="top"
| '''Summary'''
|Many XML documents include whitespaces that have been added to improve readability. The {{Code|CHOP}} This option controls the [httphttps://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:* By default, this If the option is set to {{Code|true}}. This way, leading and trailing whitespaces from text nodes will be chopped stripped, and all empty text nodes will be discarded.* The flag should be turned off disabled if a document contains [[Full-Text#Mixed Content|mixed content]].* The flag can also be turned off on via the [[Command-Line Options#BaseX Standalone|command line]] via and <code>-w</code>.* If the option is enabled, whitespaces of an element and its descendants can locally be preserved with 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 classsyntaxhighlight lang="brush:xml">
<xml>
<title>
Demonstrating the CHOP STRIPWS flag
</title>
<text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text>
</xml>
</presyntaxhighlight>If whitespaces are stripped, <code>indent=yes</code> can be assigned to the {{Option|SERIALIZER}} option to get properly indented XML output.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|STRIPNS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Strips all namespaces from an XML document and all elements while parsing.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|INTPARSE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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> (�)* 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.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DTD [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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]] CATALOG}} option can be changed to locally resolve DTDs.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|XINCLUDE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''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 [[#INTPARSE{{Option|INTPARSE]]}}).
|}
===CATFILECATALOG=== {{Announce|Updated with Version 10:}} Renamed from <code>CATFILE</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CATFILE CATALOG [path]}}|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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 values of the index options will be stored in considered if a newly new database is created database, and will be updated if indexes if the . See [[Commands#OPTIMIZE|OPTIMIZEIndexes]] command or the [[Database_Module#db:optimize|db:optimize]] function is calledfor more details.
===TEXTINDEX===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TEXTINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes. See [[IndexesIndex#Value IndexesText Index|IndexesText Index]] for more details.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ATTRINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[IndexesIndex#Value IndexesAttribute Index|IndexesAttribute Index]] for more details.
|}
===TOKENINDEX===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TOKENINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See [[IndexesIndex#Value IndexesToken Index|IndexesToken Index]] for more details.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|FTINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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 [[IndexesIndex#Value IndexesFull-Text Index|IndexesFull-Text Index]] for more details.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TEXTINCLUDE [names]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ATTRINCLUDE [names]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TOKENINCLUDE [names]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|FTINCLUDE [names]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MAXLEN [int]}}
|-valign="top"
| '''Default'''
|{{Code|96}}
|-valign="top"
| '''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]].
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MAXCATS [int]}}
|-valign="top"
| '''Default'''
|{{Code|100}}
|-valign="top"
| '''Summary'''
|Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|UPDINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If turned on, incremental indexing will be applied 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 {{Function|Database|db:optimize}} and {{Code|true()}} as second argument.* With After each update, the text and attributes value indexes will be refreshed as well.* The advantage is that Incremental updates are currently not available for the value full-text index structures will always be up-to-dateand database statistics.* However, updates will usually take longer (Find more details in the article on [[Index#Updates|Index Structures]] provides more details).* The value of this option will be assigned once to a new database. It can be reassigned by running [[Commands#OPTIMIZE|OPTIMIZE ALL]] or [[Database_Module#db:optimize|db:optimize($db, true())]].
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|AUTOOPTIMIZE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If turned on, auto optimization will be applied to new databases:
* 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 [[Commands#OPTIMIZE|OPTIMIZE]] or [[Database_Module#db:optimize|db:optimize]].|} ===INDEXSPLITSIZE=== {| width='100%'|-| width='120' | '''Signature'''|{{CodeCommand|INDEXSPLITSIZE [num]OPTIMIZE}}|-| '''Default'''|or {{CodeFunction|Database|0db:optimize}}|-| '''Summary'''|This option affects the [[Indexes#Index Construction|construction]] of new text and attribute indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied. By setting the value to its maximum (2147483647), the index will never be split.
|}
===FTINDEXSPLITSIZESPLITSIZE===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|FTINDEXSPLITSIZE SPLITSIZE [num]}}|-valign="top"
| '''Default'''
|{{Code|0}}
|-valign="top"
| '''Summary'''
|This option affects the [[Indexes#Index ConstructionPerformance|construction]] of new full-text value indexes. It specifies 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 dynamic split heuristics are applied, based on the current memory consumption. By setting Usually, this works fine.* If explicit garbage collection is disabled when running Java (e.g. via the value JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to its maximum choose a custom split size.* You can e. g. start with {{Code|1000000}} (2147483647one million)index operations and adjust this value in the next steps.* The larger the assigned value is, the index less splits will take place, and the more main memory will never be splitrequired.
|}
==Full-TextIndexing==
===STEMMING===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|STEMMING [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If {{Code|true}}, all tokens will be stemmed during full-text indexing, using a language-specific stemmer implementation. By default, token tokens will not be stemmed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
| width='120' | '''Signature'''
|{{Code|CASESENS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|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.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DIACRITICS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|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.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LANGUAGE [lang]}}
|-valign="top"
| '''Default'''
|{{Code|en}}
|-valign="top"
| '''Summary'''
|The specified language will influence the way how an input text texts will be tokenizedand 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.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|STOPWORDS [path]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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 releases or available online at http://files.basex.org/etc/stopwords.txtmore details.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|QUERYINFO [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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>.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MIXUPDATES}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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 {{Code|false}}, because the XQuery Update Facility does not allow an updating query to . See [[XQuery Update#Returning Results|return resultsReturning Results]]for more details.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|BINDINGS [vars]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Contains external variables to be bound to a query. The string must comply with the following rules:
* 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 [httphttps://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>.
|-valign="top"
| '''Examples'''
|
* <code>a=1,,2</code> binds the value {{Code|1,2}} to the variable $a
* <code>{URI}a=x</code> 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}}:<pre classsyntaxhighlight lang="brush:xmlxquery">
SET BINDINGS GREETING="hello world!"
XQUERY declare variable $GREETING external; $GREETING
</presyntaxhighlight>|} ===INLINELIMIT=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|INLINELIMIT}}|- valign="top"| '''Default'''|{{Code|50}}|- valign="top"| '''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 {{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).|} ===UNROLLLIMIT=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|UNROLLLIMIT}}|- valign="top"| '''Default'''|{{Code|5}}|- valign="top"| '''Summary'''|This option controls the unroll limit:* Loops with few iterations are ''unrolled'' by the XQuery compiler to enable further optimizations.* If the limit is increased, more optimizations will take place, but the memory consumption and compile time will increase.* See [[XQuery Optimizations#Loop Unrolling|Loop Unrolling]] for more details.
|}
===QUERYPATHENFORCEINDEX===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|QUERYPATH ENFORCEINDEX [pathboolean]}}|-valign="top"
| '''Default'''
|''empty''{{Code|false}}|-valign="top"
| '''Summary'''
|Contains the Enforces index rewritings in path (''base URI'') to the executed query (default: ''empty'')expressions. This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a querySee [[Indexes#Enforce Rewritings|Enforce Rewritings]] for details.
|}
===INLINELIMITCOPYNODE===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|INLINELIMITCOPYNODE [boolean]}}|-valign="top"
| '''Default'''
|{{Code|100true}}|-valign="top"
| '''Summary'''
|The When creating new nodes in XQuery compiler inlines functions to speed up query evaluationvia [https://www. Inlining will only take place if a function body is not too large (i.ew3.org/TR/xquery-31/#id-constructors Node Constructors], if it does not contain too many expressions). With this option, this maximum number copies of expressions can all enclosed nodes will be specifiedcreated, and the copied nodes get new node identities.As a result, the following query yields <code>false</code>:<syntaxhighlight lang="xquery">let $a := <a/>let $b := <b>{ $a }</b>return $b/a is $a<br/syntaxhighlight>Function inlining This step can be turned off by setting very expensive and memory consuming. If the value option is disabled, child nodes will only be linked to {{Code|0}}the new parent nodes, and the upper query returns <code>true</code>. <br>The limit can option should be locally overridden via used carefully as it changes the <code>semantics of XQuery. It should preferably be used in [[XQuery_3.0XQuery Extensions#AnnotationsDatabase Pragmas|%basex:inlinePragmas]]</code> annotation.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TAILCALLS}}
|-valign="top"
| '''Default'''
|{{Code|256}}
|-valign="top"
| '''Summary'''
|Specifies how many stack frames of [httphttps://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=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|WITHDB}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|By default, resources specified via {{Code|fn:doc}} and {{Code|fn:collection}} are looked up both in the database and in the file system. If you always use {{Function|Database|db:get}} to access databases, it is recommendable to disable this option:* No locks will be created for the two functions (see [[Transaction Management#Limitations|limitations of database locking]] for more details).* Access to local and external resources will be faster, as the database lookup will be skipped.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DEFAULTDB}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If this option is turned on, paths specified in the {{Code|fn:doc}} and {{Code|fn:collectionscollection}} functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the [[Commands#OPEN{{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]].
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|FORCECREATE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|By activating this option, database instances will be created with the XQuery functions {{Code|fn:doc()}} and {{Code|fn:collection()}} functions will create database instances for the addressed input files.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CHECKSTRINGS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|If this option is turned offBy default, strings characters from external sources that are invalid in XML will be adopted as trigger an error. If the option isset to <code>false</code>, i. ethese characters will be replaced with the Unicode replacement character <code>FFFD</code> (�)., without being checked for valid XML characters:* This The option affects [[Java Bindings]] and the string conversion and input functions [[such as {{Function|Archive Module#archive:create|archive:create]]}}, [[{{Function|Archive Module#archive:extract-text|archive:extract-text]]}}, [[and {{Function|Archive Module#|archive:update}}.|} ===WRAPJAVA=== {| width='100%'|archive:update- valign="top"| width='120' | '''Signature'''|{{Code|WRAPJAVA [mode]], [[Conversion Module#convert:binary}}|-tovalign="top"| '''Default'''|{{Code|some}}|-stringvalign="top"| '''Summary'''|convertDefines the way how values that result from Java code invocation will be converted to XQuery items. Allowed values:binary-to-string]]{{Code|none}}, {{Code|all}}, [[Fetch Module#fetch:text{{Code|fetch:text]]some}}, [[File Module#file:read-text{{Code|file:read-text]]instance}}, and {{Code|void}}. See [[ZIP ModuleJava_Bindings#zip:text-entryConversion to XQuery|zip:text-entryJava Bindings]].* Please be aware that an inconsiderate use of this option may cause unexpected behavior when storing or outputting stringsfor further details.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LSERROR [error]}}
|-valign="top"
| '''Default'''
|{{Code|0}}
|-valign="top"
| '''Summary'''
|This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if {{Code|0}} is assigned, the BaseX-specific fuzzy match optionerror value is calculated dynamically. See the page on [[Full-Text#Fuzzy_Querying|Full-TextsFuzzy Querying]] for more information on fuzzy queryingdetails.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|RUNQUERY [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|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>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|RUNS [num]}}
|-valign="top"
| '''Default'''
|{{Code|1}}
|-valign="top"
| '''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 Options#BaseX Standalone|command line]] via <code>-r</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SERIALIZE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''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>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SERIALIZER [params]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Parameters for [[Serialization|serializing]] query results. The string must comply with the following rules:* Variable names and values must be are separated by equality signs.* Multiple variables must be are delimited by commas.* Commas in values must be duplicatedif they appear as literals in values.
The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
|-valign="top"
| '''Examples'''
|
* <code>indent=yes</code> : enables automatic indentation of XML nodes. This is recommended if whitespaces have been stripped from a document (see {{Options|STRIPWS}}).
* <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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|EXPORTER [params]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Contains parameters for exporting all resources of a database; see [[Serialization]] for more detailsand 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.|- valign="top"| '''Examples'''|* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|XMLPLAN [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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>.
|}
===COMPPLANFULLPLAN===
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|COMPPLAN FULLPLAN [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Generates the query plan, which can be activated via [[#XMLPLAN|XMLPLAN], before or after query compilation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>. |} ===DOTPLAN=== {| width='100%'|-| widthvalign='120' | '''Signature'''|{{Code|DOTPLAN [boolean]}}|-"top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Visualizes Attaches the execution plan file path, line and column of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file the expressions in the original query string to the query directoryplan.|} ===DOTCOMPACT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|DOTCOMPACT [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Chooses a compact dot representationValues (items and sequences) have no input information attached.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|AUTOFLUSH [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''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.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|WRITEBACK [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Propagates updates on main-memory instances of files that have been retrieved via {{Code|fn:doc}} or and {{Code|fn:collection}} back to disk. :* This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>. * Please note take in mind that, when turning this option on, no backup will be created from your original files will not .* The serialization options can be backed upcontrolled via the {{Option|EXPORTER}} option.
|}
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MAXSTAT [num]}}
|-valign="top"
| '''Default'''
|{{Code|30}}
|-valign="top"
| '''Summary'''
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO{{Command|INFO INDEX]]</code> }} command.
|}
=Changelog=
;Version 10.0
* Removed: <code>COMPPLAN</code>, <code>IGNOREHOSTNAME</code>
* Updated: {{Option|IGNORECERT}}: Additionally disable hostname verification.
* Updated: {{Option|CATALOG}}: Renamed (before: {{Code|CATFILE}}).
* Updated: {{Option|STRIPWS}}: Renamed (before: {{Code|CHOP}}), new default: false.
;Version 9.7
* Updated: {{Option|GZIP}}: Support for POST and PUT requests.
;Version 9.6
* Added: {{Option|UNROLLLIMIT}}, {{Option|WRAPJAVA}}
;Version 9.5
* Updated: {{Option|INLINELIMIT}}: default reduced to 50.
* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response
;Version 9.4
* Added: {{Option|LOGTRACE}}
;Version 9.3
* Added: {{Option|WITHDB}}, {{Option|GZIP}}
;Version 9.2
* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}
* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
;Version 9.0
* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
;Version 8.6
* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}
* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)
* Removed: {{Code|QUERYPATH}} (will now be internally assigned)
* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ)
;Version 8.5
* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added.
;Version 8.4
* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}
* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)
* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code>
;Version 8.3
* Added: <code>[[#CACHERESTXQ{{Option|CACHERESTXQ]]</code>}}, <code>[[#TEXTINCLUDE{{Option|TEXTINCLUDE]]</code>}}, <code>[[#ATTRINCLUDE{{Option|ATTRINCLUDE]]</code>}}, <code>[[#FTINCLUDE{{Option|FTINCLUDE]]</code>}}, <code>[[#ARCHIVENAME{{Option|ARCHIVENAME]]</code>}}
;Version 8.2
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
;Version 8.1
* Added: <code>[[#IGNORECERT{{Option|IGNORECERT]]</code>}}, <code>[[#RESTPATH{{Option|RESTPATH]]</code>}}
;Version 8.0
* Added: <code>[[#MIXUPDATES{{Option|MIXUPDATES]]</code>}}, <code>[[#AUTOOPTIMIZE{{Option|AUTOOPTIMIZE]]</code>}}, <code>[[#AUTHMETHOD{{Option|AUTHMETHOD]]</code>}}, <code>[[#XINCLUDE{{Option|XINCLUDE]]</code>}}* Updated: <code>[[#PROXYPORT{{Option|PROXYPORT]]</code>}}: default set to 0; will be ignored. <code>[[#PROXYHOST{{Option|PROXYHOST]]</code>}}, <code>[[#NONPROXYHOSTS{{Option|NONPROXYHOSTS]]</code>}}: empty strings will be ignored.
;Version 7.8.1
* Updated: <code>[[#ADDARCHIVES{{Option|ADDARCHIVES]]</code>}}: parsing of TAR and TGZ files.
;Version 7.8
* Added: <code>[[#CSVPARSER{{Option|CSVPARSER]]</code>}}, <code>[[#JSONPARSER{{Option|JSONPARSER]]</code>}}, <code>[[#TEXTPARSER{{Option|TEXTPARSER]]</code>}}, <code>[[#HTMLPARSER{{Option|HTMLPARSER]]</code>}}, <code>[[#INLINELIMIT{{Option|INLINELIMIT]]</code>}}, <code>[[#TAILCALLS{{Option|TAILCALLS]]</code>}}, <code>[[#DEFAULTDB{{Option|DEFAULTDB]]</code>}}, <code>[[#RUNQUERY{{Option|RUNQUERY]]</code>}}* Updated: <code>[[#WRITEBACK{{Option|WRITEBACK]]</code> }} only applies to main-memory document instances.* Updated: <code>[[#DEBUG{{Option|DEBUG]]</code> }} option can be changed at runtime by users with admin permissions.* Updated: default of <code>[[#INTPARSE{{Option|INTPARSE]]</code> }} is now {{Code|false}}.* Removed: <code>HTMLOPT</code> (replaced with <code>[[#HTMLPARSER{{Option|HTMLPARSER]]</code>}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
;Version 7.7
* Added: <code>[[#ADDCACHE{{Option|ADDCACHE]]</code>}}, <code>[[#CHECKSTRINGS{{Option|CHECKSTRINGS]]</code>}}, <code>[[#FTINDEXSPLITSIZE{{Option|FTINDEXSPLITSIZE]]</code>}}, <code>[[#INDEXSPLITSIZE{{Option|INDEXSPLITSIZE]]</code>}}
;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>}}
