Changes

Jump to navigation Jump to search
22,568 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. Three data types Two kinds of options exist: strings, numbers, and booleans.
* Values can be changed with the '''[[Commands#SETGlobal Options|SETGlobal Options]] command and requested ''' are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the [[Commands#GET|GET]] commandclient/server architecture. All values are * '''Local options'statically bound'' (all remaining ones) are specific to a database client or session; they stay valid until they are changed once again by another operation. If an option is of type boolean, and if no value is specified, its existing value will be inverted.
* {{Version|7.4}}: Initial values for Values of options can now be specified via system properties, which can e.g. be passed on with the [http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.html#options -D flag] on command lineare either ''strings'', ''numbers'' or using [http://docs''booleans''.oracle.com/javase/6/docs/api/java/lang/System.html#setPropertyOptions are ''static'' and not bound to a single operation (java.lang.Stringfor example,%20java.lang.Stringthe next command) System.setProperty()] before creating a BaseX instance. The specified keys needs Various ways exist to be prefixed with {{Code|org.basex.}}. An exampleaccess and change options:
* The current value of an option can be requested with the {{Command|GET}} command. Local options can be changed via {{Command|SET}} (all global options, except for {{Option|DEBUG}}, can only be changed at startup time). If an option is of type ''boolean'', and if no value is specified, its current value will be inverted. * The {{Code|.basex}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance. It contains all global options. Local options can be specified at the end of the file after the {{Code|Local Options}} comment: <pre classsyntaxhighlight lang="brushperl"># 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 [https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on command line, or using [https:bash//docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example: <syntaxhighlight lang="perl">
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> * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:
* Options can also be set in the prolog of XQuery expressions<syntaxhighlight lang="xml"><context-param> <param-name>org. In the option declaration, keys need to be prefixed with {{Code|db:}}basex. All values will be reset after the evaluation of a query:chop</param-name> <param-value>false</param-value></context-param></syntaxhighlight>
<pre class="brush:xquery">declare * In XQuery, local options can be set via option db:key 'value';declarations and [[XQuery Extensions#Pragmas|pragmas]]...</pre>
* {{Version|7.4}}: Options can be locally set If options are changed by operations in XQuery via pragma expressions. Note that, at least for now, local pragmas will have no effect on most the [[Update|update operationsGUI]], as these the underlying commands will be evaluated at listed in the very end of a query[[GUI#Visualizations|Info View]]. The following query preserves whitespaces from the parsed XML string:<br/><br/>
<pre class="brush:xquery">(# db:chop false #) { parse-xml('<xml> hi </xml>') }</pre>Global Options=
If Global options are implicitly changed by operations constants. They can only be set in the configuration file or via system properties (see above). One exception is the [[GUI#debug|DEBUG]]option, the underlying commands will which can also be listed in the changed at runtime by users with [[GUI#VisualizationsUser Management|Info Viewadmin permissions]].<br/><br/>
=Main =General Options==
The main options are only available from the [[Standalone Mode]] and [[Database Server]] instances of BaseX, i.e., they cannot be changed by database clients. They are stored in the [[Configuration#Configuration Files|.basex config file]], which is opened by every new BaseX instance:===DEBUG===
{| width='100%'|-| width=General=='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. If the option is changed, existing databases will not be moved to the new location.
|}
===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.<br/>'''Note:''' if Relative paths will be resolved against the option is changed, BaseX needs to be restarted in order to activate existing packages and avoid side effects{{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 purposesthe [[Repository]], in which all XQuery modules are located.
|}
===LANG===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LANG [language]}}
|-
|-
| '''Summary'''
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. BaseX needs to be restarted in order to activate the new language.
|}
===LANGKEY===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LANGKEY [boolean]}}
|-
|-
| '''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. BaseX needs to be restarted in order to activate this option.
|}
==Client/Server Architecture=FAIRLOCK===
===HOST==={|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HOST FAIRLOCK [hostboolean]}}
|-
| '''Default'''
|{{Code|localhostfalse}}
|-
| '''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 host name 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 by if the client when connecting to a serverprompt evaluation of update operations is critical.
|}
===PORTCACHETIMEOUT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PORT CACHETIMEOUT [portseconds]}}
|-
| '''Default'''
|{{Code|19843600}}
|-
| '''Summary'''
|This port is used Specifies how many seconds the results of queries, which have been queued by the client when connecting to a server[[Jobs Module|asynchronously executed]], will be cached in main memory.
|}
==Client/Server Architecture=SERVERPORT= ===HOST=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERVERPORT HOST [porthost]}}
|-
| '''Default'''
|{{Code|1984localhost}}
|-
| '''Summary'''
|This host name is used by the port the database client when connecting to a server will . This option can also be listening tochanged when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
|}
===SERVERHOSTPORT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERVERHOST PORT [host&#x7c;ipport]}}
|-
| '''Default'''
|''empty'' (''wildcard''){{Code|1984}}
|-
| '''Summary'''
|This port is used by the host name or ip address the client when connecting to a server is bound to. The server will This option can also be open to all clients if changed when running the option is set to an empty stringclient on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
|}
===EVENTPORTSERVERPORT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|EVENTPORT SERVERPORT [port]}}
|-
| '''Default'''
|{{Code|19851984}}
|-
| '''Summary'''
|This is the port is used by the client database server will be listening to listen for . This option can also be changed when running the server on [[EventsCommand-Line Options#BaseX Server|server eventscommand line]]. This port will only be bound if a client attaches itself to a database eventvia <code>-p</code>.
|}
===HTTPPORTUSER===
{{Mark|Removed in Version 7.4:}} this value is now modified in the {{Code|jetty.xml}} config file, which is located in the [[#WEBPATH|WEBPATH]] directory. {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTTPPORT USER [portname]}}
|-
| '''Default'''
|{{Code|8984}}''empty''
|-
| '''Summary'''
|This Represents a user name, which is used for accessing the port 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 [[StartupCommand-Line Options#BaseX HTTP ServerClient|HTTP Servercommand line]] will be listening tovia <code>-U</code>.
|}
===STOPPORTPASSWORD==={{Mark|Removed in Version 7.4:}} by default, the stop port is now one port smaller than the HTTP port, which is specified in the {{Code|jetty.xml}} file. A custom port can still be assigned via the [[Startup Options#BaseX HTTP Server|command line]] and in the {{Code|pom.xml}} file.{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|STOPPORT PASSWORD [portpassword]}}
|-
| '''Default'''
|{{Code|8985}}''empty''
|-
| '''Summary'''
|This Represents a password, which is used for accessing the server:* The default value will be overwritten if a client specifies its own credentials.* If the port default value is empty, login will only be possible if the client specifies credentials.* The option can also be changed on which the [[StartupCommand-Line Options#BaseX HTTP ServerClient|HTTP Servercommand line]] can be locally closedvia <code>-P</code>.* Please note that it is a security risk to specify your password in plain text.
|}
===HTTPPATHAUTHMETHOD==={{Mark|Removed in Version 7.4:}} this value has been replace with the [[#WEBPATH|WEBPATH]] option.{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTTPPATH AUTHMETHOD [pathmethod]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXHTTP]]</code> or <code>[[Configuration#Database Directory|{home}/http]]</code>''Basic''
|-
| '''Summary'''
|Points to Specifies the default authentication method, which will be used by the [[Web Application|HTTP root directoryserver]] 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, in which HTML files may cannot be storedoverwritten.* With custom authentication, and query files that the server will be evaluated by RESTnot do any authentication.
|}
===WEBPATHSERVERHOST==={{Mark|Introduced in Version 7.4:}} this value is replacing the [[#HTTPPATH|HTTPPATH]] option.{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|WEBPATH SERVERHOST [pathhost&#x7c;ip]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code> or <code>[[Configuration#Database Directory|{home}/webapp]]</code>''empty''
|-
| '''Summary'''
|Points This is the host name or ip address the server is bound to . If the directory, in option is set to an empty string (which all is the [[Web Application]] contents are storeddefault), including XQuery, Script, [[RESTXQ]] and configuration filesthe server will be open to all clients.
|}
===PROXYHOST===
 {|width='100%' width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|PROXYHOST [host]}}
|-
| '''Default'''
|''empty''
|-
| '''Summary'''
|This is the host name of a proxy server. If the value is an empty string, it will be ignored.
|}
===PROXYPORT===
 {|width='100%'
|-
| width='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]}}
|-
| '''Default'''
|''empty''|-| '''Summary'''|This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored.|} ===IGNOREHOSTNAME=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|IGNOREHOSTNAME [boolean]}}|-| '''Default'''|{{Code|false}}
|-
| '''Summary'''
|This If this option is a list enabled, hostnames of hosts that should certificates will not be directly accessedverified. Use {{Option|IGNORECERT}} to completely disable certificate verification.
|}
===PARALLELIGNORECERT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARALLEL IGNORECERT [numberboolean]}}
|-
| '''Default'''
|{{Code|8false}}
|-
| '''Summary'''
|Denotes the maximum allowed This option can be turned on to ignore untrusted certificates when connecting to servers. Use {{CodeOption|numberIGNOREHOSTNAME}} of parallel read [[Transaction Management|transactions]]to suppress only the hostname verification.
|}
===TIMEOUT===
{{Mark|Updated with Version 7.3:}} default value set from {{Code|0}} to {{Code|30}}. {|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.<br/>Write Active update operations will not be affected by this timeout, as this would corrupt the integrity of the database.<br/>The timeout is deactivated if the timeout is set to {{Code|0}}. It is ignored for {{Codeoperations with [[User Management|ADMIN}} operationsadmin permissions]].
|}
===KEEPALIVE===
{{Mark|Updated with Version 7.3:}} default value set from {{Code|0}} to {{Code|600}}. {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|KEEPALIVE [seconds]}}
|-
| '''Summary'''
|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.
|}
 
