Changes

Jump to navigation Jump to search
28,191 bytes added ,  09:09, 27 May 2021
m
Fixed typo if should be is
This page is linked from the [[Getting Started]] Section.
The options listed on this page can be requested with influence the way how database [[Commands#GET|GETcommands]] command are executed and changed with the [[Commands#SET|SET]] commandXQuery expressions are evaluated. Three data types Two kinds of options exist: strings, numbers, and booleans, which can be turned ON and OFF. If options are internally changed by the [[GUI]] of BaseX, they will be listed in the [[GUI#Visualizations|Info View]].
=Main * '''[[#Global Options=|Global Options]]''' are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/server architecture.* '''Local options''' (all remaining ones) are specific to a client or session.
Values of options are either ''strings'', ''numbers'' or ''booleans''. Options are ''static'' and not bound to a single operation (for example, the next command). Various ways exist to access and change options: * The main current value of an option can be requested with the {{Command|GET}} command. Local options can be changed via {{Command|SET}} (all global options are , except for {{Option|DEBUG}}, can only available from be changed at startup time). If an option is of type ''boolean'', and if no value is specified, its current value will be inverted. * The {{Code|.basex}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance. It contains all global options. Local options can be specified at the end of the file after the {{Code|Local Options}} comment: <syntaxhighlight lang="perl"># General OptionsDEBUG = false... # Local OptionsCHOP = false</syntaxhighlight> * Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on command line, or using [Standalone Modehttps://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()]] and before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example: <syntaxhighlight lang="perl">java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"CHOP: false</syntaxhighlight> * If using the Mac OS X packaged application then global options can be set within the Info.plist file within the Contents folder of the application package. For example: <syntaxhighlight lang="xml"><key>JVMOptions</key><array> <string>-Dorg.basex.CHOP=false</string></array></syntaxhighlight> * In a [[Database ServerWeb Application]] instances of BaseX, ithe default can be adjusted in the {{Code|web.exml}} file as follows: <syntaxhighlight lang="xml"><context-param> <param-name>org.basex.chop</param-name> <param-value>false</param-value></context-param></syntaxhighlight> * In XQuery, they cannot local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]]. If options are changed by database clientsoperations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/> =Global Options= Global options are constants. They are stored can only be set in the configuration file or via system properties (see above). One exception is the [[Configuration#Configuration Filesdebug|.basex config fileDEBUG]]option, which is opened can also be changed at runtime by every new users with [[User Management|admin permissions]]. ==General Options== ===DEBUG=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|DEBUG [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Command-Line Options#BaseX instance:Standalone|command line]] via <code>-d</code>.|}
===DBPATH===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|DBPATH [path]</code>}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]] or <code>[[Configuration#Database Directory|{home}/data]]</code>
|-
| '''Summary'''
|Points to the directory in which all databases are located.<br/> '''Note:''' this option can only be changed if no database is currently opened. If the option is changed, existing databases will not be moved to the new location.
|}
===REPOPATHLOGPATH=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>REPOPATH {{Code|LOGPATH [path]</code>}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]].logs</code>
|-
| '''Summary'''
|Points to the directory in which all [[RepositoryLogging|log files]], in which all XQuery modules are locatedstored.<br/>'''Note:''' if Relative paths will be resolved against the option is changed, BaseX needs to be restarted in order to activate existing packages and avoid side effects{{Option|DBPATH}} directory.
|}
===DEBUGREPOPATH=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>DEBUG</code>{{Code|REPOPATH [path]}}
|-
| '''Default'''
|<code>false[[Configuration#Database Directory|{home}/repo]]</code>
|-
| '''Summary'''
|Sends internal debug info Points to STDERR. This option can be turned on to get additional information for development and debugging purposesthe [[Repository]], in which all XQuery modules are located.
|}
===LANG===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|LANG [language]</code>}}
|-
| '''Default'''
|<code>{{Code|English</code>}}
|-
| '''Summary'''
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. BaseX needs to be restarted in order to activate the new language.
|}
===LANGKEY===
 {|width='100%'|-| width='120' | '''Signature'''|{{Code|LANGKEY [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed.|} ===FAIRLOCK=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|FAIRLOCK [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''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='90120' | '''Signature'''|<code>LANGKEY</code>{{Code|CACHETIMEOUT [seconds]}}
|-
| '''Default'''
|<code>false</code>{{Code|3600}}
|-
| '''Summary'''
|Prefixes all texts with Specifies how many seconds the internal language keys. This option is helpful if BaseX is translated into another languageresults of queries, and if you want to see where particular texts are displayed. BaseX needs to which have been queued by the [[Jobs Module|asynchronously executed]], will be restarted cached in order to activate this optionmain memory.
|}
===HOST===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|HOST [host]</code>}}
|-
| '''Default'''
|<code>{{Code|localhost</code>}}
|-
| '''Summary'''
|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
|}
===PORT===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|PORT [port]</code>}}
|-
| '''Default'''
|<code>{{Code|1984</code>}}
|-
| '''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%'|-| width='120' | '''Signature'''|{{Code|USER [name]}}|-| '''Default'''|''empty''|-| '''Summary'''|Represents a user name, which is used for accessing the server or an HTTP service:* The default value will be overwritten if a client specifies its own credentials.* If the default value is empty, login will only be possible if the client specifies credentials.* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-U</code>.|} ===PASSWORD=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|PASSWORD [password]}}|-| '''Default'''|''empty''|-| '''Summary'''|Represents a password, which is used for accessing the server:* The default value will be overwritten if a client specifies its own credentials.* If the default value is empty, login will only be possible if the client specifies credentials.* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>.* Please note that it is a security risk to specify your password in plain text.|} ===AUTHMETHOD=== {| width='100%'
|-
| width='90120' | '''Signature'''|<code>SERVERPORT {{Code|AUTHMETHOD [portmethod]</code>}}
|-
| '''Default'''
|<code>1984</code>''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 port the database server will be listening tonot do any authentication.
|}
===SERVERHOST===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|SERVERHOST [host&#x7c;ip]</code>}}
|-
| '''Default'''
|''empty'' (''wildcard'')
|-
| '''Summary'''
|This is the host name or ip address the server is bound to. The server will be open to all clients if If the option is set to an empty string(which is the default), the server will be open to all clients.
|}
===EVENTPORTPROXYHOST=== {|width='100%' width='100%'
|-
| width='90120' | '''Signature'''|<code>EVENTPORT {{Code|PROXYHOST [porthost]</code>}}
|-
| '''Default'''
|<code>1985</code>''empty''
|-
| '''Summary'''
|This port is used by the client to listen for [[Events|host name of a proxy server events]]. This port If the value is an empty string, it will only be bound if a client attaches itself to a database eventignored.
|}
===HTTPPORTPROXYPORT=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>HTTPPORT {{Code|PROXYPORT [port]</code>}}
|-
| '''Default'''
|<code>8984</code>{{Code|0}}
|-
| '''Summary'''
|This is the port number of a proxy server. If the [[Startup#BaseX HTTP Servervalue is set to {{Code|HTTP Server]] 0}}, it will be listening toignored.
|}
===STOPPORTNONPROXYHOSTS=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>STOPPORT {{Code|NONPROXYHOSTS [porthosts]</code>}}
|-
| '''Default'''
|<code>8985</code>''empty''
|-
| '''Summary'''
|This is a list of hosts that should be directly accessed. If the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can value is an empty string, it will be locally closedignored.
|}
===HTTPPATHIGNOREHOSTNAME=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>HTTPPATH {{Code|IGNOREHOSTNAME [pathboolean]</code>}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory{{Code|{homefalse}}/BaseXHTTP]]</code>
|-
| '''Summary'''
|Points to the HTTP root directory, in which HTML files may be storedIf this option is enabled, and query files that hostnames of certificates will not be evaluated by the [[REST]] serviceverified. Use {{Option|IGNORECERT}} to completely disable certificate verification.
|}
===PROXYHOSTIGNORECERT==={{Mark|Introduced with Version 7.2:}}{|width='100%'
|-
| width='90120' | '''Signature'''|<code>PROXYHOST {{Code|IGNORECERT [hostboolean]</code>}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|This is option can be turned on to ignore untrusted certificates when connecting to servers. Use {{Option|IGNOREHOSTNAME}} to suppress only the host name of a proxy serverhostname verification.
|}
===PROXYPORTTIMEOUT==={{Mark|Introduced with Version 7.2:}}{|width='100%'
|-
| width='90120' | '''Signature'''|<code>PROXYPORT {{Code|TIMEOUT [portseconds]</code>}}
|-
| '''Default'''
|<code>80</code>{{Code|30}}
|-
| '''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.2:}}{|width='100%'
|-
| width='90120' | '''Signature'''|<code>NONPROXYHOSTS {{Code|KEEPALIVE [hostsseconds]</code>}}
|-
| '''Default'''
|{{Code|600}}
|-
| '''Summary'''
|This is Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a list of hosts that should longer time than specified by this timeout, it will be directly accesseddisconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.
|}
===PARALLEL===
 {|width='100%'|-| width='120' | '''Signature'''|{{Code|PARALLEL [number]}}|-| '''Default'''|{{Code|8}}|-| '''Summary'''|Denotes the maximum allowed number of parallel [[Transaction Management|transactions]]:* If {{Option|FAIRLOCK}} is enabled, the number of parallel transactions will never exceed the specified value.* If the option is disabled (which is the default), the limit only applies to transactions that access databases.* The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.|} ===LOG=== {| width='100%'
|-
| width='90120' | '''Signature'''|<code>PARALLEL {{Code|LOG [numberboolean]</code>}}
|-
| '''Default'''
|<code>8</code>{{Code|true}}
|-
| '''Summary'''
|Denotes Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the maximum allowed server on [[Command-Line Options#BaseX Server|command line]] via <code>number-z</code> of parallel read [[Transaction Management|transactions]].
|}
===TIMEOUTLOGMSGMAXLEN=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LOGMSGMAXLEN [length]}}|-| '''Default'''|{{Code|1000}}|-| '''Summary'''|Specifies the maximum length of a single [[Logging|log message]].|} ===LOGTRACE=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>TIMEOUT {{Code|LOGTRACE [secondsboolean]</code>}}
|-
| '''Default'''
|<code>0</code> (''no timeout''){{Code|true}}
|-
| '''Summary'''
|Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted.<br/>Write operations will not be affected by this timeoutBaseX is running as [[Web Application]], as this would corrupt the integrity of the database.<br/>The timeout is deactivated if the timeout is set to trace output (generated via {{monoCode|0fn:trace}}. Since , {{VersionFunction|Profiling|7.2prof:dump}}and similar functions) is written to the [[Logging|database logs]]. If this option is disabled, trace output will be redirected to standard error, as it is ignored for {{Code|ADMIN}} operationsknown from the standalone version of BaseX.
|}
===AUTHTIMEOUT=HTTP Services== Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that will be set before the web server is started:
{{Mark|Introduced with Version 7.2.2:}}===WEBPATH===
{|width='100%'
|-
| width='90120' | '''Signature'''|<code>AUTHTIMEOUT {{Code|WEBPATH [secondspath]</code>}}
|-
| '''Default'''
|<code>10[[Configuration#Database Directory|{home}/webapp]]</code>
|-
| '''Summary'''
|Specifies Points to the maximum time reserved for creating a new session. If authentication takes longer than directory in which all the specified timeout[[Web Application]] contents are stored, the connection will be closed.<br/>including XQuery, Script, [[RESTXQ]] and configuration files:* The timeout option is deactivated ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].* It cannot be assigned via the timeout is set to {{monoCode|0web.xml}}file, as it will be evaluated before the configuration files are parsed.
|}
===KEEPALIVEGZIP=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>KEEPALIVE {{Code|GZIP [secondsboolean]</code>}}
|-
| '''Default'''
|<code>0false</code> (''no timeout'')
|-
| '''Summary'''
|Specifies 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 maximum time a client will [[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 remembered by assigned via the server{{Code|web. If there has been no interaction with a client for a longer time than specified by this timeoutxml}} file, as it will be disconnectedevaluated before the configuration files are parsed.* The [https://github. Running operations com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 same defaults] of the web server will not be affected by this optionapplied (support for GET requests, exclusion of binaries, MSIE 6. The keepalive check is deactivated if the value is set to {{mono|0}}, etc.).
|}
=Create Options==RESTXQPATH===
===CHOP==={|width='100%'
|-
| width='90120' | '''Signature'''|<code>CHOP</code>{{Code|RESTXQPATH [path]}}
|-
| '''Default'''
|<code>true</code>''empty''
|-
| '''Summary'''
|Chops all leading and trailing whitespaces from text nodes while building Points to the directory which contains the [[RESTXQ]] modules of a database, and discards empty text nodesweb application. This option often reduces Relative paths will be resolved against the database size by up to 50%{{Option|WEBPATH}} directory.
|}
===INTPARSEPARSERESTXQ=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>INTPARSE</code>{{Code|PARSERESTXQ}}
|-
| '''Default'''
|<code>true</code>{{Code|3}}
|-
| '''Summary'''
|Uses Timeout after which the internal XML parser instead of 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 standard Java XML parseridle time in seconds after which parsing will be enforced. The internal parser default value is faster, more fault tolerant and supports common HTML entities out-of-{{Code|3}}: Changes in the-box, but it does not support all features needed 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 parsing DTDsmore details.
|}
===DTDRESTXQERRORS=== {{Mark|Updated with BaseX 9.5:}} Additionally suppress stack trace in HTTP response. {| width='100%'
|-
| width='90120' | '''Signature'''|<code>DTD</code>{{Code|RESTXQERRORS}}
|-
| '''Default'''
|<code>false</code>{{Code|true}}
|-
| '''Summary'''
|Parses referenced DTDs Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and resolves XML entitiesstack trace to the client. By default, this option is switched enabled. In a production environment, it can be disabled to {{mono|false}}, as many DTDs are located externally, which may completely block suppress errors that should not be seen by the process user of creating new databasesan API (the full error information can still be looked up in the database logs). The See [[RESTXQ#CATFILEError Handling|CATFILERESTXQ Error Handling]] option can be changed to locally resolve DTDsfor more details.
|}
===CATFILERESTPATH=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>CATFILE {{Code|RESTPATH [path]</code>}}
|-
| '''Default'''
|-
| '''Summary'''
|Specifies a catalog file Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the {{Option|WEBPATH}} directory.|} ===HTTPLOCAL=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|HTTPLOCAL [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|By default, if BaseX is run as [[Web Application]], the database server instance will be started in addition, which can then be addressed by [[Clients]] via the database port (see {{Option|PORT}}).<br/>If the option is set to {{Code|true}}, no database server will be launched.|} ===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%'
|-
| width='90120' | '''Signature'''|<code>{{Code|CREATEFILTER [filter]</code>}}
|-
| '''Default'''
|<code>{{Code|*.xml</code>}}
|-
| '''Summary'''
===ADDARCHIVES===
 {|width='100%'|-| width='120' | '''Signature'''|{{Code|ADDARCHIVES [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''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%'
|-
| width='90120' | '''Signature'''|<code>ADDARCHIVES</code>{{Code|ARCHIVENAME [boolean]}}
|-
| '''Default'''
|<code>true</code>{{Code|false}}
|-
| '''Summary'''
|If this option is set to {{monoCode|true}}, files within the file name of parsed archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a databasewill be included in the document paths.
|}
===SKIPCORRUPT===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|SKIPCORRUPT</code>[boolean]}}
|-
| '''Default'''
|<code>{{Code|false</code>}}
|-
| '''Summary'''
===ADDRAW===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|ADDRAW</code>[boolean]}}
|-
| '''Default'''
|<code>{{Code|false</code>}}
|-
| '''Summary'''
|If this option is activatedenabled, and if new all resources are added to a database, all files that are not filtered out by the [[#CREATEFILTER{{Option|CREATEFILTER]] }} option while being added to a database will be added stored as ''[[Binary Data|raw'' files ]] instead (i.e., in their binary representation).
|}
===PARSER===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|PARSER [type]</code>}}
|-
| '''Default'''
|<code>{{Code|XML</code>}}
|-
| '''Summary'''
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'Available parsers are {{Code|XML'}}, '{{Code|JSON'}}, '{{Code|CSV'}}, '{{Code|TEXT'}}, '{{Code|HTML' are available as parsers}}, and {{Code|RAW}}. HTML input will be parsed as normal XML files documents if [http://home.ccil.org/~cowan/XML/tagsoup/ [Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.
|}
===PARSEROPTCSVPARSER=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>PARSEROPT {{Code|CSVPARSER [options]</code>}}
|-
| '''Default'''
|-
| '''Summary'''
|Defines parser-specific Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options; see (except for the additional <code>encoding</code> option) are described in the [[ParsersCSV Module#Options|CSV Module]] for more information.|-| '''Examples'''|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.
|}
===HTMLOPTJSONPARSER==={{Mark|Introduced with Version 7.2:}}{|width='100%'
|-
| width='90120' | '''Signature'''|<code>HTMLOPT {{Code|JSONPARSER [options]</code>}}
|-
| '''Default'''
|-
| '''Summary'''
|Allows to specify TagSoup Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]].|-| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.|} ===HTMLPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|HTMLPARSER [options]}}|-| '''Default'''|''empty''|-| '''Summary'''|Specifies the way how HTML parsing; see 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#HTML ParserOptions|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''|-| '''Summary'''|Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are listed in the [[Parsers]] article.|-| '''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|HTML Parsercommand 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.|} ===STRIPNS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|STRIPNS [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Strips all namespaces from an XML document and all elements while parsing.|} ===INTPARSE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|INTPARSE [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the internal parser:* Performance: Documents (in particular small ones) will be parsed faster* Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (&#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.
|}
=Database Options==XINCLUDE===
===MAINMEM==={|width='100%'
|-
| width='90120' | '''Signature'''|<code>MAINMEM</code>{{Code|XINCLUDE [boolean]}}
|-
| '''Default'''
|<code>false</code>{{Code|true}}
|-
| '''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%'
|-
| width='90120' | '''Signature'''|<code>PATHINDEX</code>{{Code|CATFILE [path]}}
|-
| '''Default'''
|<code>true</code>''empty''
|-
| '''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%'
|-
| width='90120' | '''Signature'''|<code>{{Code|TEXTINDEX</code>[boolean]}}
|-
| '''Default'''
|<code>{{Code|true</code>}}
|-
| '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see . See [[IndexesIndex#Text Index|Text Index]] for more details.
|}
===ATTRINDEX===
 {|width='100%'|-| width='120' | '''Signature'''|{{Code|ATTRINDEX [boolean]}}|-| '''Default'''|{{Code|true}}
|-
| '''Summary'''|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[Index#Attribute Index|Attribute Index]] for more details.|} ===TOKENINDEX=== {| width='90100%'|-| width='120' | '''Signature'''|<code>ATTRINDEX</code>{{Code|TOKENINDEX [boolean]}}
|-
| '''Default'''
|<code>{{Code|true</code>}}
|-
| '''Summary'''
|Creates an attribute a token index whenever a new database is created. An attribute A token index speeds up queries with equality comparisons on searches for single tokens in attribute values; see . See [[IndexesIndex#Token Index|Token Index]] for more details.
|}
===FTINDEX===
 {|width='100%'|-| width='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%'|-| width='120' | '''Signature'''|{{Code|ATTRINCLUDE [names]}}|-| '''Default'''|''empty''
|-
| '''Summary'''|Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===TOKENINCLUDE=== {| width='90100%'|-| width='120' | '''Signature'''|<code>FTINDEX</code>{{Code|TOKENINCLUDE [names]}}
|-
| '''Default'''
|<code>false</code>''empty''
|-
| '''Summary'''
|Creates a full-text index whenever a new database is createdDefines name patterns for the attributes to be indexed. A full-text index speeds up queries with full-text expressions; see By default, tokens in all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===MAXLENFTINCLUDE=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>MAXLEN</code>{{Code|FTINCLUDE [names]}}
|-
| '''Default'''
|<code>96</code>''empty''
|-
| '''Summary'''
|Specifies Defines name patterns for the maximum length parent elements of strings texts that are to be indexed by the name, path, value. By default, and full-all text index structures. The value of this option 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.
|}
===MAXCATSMAXLEN=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>MAXCATS</code>{{Code|MAXLEN [int]}}
|-
| '''Default'''
|<code>100</code>{{Code|96}}
|-
| '''Summary'''
|Specifies the maximum number of distinct values (categories) that will length for strings to be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path IndexIndexes|Path Indexindex structures]]. The value of this option will be assigned once to a new database, and cannot can only be changed after thatby creating a new database or doing a [[Commands#OPTIMIZE|full optimization]].
|}
===UPDINDEXMAXCATS=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>UPDINDEX</code>{{Code|MAXCATS [int]}}
|-
| '''Default'''
|<code>false</code>{{Code|100}}
|-
| '''Summary'''
|If turned on, incremental indexing Specifies the maximum number of distinct values (categories) that will be activated: all update operations will also update stored together with the value index structures (texts and element/attribute values)names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that. The advantage of incremental indexes is that the value index structures will always be up-to-date. The downside is that updates will take a little bit longer.
|}
===WRITEBACKUPDINDEX=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>WRITEBACK</code>{{Code|UPDINDEX [boolean]}}
|-
| '''Default'''
|<code>{{Code|false</code>}}
|-
| '''Summary'''
|Updates If turned on XML nodes are written back , incremental indexing will be enabled:* The current value of this option will be assigned to new databases. It can be changed for existing databases by running {{Command|OPTIMIZE}} with the input files{{Code|ALL}} keyword or [[Database_Module#db:optimize|db:optimize($db, true())]]. Note that no backups of your original files * After each update, the value indexes will be created if this option is turned 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]].
|}
===AUTOFLUSHAUTOOPTIMIZE=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>AUTOFLUSH</code>{{Code|AUTOOPTIMIZE [boolean]}}
|-
| '''Default'''
|<code>true</code>{{Code|false}}
|-
| '''Summary'''
|Flushes database buffers If turned on, auto optimization will be applied to disk after new databases:* With each update. If this option is set to {{mono|false}}, bulk operations (multiple single updates) outdated indexes and database statistics will be evaluated fasterrecreated. * As a drawbackresult, the chance 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 data loss increases if the this option will be assigned once to a new database is not explicitly flushed via the . It can be reassigned by running {{Command|OPTIMIZE}} or [[CommandsDatabase_Module#FLUSHdb:optimize|FLUSHdb:optimize]] command.
|}
===MAXSTATSPLITSIZE=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>MAXSTAT {{Code|SPLITSIZE [num]</code>}}
|-
| '''Default'''
|<code>30</code>{{Code|0}}
|-
| '''Summary'''
|Specifies This option affects the maximum number of index occurrences printed by the <code>[[CommandsIndexes#INFOPerformance|INFO INDEXconstruction]]</code> commandof new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk:* By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption. Usually, this works fine.* If explicit garbage collection is disabled when running Java (e.g. via the JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to choose a custom split size.* You can e. g. start with {{Code|1000000}} (one million) index operations and adjust this value in the next steps.* The larger the assigned value is, the less splits will take place, and the more main memory will be required.
|}
==Full-Text OptionsIndexing==
===STEMMING===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|STEMMING</code>[boolean]}}
|-
| '''Default'''
|<code>{{Code|false</code>}}
|-
| '''Summary'''
|A new If {{Code|true}}, all tokens will be stemmed during full-text index indexing, using a language-specific stemmer implementation. By default, tokens will stem all tokens and speed up queries on not be stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this indexSee [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===CASESENS===
 {|width='100%'|-| width='90120' | '''Signature'''|<code>{{Code|CASESENS</code>[boolean]}}
|-
| '''Default'''
|<code>{{Code|false</code>}}
|-
| '''Summary'''
|A new full-text index will preserve If {{Code|true}}, the case of all tokenswill be preserved during full-text indexing. The same By default, case normalization will be applied to ignored (all query tokens that are checked against tokens will be indexed in this indexlower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===DIACRITICS===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|DIACRITICS</code>[boolean]}}
|-
| '''Default'''
|<code>{{Code|false</code>}}
|-
| '''Summary'''
|A new If set to {{Code|true}}, diacritics will be preserved during full-text index will preserve the diacritics of all tokensindexing. The same By default, diacritics normalization will be applied to all query tokens that are checked against tokens in this indexremoved. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===LANGUAGE===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|LANGUAGE [lang]</code>}}
|-
| '''Default'''
|<code>{{Code|en</code>}}
|-
| '''Summary'''
|A new full-text index The specified language will use influence the given language to normalize all tokensway how texts will be tokenized and stemmed. This option is mainly important if tokens are to It can be stemmed, or if the tokenization name of a language differs from Western languagesor a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===STOPWORDS===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|STOPWORDS [path]</code>}}
|-
| '''Default'''
|-
| '''Summary'''
|A new If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index will drop tokens that are listed in the specified stopword listis created. A stopword list may decrease the size of the full text indexand speed up your queries. A standard stopword list See [[Indexes#Full-Text Index|Full-Text Index]] for English texts is provided in the directory <code>etc/stopwords.txt</code> in the official releasesmore details.
|}
=Query Options= ===LSERRORQUERYINFO=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>LSERROR {{Code|QUERYINFO [errorboolean]</code>}}
|-
| '''Default'''
|<code>0</code>{{Code|false}}
|-
| '''Summary'''
|This option specifies Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the maximum Levenshtein error for [[GUI#Visualizations|Info View]] in the BaseX-specific fuzzy match optionGUI. See the page It can also be activated on [[FullCommand-TextLine Options#Fuzzy_QueryingBaseX Standalone|Full-Textscommand line]] for more information on fuzzy queryingvia <code>-V</code>.
|}
===WILDCARDSMIXUPDATES===
{| width='100%'|-| width='120' | '''Signature'''|{{Code|MIXUPDATES}}|-| '''Default'''|{Mark{Code|Removed in Version 7false}}|-| '''Summary'''|Allows queries to both contain updating and non-updating expressions.2All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression.2:By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}} new index supports both fuzzy and wildcard queries.See [[XQuery Update#Returning Results|Returning Results]] for more details.|} ===BINDINGS===
{|width='100%'
|-
| width='90120' | '''Signature'''|<code>WILDCARDS</code>{{Code|BINDINGS [vars]}}
|-
| '''Default'''
|<code>false</code>''empty''
|-
| '''Summary'''
|Contains external variables to be bound to a query. The string must comply with the following rules:* Variable names and values must be separated by equality signs.* Multiple variables must be delimited by commas.* Commas in values must be duplicated.* Variables may optionally be introduced with a leading dollar sign.* If a new full-text index is createdvariable uses a namespace different to the default namespace, it will can be particularly optimized for wildcards expressionsspecified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [https://www. See the page w3.org/TR/xquery-30/#id-basics Expanded QName Notation].This option can also be used on [[FullCommand-TextLine Options#BaseX Standalone|command line]]s for more information on XQuery Full Textwith the flag <code>-b</code>.|-| '''Examples'''|* <code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a* <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}. * In the following [[Commands#Command_Scripts| Command Script]], 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>
|}
===SCORINGINLINELIMIT===
{{Mark|Removed in Updated with Version 79.2.25:}} new scoring model will focus on lengths of text nodes and match optionsdefault reduced to 50.
{|width='100%'
|-
| width='90120' | '''Signature'''|<code>SCORING [mode]</code>{{Code|INLINELIMIT}}
|-
| '''Default'''
|<code>0</code>{{Code|50}}
|-
| '''Summary'''
|A new full-text index This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to speed up query evaluation.* Inlining will pre-calculate full-text scoresonly take place if a function body is not too large (i.e., if it does not contain too many expressions). This * With this option enables TF/IDF/based scores in full-text queries and increases main memory consumption while indexing, this maximum number of expressions can be specified. See * Function inlining can be turned off by setting the value to {{Code|0}}.* The limit can be locally overwritten via the [[Full-TextXQuery Extensions#ScoringFunction Inlining|Scoring%basex:inline]] for annotation (follow the link to get more information on different scoring typesfunction inlining).
|}
=Query Options==UNROLLLIMIT=== {{Mark|Introduced with Version 9.6:}}
===QUERYINFO==={|width='100%'
|-
| width='90120' | '''Signature'''|<code>QUERYINFO</code>{{Code|UNROLLLIMIT}}
|-
| '''Default'''
|<code>false</code>{{Code|5}}
|-
| '''Summary'''
|Prints 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 information on internal query rewritings, optimizationswill take place, but the memory consumption and performancecompile time will increase. The query info will always be printed in the * See [[GUIXQuery Optimizations#VisualizationsLoop Unrolling|Info ViewLoop Unrolling]] in the GUI, or it can be activated with the [[Startup_Options#BaseX_Standalone|-V flag]] on command linefor more details.
|}
===XQUERY3ENFORCEINDEX=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>XQUERY3</code>{{Code|ENFORCEINDEX [boolean]}}
|-
| '''Default'''
|<code>true</code>{{Code|false}}
|-
| '''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%'
|-
| width='90120' | '''Signature'''|<code>SERIALIZE</code>{{Code|COPYNODE [boolean]}}
|-
| '''Default'''
|<code>{{Code|true</code>}}
|-
| '''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 copied, and all resulting nodes will get new node identities. This step can be very expensive, and it can be serialized if 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='90120' | '''Signature'''|<code>BINDINGS [vars]</code>{{Code|TAILCALLS}}
|-
| '''Default'''
|''empty''{{Code|256}}
|-
| '''Summary'''
|Contains external variables to be bound to a querySpecifies how many stack frames of [https://en.wikipedia. Variable names and values org/wiki/Tail_call tail-calls] are separated by equality signsallowed on the stack at any time. When this limit is reached, tail-call optimization takes place and multiple variables some call frames are delimited by commaseliminated. Variables may optionally The feature can be introduced with a leading dollar sign. Commas that occur in turned off by setting 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{{Code|-1}}.htm Clark Notation] or [http://www.w3.org/TR/xquery|} ===WITHDB=== {| width='100%'|-30/#id| width='120' | '''Signature'''|{{Code|WITHDB}}|-basics Expanded QName Notation].| '''Default'''|{{Code|true}}
|-
| '''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 {{Codetwo functions (see [[Transaction Management#Limitations|x}} limitations of database locking]] for more details).* Access to local and external resources will be faster, as the variable $a with the namespace {{Code|URI}}database lookup will be skipped.
|}
===SERIALIZERDEFAULTDB=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>SERIALIZER [params]</code>{{Code|DEFAULTDB}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Contains parameters for serializing queries; see If this option is turned on, paths specified in the [[SerializationDatabases#XML Documents|fn:doc]] for more details. Keys and values are separated by equality signs, and multiple parameters are delimited by commas.|-| '''Example'''[[Databases#XML Documents|<code>encoding=US-ASCII,omit-xml-declaration=no</code> fn: sets collection]] functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the encoding to {{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%'
|-
| width='90120' | '''Signature'''|<code>EXPORTER {{Code|FORCECREATE [paramsboolean]</code>}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Contains parameters for exporting all resources of a By activating this option, database; see instances will be created with the XQuery functions [[SerializationDatabases#XML Documents|fn:doc]] for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas[[Databases#XML Documents|fn:collection]].
|}
===QUERYPATHCHECKSTRINGS=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>QUERYPATH {{Code|CHECKSTRINGS [pathboolean]</code>}}
|-
| '''Default'''
|''empty''{{Code|true}}
|-
| '''Summary'''
|Contains By default, characters from external sources that are invalid in XML will trigger an error. If the path (''base URI'') option is set to <code>false</code>, these characters will be replaced with the executed query Unicode replacement character <code>FFFD</code> (default: ''empty''&#xFFFD;). This directory will be used to resolve relative paths to documentsThe option affects [[Java Bindings]] and string conversion and input functions such as [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], query modules[[Archive Module#archive:update|archive:update]], and other resources addressed in a query[[ZIP Module#zip:text-entry|zip:text-entry]].
|}
===CACHEQUERYLSERROR=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>CACHEQUERY</code>{{Code|LSERROR [error]}}
|-
| '''Default'''
|<code>false</code>{{Code|0}}
|-
| '''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%'
|-
| width='90120' | '''Signature'''|<code>FORCECREATE</code>{{Code|RUNQUERY [boolean]}}
|-
| '''Default'''
|<code>false</code>{{Code|true}}
|-
| '''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%'
|-
| width='90120' | '''Signature'''|<code>{{Code|RUNS [num]</code>}}
|-
| '''Default'''
|<code>{{Code|1</code>}}
|-
| '''Summary'''
|Specify number of runs Specifies how often a query will be evaluated. The result is executed. Results are printed a single time serialized only once, and evaluation the measured times are averages of all runs. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-r</code>.
|}
=Serialization Options=
 
===SERIALIZE===
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|SERIALIZE [boolean]}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.
|}
 
===SERIALIZER===
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|SERIALIZER [params]}}
|-
| '''Default'''
|''empty''
|-
| '''Summary'''
|Parameters for [[Serialization|serializing]] query results. The string must comply with the following rules:
* Variable names and values must be separated by equality signs.
* Multiple variables must be delimited by commas.
* Commas in values must be duplicated.
The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
|-
| '''Examples'''
|
* <code>indent=no</code> : disables automatic indentation of XML nodes. This is usually a good choice when working with [[Full-Text#Mixed Content|Mixed-Content Data]].
* <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.
* <code>item-separator=,,</code> : separates serialized items by a single comma.
|}
 
===EXPORTER===
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|EXPORTER [params]}}
|-
| '''Default'''
|''empty''
|-
| '''Summary'''
|Contains parameters for exporting resources of a database and writing files after updates via the {{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[Serialization]] for more details.
|-
| '''Examples'''
|
* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
|}
===XMLPLAN===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|XMLPLAN</code>[boolean]}}
|-
| '''Default'''
|<code>{{Code|false</code>}}
|-
| '''Summary'''
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.
|}
===COMPPLAN===
 {|width='100%'
|-
| width='90120' | '''Signature'''|<code>{{Code|COMPPLAN</code>[boolean]}}
|-
| '''Default'''
|<code>{{Code|true</code>}}
|-
| '''Summary'''
|Creates Generates the query plan , which can be activated via {{Option|XMLPLAN}}, before or after the query compilation step. Query plans might change due to optimizationsThis option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>.
|}
===DOTPLANFULLPLAN=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>DOTPLAN</code>{{Code|FULLPLAN [boolean]}}
|-
| '''Default'''
|<code>{{Code|false</code>}}
|-
| '''Summary'''
|Visualizes Attaches the execution plan file path, line and column of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file the expressions in the original query string to the query directoryplan. Values (items and sequences) have no input information attached.
|}
=Other Options= ===DOTCOMPACTAUTOFLUSH=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>DOTCOMPACT</code>{{Code|AUTOFLUSH [boolean]}}
|-
| '''Default'''
|<code>false</code>{{Code|true}}
|-
| '''Summary'''
|Chooses Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a compact dot representationdrawback, the chance of data loss increases if the database is not explicitly flushed via the {{Command|FLUSH}} command.
|}
===DOTDISPLAYWRITEBACK=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>DOTDISPLAY</code>{{Code|WRITEBACK [boolean]}}
|-
| '''Default'''
|<code>true</code>{{Code|false}}
|-
| '''Summary'''
|Visualizes Propagates updates on main-memory instances of files that have been retrieved via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] back to disk:* This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>.* Please take in mind that no backup will be created from your original files.* The serialization options can be controlled via the dot representation after the query execution{{Option|EXPORTER}} option.
|}
===DOTTYMAXSTAT=== {|width='100%'
|-
| width='90120' | '''Signature'''|<code>DOTTY {{Code|MAXSTAT [pathnum]</code>}}
|-
| '''Default'''
|<code>dotty</code>{{Code|30}}
|-
| '''Summary'''
|Location Specifies the maximum number of index occurrences printed by the {{monoCommand|dottyINFO INDEX}} executablecommand.
|}
=Changelog=
===;Version 79.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: <code>[[#AUTHTIMEOUT{{Option|ADDCACHE}}, {{Option|AUTHTIMEOUT]]</code>* Removed: <code>WILDCARDS</code>; new index supports both fuzzy and wildcard queries* Removed: <code>SCORING</code>; new scoring model will focus on lengths of text nodes and match optionsCHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}}
===;Version 7.2===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: <code>[[#PROXYHOST{{Option|USER}}, {{Option|PROXYHOST]]</code>PASSWORD}}, <code>[[#PROXYPORT{{Option|PROXYPORT]]</code>LOG}}, <code>[[#NONPROXYHOSTS{{Option|NONPROXYHOSTS]]</code>LOGMSGMAXLEN}}, <code>[[#HTMLOPT{{Option|HTMLOPT]]</code>WEBPATH}}, {{Option|RESTXQPATH}}{{Option|HTTPLOCAL}}, {{Option|CREATEONLY}}, {{Option|STRIPNS}}* UpdatedRemoved: <code>[[#TIMEOUT{{Code|TIMEOUT]]</code>HTTPPATH}}; {{Code|HTTPPORT}}: {{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
5

edits

Navigation menu