Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
no edit summary
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DEBUG [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Command-Line Options#BaseX Standalone|command line]] via <code>-d</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DBPATH [path]}}
|-valign="top"
| '''Default'''
|<code><code>[[Configuration#Database Directory|{home}/data]]</code>
|-valign="top"
| '''Summary'''
|Points to the directory in which all databases are located.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LOGPATH [path]}}
|-valign="top"
| '''Default'''
|<code>.logs</code>
|-valign="top"
| '''Summary'''
|Points to the directory in which all [[Logging|log files]] are stored. Relative paths will be resolved against the {{Option|DBPATH}} directory.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|REPOPATH [path]}}
|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/repo]]</code>
|-valign="top"
| '''Summary'''
|Points to the [[Repository]], in which all XQuery modules are located.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LANG [language]}}
|-valign="top"
| '''Default'''
|{{Code|English}}
|-valign="top"
| '''Summary'''
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LANGKEY [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|FAIRLOCK [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Defines the locking strategy:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CACHETIMEOUT [seconds]}}
|-valign="top"
| '''Default'''
|{{Code|3600}}
|-valign="top"
| '''Summary'''
|Specifies how many seconds the results of queries, which have been queued by the [[Jobs Module|asynchronously executed]], will be cached in main memory.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|HOST [host]}}
|-valign="top"
| '''Default'''
|{{Code|localhost}}
|-valign="top"
| '''Summary'''
|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|1984}}
|-valign="top"
| '''Summary'''
|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SERVERPORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|1984}}
|-valign="top"
| '''Summary'''
|This is the port the database server will be listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-p</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|USER [name]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Represents a user name, which is used for accessing the server or an HTTP service:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PASSWORD [password]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Represents a password, which is used for accessing the server:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|AUTHMETHOD [method]}}
|-valign="top"
| '''Default'''
|''Basic''
|-valign="top"
| '''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/>
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SERVERHOST [host|ip]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|This is the host name or IP address the server is bound to. If the option is set to an empty string (which is the default), the server will be open to all clients.
{| width='100%' width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PROXYHOST [host]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|This is the host name of a proxy server. If the value is an empty string, it will be ignored.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PROXYPORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|0}}
|-valign="top"
| '''Summary'''
|This is the port number of a proxy server. If the value is set to {{Code|0}}, it will be ignored.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|NONPROXYHOSTS [hosts]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|IGNORECERT [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Disable SSL hostname verification and ignore untrusted certificates when connecting to servers.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TIMEOUT [seconds]}}
|-valign="top"
| '''Default'''
|{{Code|30}}
|-valign="top"
| '''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]].
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|KEEPALIVE [seconds]}}
|-valign="top"
| '''Default'''
|{{Code|600}}
|-valign="top"
| '''Summary'''
|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PARALLEL [number]}}
|-valign="top"
| '''Default'''
|{{Code|8}}
|-valign="top"
| '''Summary'''
|Denotes the maximum allowed number of parallel [[Transaction Management|transactions]]:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LOG [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LOGMSGMAXLEN [length]}}
|-valign="top"
| '''Default'''
|{{Code|1000}}
|-valign="top"
| '''Summary'''
|Specifies the maximum length of a single [[Logging|log message]].
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LOGTRACE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|If BaseX is running as [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and similar functions) is written to the [[Logging|database logs]]. If this option is disabled, trace output will be redirected to standard error, as it is known from the standalone version of BaseX.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|WEBPATH [path]}}
|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/webapp]]</code>
|-valign="top"
| '''Summary'''
|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|GZIP [boolean]}}
|-valign="top"
| '''Default'''
|<code>false</code>
|-valign="top"
| '''Summary'''
|Jetty provides a [https://www.eclipse.org/jetty/documentation/current/gzip-filter.html Gzip handler] for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the [[Web Application|BaseX HTTP Server]]:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|RESTXQPATH [path]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PARSERESTXQ}}
|-valign="top"
| '''Default'''
|{{Code|3}}
|-valign="top"
| '''Summary'''
|Timeout after which the RESTXQ directory will be parsed for changes:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|RESTXQERRORS}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|RESTPATH [path]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|HTTPLOCAL [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|By default, if BaseX is run as [[Web Application]], the database server instance will be started in addition, which can then be addressed by [[Clients]] via the database port (see {{Option|PORT}}).<br/>If the option is set to {{Code|true}}, no database server will be launched.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|STOPPORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|8081}}
|-valign="top"
| '''Summary'''
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MAINMEM [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If this option is turned on, new databases will be created in main memory:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ADDCACHE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If this option is activated, data structures of documents will first be cached to disk before being added to the final database. This option is helpful when larger documents need to be added, and if the existing heuristics cannot estimate the input size (e.g. when adding directories or sending input streams).
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CREATEFILTER [filter]}}
|-valign="top"
| '''Default'''
|{{Code|*.xml}}
|-valign="top"
| '''Summary'''
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ADDARCHIVES [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc.) are parsed whenever new databases are created or resources are added to a database.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ARCHIVENAME [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If this option is set to {{Code|true}}, the file name of parsed archives will be included in the document paths.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SKIPCORRUPT [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files will be parsed twice. Next, main memory consumption will be higher as parsed files will be cached in main memory.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ADDRAW [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If this option is enabled, all resources that are filtered out by the {{Option|CREATEFILTER}} option while being added to a database will be stored as [[Binary Data|raw files]] instead (i.e., in their binary representation).
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|PARSER [type]}}
|-valign="top"
| '''Default'''
|{{Code|XML}}
|-valign="top"
| '''Summary'''
|Defines a [[Parsers|parser]] for importing new files to the database. Available parsers are {{Code|XML}}, {{Code|JSON}}, {{Code|CSV}}, {{Code|TEXT}}, {{Code|HTML}}, and {{Code|RAW}}. HTML input will be parsed as XML documents if [[Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CSVPARSER [options]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]].
|-valign="top"
| '''Examples'''
|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|JSONPARSER [options]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]].
|-valign="top"
| '''Examples'''
|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|HTMLPARSER [options]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Specifies the way how HTML data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are described in the [[Parsers#Options|Parsers]] article.
|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TEXTPARSER [options]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are listed in the [[Parsers]] article.
|-valign="top"
| '''Examples'''
|<code>lines=true</code> creates a single element for each line of text.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|STRIPWS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|STRIPNS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Strips all namespaces from an XML document while parsing.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|INTPARSE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the internal parser:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DTD [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The {{Option|CATALOG}} option can be changed to locally resolve DTDs.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|XINCLUDE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is switched to {{Code|true}}. This option is only available if the standard Java XML Parser is used (see {{Option|INTPARSE}}).
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CATALOG [path]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Semicolon-separated list of XML catalog files to resolve URIs. See [[Catalog Resolver]]s for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TEXTINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes. See [[Index#Text Index|Text Index]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ATTRINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[Index#Attribute Index|Attribute Index]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TOKENINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See [[Index#Token Index|Token Index]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|FTINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions. See [[Index#Full-Text Index|Full-Text Index]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TEXTINCLUDE [names]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ATTRINCLUDE [names]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TOKENINCLUDE [names]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|FTINCLUDE [names]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MAXLEN [int]}}
|-valign="top"
| '''Default'''
|{{Code|96}}
|-valign="top"
| '''Summary'''
|Specifies the maximum length for strings to be stored in [[Indexes|index structures]]. The value of this option will be assigned once to a new database, and can only be changed by creating a new database or doing a [[Commands#OPTIMIZE|full optimization]].
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MAXCATS [int]}}
|-valign="top"
| '''Default'''
|{{Code|100}}
|-valign="top"
| '''Summary'''
|Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|UPDINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If turned on, incremental indexing will be enabled:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|AUTOOPTIMIZE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If turned on, auto optimization will be applied to new databases:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SPLITSIZE [num]}}
|-valign="top"
| '''Default'''
|{{Code|0}}
|-valign="top"
| '''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:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|STEMMING [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If {{Code|true}}, all tokens will be stemmed during full-text indexing, using a language-specific stemmer implementation. By default, tokens will not be stemmed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
| width='120' | '''Signature'''
|{{Code|CASESENS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If {{Code|true}}, the case of tokens will be preserved during full-text indexing. By default, case will be ignored (all tokens will be indexed in lower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DIACRITICS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If set to {{Code|true}}, diacritics will be preserved during full-text indexing. By default, diacritics will be removed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LANGUAGE [lang]}}
|-valign="top"
| '''Default'''
|{{Code|en}}
|-valign="top"
| '''Summary'''
|The specified language will influence the way how 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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|STOPWORDS [path]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|QUERYINFO [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MIXUPDATES}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|BINDINGS [vars]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Contains external variables to be bound to a query. The string must comply with the following rules:
* 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>.
|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|INLINELIMIT}}
|-valign="top"
| '''Default'''
|{{Code|50}}
|-valign="top"
| '''Summary'''
|This option controls inlining of XQuery functions:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|UNROLLLIMIT}}
|-valign="top"
| '''Default'''
|{{Code|5}}
|-valign="top"
| '''Summary'''
|This option controls the unroll limit:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|ENFORCEINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Enforces index rewritings in path expressions. See [[Indexes#Enforce Rewritings|Enforce Rewritings]] for details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|COPYNODE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|When creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], copies of all enclosed nodes will be created, and the copied nodes get new node identities. As a result, the following query yields <code>false</code>:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|TAILCALLS}}
|-valign="top"
| '''Default'''
|{{Code|256}}
|-valign="top"
| '''Summary'''
|Specifies how many stack frames of [https://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1}}.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|WITHDB}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|By default, resources specified via {{Code|fn:doc}} and {{Code|fn:collection}} are looked up both in the database and in the file system. If you always use {{Function|Database|db:get}} to access databases, it is recommendable to disable this option:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|DEFAULTDB}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If this option is turned on, paths specified in the {{Code|fn:doc}} and {{Code|fn:collection}} functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the {{Command|OPEN}} command). If the path does not match any existing resources, it will be resolved as described in the article on [[Databases#Access Resources|accessing database resources]].
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|FORCECREATE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|By activating this option, database instances will be created with the XQuery functions {{Code|fn:doc}} and {{Code|fn:collection}}.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|CHECKSTRINGS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''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 be replaced with the Unicode replacement character <code>FFFD</code> (�). The option affects [[Java Bindings]] and string conversion and input functions such as {{Function|Archive|archive:create}}, {{Function|Archive|archive:extract-text}}, and {{Function|Archive|archive:update}}.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|WRAPJAVA [mode]}}
|-valign="top"
| '''Default'''
|{{Code|some}}
|-valign="top"
| '''Summary'''
|Defines the 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 [[Java_Bindings#Conversion to XQuery|Java Bindings]] for further details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|LSERROR [error]}}
|-valign="top"
| '''Default'''
|{{Code|0}}
|-valign="top"
| '''Summary'''
|This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if {{Code|0}} is assigned, the error value is calculated dynamically. See [[Full-Text#Fuzzy_Querying|Fuzzy Querying]] for more details.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|RUNQUERY [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Specifies if a query will be executed or parsed only. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|RUNS [num]}}
|-valign="top"
| '''Default'''
|{{Code|1}}
|-valign="top"
| '''Summary'''
|Specifies how often a query will be evaluated. The result is serialized only once, and the measured times are averages of all runs. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-r</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SERIALIZE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|SERIALIZER [params]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Parameters for [[Serialization|serializing]] query results:
* Commas must be duplicated if they appear as literals in values.
The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|EXPORTER [params]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Contains parameters for exporting resources of a database and writing files after updates via the {{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[Serialization]] for more details.
|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|XMLPLAN [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|FULLPLAN [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|AUTOFLUSH [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the {{Command|FLUSH}} command.
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|WRITEBACK [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Propagates updates on main-memory instances of files that have been retrieved via {{Code|fn:doc}} and {{Code|fn:collection}} back to disk:
{| width='100%'
|-valign="top"
| width='120' | '''Signature'''
|{{Code|MAXSTAT [num]}}
|-valign="top"
| '''Default'''
|{{Code|30}}
|-valign="top"
| '''Summary'''
|Specifies the maximum number of index occurrences printed by the {{Command|INFO INDEX}} command.
