Changes

<p>This page is linked from the [[Getting Started]] Section. The following <code>options listed on this page influence the way how database [[optionCommands|commands]]</code>s are available executed and can be changed using theXQuery expressions are evaluated. Two kinds of options exist: <a href=* 'commands#set'><code>'set[[#Global Options|Global Options]]'''-command<are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/code></a>server architecture. Either they can be turned[on]/[off] * '''Local options''' (all remaining ones) are specific to a client or a value can be set:</p> session. <h3>General Values of options</h3> <ul> <li><code>debug</code>: Show internal debug infoare either ''strings'', ''numbers'' or ''booleans''. Options are ''static'' and not bound to a single operation (for example, usually used for development of new featuresthe next command).</li> Various ways exist to access and change options: <li><code>mainmem</code>: Use main-memory mode* The current value of an option can be requested with the {{Command|SHOW OPTIONS}} command. Now Local options can be changed via {{Command|SET}} (all data global options, except for {{Option|DEBUG}}, can only be changed at startup time). If an option is stored exclusively in main memory of type ''boolean'', and enables even faster evaluation timesif no value is specified, but the data its current value is lost after shut down of BaseXinverted.</li> <li><code>timeout * The {{Code|.basex}} [[TIMEConfiguration#Configuration Files|configuration file]</code>: Set server timeout in seconds] is parsed by every new local BaseX instance. It contains all global options. The timeout describes Local options can be specified at the maximum execution time end of a query at the BaseX server. The timeout is deactivated if file after the {{Code|Local Options}} comment: <codepre lang="perl">TIME# General OptionsDEBUG = false... # Local OptionsCATALOG = etc/w3-catalog.xml</codepre> is set to <code>0< * Initial values for global options can also be specified via system properties, which can be passed on with the [https://code>docs.oracle.<com/en/java/li> <li><code>serverport [PORT]<javase/code>: Client11/server communication: <code>PORT<tools/code>java.html -D flag] on the command line, used for starting the server.</li> <li><code>restport or with [PORT]</code>https: Client/server communication: <code>PORT</code>, used for starting the REST serverdocs.oracle.<com/en/java/li> <li><code>host [HOST]<javase/11/code>: Clientdocs/server communication: <code>HOST<api/code>, used for connecting new clientsjava.<base/li> <li><code>port [PORT]<java/code>: Clientlang/server communication: <code>PORT</code>System.html#setProperty(java.lang.String, used for connecting new clientsjava.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}.</li> </ul> An example: <h3>Database options</h3pre lang="perl"> <ul> java -Dorg.basex.CATALOG=etc/w3-catalog.xml -cp basex.jar org.basex.BaseX -c"SHOW OPTIONS catalog"<li><code>dbpath [PATH]</code>CATALOG: Set a new database <code>PATH<etc/code>w3-catalog.xml</lipre> <li><code>chop</code>: Chop all XML whitespace nodes and reduce * If the Mac OS X packaged application is used, global options can be set within the Info.plist file within the memory consumption Contents folder of the database without lack of informationapplication package.For example: <pre lang="xml"><key>JVMOptions</likey> <liarray> <codestring>intparse-Dorg.basex.CATALOG=etc/w3-catalog.xml</codestring>: Use internal XML parser instead of standard Java XML parser and reduce main memory consumption.</liarray> <li/pre> * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows: <codepre lang="xml">entity</codecontext-param>: Internal parser parses XML entities <param-name>org.basex.catalog</liparam-name> <liparam-value><code>dtd<etc/code>: Internal parser parses a DTD and checks the parsed XML data against the DTDw3-catalog.xml</liparam-value> <li/context-param><code>pathindex</codepre>: Create index for paths  * In XQuery, local options can be set via option declarations and speedup path based queries[[XQuery Extensions#Pragmas|pragmas]]. If options are changed by operations in the [[GUI]], the underlying commands are output in the [[GUI#Visualizations|Info View]].<br/li> <li><code>textindex</code>: Create index for text nodes and speedup queries querying =Global Options= Global options are constants. They can only be set in the entire text of a nodeconfiguration file or via system properties (see above).</li> <li><code>attrindex</code>: Create index for attribute values and speedup queries querying attribute valuesOne exception is the [[#debug|DEBUG]] option, which can also be changed at runtime by users with [[User Management|admin permissions]].</li> <li><code>ftindex</code>: Create index for fulltext and speedup queries querying full text.</li> <li><code>wildcards</code>: Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions.</li> ==General Options== ===DEBUG=== <li><code>stemming</code>: Stemm full text tokens before indexing and decrease index size. Should only be assigned for full text queries using stemming, otherwise the full text index could not be assigned for query speedups.</li> {| width='100%'|- valign="top"<li><code>casesens</code>: Case sensitive full text indexing, i| width='120' | '''Signature'''|{{Code|DEBUG [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|Sends debug information to STDERR.eThis option can be enabled to get additional information for development and debugging purposes. full text tokens are stored case sensitive and enables It can also be triggered on the assignment of the full text index for case sensitive queries.</li> <li>[[Command-Line Options#BaseX Standalone|command line]] via <code>diacritics-d</code>: Diacritic sensitive full text indexing, i.e. full text tokens are stored with diacritics and enables Note that the assignment amount of the full text index for diacritic queriesoutput can be overwhelming, so it should not be used productively.</li> <li><code>language [LANG]</code>: Language for full|} ===DBPATH=== {| width='100%'|-text search index, e.g. valign="top"| width='120' | '''Signature'''|{{Code|DBPATH [path]}}|- valign="top"| '''Default'''|<code>LANG</code> can be set to <code>English[[Configuration#Database Directory|{home}/data]]</code> or <code>German</code>.</li> <li><code>scoring [MODE]</code>: Precalculation of full text scores and storage within |- valign="top"| '''Summary'''|Points to the full text index structure. Enables TF/IDF based scores in full text queries and increases memory consumption while indexingdirectory in which all databases are located. |} ===LOGPATH=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|LOGPATH [path]}}|- valign="top"| '''Default'''|<code>MODE.logs</code> can be set |- valign="top"| '''Summary'''|Points to the directory where [[Logging|log files]] are stored. Relative paths are resolved against the {{Option|DBPATH}} directory.|} ===REPOPATH=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|REPOPATH [path]}}|- valign="top"| '''Default'''|<code>1</code> for document based scoring, <code>2</code> for text node based scoring and <code>0[[Configuration#Database Directory|{home}/repo]]</code> for non scoring.</li> <li><code>stopwords |- valign="top"| '''Summary'''|Points to the [[PATHRepository]]</code>: Specify stop word list at <code>PATH</code>, that could be used ein which all XQuery modules are located.g. to decrease the full text index size. The standard stopword list (english) is provided at <code>|} ===LANG=== {| width='etc/xml/stopWords100%'</code>.</li> <li><code>lserror |- valign="top"| width='120' | '''Signature'''|{{Code|LANG [ERRORlanguage]</code>: Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOption, e}}|- valign="top"| '''Default'''|{{Code|English}}|- valign="top"| '''Summary'''|Specifies the interface language.g. <code>ERROR</code> could be <code>2</code>.</li> <li><code>createfilter [FILTER]</code>: Path for filtering xml documents, e.g. <code>FILTER</code> could be <code>|} ===FAIRLOCK=== {| width='*.xml100%'</code>.</li> <li><code>compress [MODE]</code>: Compress text in database. Activate with setting <code>MODE</code> to <code>1</code></li> |- valign="top"| width='120' | '''Signature'''</ul> |{{Code|FAIRLOCK [boolean]}} |- valign="top"<h3>Query options</h3> | '''Default'''|{{Code|false}}|- valign="top"<ul> | '''Summary'''<li><code>queryinfo</code>|Defines the locking strategy: Show * By default, non-fair locking is used. Read transactions are favored, and transactions that no not access databases can be evaluated even if the limit for parallel transactions (allspecified via {{Option|PARALLEL}}) process infois reached. This prevents update operations from blocking all other requests.</li> <li><code>serialize</code>: Flag for serialization of query results. I.e. there For example, the DBA can still be used to see which jobs are any results printed running even if serialization the queue is turned offfull.</li> <li><code>wrapoutput</code>: Serialize query results as XML* When fair locking is enabled, read and write transactions are treated equally (first in, ifirst out).e. the result output This avoids starvation of updates and should be used when prompt evaluation of updates is a valid xml documentcritical.</li> <li><code>serializer |} ===CACHETIMEOUT=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|CACHETIMEOUT [ARGSseconds]</code>: Serialization parameters <code>ARGS</code>, separated by commas.</li> }}|- valign="top"<li><code>exporter | '''Default'''|{{Code|3600}}|- valign="top"| '''Summary'''|Specifies how many seconds the results of [[ARGSJob Module|asynchronously executed jobs]]<are cached in main memory.|} ==Client/code>: Exporter serialization parameters <code>ARGS</code>, separated by commas.</li> Server Architecture== ===HOST=== {| width='100%'|- valign="top"| width='120' | '''Signature'''<li><code>runs |{{Code|HOST [NUMhost]</code>: Specify number of runs a query }}|- valign="top"| '''Default'''|{{Code|localhost}}|- valign="top"| '''Summary'''|This host name is executed. Results are printed used by the client when connecting to a single time and evaluation times are averages of all runsserver.</li> <li>This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>tablemem-n</code>: Loading database table into main memory and speedup evaluation times.</li> </ul> |} <h3>Print query options</h3> ===PORT=== <ul> {| width='100%'|- valign="top"<li><code>dotplan</code>: Create query plans visualized with <a href| width='http://www.graphviz.org/120' | '''Signature'>dotty</a>, see <code>'plan.dot'</code> file in your project folder.</li> <li><code>dotcompact</code>: Compact dot representation.</li> |{{Code|PORT [port]}}<li><code>dotdisplay</code>: Display dot representation after query execution.</li> |- valign="top"<li><code>dotty | '''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 [[PATHCommand-Line Options#BaseX Client|command line]]via </code>: Program -p</code>PATH</code> of dotty executable.</li> <li><code>xmlplan</code>: Print query plan as xml document.</li> |} ===SERVERPORT=== <li><code>compplan</code>: Create query plan before or after compilation {| width='100%'|- query plan might change due to optimizations.</li> valign="top"<li><code>cachequery</code>: Cache the query results.</li> | width='120' | '''Signature'''<li><code>maxtext |{{Code|SERVERPORT [SIZEport]</code>: Maximum text size }}|- valign="top"| '''Default'''|{{Code|1984}}|- valign="top"| '''Summary'''|This is the port the database server is listening to be displayed, e.g. <code>SIZE</code> could This option can also be <changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>1024-p</code> for displaying maximal 1024 bytes.</li> <li><code>maxstat |} ===USER=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|USER [NUMname]</code>: Set maximum number of index occurrences to print (through }}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Represents a username, which is used for accessing the command info index), eserver or an HTTP service:* The default value is overwritten if a client specifies its own credentials.g* If the default value is empty, login will only be possible if the client specifies credentials. <code>NUM</code> could * The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>15-U</code> for displaying fifteen index occurrences.</li> <li><code>writeback</code>: Write original files back after updates.</li> |} </ul> ===PASSWORD=== <h3>DeepFS options</h3> {| width='100%'<ul> |- valign="top"<li><code>fsmeta</code>: Import file metadata.</li> | width='120' | '''Signature'''|{{Code|PASSWORD [password]}}<li><code>fscont</code>: Import file content.</li> |- valign="top"<li><code>fsxml</code>| '''Default'''|''empty''|- valign="top"| '''Summary'''|Represents a password, which is used for accessing the server: Import xml contents* The default value is overwritten if a client specifies its own credentials.</li> <li><code>fstextmax [SIZE]</code>: Maximal size of textual imports* If the default value is empty, eauthentication will only be possible if the client supplies credentials.g. <code>SIZE</code> could * The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>1024-P</code> for importing less equal 1024 bytes.</li> <li><code>fsverbose</code>: Verbose debug informations for file system traversal* Please note that it is a security risk to specify your password in plain text.</li> <li><code>fuse</code>: Fuse support.</li> |} <li><code>spotlight</code>: Spotlight integration on mac platforms, i.e. the spotlight index is used instead of the internal parser implementations.</li> ===AUTHMETHOD=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|AUTHMETHOD [method]}}|- valign="top"</ul| '''Default'''|''Basic''|- valign="top"| '''Summary'''|Specifies the default authentication method used by the [[Web Application|HTTP server]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}:* If basic access is chosen, the client can still request digest authentication.* This is different for digest access, which cannot be overwritten.* With custom authentication, the server will not do any authentication.|} ===SERVERHOST=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|SERVERHOST [host&#x7c;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 accepts requests from all clients.|} ===PROXYHOST=== {| 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 is ignored.|} ===PROXYPORT=== {| 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 is ignored.|} ===NONPROXYHOSTS=== {| 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 is ignored.|} ===IGNORECERT=== {| 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.|} ===TIMEOUT=== {| 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. An operation is interrupted when it takes longer than the specified number of seconds. Running update operations are not affected by this timeout, as this would corrupt the integrity of the database. The timeout is disabled if the timeout is set to {{Code|0}}. It is ignored for operations with [[User Management|admin permissions]].|} ===KEEPALIVE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|KEEPALIVE [seconds]}}|- valign="top"| '''Default'''|{{Code|600}}|- valign="top"| '''Summary'''|Specifies the maximum time a client is 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 check is disabled if the value is set to {{Code|0}}.|} ===PARALLEL=== {| 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]]:* 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%'|- 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>.|} ===LOGMSGMAXLEN=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|LOGMSGMAXLEN [length]}}|- valign="top"| '''Default'''|{{Code|1000}}|- valign="top"| '''Summary'''|Specifies the maximum length of a single [[Logging|log message]].|} ===LOGTRACE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|LOGTRACE [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|If BaseX is running as a [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and similar functions) is written to the [[Logging|database logs]]. When this option is disabled, trace output is 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 are set before the web server is started: ===WEBPATH=== {| 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:* 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 is evaluated before the configuration files are parsed.|} ===GZIP=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|GZIP [boolean]}}|- valign="top"| '''Default'''|<code>false</code>|- valign="top"| '''Summary'''|Jetty provides a [https://www.eclipse.org/jetty/documentation/current/gzip-filter.html Gzip handler] for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the [[Web Application|BaseX HTTP Server]]:* The option can also be enabled on [[Command-Line Options#HTTP Server|command line]] via <code>-g</code>.* It cannot be assigned via the {{Code|web.xml}} file, as the option is evaluated before the configuration files are parsed.* In addition to the [https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 Jetty defaults] (GET requests, exclusion of binaries, MSIE 6.0, etc.), POST and PUT requests are supported.|} ===RESTXQPATH=== {| 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 are resolved against the {{Option|WEBPATH}} directory.|} ===PARSERESTXQ=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|PARSERESTXQ}}|- valign="top"| '''Default'''|{{Code|3}}|- valign="top"| '''Summary'''|Timeout after which the RESTXQ directory is parsed for changes:* If {{Code|0}} is specified, the directory is parsed every time a RESTXQ function is called.* A positive value defines the idle time, in seconds, after which parsing is enforced. The default value is {{Code|3}}: Changes in the RESTXQ directory is detected after 3 seconds without RESTXQ function calls.* Monitoring is completely disabled if a negative value is specified. See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details.|} ===RESTXQERRORS=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|RESTXQERRORS}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.|} ===RESTPATH=== {| width='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 are resolved against the {{Option|WEBPATH}} directory.|} ===HTTPLOCAL=== {| 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 is started in addition, which can then be addressed by [[Clients]] via the database port (see {{Option|PORT}}). If the option is set to {{Code|true}}, no database server is launched.|} ===STOPPORT=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|STOPPORT [port]}}|- valign="top"| '''Default'''|{{Code|8081}}|- valign="top"| '''Summary'''|If Jetty is started from BaseX, this is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be closed:* The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}.* The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].* This option can also be changed when running the HTTP server on [[Command-Line Options#BaseX Server|command line]] via <code>-s</code>.|} =Create Options= ==General== ===MAINMEM=== {| 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 arecreated in main memory:* Most queries are evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down.* It is not possible to store binary resources in a main-memory database.* A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new database from the exported file in a second step.* This option will not be available for {{Function|Database|db:create}} because the database would not be accessible anymore after database creation, i.e., outside the query scope.|} ===ADDCACHE=== {| 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).|} ==Parsing== ===CREATEFILTER=== {| 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.|} ===ADDARCHIVES=== {| 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.|} ===ARCHIVENAME=== {| 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 is included in the document paths.|} ===SKIPCORRUPT=== {| 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 are parsed twice. Next, main-memory consumption is higher, as parsed files are cached in main memory.|} ===ADDRAW=== {| 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 are stored as [[Binary Data|raw files]] instead (i.e., in their binary representation).|} ===PARSER=== {| 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 is parsed as XML if [[Parsers#HTMLParser|Tagsoup]] is not found in the class path.|} ===CSVPARSER=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|CSVPARSER [options]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Specifies the way how CSV data is 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.|} ===JSONPARSER=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|JSONPARSER [options]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Specifies the way how JSON data is 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.|} ===HTMLPARSER=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|HTMLPARSER [options]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Specifies the way how HTML data is 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'''|* <code>encoding=Shift-JIS,nons=true</code> parses the input as Shift-JIS and suppresses namespaces.* <code>lexical=true</code> preserves comments.|} ==XML Parsing== ===STRIPWS=== {| 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:* If the option is set to {{Code|true}}, leading and trailing whitespaces from text nodes are stripped and empty text nodes are discarded.* The flag should be disabled if a document contains [[Full-Text#Mixed Content|mixed content]].* The flag can also be turned on via the [[Command-Line Options#BaseX Standalone|command line]] and <code>-w</code>.* If the option is enabled, whitespaces of an element and its descendants can locally be preserved with the <code>xml:space="preserve"</code> attribute: <pre lang="xml"><xml> <title> Demonstrating the STRIPWS flag </title> <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text></xml></pre>If whitespaces are stripped, <code>indent=yes</code> can be assigned to the {{Option|SERIALIZER}} option to get properly indented XML output.<br/>See [[BaseX_10#Whitespaces|BaseX 10: Whitespaces]] for more information on whitespace handling.|} ===STRIPNS=== {| 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.|} ===INTPARSE=== {| 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. Reasons for using the internal parser are:* Performance: Documents, in particular small ones, are parsed faster.* Entity support: More than 2000 [https://html.spec.whatwg.org/multipage/named-characters.html HTML character references] are decoded.* Fault tolerance: Invalid characters are replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;).By default, Java’s Xerces parser is used as it supports all features of the XML standard, including {{Option|XINCLUDE}}, or recursive entity expansion if specified in DTDs.|} ===DTD=== {| 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.|} ===XINCLUDE=== {| 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}}).|} ===CATALOG=== {| 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.|} ==Indexing== The following options control the creation of index structures. The current values are considered if a new database is created. See [[Indexes]] for more details. ===TEXTINDEX=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|TEXTINDEX [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes. See [[Index#Text Index|Text Index]] for more details.|} ===ATTRINDEX=== {| 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.|} ===TOKENINDEX=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|TOKENINDEX [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See [[Index#Token Index|Token Index]] for more details.|} ===FTINDEX=== {| 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.|} ===TEXTINCLUDE=== {| 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 are indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===ATTRINCLUDE=== {| 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 are indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===TOKENINCLUDE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|TOKENINCLUDE [names]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes are indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===FTINCLUDE=== {| 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 are indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===MAXLEN=== {| 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 is assigned once to a new database, and can only be changed by creating a new database or doing a [[Commands#OPTIMIZE|full optimization]].|} ===MAXCATS=== {| 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 are 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 is assigned once to a new database, and cannot be changed after that.|} ===UPDINDEX=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|UPDINDEX [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|If turned on, incremental indexing is enabled:* The current value of this option is assigned to new databases. It can be changed for existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or {{Function|Database|db:optimize}} and {{Code|true()}} as second argument.* After each update, the value indexes are refreshed as well. Incremental updates are currently not available for the full-text index and database statistics.* Find more details in the article on [[Index#Updates|Index Structures]].|} ===AUTOOPTIMIZE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|AUTOOPTIMIZE [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|If turned on, auto optimization is applied to new databases:* With each update, outdated indexes and database statistics are recreated.* As a result, the index structures will always be up-to-date.* However, updates can take much longer, so this option should only be activated for medium-sized databases.* The value of this option is assigned once to a new database. It can be reassigned by running {{Command|OPTIMIZE}} or {{Function|Database|db:optimize}}.|} ===SPLITSIZE=== {| 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:* 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 fewer splits take place, and main-memory consumption increases.|} ==Full-Text Indexing== ===STEMMING=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|STEMMING [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|If {{Code|true}}, all tokens are 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.|} ===CASESENS=== {| width='100%' | width='120' | '''Signature'''|{{Code|CASESENS [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|If {{Code|true}}, the case of tokens is preserved during full-text indexing. By default, case is ignored (all tokens are indexed in lower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} ===DIACRITICS=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|DIACRITICS [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|If set to {{Code|true}}, diacritics are preserved during full-text indexing. By default, diacritics are removed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} ===LANGUAGE=== {| 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 are tokenized and stemmed. It can be the name of a language or a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} ===STOPWORDS=== {| width='100%'|- 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 are ignored when a full-text index is created. A stop word list may decrease the size of the full-text index and speed up your queries. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} =Query Options= ===QUERYINFO=== {| width='100%'|- valign="top"| width='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>. |} ===MIXUPDATES=== {| 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 are turned off, and nodes to be returned are copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for more details.|} ===BINDINGS=== {{Announce|Updated with Version 11}}: The Clark notation was replaced with the [[XQuery 3.0#Expanded QNames|Expanded QNames]] notation. {| 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:* 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 from the default namespace, it can be specified with the [[XQuery 3.0#Expanded QNames|Expanded QNames]] notation.This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>.|- valign="top"| '''Examples'''|* <code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a* <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.* In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable {{Code|$GREETING}}:<pre lang='xquery'>SET BINDINGS GREETING="hello world!"XQUERY declare variable $GREETING external; $GREETING</pre>|} ===INLINELIMIT=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|INLINELIMIT}}|- valign="top"| '''Default'''|{{Code|50}}|- valign="top"| '''Summary'''|This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to speed up query evaluation.* Inlining will only take place if a function body is not too large (i.e., if it does not contain too many expressions).* With this option, this maximum number of expressions can be specified.* Function inlining can be turned off by setting the value to {{Code|0}}.* The limit can be locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (follow the link to get more information on function inlining).|} ===UNROLLLIMIT=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|UNROLLLIMIT}}|- valign="top"| '''Default'''|{{Code|5}}|- valign="top"| '''Summary'''|This option controls the unroll limit:* Loops with few iterations are ''unrolled'' by the XQuery compiler to enable further optimizations.* If the limit is increased, more optimizations will take place, but the memory consumption and compile time will increase.* See [[XQuery Optimizations#Loop Unrolling|Loop Unrolling]] for more details.|} ===ENFORCEINDEX=== {| 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.|} ===COPYNODE=== {| 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 are created, and the copied nodes get new node identities. As a result, the following query yields <code>false</code>:<pre lang='xquery'>let $a := <a/>let $b := <b>{ $a }</b>return $b/a is $a</pre>This step can be expensive and memory consuming. If the option is disabled, child nodes will only be linked to the new parent nodes, and the upper query returns <code>true</code>.<br/>The option should be used carefully as it changes the semantics of XQuery. It should preferably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].|} ===TAILCALLS=== {| 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}}.|} ===WITHDB=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|WITHDB}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|By default, resources specified via {{Code|fn:doc}} and {{Code|fn:collection}} are looked up both in the database and in the file system. If you always use {{Function|Database|db:get}} to access databases, it is recommendable to disable this option:* No locks are created for the two functions (see [[Transaction Management#Limitations|limitations of database locking]] for more details).* Access to local and external resources is faster, as the database lookup is skipped.|} ===DEFAULTDB=== {| 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 is resolved as described in the article on [[Databases#Access Resources|accessing database resources]].|} ===FORCECREATE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|FORCECREATE [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|By enabling this option, database instances are created if the XQuery functions {{Code|fn:doc}} and {{Code|fn:collection}} are called.|} ===CHECKSTRINGS=== {| 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 are replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;). 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}}.|} ===WRAPJAVA=== {| 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 are 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.|} ===LSERROR=== {| 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.|} ===RUNQUERY=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|RUNQUERY [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|Specifies if a query is executed or parsed only. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>.|} ===RUNS=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|RUNS [num]}}|- valign="top"| '''Default'''|{{Code|1}}|- valign="top"| '''Summary'''|Specifies how often a query is 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>.|} =Serialization Options= ===SERIALIZE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|SERIALIZE [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|Results of XQuery expressions are 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%'|- valign="top"| width='120' | '''Signature'''|{{Code|SERIALIZER [params]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Parameters for [[Serialization|serializing]] query results:* Variable names and values are separated by equality signs.* Multiple variables are delimited by commas.* 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'''|* <code>indent=yes</code> : enables automatic indentation of XML nodes. This is recommended if whitespaces have been stripped from a document (see {{Options|STRIPWS}}).* <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.* <code>item-separator=,,</code> : separates serialized items by a single comma.|} ===EXPORTER=== {| 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'''|* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.|} ===XMLPLAN=== {| 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>. |} ===FULLPLAN=== {| 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.|} =Other Options= ===AUTOFLUSH=== {| 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) are evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the {{Command|FLUSH}} command.|} ===WRITEBACK=== {| width='100%'|- 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:* 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 is created from your original files.* The serialization options can be controlled via the {{Option|EXPORTER}} option.|} ===MAXSTAT=== {| 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.|} =Changelog= ;Version 11.0* Removed: <code>TEXTPARSER</code>* Updated: {{Option|BINDINGS}}: The Clark notation was replaced with the [[XQuery 3.0#Expanded QNames|Expanded QNames]] notation. ;Version 10.0* Removed: <code>COMPPLAN</code>, <code>IGNOREHOSTNAME</code>* Updated: {{Option|IGNORECERT}}: Additionally disable hostname verification.* Updated: {{Option|CATALOG}}: Renamed (before: {{Code|CATFILE}}).* Updated: {{Option|STRIPWS}}: Renamed (before: {{Code|CHOP}}), new default: false. ;Version 9.7* Updated: {{Option|GZIP}}: Support for POST and PUT requests. ;Version 9.6* Added: {{Option|UNROLLLIMIT}}, {{Option|WRAPJAVA}} ;Version 9.5* Updated: {{Option|INLINELIMIT}}: default reduced to 50.* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response ;Version 9.4* Added: {{Option|LOGTRACE}} ;Version 9.3* Added: {{Option|WITHDB}}, {{Option|GZIP}} ;Version 9.2* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code> ;Version 9.0* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}} ;Version 8.6* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)* Removed: {{Code|QUERYPATH}} (will now be internally assigned)* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ) ;Version 8.5* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added. ;Version 8.4* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code> ;Version 8.3* Added: {{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}}, TEXTPARSER, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}}* Updated: {{Option|WRITEBACK}} only applies to main-memory document instances.* Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions.* Updated: default of {{Option|INTPARSE}} is now {{Code|false}}.* Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code> ;Version 7.7* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}} ;Version 7.6* Added: {{Option|GLOBALLOCK}}* Added: store local options in configuration file after {{Code|# Local Options}} comments. ;Version 7.5* Added: options can now be set via system properties* Added: a pragma expression can be used to locally change database options* Added: {{Option|USER}}, {{Option|PASSWORD}}, {{Option|LOG}}, {{Option|LOGMSGMAXLEN}}, {{Option|WEBPATH}}, {{Option|RESTXQPATH}}{{Option|HTTPLOCAL}}, {{Option|CREATEONLY}}, {{Option|STRIPNS}}* Removed: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: {{Code|jetty.xml}} configuration file is used instead* Removed: global options cannot be changed anymore during the lifetime of a BaseX instance ;Version 7.3* Updated: {{Option|KEEPALIVE}}, {{Option|TIMEOUT}}: default values changed* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries* Removed: {{Code|SCORING}}; new scoring model will focus on lengths of text nodes and match options ;Version 7.2* Added: {{Option|PROXYHOST}}, {{Option|PROXYPORT}}, {{Option|NONPROXYHOSTS}}, {{Option|HTMLOPT}}* Updated: {{Option|TIMEOUT}}: ignore timeout for admin users ;Version 7.1* Added: {{Option|ADDRAW}}, {{Option|MAXLEN}}, {{Option|MAXCATS}}, {{Option|UPDINDEX}}* Updated: {{Option|BINDINGS}} ;Version 7.0* Added: {{Option|SERVERHOST}}, {{Option|KEEPALIVE}}, {{Option|AUTOFLUSH}}, {{Option|QUERYPATH}}