Changes

Jump to navigation Jump to search
28,870 bytes added ,  27 May
m
Fixed typo if should be is
This page is linked from the [[Getting Started]] Section.
The options listed on this page 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 Two kinds of options exist: strings, numbers, and booleans, which can be turned ON and OFF. If options are internally changed by the [[GUI]] of BaseX, they will be listed in the [[GUI#Visualizations|Info View]].
=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.
Values of options are either ''strings'', ''numbers'' or ''booleans''. Options are ''static'' and not bound to a single operation (for example, the next command). Various ways exist to access and change options: * The main current value of an option can be requested with the {{Command|GET}} command. Local options can be changed via {{Command|SET}} (all global options are , except for {{Option|DEBUG}}, can only available from 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 = false</syntaxhighlight> * Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on command line, or using [Standalone Modehttps://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()]] and 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 [[Database ServerWeb Application]] instances of BaseX, ithe default can be adjusted in the {{Code|web.exml}} 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, they cannot local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]]. If options are changed by database clientsoperations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/> =Global Options= Global options are constants. They are stored can only be set in the configuration file or via system properties (see above). One exception is the [[Configuration#Configuration Filesdebug|.basex config fileDEBUG]]option, which is opened can also be changed at runtime by every new users with [[User Management|admin permissions]]. ==General Options== ===DEBUG=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|DEBUG [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Command-Line Options#BaseX instance:Standalone|command line]] via <code>-d</code>.|}
===DBPATH===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|DBPATH [path]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> or <code>[[Configuration#Database Directory|{home}/data]]</code>
|-
| '''Summary'''
|Points to the directory in which all databases are located.<br/> '''Note:''' this option can only be changed if no database is currently opened. If the option is changed, existing databases will not be moved to the new location.
|}
===REPOPATHLOGPATH=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|REPOPATH LOGPATH [path]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]].logs</code>
|-
| '''Summary'''
|Points to the directory in which all [[RepositoryLogging|log files]], in which all XQuery modules are locatedstored.<br/>'''Note:''' if Relative paths will be resolved against the option is changed, BaseX needs to be restarted in order to activate existing packages and avoid side effects{{Option|DBPATH}} directory.
|}
===DEBUGREPOPATH=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DEBUGREPOPATH [path]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{{Code|false}home}/repo]]</code>
|-
| '''Summary'''
|Sends internal debug info Points to STDERR. This option can be turned on to get additional information for development and debugging purposesthe [[Repository]], in which all XQuery modules are located.
|}
===LANG===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LANG [language]}}
|-
|-
| '''Summary'''
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. BaseX needs to be restarted in order to activate the new language.
|}
===LANGKEY===
 {|width='100%'|-| width='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='90120' | '''Signature'''|{{Code|LANGKEYFAIRLOCK [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Prefixes all texts with Defines the locking strategy:* By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the internal language keyslimit of parallel transactions (specified via {{Option|PARALLEL}}) has been reached. This option 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 helpful if BaseX full.* If fair locking is translated into another languageenabled, read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it should be used if you want to see where particular texts are displayedthe prompt evaluation of update operations is critical. BaseX needs to |} ===CACHETIMEOUT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CACHETIMEOUT [seconds]}}|-| '''Default'''|{{Code|3600}}|-| '''Summary'''|Specifies how many seconds the results of queries, which have been queued by the [[Jobs Module|asynchronously executed]], will be restarted cached in order to activate this optionmain memory.
|}
===HOST===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|HOST [host]}}
|-
|-
| '''Summary'''
|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
|}
===PORT===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|PORT [port]}}
|-
|-
| '''Summary'''
|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
|}
===SERVERPORT===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|SERVERPORT [port]}}
|-
|-
| '''Summary'''
|This is the port the database server will be listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-p</code>.|} ===USER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|USER [name]}}|-| '''Default'''|''empty''|-| '''Summary'''|Represents a user name, which is used for accessing the server or an HTTP service:* The default value will be overwritten if a client specifies its own credentials.* If the default value is empty, login will only be possible if the client specifies credentials.* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-U</code>.|} ===PASSWORD=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|PASSWORD [password]}}|-| '''Default'''|''empty''|-| '''Summary'''|Represents a password, which is used for accessing the server:* The default value will be overwritten if a client specifies its own credentials.* If the default value is empty, 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>-P</code>.* Please note that it is a security risk to specify your password in plain text.|} ===AUTHMETHOD=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|AUTHMETHOD [method]}}|-| '''Default'''|''Basic''|-| '''Summary'''|Specifies the default authentication method, which will be used by the [[Web Application|HTTP server]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}:<br/>* If basic access is chosen, the client can still request digest authentication.* This is different for digest access, which cannot be overwritten.* With custom authentication, the server will not do any authentication.
|}
===SERVERHOST===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|SERVERHOST [host&#x7c;ip]}}
|-
| '''Default'''
|''empty'' (''wildcard'')
|-
| '''Summary'''
|This is the host name or ip address the server is bound to. The server will be open to all clients if If the option is set to an empty string(which is the default), the server will be open to all clients.
|}
===EVENTPORTPROXYHOST=== {|width='100%' width='100%'
|-
| width='90120' | '''Signature'''|{{Code|EVENTPORT PROXYHOST [porthost]}}
|-
| '''Default'''
|{{Code|1985}}''empty''
|-
| '''Summary'''
|This port is used by the client to listen for [[Events|host name of a proxy server events]]. This port If the value is an empty string, it will only be bound if a client attaches itself to a database eventignored.
|}
===HTTPPORTPROXYPORT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTTPPORT PROXYPORT [port]}}
|-
| '''Default'''
|{{Code|89840}}
|-
| '''Summary'''
|This is the port number of a proxy server. If the [[Startup#BaseX HTTP Servervalue is set to {{Code|HTTP Server]] 0}}, it will be listening toignored.
|}
===STOPPORTNONPROXYHOSTS=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|STOPPORT NONPROXYHOSTS [porthosts]}}
|-
| '''Default'''
|{{Code|8985}}''empty''
|-
| '''Summary'''
|This is a list of hosts that should be directly accessed. If the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can value is an empty string, it will be locally closedignored.
|}
===HTTPPATHIGNOREHOSTNAME=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTTPPATH IGNOREHOSTNAME [pathboolean]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory{{Code|{homefalse}}/BaseXHTTP]]</code>
|-
| '''Summary'''
|Points to the HTTP root directory, in which HTML files may be storedIf this option is enabled, and query files that hostnames of certificates will not be evaluated by the [[REST]] serviceverified. Use {{Option|IGNORECERT}} to completely disable certificate verification.
|}
===PROXYHOSTIGNORECERT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PROXYHOST IGNORECERT [hostboolean]}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|This is option can be turned on to ignore untrusted certificates when connecting to servers. Use {{Option|IGNOREHOSTNAME}} to suppress only the host name of a proxy serverhostname verification.
|}
===PROXYPORTTIMEOUT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PROXYPORT TIMEOUT [portseconds]}}
|-
| '''Default'''
|{{Code|8030}}
|-
| '''Summary'''
|This is Specifies the maximum time a transaction triggered by a client may take. If an operation takes longer than the port specified number of a proxy serverseconds, 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]].
|}
===NONPROXYHOSTSKEEPALIVE=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|NONPROXYHOSTS KEEPALIVE [hostsseconds]}}
|-
| '''Default'''
|{{Code|600}}
|-
| '''Summary'''
|This is Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a list of hosts that should longer time than specified by this timeout, it will be directly accesseddisconnected. 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='90120' | '''Signature'''
|{{Code|PARALLEL [number]}}
|-
|-
| '''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|numberLOG [boolean]}}|-| '''Default'''|{{Code|true}} |-| '''Summary'''|Turns [[Logging]] of parallel read server operations and HTTP requests on/off. This option can also be changed when running the server on [[Transaction ManagementCommand-Line Options#BaseX Server|transactionscommand line]]via <code>-z</code>.
|}
===TIMEOUTLOGMSGMAXLEN=== {| 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='90120' | '''Signature'''|{{Code|TIMEOUT GZIP [secondsboolean]}}
|-
| '''Default'''
|{{Code|0}} (''no timeout'')<code>false</code>
|-
| '''Summary'''
|Specifies the maximum time Jetty provides a read[https://www.eclipse.org/jetty/documentation/current/gzip-only transaction may takefilter.html Gzip handler] for dynamically uncompressing requests and compressing responses. If an operation takes longer than This feature can be enabled if Jetty is started via the specified timeout, it will [[Web Application|BaseX HTTP Server]]:* The option can also be aborted.enabled on [[Command-Line Options#HTTP Server|command line]] via <br/code>Write operations will not be affected by this timeout, as this would corrupt the integrity of the database.-g<br/code>The timeout is deactivated if .* It cannot be assigned via the timeout is set to {{Code|0web.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. It is ignored java#L187-L211 same defaults] of the web server will be applied (support for {{Code|ADMIN}} operationsGET requests, exclusion of binaries, MSIE 6.0, etc.).
|}
===AUTHTIMEOUTRESTXQPATH===
{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|AUTHTIMEOUT RESTXQPATH [secondspath]}}
|-
| '''Default'''
|{{Code|10}}''empty''
|-
| '''Summary'''
|Specifies Points to the maximum time reserved for creating directory which contains the [[RESTXQ]] modules of a new sessionweb application. If authentication takes longer than the specified timeout, the connection Relative paths will be closed.<br/>The timeout is deactivated if resolved against the timeout is set to {{CodeOption|0WEBPATH}}directory.
|}
===KEEPALIVEPARSERESTXQ=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|KEEPALIVE [seconds]PARSERESTXQ}}
|-
| '''Default'''
|{{Code|03}} (''no timeout'')
|-
| '''Summary'''
|Specifies Timeout after which the maximum time a client RESTXQ directory will be remembered by the server. parsed for changes:* If there has been no interaction with a client for a longer time than {{Code|0}} is specified by this timeout, it the directory will be disconnectedparsed every time a RESTXQ function is called. Running operations * A positive value defines the idle time in seconds after which parsing will not be affected by this optionenforced. The keepalive check is deactivated if the default value is set to {{Code|03}}: 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.
|}
=Create Options==RESTXQERRORS=== {{Mark|Updated with BaseX 9.5:}} Additionally suppress stack trace in HTTP response.
===CHOP==={|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CHOPRESTXQERRORS}}
|-
| '''Default'''
|-
| '''Summary'''
|Chops all leading Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and trailing whitespaces from text nodes while building 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 databaselogs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.|} ===RESTPATH=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|RESTPATH [path]}}|-| '''Default'''|''empty''|-| '''Summary'''|Points to the directory which contains XQuery files and command scripts, and discards empty text nodeswhich can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the {{Option|WEBPATH}} directory. This option often reduces |} ===HTTPLOCAL=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|HTTPLOCAL [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|By default, if BaseX is run as [[Web Application]], the database size server instance will be started in addition, which can then be addressed by up [[Clients]] via the database port (see {{Option|PORT}}).<br/>If the option is set to 50%{{Code|true}}, no database server will be launched.
|}
===INTPARSESTOPPORT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|INTPARSESTOPPORT [port]}}
|-
| '''Default'''
|{{Code|true8985}}
|-
| '''Summary'''
|Uses This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:* The listener for stopping the internal XML parser instead of web server will only be started if the standard Java XML parserspecified 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-ofused as a [[Web Application]] or started via [[Web Application#Maven|Maven]].* This option can also be changed when running the HTTP server on [[Command-theLine Options#BaseX Server|command line]] via <code>-box, but it does not support all features needed for parsing DTDss</code>.
|}
=Create Options= ==General== ===DTDMAINMEM=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DTDMAINMEM [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Parses referenced DTDs and resolves XML entitiesIf 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. By defaultHowever, this option it is switched possible to export the database via the {{CodeCommand|falseEXPORT}}command, as many DTDs are located externally, which may completely block and create a new database from the process of creating new databasesexported file in a second step. The * This option will not be available for [[Database Module#CATFILEdb:create|CATFILEdb:create]] option can , because the database would not be changed to locally resolve DTDsaccessible anymore after database creation, i. e., outside the query scope.
|}
===CATFILEADDCACHE=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CATFILE ADDCACHE [pathboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Specifies a catalog file If this option is activated, data structures of documents will first be cached to locally resolve DTDs; see 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 entry on [[Catalog Resolver]]s for more detailsinput size (e.g. when adding directories or sending input streams).
|}
 
==Parsing==
===CREATEFILTER===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|CREATEFILTER [filter]}}
|-
===ADDARCHIVES===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|ADDARCHIVES[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc.) are parsed whenever new database databases are created or resources are added to a database.|} ===ARCHIVENAME=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|ARCHIVENAME [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|If this option is set to {{Code|true}}, the file name of parsed archives will be included in the document paths.
|}
===SKIPCORRUPT===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SKIPCORRUPT[boolean]}}
|-
| '''Default'''
===ADDRAW===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|ADDRAW[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|If this option is activatedenabled, and if new all resources are added to a database, all files that are not filtered out by the [[#CREATEFILTER{{Option|CREATEFILTER]] }} option while being added to a database will be added stored as ''[[Binary Data|raw'' files ]] instead (i.e., in their binary representation).
|}
===PARSER===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|PARSER [type]}}
|-
|-
| '''Summary'''
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'Available parsers are {{Code|XML'}}, '{{Code|JSON'}}, '{{Code|CSV'}}, '{{Code|TEXT'}}, '{{Code|HTML' are available as parsers}}, and {{Code|RAW}}. HTML input will be parsed as normal XML files documents if [http:[Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.|} ===CSVPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CSVPARSER [options]}}|-| '''Default'''|''empty''|-| '''Summary'''|Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</homecode>.ccilThe available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]].org|-| '''Examples'''|<code>encoding=CP1252,header=true</~cowancode> parses the input as CP1252 and the first line as header.|} ===JSONPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|JSONPARSER [options]}}|-| '''Default'''|''empty''|-| '''Summary'''|Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</XMLcode>, and multiple options are delimited with <code>,</tagsoupcode>. The available options (except for the additional <code>encoding</ Tagsoupcode> option) are described in the [[JSON Module#Options|JSON Module]] is not found in .|-| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the classpathinput as JSONML and uses lax parsing.
|}
===PARSEROPTHTMLPARSER=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARSEROPT HTMLPARSER [options]}}
|-
| '''Default'''
|-
| '''Summary'''
|Defines parser-specific Specifies the way how HTML data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options; see are described in the [[Parsers#Options|Parsers]] for more informationarticle.|-| '''Examples'''|* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.* <code>lexical=true</code> preserves comments.
|}
===HTMLOPTTEXTPARSER==={{Mark|Introduced with Version 7.2:}}{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTMLOPT TEXTPARSER [options]}}
|-
| '''Default'''
|-
| '''Summary'''
|Allows to specify TagSoup Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options for HTML parsing; see are delimited with <code>,</code>. The available options are listed in the [[Parsers#HTML Parser|HTML Parser]] article.|-| '''Examples'''|<code>lines=true</code> creates a single element for more informationeach line of text.
|}
=Database =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.|}
===MAINMEMSTRIPNS=== {| 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> (&#xFFFD;)* Entities: around 250 HTML entities will be detected and decodedYou will be able to correctly parse most XML documents with the internal parser. Java’s Xerces parser is still used as default, however, because it supports all features of the XML standard and advanced DTD features, such as recursive entity expansion.|} ===DTD=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|MAINMEMDTD [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|If Parses referenced DTDs and resolves XML entities. By default, this option is turned onswitched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases will be exclusively created in main memory. Most queries will be evaluated faster in main memory mode, but all data is lost if BaseX is shut down. The value of this {{Option|CATFILE}} option will can be assigned once changed to a new database, and cannot be changed after thatlocally resolve DTDs.
|}
===PATHINDEXXINCLUDE=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PATHINDEXXINCLUDE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates a path index whenever a new database Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is createdswitched to {{Code|true}}. A 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 index helps ]}}|-| '''Default'''|''empty''|-| '''Summary'''|Semicolon-separated list of XML catalog files to optimize location paths; see resolve URIs. See [[IndexesCatalog 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%'
|-
| width='90120' | '''Signature'''|{{Code|TEXTINDEX[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see . See [[IndexesIndex#Text Index|Text Index]] for more details.
|}
===ATTRINDEX===
 {|width='100%'|-| width='120' | '''Signature'''|{{Code|ATTRINDEX [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''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='90120' | '''Signature'''|{{Code|ATTRINDEXTOKENINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates an attribute a token index whenever a new database is created. An attribute A token index speeds up queries with equality comparisons on searches for single tokens in attribute values; see . See [[IndexesIndex#Token Index|Token Index]] for more details.
|}
===FTINDEX===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|FTINDEX[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions; see . See [[Index#Full-Text Index|Full-Text Index]] for more details.|} ===TEXTINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TEXTINCLUDE [names]}}|-| '''Default'''|''empty''|-| '''Summary'''|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===ATTRINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|ATTRINCLUDE [names]}}|-| '''Default'''|''empty''|-| '''Summary'''|Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===TOKENINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TOKENINCLUDE [names]}}|-| '''Default'''|''empty''|-| '''Summary'''|Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===FTINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|FTINCLUDE [names]}}|-| '''Default'''|''empty''|-| '''Summary'''|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===MAXLEN===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|MAXLEN[int]}}
|-
| '''Default'''
|-
| '''Summary'''
|Specifies the maximum length of for strings that are to be indexed by the name, path, value, and full-text stored in [[Indexes|index structures]]. The value of this option will be assigned once to a new database, and cannot can only be changed after thatby creating a new database or doing a [[Commands#OPTIMIZE|full optimization]].
|}
===MAXCATS===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|MAXCATS[int]}}
|-
| '''Default'''
===UPDINDEX===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|UPDINDEX[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|If turned on, incremental indexing will be activatedenabled: all update operations will also update the value index structures (texts and attribute values). * The current value of this option will be assigned once to a new database, and cannot databases. It can be changed after thatfor existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or [[Database_Module#db:optimize|db:optimize($db, true())]]. The advantage of incremental indexes is that * After each update, the value index structures indexes will always be uprefreshed as well. Incremental updates are currently not available for the full-to-datetext index and database statistics. The downside is that updates will take a little bit longer* Find more details in the article on [[Index#Updates|Index Structures]].
|}
===WRITEBACKAUTOOPTIMIZE=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|WRITEBACKAUTOOPTIMIZE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Updates If turned on XML nodes are written back , auto optimization will be applied to new databases:* With each update, outdated indexes and database statistics will be recreated.* As a result, the input filesindex structures will always be up-to-date.* However, updates can take much longer, so this option should only be activated for medium-sized databases. Note that no backups * The value of your original files this option will be created if this option is turned onassigned once to a new database. It can be reassigned by running {{Command|OPTIMIZE}} or [[Database_Module#db:optimize|db:optimize]].
|}
===AUTOFLUSHSPLITSIZE==={||-| width='90' | '''Signature'''|{{Code|AUTOFLUSH}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the [[Commands#FLUSH|FLUSH]] command.|}
===MAXSTAT==={|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|MAXSTAT SPLITSIZE [num]}}
|-
| '''Default'''
|{{Code|300}}
|-
| '''Summary'''
|Specifies This option affects the maximum number of index occurrences printed by the <code>[[CommandsIndexes#INFOPerformance|INFO INDEXconstruction]]</code> commandof new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk:* By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption. Usually, this works fine.* If explicit garbage collection is disabled when running Java (e.g. via the JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to choose a custom split size.* You can e. g. start with {{Code|1000000}} (one million) index operations and adjust this value in the next steps.* The larger the assigned value is, the less splits will take place, and the more main memory will be required.
|}
==Full-Text OptionsIndexing==
===STEMMING===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|STEMMING[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|A new If {{Code|true}}, all tokens will be stemmed during full-text index indexing, using a language-specific stemmer implementation. By default, tokens will stem all tokens and speed up queries on not be stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this indexSee [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===CASESENS===
 {|width='100%'|-| width='90120' | '''Signature'''|{{Code|CASESENS[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|A new full-text index will preserve If {{Code|true}}, the case of all tokenswill be preserved during full-text indexing. The same By default, case normalization will be applied to ignored (all query tokens that are checked against tokens will be indexed in this indexlower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===DIACRITICS===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DIACRITICS[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|A new If set to {{Code|true}}, diacritics will be preserved during full-text index will preserve the diacritics of all tokensindexing. The same By default, diacritics normalization will be applied to all query tokens that are checked against tokens in this indexremoved. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===LANGUAGE===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LANGUAGE [lang]}}
|-
|-
| '''Summary'''
|A new full-text index The specified language will use influence the given language to normalize all tokensway how texts will be tokenized and stemmed. This option is mainly important if tokens are to It can be stemmed, or if the tokenization name of a language differs from Western languagesor a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===STOPWORDS===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|STOPWORDS [path]}}
|-
|-
| '''Summary'''
|A new If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index will drop tokens that are listed in the specified stopword listis created. A stopword list may decrease the size of the full text indexand speed up your queries. A standard stopword list See [[Indexes#Full-Text Index|Full-Text Index]] for English texts more details.|} =Query Options= ===QUERYINFO=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|QUERYINFO [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is provided shown in the [[GUI#Visualizations|Info View]] in the directory GUI. It can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>. |} ===MIXUPDATES=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|etc/stopwords.txtMIXUPDATES}}|-| '''Default'''|{{Code|false}} |-| '''Summary'''|Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the official releasesXQuery Update Facility, this option is set to {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for more details.
|}
===LSERRORBINDINGS=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|LSERROR BINDINGS [errorvars]}}
|-
| '''Default'''
|{{Code|0}}''empty''
|-
| '''Summary'''
|This option specifies 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 maximum Levenshtein error for default namespace, it can be specified with the BaseX[http://www.jclark.com/xml/xmlns.htm Clark Notation] or [https://www.w3.org/TR/xquery-30/#id-specific fuzzy match basics Expanded QName Notation].This option. See the page can also be used on [[FullCommand-TextLine Options#Fuzzy_QueryingBaseX Standalone|Fullcommand line]] with the flag <code>-Textsb</code>.|-| '''Examples'''|* <code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a* <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.* In the following [[Commands#Command_Scripts| Command Script]] for more information on fuzzy querying., 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>
|}
===WILDCARDSINLINELIMIT===
{{Mark|Removed in Updated with Version 79.35:}} new index supports both fuzzy and wildcard queriesdefault reduced to 50.
{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|WILDCARDSINLINELIMIT}}
|-
| '''Default'''
|{{Code|false50}}
|-
| '''Summary'''
|If This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to speed up query evaluation.* Inlining will only take place if a new full-text index function body is creatednot too large (i.e., if it will does not contain too many expressions).* With this option, this maximum number of expressions can be specified.* Function inlining can be particularly optimized for wildcards expressionsturned off by setting the value to {{Code|0}}. See * The limit can be locally overwritten via the page on [[Full-TextXQuery Extensions#Function Inlining|%basex:inline]]s for annotation (follow the link to get more information on XQuery Full Textfunction inlining).
|}
===SCORINGUNROLLLIMIT===
{{Mark|Removed in Introduced with Version 79.36:}} new scoring model will focus on lengths of text nodes and match options.
{|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SCORING [mode]UNROLLLIMIT}}
|-
| '''Default'''
|{{Code|05}}
|-
| '''Summary'''
|A new full-text index will pre-calculate full-text scores. This option enables TF/IDF/based scores in full-text queries and increases main controls the unroll limit:* Loops with few iterations are ''unrolled'' by the XQuery compiler to enable further optimizations.* If the limit is increased, more optimizations will take place, but the memory consumption while indexingand compile time will increase. * See the [[Full-TextXQuery Optimizations#ScoringLoop Unrolling|ScoringLoop Unrolling]] for more information on different scoring typesdetails.
|}
=Query Options==ENFORCEINDEX===
===QUERYINFO==={|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|QUERYINFOENFORCEINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Prints more information on internal query Enforces index rewritings, optimizations, and performancein path expressions. The query info will always be printed in the [[GUI#Visualizations|Info View]] in the GUI, or it can be activated with the See [[Startup_OptionsIndexes#BaseX_StandaloneEnforce Rewritings|-V flagEnforce Rewritings]] on command linefor details.
|}
===XQUERY3COPYNODE=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|XQUERY3COPYNODE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Enables all When creating new nodes in XQuery via [[XQuery 3https://www.w3.0org/TR/xquery-31/#id-constructors Node Constructors]] features supported by BaseX, all enclosed nodes will be copied, and all resulting nodes will get new node identities. If This step can be very expensive, and it can be disabled with this option is set to {{Code|false}}. The option should be used carefully, as it changes the XQuery parser will only accept expressions standard behavior of the XQuery 1.0 specificationIt should preferrably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].
|}
===SERIALIZETAILCALLS=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERIALIZETAILCALLS}}
|-
| '''Default'''
|{{Code|true256}}
|-
| '''Summary'''
|Results Specifies how many stack frames of XQuery expressions will be serialized if [https://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this option limit is turned onreached, tail-call optimization takes place and some call frames are eliminated. For debugging purposes and performance measurements, this option The feature can be set turned off by setting the value to {{Code|false-1}}.
|}
===BINDINGSWITHDB=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|BINDINGS [vars]WITHDB}}
|-
| '''Default'''
|''empty''{{Code|true}}
|-
| '''Summary'''
|Contains external variables to be bound to a query. Variable names and values are separated by equality signs, and multiple variables are delimited by commas. Variables may optionally be introduced with a leading dollar sign. Commas that occur in the value itself are encoded by duplication. If a variable uses a namespace different to the By default namespace, it can be resources specified with the via [[httpDatabases#XML Documents|fn://www.jclark.com/xml/xmlns.htm Clark Notationdoc]] or and [[httpDatabases#XML Documents|fn://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notationcollection]]are looked up both in the database and in the file system.|-| '''Examples'''|<code>$a=1,$b=2</code> &nbsp; binds the values If you always use {{CodeFunction|1}} and {{CodeDatabase|2db:open}} to the variables $a and $b<br/><code>a=1access databases,,2</code> &nbsp; binds the value {{Code|1,2}} it is recommendable to the variable $a<br/><code>{URI}a=x</code> or <code>'URI'disable this option:a=x</code> &nbsp; binds * No locks will be created for the value {{Codetwo functions (see [[Transaction Management#Limitations|x}} limitations of database locking]] for more details).* Access to local and external resources will be faster, as the variable $a with the namespace {{Code|URI}}database lookup will be skipped.
|}
===SERIALIZERDEFAULTDB=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERIALIZER [params]DEFAULTDB}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Contains parameters for serializing queries; see If this option is turned on, paths specified in the [[SerializationDatabases#XML Documents|fn:doc]] for more details. Keys and values are separated by equality signs, and multiple parameters are delimited by commas.|-| '''Example'''[[Databases#XML Documents|<code>encoding=US-ASCII,omit-xml-declaration=no</code> fn: sets collection]] functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the encoding to {{CodeCommand|US-ASCIIOPEN}} and prints command). If the path does not match any existing resources, it will be resolved as described in the XML declarationarticle on [[Databases#Access Resources|accessing database resources]].
|}
===EXPORTERFORCECREATE=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|EXPORTER FORCECREATE [paramsboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Contains parameters for exporting all resources of a By activating this option, database; see instances will be created with the XQuery functions [[SerializationDatabases#XML Documents|fn:doc]] for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas[[Databases#XML Documents|fn:collection]].
|}
===QUERYPATHCHECKSTRINGS=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|QUERYPATH CHECKSTRINGS [pathboolean]}}
|-
| '''Default'''
|''empty''{{Code|true}}
|-
| '''Summary'''
|Contains By default, characters from external sources that are invalid in XML will trigger an error. If the path (''base URI'') option is set to <code>false</code>, these characters will be replaced with the executed query Unicode replacement character <code>FFFD</code> (default: ''empty''&#xFFFD;). This directory will be used to resolve relative paths to documentsThe option affects [[Java Bindings]] and string conversion and input functions such as [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], query modules[[Archive Module#archive:update|archive:update]], and other resources addressed in a query[[ZIP Module#zip:text-entry|zip:text-entry]].
|}
===CACHEQUERYLSERROR=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CACHEQUERYLSERROR [error]}}
|-
| '''Default'''
|{{Code|false0}}
|-
| '''Summary'''
|Caches This option specifies the query results before returning them to the clientmaximum Levenshtein error for fuzzy full-text matching. This option may be set to By default, if {{Code|true0}} if is assigned, the whole result error value is needed calculated dynamically. See [[Full-Text#Fuzzy_Querying|Fuzzy Querying]] for further operations (such as is e.g. the case in the GUI of BaseX)more details.
|}
===FORCECREATERUNQUERY=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|FORCECREATERUNQUERY [boolean]}}
|-
| '''Default'''
|{{Code|falsetrue}}
|-
| '''Summary'''
|By activating this Specifies if a query will be executed or parsed only. This option, the XQuery {{Codecan also be changed on [[Command-Line Options#BaseX Standalone|doc()}} and {{Code|collection()}} functions will create database instances for the addressed input filescommand line]] via <code>-R</code>.
|}
===RUNS===
 {|width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|RUNS [num]}}
|-
|-
| '''Summary'''
|Specify number of runs Specifies how often a query will be evaluated. The result is executed. Results are printed a single time serialized only once, and evaluation 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>.
|}
=Serialization Options=
 
===SERIALIZE===
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|SERIALIZE [boolean]}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.
|}
 
===SERIALIZER===
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|SERIALIZER [params]}}
|-
| '''Default'''
|''empty''
|-
| '''Summary'''
|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>-s</code>.
|-
| '''Examples'''
|
* <code>indent=no</code> : disables automatic indentation of XML nodes. This is usually a good choice when working with [[Full-Text#Mixed Content|Mixed-Content Data]].
* <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.
* <code>item-separator=,,</code> : separates serialized items by a single comma.
|}
 
===EXPORTER===
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|EXPORTER [params]}}
|-
| '''Default'''
|''empty''
|-
| '''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.
|-
| '''Examples'''
|
* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
|}
===XMLPLAN===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|XMLPLAN[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.
|}
===COMPPLAN===
 {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|COMPPLAN[boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates Generates the query plan , which can be activated via {{Option|XMLPLAN}}, before or after the query compilation step. Query plans might change due to optimizationsThis option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>.
|}
===DOTPLANFULLPLAN=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTPLANFULLPLAN [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Visualizes Attaches the execution plan file path, line and column of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file the expressions in the original query string to the query directoryplan. Values (items and sequences) have no input information attached.
|}
=Other Options= ===DOTCOMPACTAUTOFLUSH=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTCOMPACTAUTOFLUSH [boolean]}}
|-
| '''Default'''
|{{Code|falsetrue}}
|-
| '''Summary'''
|Chooses 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 compact dot representationdrawback, the chance of data loss increases if the database is not explicitly flushed via the {{Command|FLUSH}} command.
|}
===DOTDISPLAYWRITEBACK=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTDISPLAYWRITEBACK [boolean]}}
|-
| '''Default'''
|{{Code|truefalse}}
|-
| '''Summary'''
|Visualizes Propagates 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>-u</code>.* Please take in mind that no backup will be created from your original files.* The serialization options can be controlled via the dot representation after the query execution{{Option|EXPORTER}} option.
|}
===DOTTYMAXSTAT=== {|width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTTY MAXSTAT [pathnum]}}
|-
| '''Default'''
|{{Code|dotty30}}
|-
| '''Summary'''
|Location Specifies the maximum number of index occurrences printed by the {{CodeCommand|dottyINFO INDEX}} executablecommand.
|}
=Changelog=
 
;Version 9.6
* Added: {{Option|UNROLLLIMIT}}
 
;Version 9.5
* Updated: {{Option|INLINELIMIT}}: default reduced to 50.
* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response
 
;Version 9.4
* Added: {{Option|LOGTRACE}}
 
;Version 9.3
* Added: {{Option|WITHDB}}, {{Option|GZIP}}
 
;Version 9.2
* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}
* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
 
;Version 9.0
* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
 
;Version 8.6
* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}
* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)
* Removed: {{Code|QUERYPATH}} (will now be internally assigned)
* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ)
 
;Version 8.5
* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added.
 
;Version 8.4
* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}
* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)
* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code>
 
;Version 8.3
* Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}}
 
;Version 8.2
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
 
;Version 8.1
* Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}}
 
;Version 8.0
* Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}}
* Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored.
 
;Version 7.8.1
* Updated: {{Option|ADDARCHIVES}}: parsing of TAR and TGZ files.
 
;Version 7.8
 
* Added: {{Option|CSVPARSER}}, {{Option|JSONPARSER}}, {{Option|TEXTPARSER}}, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}}
* Updated: {{Option|WRITEBACK}} only applies to main-memory document instances.
* Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions.
* Updated: default of {{Option|INTPARSE}} is now {{Code|false}}.
* Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
 
;Version 7.7
* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}}
 
;Version 7.6
* Added: {{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
 * AddedUpdated: <code>[[#AUTHTIMEOUT{{Option|AUTHTIMEOUT]]</code>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: <code>[[#PROXYHOST{{Option|PROXYHOST]]</code>}}, <code>[[#PROXYPORT{{Option|PROXYPORT]]</code>}}, <code>[[#NONPROXYHOSTS{{Option|NONPROXYHOSTS]]</code>}}, <code>[[#HTMLOPT{{Option|HTMLOPT]]</code>}}* Updated: <code>[[#TIMEOUT{{Option|TIMEOUT]]</code>}}: ignore timeout for admin users
;Version 7.1
 * Added: <code>[[#ADDRAW{{Option|ADDRAW]]</code>}}, <code>[[#MAXLEN{{Option|MAXLEN]]</code>}}, <code>[[#MAXCATS{{Option|MAXCATS]]</code>}}, <code>[[#UPDINDEX{{Option|UPDINDEX]]</code>}}* Updated: <code>[[#BINDINGS{{Option|BINDINGS]]</code>}}
;Version 7.0
 * Added: <code>[[#SERVERHOST{{Option|SERVERHOST]]</code>}}, <code>[[#KEEPALIVE{{Option|KEEPALIVE]]</code>}}, <code>[[#AUTOFLUSH{{Option|AUTOFLUSH]]</code>}}, <code>[[#QUERYPATH{{Option|QUERYPATH]]</code>}}
administrator, editor
4

edits

Navigation menu