Changes

Jump to navigation Jump to search
26,941 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_Tutorial|GUI]] of BaseX, they will be listed in the [[GUI_Tutorial#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 are can be changed via {{Command|SET}} (all global options, except for {{Option|DEBUG}}, can only available in 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 Tutorialhttps://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|standaloneorg.basex.}}. An example: <syntaxhighlight lang="perl">java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"CHOP: false</syntaxhighlight> * If using the Mac OS X packaged application then global options can be set within the Info.plist file within the Contents folder of the application package. For example: <syntaxhighlight lang="xml"><key>JVMOptions</key><array> <string>-Dorg.basex.CHOP=false</string></array></syntaxhighlight> * In a [[Web Application]] , the default can be adjusted in the {{Code|web.xml}} file as follows: <syntaxhighlight lang="xml"><context-param> <param-name>org.basex.chop</param-name> <param-value>false</param-value></context-param></syntaxhighlight> * In XQuery, local options can be set via option declarations and [[Server TutorialXQuery Extensions#Pragmas|serverpragmas]]. If options are changed by operations in the [[GUI]] instance of BaseX, ithe underlying commands will be listed in the [[GUI#Visualizations|Info View]].e<br/><br/> =Global Options= Global options are constants. They can only be set in the configuration file or via system properties (see above).One exception is the [[#debug|DEBUG]] option, they cannot which can also be changed at runtime by database clients: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 Standalone|command line]] via <code>-d</code>.|}
===DBPATH===
 {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|DBPATH [path]</code>}}
|-
| valign='top' | '''Default'''|<code>[[Configuration#Database Directory|{home}/BaseXData]] or <code>[[Configuration#Database Directory|{home}/data]]</code>
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>REPOPATH {{Code|LOGPATH [path]</code>}}
|-
| valign='top' | '''Default'''|<code>[[Configuration#Database Directory|{home}/BaseXRepo]].logs</code>
|-
| valign='top' | '''Summary'''|Points to the repository directory, in which all [[PackagingLogging|XQuery Packageslog files]] 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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DEBUG</code>{{Code|REPOPATH [path]}}
|-
| valign='top' | '''Default'''|<code>false[[Configuration#Database Directory|{home}/repo]]</code>
|-
| valign='top' | '''Summary'''|Sends internal debug info to STDERR. This option can be turned on Points to get additional information for development and debugging purposesthe [[Repository]], in which all XQuery modules are located.
|}
===LANG===
 {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|LANG [language]</code>}}
|-
| valign='top' | '''Default'''|<code>{{Code|English</code>}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|LANGKEY</code>[boolean]}}
|-
| valign'''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='top100%'|-| width='120' | '''Signature''' |{{Code|FAIRLOCK [boolean]}}|-| '''Default'''|<code>{{Code|false</code>}}|-| '''Summary'''|Defines the locking strategy:* By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the limit of parallel transactions (specified via {{Option|PARALLEL}}) has been reached. This prevents update operations from blocking all other requests. For example, the DBA can further be used to see which jobs are running, even if the queue is full.* If fair locking is enabled, read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it should be used if the prompt evaluation of update operations is critical.|} ===CACHETIMEOUT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CACHETIMEOUT [seconds]}}|-| '''Default'''|{{Code|3600}}
|-
| valign='top' | '''Summary'''|Prefixes all texts with Specifies how many seconds the results of queries, which have been queued by the internal language keys. This option is helpful if BaseX is translated into another language[[Jobs Module|asynchronously executed]], and if you want to see where particular texts are displayed. BaseX needs to will be restarted cached in order to activate this optionmain memory.
|}
===HOST===
 {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|HOST [host]</code>}}
|-
| valign='top' | '''Default'''|<code>{{Code|localhost</code>}}
|-
| valign='top' | '''Summary'''|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
|}
===PORT===
 {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|PORT [port]</code>}}
|-
| valign='top' | '''Default'''|<code>{{Code|1984</code>}}
|-
| valign='top' | '''Summary'''|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
|}
===SERVERPORT===
 {|width='100%'|-| width='120' | '''Signature'''|{{Code|SERVERPORT [port]}}|-| '''Default'''|{{Code|1984}}|-| '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SERVERPORT {{Code|USER [portname]</code>}}
|-
| valign='top' | '''Default'''|<code>1984</code>''empty''
|-
| valign'''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='top100%' |-| width='120' | '''Signature'''|{{Code|PASSWORD [password]}}|-| '''Default'''|''empty''|-| '''Summary'''|This Represents a password, which is used for accessing the port server:* The default value will be overwritten if a client specifies its own credentials.* If the database server default value is empty, login will only be listening 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 tospecify 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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|SERVERHOST [host&#x7c;ip]</code>}}
|-
| valign='top' | '''Default'''|''empty'' (''wildcard'')
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>EVENTPORT {{Code|PROXYHOST [porthost]</code>}}
|-
| valign='top' | '''Default'''|<code>1985</code>''empty''
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>HTTPPORT {{Code|PROXYPORT [port]</code>}}
|-
| valign='top' | '''Default'''|<code>8984</code>{{Code|0}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>STOPPORT {{Code|NONPROXYHOSTS [porthosts]</code>}}
|-
| valign='top' | '''Default'''|<code>8985</code>''empty''
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>HTTPPATH {{Code|IGNOREHOSTNAME [pathboolean]</code>}}
|-
| valign='top' | '''Default'''|<code>[[Configuration#Database Directory{{Code|{homefalse}}/BaseXHTTP]]</code>
|-
| valign='top' | '''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==={{Mark|Introduced with Version 7.1.2:}}{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>PROXYHOST {{Code|IGNORECERT [hostboolean]</code>}}
|-
| valign='top' | '''Default'''|{{Code|false}}
|-
| valign='top' | '''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==={{Mark|Introduced with Version 7.1.2:}}{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>PROXYPORT {{Code|TIMEOUT [portseconds]</code>}}
|-
| valign='top' | '''Default'''|{{Code|30}}
|-
| valign='top' | '''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==={{Mark|Introduced with Version 7.1.2:}}{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>NONPROXYHOSTS {{Code|KEEPALIVE [hostsseconds]</code>}}
|-
| valign='top' | '''Default'''|{{Code|600}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|PARALLEL [number]</code>}}
|-
| valign='top' | '''Default'''|<code>{{Code|8</code>}}
|-
| valign='top' | '''Summary'''|Denotes the maximum allowed <code>number</code> of parallel read [[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.
|}
===TIMEOUTLOG=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>TIMEOUT {{Code|LOG [secondsboolean]</code>}}
|-
| valign='top' | '''Default'''|<code>0</code> (''no timeout''){{Code|true}}
|-
| valign='top' | '''Summary'''|Specifies Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the maximum time a readserver on [[Command-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted.Line Options#BaseX Server|command line]] via <br/code>Write operations will not be affected by this timeout, as this would corrupt the integrity of the database.-z<br/code>The timeout is deactivated if the timeout is set to {{mono|0}}. Since {{Version|7.1.2}}, it is ignored for {{Mono|ADMIN}} operations.
|}
===KEEPALIVELOGMSGMAXLEN=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>KEEPALIVE {{Code|LOGMSGMAXLEN [secondslength]</code>}}
|-
| valign='top' | '''Default'''|<code>0</code> (''no timeout''){{Code|1000}}
|-
| valign='top' | '''Summary'''|Specifies the maximum time length of a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{monosingle [[Logging|0}}log message]].
|}
=Create Options==LOGTRACE===
===CHOP==={|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>CHOP</code>{{Code|LOGTRACE [boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|true</code>}}
|-
| valign='top' | '''Summary'''|Chops all leading If BaseX is running as [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and trailing whitespaces from text nodes while building a similar functions) is written to the [[Logging|database, and discards empty text nodeslogs]]. This If this option often reduces is disabled, trace output will be redirected to standard error, as it is known from the database size by up to 50%standalone version of BaseX.
|}
==HTTP Services=INTPARSE= 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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>INTPARSE</code>{{Code|WEBPATH [path]}}
|-
| valign='top' | '''Default'''|<code>true[[Configuration#Database Directory|{home}/webapp]]</code>
|-
| valign='top' | '''Summary'''|Uses Points to the internal XML parser instead of directory in which all the standard Java XML parser. [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:* The internal parser option is ignored if BaseX is faster, more fault tolerant and supports common HTML entities out-of-deployed as [[Web Application#Servlet_Container|web servlet]].* It cannot be assigned via the-box{{Code|web.xml}} file, but as it does not support all features needed for parsing DTDswill be evaluated before the configuration files are parsed.
|}
===DTDGZIP=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DTD</code>{{Code|GZIP [boolean]}}
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''|Parses referenced DTDs Jetty provides a [https://www.eclipse.org/jetty/documentation/current/gzip-filter.html Gzip handler] for dynamically uncompressing requests and resolves XML entitiescompressing responses. By default, this This feature can be enabled if Jetty is started via the [[Web Application|BaseX HTTP Server]]:* The option is switched to can also be enabled on [[Command-Line Options#HTTP Server|command line]] via <code>-g</code>.* It cannot be assigned via the {{monoCode|falseweb.xml}}file, as many DTDs it will be evaluated before the configuration files are located externally, which may completely block the process of creating new databasesparsed. * The [[https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#CATFILE|CATFILEL187-L211 same defaults]] option can of the web server will be changed to locally resolve DTDsapplied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).
|}
===CATFILERESTXQPATH=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|RESTXQPATH [path]}}|-| '''Default'''|''empty''|-| '''Summary'''|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the {{Option|WEBPATH}} directory.|} ===PARSERESTXQ=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|PARSERESTXQ}}|-| '''Default'''|{{Code|3}}|-| '''Summary'''|Timeout after which the RESTXQ directory will be parsed for changes:* If {{Code|0}} is specified, the directory will be parsed every time a RESTXQ function is called.* A positive value defines the idle time in seconds after which parsing will be enforced. The default value is {{Code|3}}: Changes in the RESTXQ directory will be detected after 3 seconds without RESTXQ function calls.* Monitoring is completely disabled if a negative value is specified. See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details.|} ===RESTXQERRORS=== {{Mark|Updated with BaseX 9.5:}} Additionally suppress stack trace in HTTP response. {| width='100%'|-| width='120' | '''Signature'''|{{Code|RESTXQERRORS}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.|} ===RESTPATH=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>CATFILE {{Code|RESTPATH [path]</code>}}
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign'''Summary'''|Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the {{Option|WEBPATH}} directory.|} ===HTTPLOCAL=== {| width='100%'|-| width='120' | '''Signature''top' |{{Code|HTTPLOCAL [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Specifies a catalog file By default, if BaseX is run as [[Web Application]], the database server instance will be started in addition, which can then be addressed by [[Clients]] via the database port (see {{Option|PORT}}).<br/>If the option is set to {{Code|true}}, no database server will be launched.|} ===STOPPORT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|STOPPORT [port]}}|-| '''Default'''|{{Code|8985}}|-| '''Summary'''|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally resolve DTDs; see 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 entry HTTP server on [[Catalog ResolverCommand-Line Options#BaseX Server|command line]]via <code>-s </code>.|} =Create Options= ==General== ===MAINMEM=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|MAINMEM [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|If this option is turned on, new databases will be created in main memory:* Most queries will be evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down.* It is not possible to store binary resources in a main-memory database.* A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new database from the exported file in a second step.* This option will not be available for more details[[Database Module#db:create|db:create]], because the database would not be accessible anymore after database creation, i. e., outside the query scope.|} ===ADDCACHE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|ADDCACHE [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''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='90120' | '''Signature'''|<code>{{Code|CREATEFILTER [filter]</code>}}
|-
| valign='top' | '''Default'''|<code>{{Code|*.xml</code>}}
|-
| 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='90120' | '''Signature'''|<code>{{Code|ADDARCHIVES</code>[boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|true</code>}}
|-
| valign='top' | '''Summary'''|If this option is set to {{monoCode|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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|SKIPCORRUPT</code>[boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
|-
| valign='top' | '''Summary'''
|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files will be parsed twice. Next, main memory consumption will be higher as parsed files will be cached in main memory.
|}
===ADDRAW===
 {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|ADDRAW</code>[boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
|-
| valign='top' | '''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='120' | '''Signature'''|{{Code|PARSER [type]}}|-| '''Default'''|{{Code|XML}}|-| '''Summary'''|Defines a [[Parsers|parser]] for importing new files to the database. Available parsers are {{Code|XML}}, {{Code|JSON}}, {{Code|CSV}}, {{Code|TEXT}}, {{Code|HTML}}, and {{Code|RAW}}. HTML input will be parsed as XML documents if [[Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.|} ===CSVPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CSVPARSER [options]}}
|-
| valign='top' width='90Default' | ''|'Signature'empty''|<code>PARSER [type]</code>
|-
| valign='top' | '''DefaultSummary'''|Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>XML. The available options (except for the additional <code>encoding</code>option) are described in the [[CSV Module#Options|CSV Module]].
|-
| valign='top' | '''SummaryExamples'''|Defines a [[Parsers|parser]] for importing new files to <code>encoding=CP1252,header=true</code> parses the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available input as parsers. HTML will be parsed CP1252 and the first line as normal XML files if [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is not found in the classpathheader.
|}
===PARSEROPTJSONPARSER=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>PARSEROPT {{Code|JSONPARSER [options]</code>}}
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign'''Summary'''|Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]].|-| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.|} ===HTMLPARSER=== {| width='100%'|-| width='top120' | '''Signature'''|{{Code|HTMLPARSER [options]}}|-| '''Default' ''|''empty''|-| '''Summary'''|Defines parserSpecifies the way how HTML data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are described in the [[Parsers#Options|Parsers]] article.|-| '''Examples'''|* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.* <code>lexical=true</code> preserves comments.|} ===TEXTPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TEXTPARSER [options]}}|-| '''Default'''|''empty''|-specific | '''Summary'''|Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options; see are delimited with <code>,</code>. The available options are listed in the [[Parsers]] article.|-| '''Examples'''|<code>lines=true</code> creates a single element for each line of text.|} ==XML Parsing== ===CHOP=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CHOP [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Many XML documents include whitespaces that have been added to improve readability. This option controls the [https://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:* With the default value {{Code|true}}, leading and trailing whitespaces from text nodes will be chopped and all empty text nodes will be discarded.* The flag should be turned off if a document contains [[Full-Text#Mixed Content|mixed content]].* The flag can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>.* If the <code>xml:space="preserve"</code> attribute is attached to an element, chopping will be turned off for more informationall 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.
|}
=Database Options==STRIPNS===
{| width='100%'|-| width='120' | '''Signature'''|{{Code|STRIPNS [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Strips all namespaces from an XML document and all elements while parsing.|} ===INTPARSE==MAINMEM{| 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='120' | '''Signature'''|{{Code|DTD [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The {{Option|CATFILE}} option can be changed to locally resolve DTDs.|} ===XINCLUDE=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>MAINMEM</code>{{Code|XINCLUDE [boolean]}}
|-
| valign='top' | '''Default'''|<code>false</code>{{Code|true}}
|-
| valign='top' | '''Summary'''|If Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is turned on, new databases will be exclusively created in main memoryswitched to {{Code|true}}. Most queries will be evaluated faster in main memory mode, but all data This option is lost only available if BaseX the standard Java XML Parser is shut down. The value of this option will be assigned once to a new database, and cannot be changed after thatused (see {{Option|INTPARSE}}).
|}
===PATHINDEXCATFILE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>PATHINDEX</code>{{Code|CATFILE [path]}}
|-
| valign='top' | '''Default'''|<code>true</code>''empty''
|-
| valign='top' | '''Summary'''|Creates a path index whenever a new database is createdSemicolon-separated list of XML catalog files to resolve URIs. A path index helps to optimize location paths; see 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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|TEXTINDEX</code>[boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|true</code>}}
|-
| 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 . See [[IndexesIndex#Text Index|Text Index]] for more details.
|}
===ATTRINDEX===
 {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|ATTRINDEX</code>[boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|true</code>}}
|-
| 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 . See [[Index#Attribute Index|Attribute Index]] for more details.|} ===TOKENINDEX=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TOKENINDEX [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See [[IndexesIndex#Token Index|Token Index]] for more details.
|}
===FTINDEX===
 {|width='100%'|-| width='120' | '''Signature'''|{{Code|FTINDEX [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions. See [[Index#Full-Text Index|Full-Text Index]] for more details.|} ===TEXTINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TEXTINCLUDE [names]}}|-| '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>FTINDEX</code>{{Code|ATTRINCLUDE [names]}}
|-
| valign='top' | '''Default'''|<code>false</code>''empty''
|-
| valign='top' | '''Summary'''|Creates a full-text index whenever a new database is createdDefines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed. A full-text index speeds up queries with full-text expressions; see <br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===MAXLENTOKENINCLUDE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>MAXLEN</code>{{Code|TOKENINCLUDE [names]}}
|-
| valign='top' | '''Default'''|<code>96</code>''empty''
|-
| valign='top' | '''Summary'''|Specifies Defines name patterns for the maximum length of strings that are attributes to be indexed by the name. By default, path, value, and full-text index structures. The value of this option tokens in all attribute nodes will be assigned once to a new database, and cannot be changed after thatindexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===MAXCATSFTINCLUDE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>MAXCATS</code>{{Code|FTINCLUDE [names]}}
|-
| valign='top' | '''Default'''|<code>100</code>''empty''
|-
| valign='top' | '''Summary'''|Specifies Defines name patterns for the maximum number parent elements of distinct values (categories) texts that are indexed. By default, all text nodes will be remembered for a particular tagindexed.<br/attribute name or unique path>Name patterns are separated by commas. The value of this option will be assigned once to a new database, and cannot be changed after thatSee [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===UPDINDEXMAXLEN=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>UPDINDEX</code>{{Code|MAXLEN [int]}}
|-
| valign='top' | '''Default'''|<code>false</code>{{Code|96}}
|-
| valign='top' | '''Summary'''|If turned on, incremental indexing will Specifies the maximum length for strings to be activated: all update operations will also update the value stored in [[Indexes|index structures (texts and attribute values)]]. The value of this option will be assigned once to a new database, and cannot can only be changed after that. The advantage of incremental indexes is that the value index structures will always be up-to-date. The downside is that updates will take by creating a new database or doing a little bit longer[[Commands#OPTIMIZE|full optimization]].
|}
===WRITEBACKMAXCATS=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>WRITEBACK</code>{{Code|MAXCATS [int]}}
|-
| valign='top' | '''Default'''|<code>false</code>{{Code|100}}
|-
| valign='top' | '''Summary'''|Updates on XML nodes are written back to Specifies the input files. Note maximum number of distinct values (categories) that no backups of your original files will be created if 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 turned onwill be assigned once to a new database, and cannot be changed after that.
|}
===AUTOFLUSHUPDINDEX=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>AUTOFLUSH</code>{{Code|UPDINDEX [boolean]}}
|-
| valign='top' | '''Default'''|<code>true</code>{{Code|false}}
|-
| valign='top' | '''Summary'''|Flushes database buffers to disk after each update. If turned on, incremental indexing will be enabled:* The current value of this option is set will be assigned to new databases. It can be changed for existing databases by running {{Command|OPTIMIZE}} with the {{monoCode|falseALL}}keyword or [[Database_Module#db:optimize|db:optimize($db, bulk operations true(multiple single updates) )]].* After each update, the value indexes will be evaluated fasterrefreshed as well. As a drawback, the chance of data loss increases if Incremental updates are currently not available for the full-text index and database is not explicitly flushed via statistics.* Find more details in the article on [[CommandsIndex#FLUSHUpdates|FLUSHIndex Structures]] command.
|}
===MAXSTATAUTOOPTIMIZE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>MAXSTAT {{Code|AUTOOPTIMIZE [numboolean]</code>}}
|-
| valign='top' | '''Default'''|<code>30</code>{{Code|false}}
|-
| valign='top' | '''Summary'''|Specifies If turned on, auto optimization will be applied to new databases:* With each update, outdated indexes and database statistics will be recreated.* As a result, the maximum number 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 index occurrences printed this option will be assigned once to a new database. It can be reassigned by the <code>running {{Command|OPTIMIZE}} or [[CommandsDatabase_Module#INFOdb:optimize|INFO INDEXdb:optimize]]</code> command.
|}
=Full-Text Options==SPLITSIZE===
===WILDCARDS==={|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>WILDCARDS</code>{{Code|SPLITSIZE [num]}}
|-
| valign='top' | '''Default'''|<code>false</code>{{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 new full-text 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 created, it the less splits will be particularly optimized for wildcards expressions. See take place, and the page on [[Full-Text]]s for more information on XQuery Full Textmain memory will be required.
|}
 
==Full-Text Indexing==
===STEMMING===
 {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|STEMMING</code>[boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
|-
| valign='top' | '''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='120' | '''Signature'''|{{Code|CASESENS [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>CASESENS</code>{{Code|false}}
|-
| valign='top' | 'Summary''Default'''|<code>false</code>|-| valign='top' | '''Summary'''If {{Code|A new full-text index will preserve 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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|DIACRITICS</code>[boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
|-
| valign='top' | '''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='120' | '''Signature'''|{{Code|LANGUAGE [lang]}}|-| '''Default'''|{{Code|en}}|-| '''Summary'''|The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} ===STOPWORDS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|STOPWORDS [path]}}|-| '''Default'''|''empty''|-| '''Summary'''|If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index is created. A stopword list may decrease the size of the full text index and speed up your queries. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} =Query Options= ===QUERYINFO=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>LANGUAGE {{Code|QUERYINFO [langboolean]</code>}}
|-
| valign='top' | '''Default'''|<code>en</code>{{Code|false}}
|-
| valign='top' | '''Summary'''|A new full-text index will use Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the given language to normalize all tokensGUI. This option is mainly important if tokens are to It can also be stemmed, or if the tokenization of a language differs from Western languagesactivated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.
|}
===SCORINGMIXUPDATES=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SCORING [mode]</code>{{Code|MIXUPDATES}}
|-
| valign='top' | '''Default'''|<code>0</code>{{Code|false}}
|-
| valign='top' | '''Summary'''|A new fullAllows queries to both contain updating and non-text index updating expressions. All updating constraints will pre-calculate full-text scoresbe turned off, and nodes to be returned will be copied before they are modified by an updating expression. This By default, in compliance with the XQuery Update Facility, this option enables TF/IDF/based scores in full-text queries and increases main memory consumption while indexingis set to {{Code|false}}. See the [[Full-TextXQuery Update#ScoringReturning Results|ScoringReturning Results]] for more information on different scoring typesdetails.
|}
===STOPWORDSBINDINGS=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>STOPWORDS {{Code|BINDINGS [pathvars]</code>}}
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''|A new full-text index will drop tokens that are listed 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 the specified stopword listvalues must be duplicated. A stopword list * Variables may decrease optionally be introduced with a leading dollar sign.* If a variable uses a namespace different to the size of default namespace, it can be specified with the full text index[http://www.jclark.com/xml/xmlns.htm Clark Notation] or [https://www.w3. A standard stopword list for English texts is provided in org/TR/xquery-30/#id-basics Expanded QName Notation].This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the directory flag <code>etc-b</stopwordscode>.txt|-| '''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> in &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 official releasesnamespace {{Code|URI}}.* In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable {{Code|$GREETING}}:<syntaxhighlight lang="xquery">SET BINDINGS GREETING="hello world!"XQUERY declare variable $GREETING external; $GREETING</syntaxhighlight>
|}
===LSERRORINLINELIMIT=== {{Mark|Updated with Version 9.5:}} default reduced to 50. {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>LSERROR [error]</code>{{Code|INLINELIMIT}}
|-
| valign='top' | '''Default'''|<code>0</code>{{Code|50}}
|-
| valign='top' | '''Summary'''|This option specifies the 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 Levenshtein error for number of expressions can be specified.* Function inlining can be turned off by setting the BaseX-specific fuzzy match optionvalue to {{Code|0}}. See * The limit can be locally overwritten via the page on [[Full-TextXQuery Extensions#Fuzzy_QueryingFunction Inlining|Full-Texts%basex:inline]] for annotation (follow the link to get more information on fuzzy queryingfunction inlining).
|}
=Query Options==UNROLLLIMIT=== {{Mark|Introduced with Version 9.6:}}
===QUERYINFO==={|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>QUERYINFO</code>{{Code|UNROLLLIMIT}}
|-
| valign='top' | '''Default'''|<code>false</code>{{Code|5}}
|-
| valign='top' | 'Summary'''|This option controls the unroll limit:* Loops with few iterations are 'Summary'unrolled''by the XQuery compiler to enable further optimizations.|Prints * If the limit is increased, more information on internal query rewritings, optimizationswill take place, but the memory consumption and performancecompile time will increase.* See [[XQuery Optimizations#Loop Unrolling|Loop Unrolling]] for more details.
|}
===XQUERY3ENFORCEINDEX=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>XQUERY3</code>{{Code|ENFORCEINDEX [boolean]}}
|-
| valign='top' | '''Default'''|<code>true</code>{{Code|false}}
|-
| valign='top' | '''Summary'''|Enables all Enforces index rewritings in path expressions. See [[XQuery 3.0Indexes#Enforce Rewritings|Enforce Rewritings]] features supported by BaseX. If this option is set to {{mono|false}}, the XQuery parser will only accept expressions of the XQuery 1.0 specificationfor details.
|}
===SERIALIZECOPYNODE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SERIALIZE</code>{{Code|COPYNODE [boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|true</code>}}
|-
| valign='top' | '''Summary'''|Results of When creating new nodes in XQuery expressions via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], all enclosed nodes will be serialized if copied, and all resulting nodes will get new node identities. This step can be very expensive, and it can be disabled with this option is turned on. For debugging purposes and performance measurementsThe option should be used carefully, this option can as it changes the standard behavior of XQuery. It should preferrably be set to {{monoused in [[XQuery Extensions#Database Pragmas|false}}Pragmas]].
|}
===BINDINGSTAILCALLS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TAILCALLS}}|-| '''Default'''|{{Code|256}}
|-
| valign='top' width='90' | '''SignatureSummary'''|<code>BINDINGS Specifies how many stack frames of [varshttps://en.wikipedia.org/wiki/Tail_call tail-calls]</code>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%'
|-
| valignwidth='top120' | '''DefaultSignature'''|''empty''{{Code|WITHDB}}
|-
| valign='top' | '''SummaryDefault'''|Contains external variables to be bound to a query. Variable names and values are separated by equality signs, and multiple variables are delimited by commas. Variables may optionally be introduced with a leading dollar sign. Commas that occur in the value itself are encoded by duplication. If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [http://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].{{Code|true}}
|-
| valign='top' | '''ExamplesSummary'''|<code>$a=1By default,$b=2</code> &nbsp; binds the values {{monoresources specified via [[Databases#XML Documents|1}} fn:doc]] and {{mono[[Databases#XML Documents|2}} to fn:collection]] are looked up both in the variables $a database and $b<br/><code>a=1,,2</code> &nbsp; binds in the value file system. If you always use {{monoFunction|1,2Database|db:open}} to the variable $a<br/><code>{URI}a=x</code> or <code>'URI'access databases, it is recommendable to disable this option:a=x</code> &nbsp; binds * No locks will be created for the value {{Monotwo 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 {{Mono|URI}}database lookup will be skipped.
|}
===SERIALIZERDEFAULTDB=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SERIALIZER [params]</code>{{Code|DEFAULTDB}}
|-
| valign='top' | '''Default'''|''empty''{{Code|false}}
|-
| valign='top' | '''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.|-| valign='top' [[Databases#XML Documents| '''Example'''|<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 {{monoCommand|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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>EXPORTER {{Code|FORCECREATE [paramsboolean]</code>}}
|-
| valign='top' | '''Default'''|''empty''{{Code|false}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>QUERYPATH {{Code|CHECKSTRINGS [pathboolean]</code>}}
|-
| valign='top' | '''Default'''|''empty''{{Code|true}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>CACHEQUERY</code>{{Code|LSERROR [error]}}
|-
| valign='top' | '''Default'''|<code>false</code>{{Code|0}}
|-
| valign='top' | '''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 {{monoCode|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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>FORCECREATE</code>{{Code|RUNQUERY [boolean]}}
|-
| valign='top' | '''Default'''|<code>false</code>{{Code|true}}
|-
| valign='top' | '''Summary'''|By activating this Specifies if a query will be executed or parsed only. This option, the XQuery {{monocan also be changed on [[Command-Line Options#BaseX Standalone|doc()}} and {{mono|collection()}} functions will create database instances for the addressed input filescommand line]] via <code>-R</code>.
|}
===RUNS===
 {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|RUNS [num]</code>}}
|-
| valign='top' | '''Default'''|<code>{{Code|1</code>}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|XMLPLAN</code>[boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
|-
| 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>.
|}
===COMPPLAN===
 {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|COMPPLAN</code>[boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|true</code>}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DOTPLAN</code>{{Code|FULLPLAN [boolean]}}
|-
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DOTCOMPACT</code>{{Code|AUTOFLUSH [boolean]}}
|-
| valign='top' | '''Default'''|<code>false</code>{{Code|true}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DOTDISPLAY</code>{{Code|WRITEBACK [boolean]}}
|-
| valign='top' | '''Default'''|<code>true</code>{{Code|false}}
|-
| valign='top' | '''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%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DOTTY {{Code|MAXSTAT [pathnum]</code>}}
|-
| valign='top' | '''Default'''|<code>dotty</code>{{Code|30}}
|-
| valign='top' | '''Summary'''|Location Specifies the maximum number of index occurrences printed by the {{monoCommand|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.2===
;Version 7.5* Added: <code>[[#PROXYHOSToptions can now be set via system properties* Added: a pragma expression can be used to locally change database options* Added: {{Option|USER}}, {{Option|PROXYHOST]]</code>PASSWORD}}, <code>[[#PROXYPORT{{Option|PROXYPORT]]</code>LOG}}, <code>[[#NONPROXYHOSTS{{Option|NONPROXYHOSTS]]</code>LOGMSGMAXLEN}}, {{Option|WEBPATH}}, {{Option|RESTXQPATH}}{{Option|HTTPLOCAL}}, {{Option|CREATEONLY}}, {{Option|STRIPNS}}* UpdatedRemoved: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: <code>[[#TIMEOUT{{Code|TIMEOUT]]</code>jetty.xml}} configuration file is used instead* Removed: ignore timeout for admin usersglobal options cannot be changed anymore during the lifetime of a BaseX instance
===;Version 7.1===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: <code>[[#ADDRAW{{Option|ADDRAW]]</code>PROXYHOST}}, <code>[[#MAXLEN{{Option|MAXLEN]]</code>PROXYPORT}}, <code>[[#MAXCATS{{Option|MAXCATS]]</code>NONPROXYHOSTS}}, <code>[[#UPDINDEX{{Option|UPDINDEX]]</code>HTMLOPT}}* Updated: <code>[[#BINDINGS{{Option|BINDINGS]]</code>TIMEOUT}}: ignore timeout for admin users
===;Version 7.0===1* Added: {{Option|ADDRAW}}, {{Option|MAXLEN}}, {{Option|MAXCATS}}, {{Option|UPDINDEX}}* Updated: {{Option|BINDINGS}}
;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