===PARALLEL===
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|PARALLEL [number]}}
|-
| '''Default'''
|{{Code|8}}
|-
| '''Summary'''
|Denotes the maximum allowed number of parallel [[Transaction Management|transactions]]:
* If {{Option|FAIRLOCK}} is enabled, the number of parallel transactions will never exceed the specified value.
* If the option is disabled (which is the default), the limit only applies to transactions that access databases.
* The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.
|}
===LOG===
{{Mark|Introduced with Version 7.4}} {|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 [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.
|}
===LOGMSGMAXLEN===
{{Mark|Introduced with Version 7.4}} {|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== Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that will be set before the web server is started: ===WEBPATH===
{| width='100%'|-| width='120' | '''Signature'''|{Mark{Code|WEBPATH [path]}}|-|Introduced with Version 7'''Default'''|<code>[[Configuration#Database Directory|{home}/webapp]]</code>|-| '''Summary'''|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:* The option is ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].4:* 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 web options option can only also be modified in 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 file or set via system propertiesfiles 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]}}
|-
| '''Default'''
|<code>''empty''|-| '''Summary'''|Points to the directory which contains the [[RESTXQ]] modules of a web application.</code>Relative paths will be resolved against the {{Option|WEBPATH}} directory.|} ===PARSERESTXQ=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|PARSERESTXQ}}|-| '''Default'''|{{Code|3}}
|-
| '''Summary'''
|Points to Timeout after which the RESTXQ directory which contains will be parsed for changes:* If {{Code|0}} is specified, the [[directory will be parsed every time a RESTXQ]] modules of a web applicationfunction is called.* A positive value defines the idle time in seconds after which parsing will be enforced. By The default, this value is either {{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 by . See [[OptionsRESTXQ#WEBPATHPreliminaries|WEBPATHRESTXQ Preliminaries]], or the {{Code|webapp}} directory of a web applicationfor more details.
|}
===USERRESTXQERRORS=== {{Mark|Updated with BaseX 9.5:}} Additionally suppress stack trace in HTTP response. {| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|USER [name]RESTXQERRORS}}
|-
| '''Default'''
|<code></code>{{Code|true}}
|-
| '''Summary'''
|Represents a Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default user, which this option is used if enabled. In a client accesses production environment, it can be disabled to suppress errors that should not be seen by the user of an HTTP service without specifying a custom user name. If API (the value is empty, full error information can still be looked up in the client is required to pass on credentialsdatabase logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.
|}
===PASSWORDRESTPATH=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PASSWORD RESTPATH [passwordpath]}}
|-
| '''Default'''
|<code></code>''empty''
|-
| '''Summary'''
|Represents a default passwordPoints to the directory which contains XQuery files and command scripts, which is used if a client accesses an HTTP service without specifying a custom passwordcan be evaluated via the [[REST#GET Requests|REST run operation]]. If Relative paths will be resolved against the value is empty, the client is required to pass on credentials{{Option|WEBPATH}} directory.
|}
===SERVERHTTPLOCAL=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERVER HTTPLOCAL [boolean]}}
|-
| '''Default'''
|Standalone: <code>true</code>, Web Application: <code>{{Code|false</code>}}
|-
| '''Summary'''
|Indicates By default, if a database server instance will be opened along with the web server. If BaseX is run as [[Web Application]], the database server instance will be started as soon as in addition, which can then be addressed by [[Clients]] via the database port (see {{Option|PORT}}).<br/>If the first HTTP service option is calledset to {{Code|true}}, no database server will be launched.
|}
===VERBOSESTOPPORT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|VERBOSE STOPPORT [booleanport]}}
|-
| '''Default'''
|<code>false</code>{{Code|8985}}
|-
| '''Summary'''
|Dumps some additional debugging information This is the port on requests and responses which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:* The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}.* The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].* This option can also be changed when running the HTTP server on [[Command-Line Options#BaseX Server|command line]] via <code>-s</code>.
|}
===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 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 [[Database Module#db:create|db:create]], and cannot because the database would not be changed accessible anymore after thatdatabase creation, i. e., outside the query scope.
|}
===CREATEONLYADDCACHE===
{{Mark|Introduced with Version 7.4:}}{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CREATEONLY ADDCACHE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|By defaultIf this option is activated, newly created databases data structures of documents will automatically first be opened in order cached to disk before being added to be available for further processing stepsthe final database. By setting the flag This option is helpful when larger documents need to {{Code|true}}be added, this will be preventedand if the existing heuristics cannot estimate 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://home.ccil.org/~cowan/XML/tagsoup/ [Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.
|}
===PARSEROPTCSVPARSER=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARSEROPT CSVPARSER [options]}}
|-
| '''Default'''
|-
| '''Summary'''
|Defines parser-specific 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; see (except for the additional <code>encoding</code> option) are described in the [[ParsersCSV Module#Options|CSV Module]] for more information.|-| '''Examples'''|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.
|}
===HTMLOPTJSONPARSER==={{Mark|Introduced with Version 7.2:}}{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTMLOPT JSONPARSER [options]}}
|-
| '''Default'''
|-
| '''Summary'''
|Allows to specify TagSoup Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]].|-| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.|} ===HTMLPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|HTMLPARSER [options]}}|-| '''Default'''|''empty''|-| '''Summary'''|Specifies the way how HTML parsing; see data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are described in the [[Parsers#HTML ParserOptions|Parsers]] article.|-| '''Examples'''|* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.* <code>lexical=true</code> preserves comments.|} ===TEXTPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TEXTPARSER [options]}}|-| '''Default'''|''empty''|-| '''Summary'''|HTML ParserSpecifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are listed in the [[Parsers]] article.|-| '''Examples'''|<code>lines=true</code> creates a single element for 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 will be chopped and all empty text nodes will be discarded.* The flag should be turned off if a databasedocument contains [[Full-Text#Mixed Content|mixed content]].* The flag can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>.* If the <code>xml:space="preserve"</code> attribute is attached to an element, and discards empty chopping will be turned off for all descendant text nodes.  In the following example document, the whitespaces in the text nodesof 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. This </text></xml></syntaxhighlight>It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option often reduces ; otherwise the database size by up to 50%serialized documents will automatically be indented.
|}
===INTPARSESTRIPNS=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|INTPARSE STRIPNS [boolean]}}
|-
| '''Default'''
|{{Code|truefalse}}
|-
| '''Summary'''
|Uses the internal XML parser instead of the standard Java Strips all namespaces from an XML parser. The internal parser is faster, more fault tolerant document and supports common HTML entities out-of-the-box, but it does not support all features needed for elements while parsing DTDs.
|}
===STRIPNSINTPARSE==={{Mark|Introduced with Version 7.4:}}{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|STRIPNS INTPARSE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Strips Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the internal parser:* Performance: Documents (in particular small ones) will be parsed faster* Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;)* Entities: around 250 HTML entities will be detected and decodedYou will be able to correctly parse most XML documents with the internal parser. Java’s Xerces parser is still used as default, however, because it supports all namespaces from an features of the XML document before adding it to a databasestandard 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 values will be considered if a new database is created. See [[Indexes]] for more details. ===PATHINDEXTEXTINDEX=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PATHINDEX TEXTINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates a path text index whenever a new database is created. A path text index helps to optimize location paths; see speeds up queries with equality comparisons on text nodes. See [[IndexesIndex#Text Index|Text Index]] for more details.
|}
===TEXTINDEXATTRINDEX=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|TEXTINDEX ATTRINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates a text an attribute index whenever a new database is created. A text An attribute index speeds up queries with equality comparisons on text nodes; see attribute values. See [[IndexesIndex#Attribute Index|Attribute Index]] for more details.
|}
===ATTRINDEXTOKENINDEX=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|ATTRINDEX TOKENINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates an attribute a token index whenever a new database is created. An attribute A token index speeds up queries with equality comparisons on searches for single tokens in attribute values; see . See [[IndexesIndex#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 * The current value of this option will also be assigned to new databases. It can be changed for existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or [[Database_Module#db:optimize|db:optimize($db, true())]].* After each update , the value indexes will be refreshed as well. Incremental updates are currently not available for the full-text index structures (texts and attribute values)database statistics.* Find more details in the article on [[Index#Updates|Index Structures]]. The value of this option |} ===AUTOOPTIMIZE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|AUTOOPTIMIZE [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|If turned on, auto optimization will be assigned once applied to a new databasedatabases:* With each update, outdated indexes and cannot database statistics will be changed after thatrecreated. The advantage of incremental indexes is that * As a result, the value 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 downside is that updates value of this option will take be assigned once to a little bit longernew 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.
|}
===WILDCARDS==Query Options=
{{Mark|Removed in Version 7.3:}} new index supports both fuzzy and wildcard queries.===QUERYINFO===
{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|WILDCARDS QUERYINFO [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>. |} ===MIXUPDATES=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|MIXUPDATES}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for more details.|} ===BINDINGS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|BINDINGS [vars]}}|-| '''Default'''|''empty''|-| '''Summary'''|Contains external variables to be bound to a query. The string must comply with the following rules:* Variable names and values must be separated by equality signs.* Multiple variables must be delimited by commas.* Commas in values must be duplicated.* Variables may optionally be introduced with a leading dollar sign.* If a new fullvariable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [https://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-text index b</code>.|-| '''Examples'''|* <code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a* <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.* In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is createdbound to the variable {{Code|$GREETING}}:<syntaxhighlight lang="xquery">SET BINDINGS GREETING="hello world!"XQUERY declare variable $GREETING external; $GREETING</syntaxhighlight>|} ===INLINELIMIT=== {{Mark|Updated with Version 9.5:}} default reduced to 50. {| width='100%'|-| width='120' | '''Signature'''|{{Code|INLINELIMIT}}|-| '''Default'''|{{Code|50}}|-| '''Summary'''|This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to speed up query evaluation.* Inlining will only take place if a function body is not too large (i.e., if it will does not contain too many expressions).* With this option, this maximum number of expressions can be specified.* Function inlining can be particularly optimized for wildcards expressionsturned off by setting the value to {{Code|0}}. See * The limit can be locally overwritten via the page on [[Full-TextXQuery Extensions#Function Inlining|%basex:inline]]s for annotation (follow the link to get more information on XQuery Full Textfunction inlining).
|}
===SCORINGUNROLLLIMIT===
{{Mark|Removed in Introduced with Version 79.36:}} new scoring model will focus on lengths of text nodes and match options.
{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SCORING [mode]UNROLLLIMIT}}
|-
| '''Default'''
|{{Code|05}}
|-
| '''Summary'''
|A new full-text index will pre-calculate full-text scores. This option enables TF/IDF/based scores in full-text queries and increases main 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 while indexingand compile time will increase. * See the [[Full-TextXQuery Optimizations#ScoringLoop Unrolling|ScoringLoop Unrolling]] for more information on different scoring typesdetails.
|}
=Query Options==ENFORCEINDEX===
===QUERYINFO==={|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|QUERYINFO ENFORCEINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Prints more information on internal query Enforces index rewritings, optimizations, and performancein path expressions. The query info will always be printed in the [[GUI#Visualizations|Info View]] in the GUI, or it can be activated with the See [[Startup_OptionsIndexes#BaseX_StandaloneEnforce Rewritings|-V flagEnforce Rewritings]] on command linefor details.
|}
===XQUERY3COPYNODE=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|XQUERY3COPYNODE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Enables all When creating new nodes in XQuery via [[XQuery 3https://www.w3.0org/TR/xquery-31/#id-constructors Node Constructors]] features supported by BaseX, all enclosed nodes will be copied, and all resulting nodes will get new node identities. If This step can be very expensive, and it can be disabled with this option is set to {{Code|false}}. The option should be used carefully, as it changes the XQuery parser will only accept expressions standard behavior of the XQuery 1.0 specificationIt should preferrably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].
|}
===BINDINGSTAILCALLS=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|BINDINGS [vars]TAILCALLS}}
|-
| '''Default'''
|''empty''{{Code|256}}
|-
| '''Summary'''
|Contains external variables to be bound to a query. Variable names and values are separated by equality signs, and multiple variables are delimited by commas. Variables may optionally be introduced with a leading dollar sign. Commas that occur in the value itself are encoded by duplication. If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or Specifies how many stack frames of [httphttps://wwwen.w3wikipedia.org/TRwiki/xqueryTail_call tail-30/#id-basics Expanded QName Notationcalls]are allowed on the stack at any time.|When this limit is reached, tail-| '''Examples'''|<code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} call optimization takes place and {{Code|2}} to the variables $a and $b<br/><code>a=1,,2</code> &nbsp; binds some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1,2}} to the variable $a<br/><code>{URI}a=x</code> or <code>'URI':a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.
|}
===QUERYPATHWITHDB=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|QUERYPATH [path]WITHDB}}
|-
| '''Default'''
|''empty''{{Code|true}}
|-
| '''Summary'''
|Contains By default, resources specified via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] are looked up both in the path (''base URI'') database and in the file system. If you always use {{Function|Database|db:open}} to access databases, it is recommendable to disable this option:* No locks will be created for the executed query two functions (default: ''empty''see [[Transaction Management#Limitations|limitations of database locking]] for more details). This directory * Access to local and external resources will be used to resolve relative paths to documentsfaster, query modules, and other resources addressed in a queryas the database lookup will be skipped.
|}
===CACHEQUERYDEFAULTDB=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CACHEQUERY [boolean]DEFAULTDB}}
|-
| '''Default'''
|-
| '''Summary'''
|Caches 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 results before returning them to (e.g. by the client. This option may be set to {{CodeCommand|trueOPEN}} if command). If the whole result is needed for further operations (such path does not match any existing resources, it will be resolved as is e.g. the case described in the GUI of BaseX)article on [[Databases#Access Resources|accessing database resources]].
|}
===FORCECREATE===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|FORCECREATE [boolean]}}
|-
|-
| '''Summary'''
|By activating this option, database instances will be created with the XQuery functions [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]].|} ===CHECKSTRINGS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|doc()CHECKSTRINGS [boolean]}} and |-| '''Default'''|{{Code|collection()true}} functions |-| '''Summary'''|By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>, these characters will create database instances for be replaced with the addressed Unicode replacement character <code>FFFD</code> (&#xFFFD;). The option affects [[Java Bindings]] and string conversion and input filesfunctions such as [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], [[Archive Module#archive:update|archive:update]], and [[ZIP Module#zip:text-entry|zip:text-entry]].
|}
===LSERROR===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LSERROR [error]}}
|-
|-
| '''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 details.|} ===RUNQUERY=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|RUNQUERY [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Specifies if a query will be executed or parsed only. This option can also be changed on fuzzy querying[[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>.
|}
===RUNS===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|RUNS [num]}}
|-
|-
| '''Summary'''
|Specify number of runs Specifies how often a query is executed by the [[Commands#XQUERY|XQUERY]] commandwill be evaluated. The result is serialized only serialized 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>.
|}
===SERIALIZE===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|SERIALIZE [boolean]}}
|-
|-
| '''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>.
|}
===SERIALIZER===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|SERIALIZER [params]}}
|-
|-
| '''Summary'''
|Contains parameters Parameters for serializing queries; see [[Serialization|serializing]] for more detailsquery results. Keys The string must comply with the following rules:* Variable names and values are must be separated by equality signs, and multiple parameters are .* Multiple variables must be delimited by commas.* Commas in values must be duplicated.The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
|-
| '''ExampleExamples'''|* <code>indent=no</code> : disables automatic indentation of XML nodes. This is usually a good choice when working with [[Full-Text#Mixed Content|Mixed-Content Data]].* <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.* <code>item-separator=,,</code> : separates serialized items by a single comma.
|}
===EXPORTER===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|EXPORTER [params]}}
|-
|-
| '''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.|-| '''Examples'''|* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
|}
===XMLPLAN===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|XMLPLAN [boolean]}}
|-
|-
| '''Summary'''
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.
|}
===COMPPLAN===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|COMPPLAN [boolean]}}
|-
|-
| '''Summary'''
|Creates Generates the query plan , which can be activated via {{Option|XMLPLAN}}, before or after the query compilation step. Query plans might change due to optimizationsThis option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>.
|}
===DOTPLANFULLPLAN==={||-| width='90' | '''Signature'''|{{Code|DOTPLAN [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file in the query directory.|}
===DOTCOMPACT==={|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTCOMPACT FULLPLAN [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Chooses a compact dot representation.|} ===DOTDISPLAY==={||-| width='90' | '''Signature'''|{{Code|DOTDISPLAY [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Visualizes Attaches the file path, line and column of the dot representation after expressions in the original query executionstring to the query plan.|} ===DOTTY==={||-| width='90' | '''Signature'''|{{Code|DOTTY [path]}}|-| '''Default'''|{{Code|dotty}}|-| '''Summary'''|Location of the {{Code|dotty}} executableValues (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 filesdisk:* This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>. Note * Please take in mind that no backups of backup will be created from your original files will .* The serialization options can be created if this controlled via the {{Option|EXPORTER}} option is turned on.
|}
===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 79.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|STOPPORTGLOBALLOCK}}, (exclusive use of database lock)* Removed: {{Code|HTTPPORTQUERYPATH}}, (will now be internally assigned)* Removed: {{Code|HTTPPATHCACHERESTXQ}}(replaced with PARSERESTXQ) ; Version 8.5* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}* Updated: {{Option|AUTHMETHOD}}: {{Code|jettycustom}} value added. ;Version 8.xml4* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}} configuration file is used instead* Added: set options via system properties{{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code> ;Version 8.3* Added: use pragma expression for changing database options locally{{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}} ;Version 8.2* AddedRemoved: <code>[[#WEBPATH|WEBPATH]]EVENTPORT</code>, <code>[[#STRIPNSCACHEQUERY</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|STRIPNS]]false}}.* Removed: <code>HTMLOPT</code>(replaced with {{Option|HTMLPARSER}}), <code>[[#LOGMSGMAXLEN|LOGMSGMAXLEN]]PARSEROPT</code>(replaced with parser-specific options), <code>[[#LOG|LOG]]DOTDISPLAY</code>, <code>[[#CREATEONLY|CREATEONLY]]DOTTY</code> ;Version 7.7* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}} ; section on [[Version 7.6* Added: {{Option|GLOBALLOCK}}* Added: store local options in configuration file after {{Code|#HTTP Local Options}} comments. ;Version 7.5* Added: options can now be set via system properties* Added: a pragma expression can be used to locally change database options* Added: {{Option|USER}}, {{Option|PASSWORD}}, {{Option|LOG}}, {{Option|LOGMSGMAXLEN}}, {{Option|WEBPATH}}, {{Option|RESTXQPATH}}{{Option|HTTPLOCAL}}, {{Option|CREATEONLY}}, {{Option|STRIPNS}}* Removed: {{Code|HTTP Options]]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