Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
=Main * '''[[#Global Options=|Global Options]]''' are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/server architecture.* '''Local options''' (all remaining ones) are specific to a client or session.
The main Values of options are only available in either ''strings'', ''numbers'' or ''booleans''. Options are ''static'' and not bound to a single operation (for example, the [[Standalone Tutorial|standalone]] next command). Various ways exist to access and [[Server Tutorial|server]] instance of BaseX; they cannot be changed by database clientschange options:
| valign='top' | '''Summary'''|Set the interface languageSends internal debug info to STDERR. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', This option can be turned on to get additional information for development and 'Vietnamese' (default: debugging purposes. It can also be triggered on [[Command-Line Options#BaseX Standalone|command line]] via <code>English-d</code>). BaseX needs to be restarted in order to activate the new language.
| valign='top' | '''Summary'''|Prefix all texts with Points to the internal language keys. This option is helpful for creating new translations. BaseX needs to be restarted directory in order to activate this optionwhich all databases are located.
| valign='top' | '''Summary'''|Set a new database path (default: <code>Points to the directory in which all [[Configuration#Database DirectoryLogging|{home}/BaseXDatalog files]]</code>)are stored. Note: if the database path is changed, existing databases have to Relative paths will be manually moved to resolved against the new location{{Option|DBPATH}} directory.
| valign='top' | '''Summary'''|this <code>path</code> points to Specifies the XQuery package repository (defaultinterface language. Currently, seven languages are available: <code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>)'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.
| valign='top' | '''Summary'''|Set Defines the maximum <code>number</code> 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 readers 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 (default: <code>8</code>first in, first out). This avoids starvation of update operations, and it should be used if the prompt evaluation of update operations is critical.
| valign='top' | '''Summary'''|Show internal debug infoSpecifies how many seconds the results of queries, usually used for development of new features (default: <code>false</code>)which have been queued by the [[Jobs Module|asynchronously executed]], will be cached in main memory.
| valign='top' | '''Summary'''|Used This port is used by the client when connecting to connect a server. This option can also be changed when running the server (default: client on [[Command-Line Options#BaseX Client|command line]] via <code>1984-p</code>).
| valign='top' | '''Summary'''|Port of This is the port the database server (default: will be listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>1984-p</code>).
| valign='top' | '''Summary'''|Server timeout in seconds. The timeout describes Points to the directory which contains the maximum execution time [[RESTXQ]] modules of a client queryweb application. The timeout is deactivated if <code>time</code> is set to <code>0</code> (default: no timeout (<code>0</code>))Relative paths will be resolved against the {{Option|WEBPATH}} directory.
| valign='top' | '''Summary'''|Chop all leading and trailing whitespaces from text nodes while building a By default, if BaseX is run as [[Web Application]], the databaseserver instance will be started in addition, and discard empty text nodes. This option often reduces which can then be addressed by [[Clients]] via the database size by up to 50% port (default: see {{Option|PORT}}).<codebr/>If the option is set to {{Code|true</code>)}}, no database server will be launched.
| valign='top' | '''Summary'''|Use internal XML parser instead of This is the standard Java XML parserport on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:* The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}. * The internal parser option is ignored if BaseX is faster, more fault tolerant and supports common HTML entities out-of-used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].* This option can also be changed when running theHTTP server on [[Command-box, but it does not support all features needed for parsing DTDs. (default: Line Options#BaseX Server|command line]] via <code>false-s</code>).
| valign='top' | '''Summary'''|Parse referenced DTDs If this option is turned on, new databases will be created in main memory:* Most queries will be evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down.* It is not possible to store binary resources in a main-memory database.* A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and resolve XML entities (defaultcreate a new database from the exported file in a second step.* This option will not be available for [[Database Module#db:create|db: <code>false</code>)create]], because the database would not be accessible anymore after database creation, i. e., outside the query scope.
| valign='top' | '''Summary'''|Specify a catalog file 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 locally resolve DTDs; see be added, and if the existing heuristics cannot estimate the Wikipedia entry on [http://eninput size (e.wikipediag.org/wiki/XML_Catalog XML Catalogs] for more details (default: ''empty''when adding directories or sending input streams).
| valign='top' | '''Summary'''|Globbing syntax for filtering input documents (default: <code>*.xml</code>)File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
| valign='top' width='90' | '''SignatureSummary'''|Specifies the way how HTML data will be parsed. Keys and values are delimited with <code>=</code>PARSEROPT [, and multiple options]are delimited with <code>,</code>. The available options are described in the [[Parsers#Options|Parsers]] article.
| valign='top' | '''SummaryExamples'''|Define parser* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-specific options (default: ''empty'')JIS and suppresses namespaces. See [[Parsers|parsers]] page for more information* <code>lexical=true</code> preserves comments.
| valign='top' | '''Summary'''|Create index Defines name patterns for fulltext and speedup queries querying full the parent elements of texts that are indexed. By default, all text (default: <code>falsenodes will be indexed.<br/code>)Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
| valign='top' | '''Summary'''|Write original files back after updatesSpecifies the maximum length for strings to be stored in [[Indexes|index structures]]. As The value of this option will alter your input file make sure you have be assigned once to a new database, and can only be changed by creating a backup before you use this option (default: <code>false</code>)new database or doing a [[Commands#OPTIMIZE|full optimization]].
| valign='top' | '''Summary'''|Use main-memory mode. Now all data is exclusively Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in main memorythe [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. Some queries The value of this option will be evaluated even fasterassigned once to a new database, but the data is lost if BaseX is shut down (default: <code>false</code>)and cannot be changed after that.
| valign='top' | '''Summary'''|Force database creation If turned on, incremental indexing will be enabled:* The current value of this option will be assigned to new databases. It can be changed for unknown documents specified in XQuery expressions existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or [[Database_Module#db:optimize|db:optimize($db, true(default: <code>false</code>))]].* After each update, the value indexes will be refreshed as well. Incremental updates are currently not available for the full-text index and database statistics.* Find more details in the article on [[Index#Updates|Index Structures]].
| valign='top' | '''Summary'''|Stemm full text If {{Code|true}}, all tokens before indexing and decrease index size. Should only will be assigned for stemmed during full -text queries indexing, using stemminga language-specific stemmer implementation. By default, otherwise the full text index could tokens will not be assigned stemmed. See [[Indexes#Full-Text Index|Full-Text Index]] for query speedups (default: <code>false</code>)more details.
| valign='top' | '''Summary'''|Case sensitive full text indexingIf {{Code|true}}, i.e. full text tokens are stored the case sensitive and enables the assignment of the tokens will be preserved during full -text index for indexing. By default, case sensitive queries will be ignored (default: <code>false</code>all tokens will be indexed in lower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
| valign='top' | '''Summary'''|Diacritic sensitive If set to {{Code|true}}, diacritics will be preserved during full -text indexing. By default, idiacritics will be removed.e. full text tokens are stored with diacritics and enables the assignment of the full text index See [[Indexes#Full-Text Index|Full-Text Index]] for diacritic queries (default: <code>false</code>)more details.
| valign='top' | '''Summary'''|Specify stop word list at <code>PATH</code>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, that could this maximum number of expressions can be used e.gspecified. * Function inlining can be turned off by setting the value to decrease the full text index size{{Code|0}}. * The standard stopword list limit can be locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (english) is provided at <code>'etc/xml/stopWords'</code> (default: ''empty''follow the link to get more information on function inlining).
| valign='top' | '''Summary'''|Levenshtein default error used for fuzzy search This option controls the unroll limit:* Loops with BaseX specialized own FTMatchOptionfew iterations are ''unrolled'' by the XQuery compiler to enable further optimizations.* If the limit is increased, emore optimizations will take place, but the memory consumption and compile time will increase.g. error could be <code>2</code> (default: <code>0</code>)* See [[XQuery Optimizations#Loop Unrolling|Loop Unrolling]] for more details.
| valign='top' | '''Summary'''|Show (all) process info (defaultWhen creating new nodes in XQuery via [https: <code>false</code>)/www.w3.org/TR/xquery-31/#id-constructors Node Constructors], all enclosed nodes will be copied, and all resulting nodes will get new node identities. This step can be very expensive, and it can be disabled with this option. The option should be used carefully, as it changes the standard behavior of XQuery. It should preferrably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].
| valign='top' | '''Summary'''|Enable/disable Specifies how many stack frames of [httphttps://wwwen.w3wikipedia.org/TRwiki/xqueryTail_call tail-30/ XQuery 3calls] are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated.0] functions (default: <code>true</code>)The feature can be turned off by setting the value to {{Code|-1}}.
| valign='top' | '''Summary'''|Flag for serialization of 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(e. Ig.eby the {{Command|OPEN}} command). there are If the path does not match any results printed if serialization is turned off (default: <code>true</code>)existing resources, it will be resolved as described in the article on [[Databases#Access Resources|accessing database resources]].
| valign='top' | '''Summary'''|Contains external variables to By activating this option, database instances will be bound to created with the query. Keys XQuery functions [[Databases#XML Documents|fn:doc]] and values are separated by equality signs, multiple variables are separated by commas (default[[Databases#XML Documents|fn: ''empty'')collection]].
| valign='top' | '''Summary'''|Parameters for serializing queriesBy default, characters from external sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (� see ). The option affects [[SerializationJava Bindings]] for more details. Keys and values are separated by equality signsstring conversion and input functions such as [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], [[Archive Module#archive:update|archive:update]], multiple parameters are separated by commas (defaultand [[ZIP Module#zip:text-entry|zip: ''empty'')text-entry]].
| valign='top' | '''Summary'''|Parameters for exporting Defines the documents; see way how values that result from Java code invocation will be converted to XQuery items. Allowed values: {{Code|none}}, {{Code|all}}, {{Code|some}}, {{Code|instance}}, and {{Code|void}}. See [[SerializationJava_Bindings#Conversion to XQuery|Java Bindings]] for more further details. Keys and values are separated by equality signs, multiple parameters are separated by commas (default: ''empty'').
| valign='top' | '''Summary'''|Specify number of runs a query This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if {{Code|0}} is assigned, the error value is executedcalculated dynamically. Results are printed a single time and evaluation times are averages of all runs (default: <code>1</code>)See [[Full-Text#Fuzzy_Querying|Fuzzy Querying]] for more details.
===DOTPLAN==={|width='100%'
| valign='top' | '''Summary'''|Compact dot representation (default: 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>false-z</code>).
| valign='top' | '''SummaryExamples'''|Display dot representation after query execution (default* <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>trueencoding=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.
| valign='top' | '''SummaryExamples'''|Program * <code>PATHindent=no,omit-xml-declaration=no</code> : disables automatic indentation of dotty executable (default: <code>dotty</code>)XML nodes, outputs the XML declaration.
no edit summary
This page is linked from the [[Getting Started]] Section.
The options listed on this page can be requested with influence the way how database [[Commands#GET|GETcommands]] command are executed and changed with the [[Commands#SET|SET]] commandXQuery expressions are evaluated. Three data types exist: strings, numbers, and booleans, which can be turned ON and OFF. If options are internally changed by the [[GUI_Tutorial|GUI]] Two kinds of BaseX, they will be listed in the [[GUI_Views|Info View]]. A [[Options_(Snapshot)|preview page]] contains all options offered by the [httpexist://files.basex.org/releases/latest/ latest stable snapshot].
* 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: <syntaxhighlight lang="perl"># General OptionsDEBUG =false... # Local OptionsCHOP =LANGfalse</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://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</syntaxhighlight> * 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: <syntaxhighlight lang="xml"><context-param> <param-name>org.basex.chop</param-name> <param-value>false</param-value></context-param></syntaxhighlight> * In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]]. If options are changed by operations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/> =Global Options= Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception is the [[#debug|DEBUG]] option, which can also be changed at runtime by users with [[User Management|admin permissions]]. ==General Options== ===DEBUG=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|DEBUG [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>LANG [language]</code>{{Code|false}}
|-
|}
===LANGKEYDBPATH=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|DBPATH [path]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>LANGKEY<code>[[Configuration#Database Directory|{home}/data]]</code>
|-
|}
===DBPATHLOGPATH=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LOGPATH [path]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>DBPATH [path].logs</code>
|-
|}
===REPOPATH===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|REPOPATH [path]}}|-| '''Default'''|<code>[[Configuration#Database Directory|{home}/repo]]</code>|-| '''Summary'''|Points to the [[Repository]], in which all XQuery modules are located.|} ===LANG=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LANG [language]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>REPOPATH [path]</code>{{Code|English}}
|-
|}
===PARALLELLANGKEY=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LANGKEY [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed.|} ===FAIRLOCK=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|FAIRLOCK [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>PARALLEL [number]</code>{{Code|false}}
|-
|}
===DEBUGCACHETIMEOUT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CACHETIMEOUT [seconds]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>DEBUG</code>{{Code|3600}}
|-
|}
===HOST===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|HOST [host]</code>}}
|-
| valign='top' 'Default'''|{{Code|localhost}}|-| '''Summary'''|Used This host name is used by the client when connecting to connect a server. This option can also be changed when running the server (default: client on [[Command-Line Options#BaseX Client|command line]] via <code>localhost-n</code>).
|}
===PORT===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|PORT [port]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>PORT [port]</code>{{Code|1984}}
|-
|}
===SERVERPORT===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|SERVERPORT [port]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>SERVERPORT [port]</code>{{Code|1984}}
|-
|}
===EVENTPORTUSER=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>EVENTPORT {{Code|USER [portname]</code>}}
|-
| valign='top' 'Default'''|''empty''|-| '''Summary'''|Port of the clientRepresents a user name, listening which is used for accessing the server eventsor an HTTP service:* The default value will be overwritten if a client specifies its own credentials. This port * If the default value is empty, login will only used be possible if a the client attaches itself to a database event (default: specifies credentials.* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>1985-U</code>).
|}
===JAXRXPORTPASSWORD=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>JAXRXPORT {{Code|PASSWORD [portpassword]</code>}}
|-
| valign='top' 'Default'''|''empty''|-| '''Summary'''|Port of Represents a password, which is used for accessing the JAX-RX web server:* The default value will be overwritten if a client specifies its own credentials.* If the default value is empty, usually Jetty (default: login will only be possible if the client specifies credentials.* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>8984-P</code>).* Please note that it is a security risk to specify your password in plain text.
|}
===JAXRXPATHAUTHMETHOD=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|AUTHMETHOD [method]}}|-| '''Default'''|''Basic''|-| '''Summary'''|Specifies the default authentication method, which will be used by the [[Web Application|HTTP server]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}:<br/>* If basic access is chosen, the client can still request digest authentication.* This is different for digest access, which cannot be overwritten.* With custom authentication, the server will not do any authentication.|} ===SERVERHOST=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>JAXRXPATH {{Code|SERVERHOST [pathhost|ip]</code>}}
|-
| valign='top' 'Default'''|''empty''|-| '''Summary'''|This local <code>path</code> points is the host name or ip address the server is bound to . If the JAX-RX web directory option is set to an empty string (which is the default: <code>), the server will be open to all clients.|} ===PROXYHOST=== {| width='100%' width='100%'|-| width='120' | '''Signature'''|{{Code|PROXYHOST [host]}}|-| '''Default'''|''empty'' |-| '''Summary'''|This is the host name of a proxy server. If the value is an empty string, it will be ignored.|} ===PROXYPORT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|PROXYPORT [Configuration#Database Directoryport]}}|-| '''Default'''|{{Code|0}}|-| '''Summary'''|This is the port number of a proxy server. If the value is set to {{Code|0}}, it will be ignored.|} ===NONPROXYHOSTS=== {| width='100%'|-| width='120' | '''Signature'''|{home{Code|NONPROXYHOSTS [hosts]}/BaseXWeb}|-| '''Default'''|''empty''|-| '''Summary'''|This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored.|} ===IGNOREHOSTNAME=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|IGNOREHOSTNAME [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|If this option is enabled, hostnames of certificates will not be verified. Use {{Option|IGNORECERT}} to completely disable certificate verification.|} ===IGNORECERT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|IGNORECERT [boolean]</code>)}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|This option can be turned on to ignore untrusted certificates when connecting to servers. Use {{Option|IGNOREHOSTNAME}} to suppress only the hostname verification.
|}
===TIMEOUT===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|TIMEOUT [seconds]}}|-| '''Default'''|{{Code|30}}|-| '''Summary'''|Specifies the maximum time a transaction triggered by a client may take. If an operation takes longer than the specified number of seconds, it will be aborted. Active update operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to {{Code|0}}. It is ignored for operations with [[User Management|admin permissions]].|} ===KEEPALIVE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|KEEPALIVE [seconds]}}|-| '''Default'''|{{Code|600}}|-| '''Summary'''|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.|} ===PARALLEL=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|PARALLEL [number]}}|-| '''Default'''|{{Code|8}}|-| '''Summary'''|Denotes the maximum allowed number of parallel [[Transaction Management|transactions]]:* If {{Option|FAIRLOCK}} is enabled, the number of parallel transactions will never exceed the specified value.* If the option is disabled (which is the default), the limit only applies to transactions that access databases.* The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.|} ===LOG=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LOG [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.|} ===LOGMSGMAXLEN=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LOGMSGMAXLEN [length]}}|-| '''Default'''|{{Code|1000}}|-| '''Summary'''|Specifies the maximum length of a single [[Logging|log message]].|} ===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 Services== Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that will be set before the web server is started: ===WEBPATH=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|WEBPATH [path]}}|-| '''Default'''|<code>[[Configuration#Database Directory|{home}/webapp]]</code>|-| '''Summary'''|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:* The option is ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.|} ===GZIP=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|GZIP [boolean]}}|-| '''Default'''|<code>false</code>|-| '''Summary'''|Jetty provides a [https://www.eclipse.org/jetty/documentation/current/gzip-filter.html Gzip handler] for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the [[Web Application|BaseX HTTP Server]]:* The option can also be enabled on [[Command-Line Options#HTTP Server|command line]] via <code>-g</code>.* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.* The [https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 same defaults] of the web server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).|} ===RESTXQPATH=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|RESTXQPATH [path]}}
|-
| valign='top' width='90Default' | ''|'Signature'empty''|<code>TIMEOUT [time]</code>
|-
|}
===PARSERESTXQ===
{| width=Database Options'100%'|-| width='120' | '''Signature'''|{{Code|PARSERESTXQ}}|-| '''Default'''|{{Code|3}}|-| '''Summary'''|Timeout after which the RESTXQ directory will be parsed for changes:* If {{Code|0}} is specified, the directory will be parsed every time a RESTXQ function is called.* A positive value defines the idle time in seconds after which parsing will be enforced. The default value is {{Code|3}}: Changes in the RESTXQ directory will be detected after 3 seconds without RESTXQ function calls.* Monitoring is completely disabled if a negative value is specified.
See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details.|} ===RESTXQERRORS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|RESTXQERRORS}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.|} ===RESTPATH=== {| width=CHOP'100%'|-| width='120' | '''Signature'''|{{Code|RESTPATH [path]}}|-| '''Default'''|''empty''|-| '''Summary'''|Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the {{Option|WEBPATH}} directory.|} ===HTTPLOCAL=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|HTTPLOCAL [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>CHOP</code>{{Code|false}}
|-
|}
===INTPARSESTOPPORT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|STOPPORT [port]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>INTPARSE</code>{{Code|8985}}
|-
|}
=Create Options= ==General== ===DTDMAINMEM=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|MAINMEM [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>DTD</code>{{Code|false}}
|-
|}
===CATFILEADDCACHE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|ADDCACHE [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>CATFILE [path]</code>{{Code|false}}
|-
|}
==Parsing==
===CREATEFILTER===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|CREATEFILTER [filter]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>CREATEFILTER [filter]</code>{{Code|*.xml}}
|-
|}
===ADDARCHIVES===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|ADDARCHIVES</code>[boolean]}}
|-
| valign='top' 'Default'''|{{Code|true}}|-| '''Summary'''|Parse If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, GZIP, etc.) while creating are parsed whenever new databases are created or resources are added to a database or adding new documents (default: <code>.|} ===ARCHIVENAME=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|ARCHIVENAME [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|If this option is set to {{Code|true</code>)}}, the file name of parsed archives will be included in the document paths.
|}
===SKIPCORRUPT===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|SKIPCORRUPT [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files will be parsed twice. Next, main memory consumption will be higher as parsed files will be cached in main memory.|} ===ADDRAW=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SKIPCORRUPT</code>{{Code|ADDRAW [boolean]}}
|-
| valign='top' 'Default'''|{{Code|false}}|-| '''Summary'''|Skip corrupt (i.e., non-well-formed) files while creating a database or adding new documents. If this option is usedenabled, all resources that are filtered out by the {{Option|CREATEFILTER}} option while being added to a database creation is slowed down, will be stored as all [[Binary Data|raw files will be parsed twice]] instead (i.e. Next, main memory consumption will be higher as parsed files will be cached in main memory (default: <code>false</code>their binary representation).
|}
===PARSER===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|PARSER [type]</code>}}
|-
| valign='top' 'Default'''|{{Code|XML}}|-| '''Summary'''|Define import Defines a [[Parsers|parser]]for importing new files to the database. As <code>TYPE</code> Available parsers are available '{{Code|XML'}}, {{Code|JSON}}, '{{Code|CSV' or '}}, {{Code|TEXT'}}, {{Code|HTML}}, and {{Code|RAW}}. If HTML input will be parsed as XML documents if [http://home.ccil.org/~cowan/XML/tagsoup/ [Parsers#HTML_Parser|Tagsoup]] is not found in the classpath, 'HTML' is also available (default: <code>XML</code>).
|}
===PARSEROPTCSVPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CSVPARSER [options]}}|-| '''Default'''|''empty''|-| '''Summary'''|Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]].|-| '''Examples'''|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.|} ===JSONPARSER=== {|width='100%'|-| width='120' | '''Signature'''|{{Code|JSONPARSER [options]}}|-| '''Default'''|''empty''|-| '''Summary'''|Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]].|-| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.|} ===HTMLPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|HTMLPARSER [options]}}|-| '''Default'''|''empty''
|-
|-
|}
===PATHINDEXTEXTPARSER=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>PATHINDEX</code>{{Code|TEXTPARSER [options]}}
|-
| valign='top' 'Default'''|''empty''|-| '''Summary'''|Create index for paths Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and speedup path based queries (default: multiple options are delimited with <code>,</code>. The available options are listed in the [[Parsers]] article.|-| '''Examples'''|<code>lines=true</code>)creates a single element for each line of text.
|}
==XML Parsing==
===CHOP===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|CHOP [boolean]}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Many XML documents include whitespaces that have been added to improve readability. This option controls the [https://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:
* With the default value {{Code|true}}, leading and trailing whitespaces from text nodes will be chopped and all empty text nodes will be discarded.
* The flag should be turned off if a document contains [[Full-Text#Mixed Content|mixed content]].
* The flag can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>.
* If the <code>xml:space="preserve"</code> attribute is attached to an element, chopping will be turned off for all descendant text nodes.
In the following example document, the whitespaces in the text nodes of the {{Code|text}} element will not be chopped:
<syntaxhighlight lang="xml">
<xml>
<title>
Demonstrating the CHOP flag
</title>
<text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text>
</xml>
</syntaxhighlight>
It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option; otherwise the serialized documents will automatically be indented.
|}
===STRIPNS===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|STRIPNS [boolean]}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|Strips all namespaces from an XML document and all elements while parsing.
|}
===INTPARSE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|INTPARSE [boolean]}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the internal parser:
* Performance: Documents (in particular small ones) will be parsed faster
* Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (�)
* Entities: around 250 HTML entities will be detected and decoded
You will be able to correctly parse most XML documents with the internal parser. Java’s Xerces parser is still used as default, however, because it supports all features of the XML standard and advanced DTD features, such as recursive entity expansion.
|}
===DTD===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|DTD [boolean]}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The {{Option|CATFILE}} option can be changed to locally resolve DTDs.
|}
===XINCLUDE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|XINCLUDE [boolean]}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is switched to {{Code|true}}. This option is only available if the standard Java XML Parser is used (see {{Option|INTPARSE}}).
|}
===CATFILE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|CATFILE [path]}}
|-
| '''Default'''
|''empty''
|-
| '''Summary'''
|Semicolon-separated list of XML catalog files to resolve URIs. See [[Catalog Resolver]]s for more details.
|}
==Indexing==
The following options control the creation of index structures. The current values will be considered if a new database is created. See [[Indexes]] for more details.
===TEXTINDEX===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|TEXTINDEX</code>[boolean]}}
|-
| valign='top' 'Default'''|{{Code|true}}|-| '''Summary'''|Create Creates a text index for whenever a new database is created. A text nodes and speedup index speeds up queries querying the entire with equality comparisons on text of a node (default: <code>true</code>)nodes. See [[Index#Text Index|Text Index]] for more details.
|}
===ATTRINDEX===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|ATTRINDEX [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>ATTRINDEX</code>{{Code|true}}
|-
| valign'''Summary'''|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[Index#Attribute Index|Attribute Index]] for more details.|} ===TOKENINDEX=== {| width='100%'|-| width='top120' | '''Signature'''|{{Code|TOKENINDEX [boolean]}}|-| ''' Default'''|{{Code|true}}|-| '''Summary'''|Create Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values and speedup queries querying attribute values (default: <code>true</code>). See [[Index#Token Index|Token Index]] for more details.
|}
===FTINDEX===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|FTINDEX [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions. See [[Index#Full-Text Index|Full-Text Index]] for more details.|} ===TEXTINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TEXTINCLUDE [names]}}
|-
| valign='top' width='90Default' | ''|'Signature'empty''|<code>FTINDEX</code>
|-
|}
===WRITEBACKATTRINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|ATTRINCLUDE [names]}}|-| '''Default'''|''empty''|-| '''Summary'''|Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===TOKENINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TOKENINCLUDE [names]}}|-| '''Default'''|''empty''|-| '''Summary'''|Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===FTINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|FTINCLUDE [names]}}|-| '''Default'''|''empty''|-| '''Summary'''|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===MAXLEN=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|MAXLEN [int]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>WRITEBACK</code>{{Code|96}}
|-
|}
===MAINMEMMAXCATS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|MAXCATS [int]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>MAINMEM</code>{{Code|100}}
|-
|}
===FORCECREATEUPDINDEX=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|UPDINDEX [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>FORCECREATE</code>{{Code|false}}
|-
|}
===AUTOOPTIMIZE===
{| width=Full'100%'|-Text Options| width='120' | '''Signature'''|{{Code|AUTOOPTIMIZE [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|If turned on, auto optimization will be applied to new databases:* With each update, outdated indexes and database statistics will be recreated.* As a result, the index structures will always be up-to-date.* However, updates can take much longer, so this option should only be activated for medium-sized databases.* The value of this option will be assigned once to a new database. It can be reassigned by running {{Command|OPTIMIZE}} or [[Database_Module#db:optimize|db:optimize]].|}
===WILDCARDSSPLITSIZE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>WILDCARDS</code>{{Code|SPLITSIZE [num]}}
|-
| valign='top' 'Default'''|{{Code|0}}|-| '''Summary'''|Create wildcard optimized full text 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 especially tuned for querying full text using wildcards expressions disabled when running Java (defaulte.g. via the JVM option {{Code|-XX: <code>false</code>+DisableExplicitGC}}), you may need to choose a custom split size.* You can e. g. start with {{Code|1000000}} (one million) index operations and adjust this value in the next steps.* The larger the assigned value is, the less splits will take place, and the more main memory will be required.
|}
==Full-Text Indexing==
===STEMMING===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|STEMMING [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>STEMMING</code>{{Code|false}}
|-
|}
===CASESENS===
{|width='100%' | width='120' | '''Signature'''|{{Code|CASESENS [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>CASESENS</code>{{Code|false}}
|-
|}
===DIACRITICS===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|DIACRITICS [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>DIACRITICS</code>{{Code|false}}
|-
|}
===LANGUAGE===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|LANGUAGE [lang]}}|-| '''Default'''|{{Code|en}}|-| '''Summary'''|The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} ===STOPWORDS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|STOPWORDS [path]}}|-| '''Default'''|''empty''|-| '''Summary'''|If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index is created. A stopword list may decrease the size of the full text index and speed up your queries. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} =Query Options= ===QUERYINFO=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>LANGUAGE {{Code|QUERYINFO [langboolean]</code>}}
|-
| valign='top' 'Default'''|{{Code|false}}|-| '''Summary'''|Language for full-text search indexPrints more information on internal query rewritings, optimizations, eand performance.gBy default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. <code>LANG</code> It can also be set to activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>English-V</code> or <code>German</code> (default: ''empty'').
|}
===SCORINGMIXUPDATES=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SCORING [mode]</code>{{Code|MIXUPDATES}}
|-
| valign='top' 'Default'''|{{Code|false}}|-| '''Summary'''|Precalculation of full text scores Allows queries to both contain updating and storage within the full text index structurenon-updating expressions. Enables TF/IDF based scores in full text queries All updating constraints will be turned off, and increases memory consumption while indexingnodes to be returned will be copied before they are modified by an updating expression. <code>MODE</code> can be By default, in compliance with the XQuery Update Facility, this option is set to <code>1</code> {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for document based scoring, <code>2</code> for text node based scoring and <code>0</code> for non scoring (default: <code>0</code>)more details.
|}
===STOPWORDSBINDINGS=== {| 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 variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [https://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>.|-| '''Examples'''|* <code>$a=1,$b=2</code> binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b* <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}}:<syntaxhighlight lang="xquery">SET BINDINGS GREETING="hello world!"XQUERY declare variable $GREETING external; $GREETING</syntaxhighlight>|} ===INLINELIMIT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|INLINELIMIT}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>STOPWORDS [path]</code>{{Code|50}}
|-
|}
===LSERRORUNROLLLIMIT=== {{Mark|Introduced with Version 9.6:}} {| width='100%'|-| width='120' | '''Signature'''|{{Code|UNROLLLIMIT}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>LSERROR [error]</code>{{Code|5}}
|-
|}
===ENFORCEINDEX===
{| width='100%'|-| width='120' | '''Signature'''|{{Code|ENFORCEINDEX [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Enforces index rewritings in path expressions. See [[Indexes#Enforce Rewritings|Enforce Rewritings]] for details.|} ===COPYNODE==Query Options=
{| width='100%'|-| width==QUERYINFO==='120' | '''Signature'''|{{Code|COPYNODE [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>QUERYINFO</code>{{Code|true}}
|-
|}
===QUERY3TAILCALLS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TAILCALLS}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>QUERY3</code>{{Code|256}}
|-
|}
===SERIALIZEWITHDB=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|WITHDB}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|By default, resources specified via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] are looked up both in the database and in the file system. If you always use {{Function|Database|db:open}} to access databases, it is recommendable to disable this option:* No locks will be created for the two functions (see [[Transaction Management#Limitations|limitations of database locking]] for more details).* Access to local and external resources will be faster, as the database lookup will be skipped.|} ===DEFAULTDB=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|DEFAULTDB}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>SERIALIZE</code>{{Code|false}}
|-
|}
===BINDINGSFORCECREATE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|FORCECREATE [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>BINDINGS [vars]</code>{{Code|false}}
|-
|}
===SERIALIZERCHECKSTRINGS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CHECKSTRINGS [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>SERIALIZER [params]</code>{{Code|true}}
|-
|}
===EXPORTERWRAPJAVA=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|WRAPJAVA [mode]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>EXPORTER [params]</code>{{Code|some}}
|-
|}
===RUNSLSERROR=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LSERROR [error]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>RUNS [num]</code>{{Code|0}}
|-
|}
===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 [[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>.
|}
=Serialization Options==RUNS===
|-
| valign='top' width='90120' | '''Signature'''|<code>DOTPLAN</code>{{Code|RUNS [num]}}
|-
| valign='top' 'Default'''|{{Code|1}}|-| '''Summary'''|Create Specifies how often a query plans visualized with [http://wwwwill be evaluated.graphvizThe result is serialized only once, and the measured times are averages of all runs.org dottyThis option can also be changed on [[Command-Line Options#BaseX Standalone|command line]], see <code>'plan.dot'</code> file in your project folder (default: via <code>false-r</code>).
|}
=Serialization Options= =DOTCOMPACT==SERIALIZE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|SERIALIZE [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>DOTCOMPACT</code>{{Code|true}}
|-
|}
===DOTDISPLAYSERIALIZER=== {|width='100%'|-| width='120' | '''Signature'''|{{Code|SERIALIZER [params]}}|-| '''Default'''|''empty''
|-
| valign='top' width='90' | '''SignatureSummary'''|Parameters for [[Serialization|serializing]] query results. The string must comply with the following rules:* Variable names and values must be separated by equality signs.* Multiple variables must be delimited by commas.* Commas in values must be duplicated.The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>DOTDISPLAY-s</code>.
|-
|}
===DOTTYEXPORTER=== {|width='100%'|-| width='120' | '''Signature'''|{{Code|EXPORTER [params]}}|-| '''Default'''|''empty''
|-
| valign='top' width='90' | '''SignatureSummary'''|<code>DOTTY Contains parameters for exporting resources of a database and writing files after updates via the {{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[pathSerialization]]</code>for more details.
|-
|}
===XMLPLAN===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|XMLPLAN</code>[boolean]}}
|-
| valign='top' 'Default'''|{{Code|false}}|-| '''Summary'''|Print query Prints the execution plan as xml document (default: of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>false-x</code>).
|}
===COMPPLAN===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|COMPPLAN</code>[boolean]}}
|-
| valign='top' 'Default'''|{{Code|true}}|-| '''Summary'''|Create Generates the query plan , which can be activated via {{Option|XMLPLAN}}, before or after query compilation . This option can also be activated on [[Command- query plan might change due to optimizations (default: Line Options#BaseX Standalone|command line]] via <code>true-X</code>).
|}
===CACHEQUERYFULLPLAN=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|FULLPLAN [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Attaches the file path, line and column of the expressions in the original query string to the query plan. Values (items and sequences) have no input information attached.|} =Other Options= ===AUTOFLUSH=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|AUTOFLUSH [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>CACHEQUERY</code>{{Code|true}}
|-
| valign'''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 {{Command|FLUSH}} command.|} ===WRITEBACK=== {| width='100%'|-| width='120' | '''Signature''top' |{{Code|WRITEBACK [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Cache the query results (defaultPropagates updates on main-memory instances of files that have been retrieved via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] back to disk: * This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>false-u</code>).* Please take in mind that no backup will be created from your original files.* The serialization options can be controlled via the {{Option|EXPORTER}} option.
|}
===MAXSTAT===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|MAXSTAT [num]</code>}}
|-
| valign='top' 'Default'''|{{Code|30}}|-| '''Summary'''|Set Specifies the maximum number of index occurrences to print through printed by the {{Command|INFO INDEX}} command <code>info index</code> (default: <code>15</code>).
|}
=Changelog=
;Version 9.6
* Added: {{Option|UNROLLLIMIT}}, {{Option|WRAPJAVA}}
;Version 9.5
* Updated: {{Option|INLINELIMIT}}: default reduced to 50.
* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response
;Version 9.4
* Added: {{Option|LOGTRACE}}
;Version 9.3
* Added: {{Option|WITHDB}}, {{Option|GZIP}}
;Version 9.2
* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}
* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
;Version 9.0
* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
;Version 8.6
* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}
* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)
* Removed: {{Code|QUERYPATH}} (will now be internally assigned)
* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ)
;Version 8.5
* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added.
;Version 8.4
* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}
* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)
* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code>
;Version 8.3
* Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}}
;Version 8.2
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
;Version 8.1
* Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}}
;Version 8.0
* Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}}
* Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored.
;Version 7.8.1
* Updated: {{Option|ADDARCHIVES}}: parsing of TAR and TGZ files.
;Version 7.8
* Added: {{Option|CSVPARSER}}, {{Option|JSONPARSER}}, {{Option|TEXTPARSER}}, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}}
* Updated: {{Option|WRITEBACK}} only applies to main-memory document instances.
* Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions.
* Updated: default of {{Option|INTPARSE}} is now {{Code|false}}.
* Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
;Version 7.7
* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}}
;Version 7.6
* Added: {{Option|GLOBALLOCK}}
* Added: store local options in configuration file after {{Code|# Local Options}} comments.
;Version 7.5
* Added: options can now be set via system properties
* Added: a pragma expression can be used to locally change database options
* Added: {{Option|USER}}, {{Option|PASSWORD}}, {{Option|LOG}}, {{Option|LOGMSGMAXLEN}}, {{Option|WEBPATH}}, {{Option|RESTXQPATH}}{{Option|HTTPLOCAL}}, {{Option|CREATEONLY}}, {{Option|STRIPNS}}
* Removed: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: {{Code|jetty.xml}} configuration file is used instead
* Removed: global options cannot be changed anymore during the lifetime of a BaseX instance
;Version 7.3
* Updated: {{Option|KEEPALIVE}}, {{Option|TIMEOUT}}: default values changed
* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries
* Removed: {{Code|SCORING}}; new scoring model will focus on lengths of text nodes and match options
;Version 7.2
* Added: {{Option|PROXYHOST}}, {{Option|PROXYPORT}}, {{Option|NONPROXYHOSTS}}, {{Option|HTMLOPT}}
* Updated: {{Option|TIMEOUT}}: ignore timeout for admin users
;Version 7.1
* Added: {{Option|ADDRAW}}, {{Option|MAXLEN}}, {{Option|MAXCATS}}, {{Option|UPDINDEX}}
* Updated: {{Option|BINDINGS}}
;Version 7.0
* Added: {{Option|SERVERHOST}}, {{Option|KEEPALIVE}}, {{Option|AUTOFLUSH}}, {{Option|QUERYPATH}}
