Changes

Jump to navigation Jump to search

Options (edit)

Revision as of 11:25, 28 July 2022

26,005 bytes added ,  11:25, 28 July 2022
m
Text replacement - "[[Jobs Module" to "[[Job Module"
This page is linked from the [[Getting Started]] Section.
The options listed on this page influence the way how database [[Commands|commands]] are executed and XQuery expressions are evaluated. Options are divided into [[#global options|global]] options, which are valid for all BaseX instances, and local options, which are specific to a client or session. Values Two kinds of options are either ''strings'', ''numbers'' or ''booleans''.exist:
Various ways exist * '''[[#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 access and change options:a client or session.
* The current value Values of an option can be requested with the [[Commands#GET|GET]] and changed with the [[Commands#SET|SET]] command. All values options are either ''strings'', ''staticnumbers'' or ''booleans'': they stay valid until they . Options are changed once again by another operation. If an option is of type ''booleanstatic'', and if no value is specifiednot bound to a single operation (for example, its existing value will be invertedthe next command).Various ways exist to access and change options:
* The current value of an option can be requested with the {{VersionCommand|7.5SHOW OPTIONS}}: Initial values for command. Local options can also be specified changed via system properties{{Command|SET}} (all global options, except for {{Option|DEBUG}}, which can e.g. only be passed on with the [http://docschanged at startup time).oracle.com/javase/1.4.2/docs/tooldocs/windows/java.html#options -D flag] on command lineIf an option is of type ''boolean'', or using [http://docs.oracle.com/javase/6/docs/api/java/lang/System.html#setProperty(java.lang.Stringand if no value is specified,%20java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys needs to its current value will be prefixed with {{Code|org.basex.}}inverted. An example:
<pre class="brush:bash">java -Dorg* The {{Code|.basex}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance.CHOP=false -cp basex.jar orgIt contains all global options.basex.BaseX -c"get chop"CHOPLocal options can be specified at the end of the file after the {{Code|Local Options}} comment: false</pre>
<syntaxhighlight lang="perl"># General OptionsDEBUG = false... # Local OptionsCATALOG = etc/w3-catalog.xml</syntaxhighlight> * Options Initial values for global options can also be set in the prolog of an XQuery expressionspecified via system properties, which can e.g. In the option declaration, options need to be bound to passed on with the [https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on command line, or using [Database Modulehttps://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()]] namespacebefore creating a BaseX instance. All values will The specified keys need to be reset after the evaluation of a queryprefixed with {{Code|org.basex.}}. An example: <syntaxhighlight lang="perl">java -Dorg.basex.CATALOG=etc/w3-catalog.xml -cp basex.jar org.basex.BaseX -c"SHOW OPTIONS catalog"CATALOG:etc/w3-catalog.xml</syntaxhighlight>
* If the Mac OS X packaged application is used, global options can be set within the Info.plist file within the Contents folder of the application package. For example: <pre classsyntaxhighlight lang="brush:xqueryxml">declare option db:chop 'false';<key>JVMOptions</key><array> <string>-Dorg.basex.CATALOG=etc/w3-catalog.xml</string></prearray></syntaxhighlight> * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:
* {{Version|7<syntaxhighlight lang="xml"><context-param> <param-name>org.5}}: Options can be locally set in XQuery via pragma expressions:basex.catalog</param-name> <param-value>etc/w3-catalog.xml</param-value></context-param></syntaxhighlight>
<pre class="brush:xquery">(* In XQuery, local options can be set via option declarations and [[XQuery Extensions# db:chop false #) { parse-xml('<xml> hi </xml>') }</pre>Pragmas|pragmas]].
If options are implicitly changed by operations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/>
=Global Options=
All global Global options are stored constants. They can only be set in the configuration file or via system properties (see above). One exception is the [[Configuration#Configuration Filesdebug|configuration fileDEBUG]] {{Code|.basex}}option, which is parsed can also be changed at runtime by every new local BaseX instanceusers with [[User Management|admin permissions]].
With {{Version|7.5}}, once they have been parsed, global options will be fixed; they can only be changed before a BaseX instance is started. This reduces the risk of side effects and security holes.==General Options==
==General=DEBUG=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|DEBUG [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Command-Line Options#BaseX Standalone|command line]] via <code>-d</code>.|}
===DBPATH===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|DBPATH [path]}}
|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> 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.
|}
===REPOPATHLOGPATH=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|REPOPATH LOGPATH [path]}}|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]].logs</code>|-valign="top"
| '''Summary'''
|Points to the directory in which all [[RepositoryLogging|log files]], in which all XQuery modules are locatedstored. Relative paths will be resolved against the {{Option|DBPATH}} directory.
|}
===DEBUGREPOPATH=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|DEBUG REPOPATH [booleanpath]}}|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{{Code|false}home}/repo]]</code>|-valign="top"
| '''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%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|LANG [language]}}
|-valign="top"
| '''Default'''
|{{Code|English}}
|-valign="top"
| '''Summary'''
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.
===LANGKEY===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|LANGKEY [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed.
|}
 
===FAIRLOCK===
 
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|FAIRLOCK [boolean]}}
|- valign="top"
| '''Default'''
|{{Code|false}}
|- valign="top"
| '''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%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|CACHETIMEOUT [seconds]}}
|- valign="top"
| '''Default'''
|{{Code|3600}}
|- valign="top"
| '''Summary'''
|Specifies how many seconds the results of queries, which have been queued by the [[Job Module|asynchronously executed]], will be cached in main memory.
|}
===HOST===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|HOST [host]}}
|-valign="top"
| '''Default'''
|{{Code|localhost}}
|-valign="top"
| '''Summary'''
|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
|}
===PORT===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|PORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|1984}}
|-valign="top"
| '''Summary'''
|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
|}
===SERVERPORT===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|SERVERPORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|1984}}
|-valign="top"
| '''Summary'''
|This is the port the database server will be listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-p</code>.
|}
===EVENTPORTUSER==={||-| width='90' | '''Signature'''|{{Code|EVENTPORT [port]}}|-| '''Default'''|{{Code|1985}}|-| '''Summary'''|This port is used by the client to listen for [[Events|server events]]. This port will only be bound if a client attaches itself to a database event.|}
===USER==={{Mark|Introduced with Version 7.5:}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|USER [name]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Represents a user nameusername, which is used for accessing the server or an HTTP service.<br/>:* The default value will be overwritten if a client specifies its own credentials.<br/>* 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===
{{Mark|Introduced with Version 7.5:}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|PASSWORD [password]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"| '''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, authentication will only be possible if the client supplies 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%'|- valign="top"| width='120' | '''Signature'''|{{Code|AUTHMETHOD [method]}}|- valign="top"| '''Default'''|''Basic''|- valign="top"
| '''Summary'''
|Represents a passwordSpecifies the default authentication method, which is will be used for accessing by the [[Web Application|HTTP server or an HTTP service. The default value will be overwritten if a client specifies its own ]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}:<br/>* If the default value basic access is emptychosen, login will only be possible if the client specifies credentialscan still request digest authentication. Please note that it * This is discouraged to store passwords in plain textdifferent 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|SERVERHOST [host&#x7c;ip]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|This is the host name or ip IP address the server is bound to. If the option is set to an empty string (which is the default), the server will be open to all clients.
|}
===PROXYHOST===
 {|width='100%' width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|PROXYHOST [host]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|This is the host name of a proxy server. If the value is an empty string, it will be ignored.
|}
===PROXYPORT===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|PROXYPORT [port]}}
|-valign="top"
| '''Default'''
|{{Code|800}}|-valign="top"
| '''Summary'''
|This is the port number of a proxy server. If the value is set to {{Code|0}}, it will be ignored.
|}
===NONPROXYHOSTS===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|NONPROXYHOSTS [hosts]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"| '''Summary'''|This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored.|} ===IGNORECERT=== {{Announce|Updated with Version 10}}: Additionally disable hostname verification. {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|IGNORECERT [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"
| '''Summary'''
|This is a list of hosts that should be directly accessedDisable SSL hostname verification and ignore untrusted certificates when connecting to servers.
|}
===TIMEOUT===
{{Mark|Updated with Version 7.3:}} default value set from {{Code|0}} to {{Code|30}}.{|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|TIMEOUT [seconds]}}
|-valign="top"
| '''Default'''
|{{Code|30}}
|-valign="top"
| '''Summary'''
|Specifies the maximum time a read-only transaction triggered by a client may take. If an operation takes longer than the specified timeoutnumber of seconds, it will be aborted. Write 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 {{Codeoperations with [[User Management|ADMIN}} operationsadmin permissions]].
|}
===KEEPALIVE===
{{Mark|Updated with Version 7.3:}} default value set from {{Code|0}} to {{Code|600}}.{|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|KEEPALIVE [seconds]}}
|-valign="top"
| '''Default'''
|{{Code|600}}
|-valign="top"
| '''Summary'''
|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.
===PARALLEL===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|PARALLEL [number]}}
|-valign="top"
| '''Default'''
|{{Code|8}}
|-valign="top"
| '''Summary'''
|Denotes the maximum allowed {{Code|number}} 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.
|}
===LOG===
{{Mark|Introduced with Version 7.5}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|LOG [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.
|}
===LOGMSGMAXLEN===
{{Mark|Introduced with Version 7.5}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|LOGMSGMAXLEN [length]}}
|-valign="top"
| '''Default'''
|{{Code|1000}}
|-valign="top"
| '''Summary'''
|Specifies the maximum length of a single [[Logging|log message]].
|}
===LOGTRACE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|LOGTRACE [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|If BaseX is running as [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and similar functions) is written to the [[Logging|database logs]]. If this option is disabled, trace output will be redirected to standard error, as it is known from the standalone version of BaseX.|} ==HTTP OptionsServices==
If BaseX is run as [[Web Application]], the Most HTTP options are either determined by the used web server or specified defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the {{Code|<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===
{{Mark|Introduced in Version 7.5:}} this value is replacing the [[#HTTPPATH|HTTPPATH]] option.{|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|WEBPATH [path]}}
|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code> or <code>[[Configuration#Database Directory|{home}/webapp]]</code>|-valign="top"
| '''Summary'''
|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:* The option is ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.|} ===GZIP=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|GZIP [boolean]}}|- valign="top"| '''Default'''|<code>false</code>|- valign="top"| '''Summary'''|Jetty provides a [https://www.eclipse.org/jetty/documentation/current/gzip-filter.html Gzip handler] for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the [[Web Application|BaseX HTTP Server]]:* The option can also be enabled on [[Command-Line Options#HTTP Server|command line]] via <code>-g</code>.* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.* In addition to the [https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 Jetty defaults] (GET requests, exclusion of binaries, MSIE 6.0, etc.), POST and PUT requests are supported.
|}
===RESTXQPATH===
{{Mark|Introduced with Version 7.5:}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|RESTXQPATH [path]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"| '''Summary'''|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the {{Option|WEBPATH}} directory.|} ===PARSERESTXQ=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|PARSERESTXQ}}|- valign="top"| '''Default'''|{{Code|3}}|- valign="top"
| '''Summary'''
|Points to Timeout after which the RESTXQ directory which contains will be parsed for changes:* If {{Code|0}} is specified, the [[directory will be parsed every time a RESTXQ]] modules of a web applicationfunction is called. Relative paths * A positive value defines the idle time in seconds after which parsing will be resolved against 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#WEBPATHPreliminaries|WEBPATHRESTXQ Preliminaries]] directoryfor more details.
|}
===HTTPLOCALRESTXQERRORS==={{Mark|Introduced with Version 7.5:}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|HTTPLOCAL [boolean]RESTXQERRORS}}|-valign="top"
| '''Default'''
|{{Code|falsetrue}}|-valign="top"
| '''Summary'''
|Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a database server instance will production environment, it can be disabled to suppress errors that should not be opened along with seen by the web server. If user of an API (the flag is set to {{Code|true}}, all commands will full error information can still be executed looked up in an embedded the database contextlogs).<br/>If BaseX is run as See [[Web ApplicationRESTXQ#Error Handling|RESTXQ Error Handling]], and if the flag is {{Code|false}}, the server will be started as soon as the first HTTP service is calledfor more details.
|}
===STOPPORTRESTPATH=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|STOPPORT RESTPATH [portpath]}}|-valign="top"
| '''Default'''
|{{Code|8985}}''empty''|-valign="top"
| '''Summary'''
|This is Points to the port on directory which contains XQuery files and command scripts, which can be evaluated via the [[StartupREST#BaseX HTTP ServerGET Requests|HTTP ServerREST run operation]] can be locally closed. The listener for stopping the web server Relative paths will only be started if resolved against the specified value is greater than {{CodeOption|0WEBPATH}}. – The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]]directory.
|}
===HTTPPATHHTTPLOCAL==={{Mark|Removed in Version 7.5:}} this value has been replaced with the [[#WEBPATH|WEBPATH]] and [[#RESTXQPATH|RESTXQPATH]] options.{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|HTTPPATH HTTPLOCAL [pathboolean]}}|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory{{Code|{homefalse}/BaseXHTTP]]</code> or <code>[[Configuration#Database Directory|{home}/http]]</code>|-valign="top"
| '''Summary'''
|Points to By default, if BaseX is run as [[Web Application]], the HTTP root directorydatabase server instance will be started in addition, in which HTML files may can then be storedaddressed by [[Clients]] via the database port (see {{Option|PORT}}).<br/>If the option is set to {{Code|true}}, and query files that no database server will be evaluated by RESTlaunched.
|}
===HTTPPORTSTOPPORT==={{Mark|Removed in Version 7.5:}} this value is now modified in the {{Code|jetty.xml}} config file.
{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|HTTPPORT STOPPORT [port]}}|-valign="top"
| '''Default'''
|{{Code|89848081}}|-valign="top"
| '''Summary'''
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally 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 listening tochanged when running the HTTP server on [[Command-Line Options#BaseX Server|command line]] via <code>-s</code>.
|}
===MAINMEM===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|MAINMEM [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If this option is turned on, new databases will be exclusively created in main memory. :* Most queries will be evaluated faster in main -memory mode, but all data is lost if the BaseX instance in which the database was created is shut down. The value of this option * It is not possible to store binary resources in a main-memory database.* A main-memory database will be assigned once have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new databasefrom the exported file in a second step.* This option will not be available for {{Function|Database|db:create}}, and cannot because the database would not be changed accessible anymore after thatdatabase creation, i. e., outside the query scope.
|}
===CREATEONLYADDCACHE===
{{Mark|Introduced with Version 7.5:}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|CREATEONLY ADDCACHE [boolean]}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|By defaultIf this option is activated, newly created databases data structures of documents will automatically first be opened in order cached to disk before being added to be available for further processing stepsthe final database. By setting the flag This option is helpful when larger documents need to {{Code|true}}be added, this will be preventedand if the existing heuristics cannot estimate the input size (e.g. when adding directories or sending input streams).
|}
===CREATEFILTER===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|CREATEFILTER [filter]}}
|-valign="top"
| '''Default'''
|{{Code|*.xml}}
|-valign="top"
| '''Summary'''
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
===ADDARCHIVES===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|ADDARCHIVES [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"| '''Summary'''|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc.) are parsed whenever new databases are created or resources are added to a database.|} ===ARCHIVENAME=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|ARCHIVENAME [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"
| '''Summary'''
|If this option is set to {{Code|true}}, 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%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|SKIPCORRUPT [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files will be parsed twice. Next, main memory consumption will be higher as parsed files will be cached in main memory.
===ADDRAW===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|ADDRAW [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-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%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|PARSER [type]}}
|-valign="top"
| '''Default'''
|{{Code|XML}}
|-valign="top"| '''Summary'''|Defines a [[Parsers|parser]] for importing new files to the database. Available parsers are {{Code|XML}}, {{Code|JSON}}, {{Code|CSV}}, {{Code|TEXT}}, {{Code|HTML}}, and {{Code|RAW}}. HTML input will be parsed as XML documents if [[Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.|} ===CSVPARSER=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|CSVPARSER [options]}}|- valign="top"| '''Default'''|''empty''|- valign="top"
| '''Summary'''
|Defines a Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[ParsersCSV Module#Options|parserCSV Module]] for importing new files to the database. Currently, |- valign="top"| 'XML', 'JSONExamples', 'CSV'|<code>encoding=CP1252, 'TEXT', 'HTML' are available header=true</code> parses the 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 JSONPARSER [options]}}|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Defines parser-specific 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; see (except for the additional <code>encoding</code> option) are described in the [[ParsersJSON Module#Options|JSON Module]] for more information.|- valign="top"| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.
|}
===HTMLOPTHTMLPARSER==={{Mark|Introduced with Version 7.2:}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|HTMLOPT HTMLPARSER [options]}}|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Allows to specify TagSoup Specifies the way how HTML data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options for HTML parsing; see are delimited with <code>,</code>. The available options are described in the [[Parsers#HTML ParserOptions|HTML ParserParsers]] for more informationarticle.|- valign="top"| '''Examples'''|* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.* <code>lexical=true</code> preserves comments.
|}
==XML Parsing=TEXTPARSER===
===CHOP==={|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|CHOP TEXTPARSER [booleanoptions]}}|-valign="top"
| '''Default'''
|{{Code|true}}''empty''|-valign="top"
| '''Summary'''
|Chops all leading Specifies the way how TEXT data will be parsed. Keys and trailing whitespaces from text nodes while building a databasevalues are delimited with <code>=</code>, and discards empty text nodesmultiple options are delimited with <code>,</code>. This option often reduces The available options are listed in the database size by up to 50%[[Parsers]] article.|- valign="top"| '''Examples'''|<code>lines=true</code> creates a single element for each line of text.
|}
==XML Parsing=INTPARSE= ===STRIPWS=== {{Announce|Updated with Version 10:}} Renamed (before: {{Code|CHOP}}), new default: {{Code|false}}. {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|INTPARSE STRIPWS [boolean]}}|-valign="top"
| '''Default'''
|{{Code|truefalse}}|-valign="top"
| '''Summary'''
|Uses Many XML documents include whitespaces that have been added to improve readability. This option controls the internal XML parser instead [https://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the standard Java XML parser:* If the option is set to {{Code|true}}, leading and trailing whitespaces from text nodes will be stripped, and empty text nodes will be discarded. * The internal parser flag should be disabled if a document contains [[Full-Text#Mixed Content|mixed content]].* The flag can also be turned on via the [[Command-Line Options#BaseX Standalone|command line]] and <code>-w</code>.* If the option is fasterenabled, more fault tolerant whitespaces of an element and supports common HTML entities out-of-its descendants can locally be preserved with the <code>xml:space="preserve"</code> attribute: <syntaxhighlight lang="xml"><xml> <title> Demonstrating the-boxSTRIPWS flag </title> <text xml:space="preserve">To <b>be</b>, but it does or not support all features needed for parsing DTDsto <b>be</b>, that is the question.</text></xml></syntaxhighlight>If whitespaces are stripped, <code>indent=yes</code> can be assigned to the {{Option|SERIALIZER}} option to get properly indented XML output.
|}
===STRIPNS===
{{Mark|Introduced with Version 7.5:}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|STRIPNS [boolean]}}
|-valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|Strips all namespaces from an XML document while parsing.|} ===INTPARSE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|INTPARSE [boolean]}}|- valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Strips 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 namespaces from an features of the XML document before adding it to a databasestandard and advanced DTD features, such as recursive entity expansion.
|}
===DTD===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|DTD [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"| '''Summary'''|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The {{Option|CATALOG}} option can be changed to locally resolve DTDs.|} ===XINCLUDE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|XINCLUDE [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"
| '''Summary'''
|Parses Resolves XInclude inclusion tags and merges referenced DTDs and resolves XML entitiesdocuments. By default, this option is switched to {{Code|falsetrue}}, as many DTDs are located externally, which may completely block . This option is only available if the process of creating new databases. The [[#CATFILEstandard Java XML Parser is used (see {{Option|CATFILE]] option can be changed to locally resolve DTDsINTPARSE}}).
|}
===CATFILECATALOG=== {{Announce|Updated with Version 10:}} Renamed from <code>CATFILE</code>. {| width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|CATFILE CATALOG [path]}}|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Specifies a Semicolon-separated list of XML catalog file files to locally resolve DTDs; see the entry on URIs. See [[Catalog 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|TEXTINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see . See [[IndexesIndex#Text Index|Text Index]] for more details.
|}
===ATTRINDEX===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|ATTRINDEX [boolean]}}
|-valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[Index#Attribute Index|Attribute Index]] for more details.|} ===TOKENINDEX=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|TOKENINDEX [boolean]}}|- valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates 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%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|FTINDEX [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"| '''Summary'''|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions. See [[Index#Full-Text Index|Full-Text Index]] for more details.|} ===TEXTINCLUDE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|TEXTINCLUDE [names]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes 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='120' | '''Signature'''|{{Code|ATTRINCLUDE [names]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===TOKENINCLUDE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|TOKENINCLUDE [names]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===FTINCLUDE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|FTINCLUDE [names]}}|- valign="top"| '''Default'''|''empty''|- valign="top"
| '''Summary'''
|Creates a full-Defines name patterns for the parent elements of texts that are indexed. By default, all text index whenever a new database is creatednodes will be indexed.<br/>Name patterns are separated by commas. A full-text index speeds up queries with full-text expressions; see See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===MAXLEN===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|MAXLEN [int]}}
|-valign="top"
| '''Default'''
|{{Code|96}}
|-valign="top"
| '''Summary'''
|Specifies the maximum length of for strings that are to be indexed by the name, path, value, and full-text stored in [[Indexes|index structures]]. The value of this option will be assigned once to a new database, and cannot can only be changed after thatby creating a new database or doing a [[Commands#OPTIMIZE|full optimization]].
|}
===MAXCATS===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|MAXCATS [int]}}
|-valign="top"
| '''Default'''
|{{Code|100}}
|-valign="top"
| '''Summary'''
|Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that.
===UPDINDEX===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|UPDINDEX [boolean]}}
|-valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|If turned on, 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 {{Code|ALL}} keyword or {{Function|Database|db:optimize}} and {{Code|true()}} as second argument.* After each update, the value indexes will be refreshed as well. Incremental updates are currently not available for the full-text index and database statistics.* Find more details in the article on [[Index#Updates|Index Structures]].|} ===AUTOOPTIMIZE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|AUTOOPTIMIZE [boolean]}}|- valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If turned on, incremental indexing auto optimization will be activatedapplied to new databases: all * With each update operations , outdated indexes and database statistics will also update be recreated.* As a result, the value index structures (texts and attribute values)will always be up-to-date.* However, updates can take much longer, so this option should only be activated for medium-sized databases. * The value of this option 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 It can be up-to-date. The downside is that updates will take a little bit longerreassigned by running {{Command|OPTIMIZE}} or {{Function|Database|db:optimize}}.
|}
===PATHINDEXSPLITSIZE==={{Mark|Removed in Version 7.3:}} the path index will always be created.{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|PATHINDEX SPLITSIZE [booleannum]}}|-valign="top"
| '''Default'''
|{{Code|true0}}|-valign="top"
| '''Summary'''
|Creates a path index whenever a new database is created. A path index helps to optimize location paths; see This option affects the [[Indexes#Performance|construction]] for of new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk:* By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption. Usually, this works fine.* If explicit garbage collection is disabled when running Java (e.g. via the JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to choose a custom split size.* You can e. g. start with {{Code|1000000}} (one million) index operations and adjust this value in the next steps.* The larger the assigned value is, the less splits will take place, and the more detailsmain memory will be required.
|}
==Full-TextIndexing==
===STEMMING===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|STEMMING [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-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='90120' | '''Signature'''
|{{Code|CASESENS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''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%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|DIACRITICS [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-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%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|LANGUAGE [lang]}}
|-valign="top"
| '''Default'''
|{{Code|en}}
|-valign="top"
| '''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%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|STOPWORDS [path]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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}} in the official releasesmore details.
|}
=Query Options= =WILDCARDS==QUERYINFO=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|QUERYINFO [boolean]}}|- valign="top"| '''Default'''|{{Code|false}}|- valign="top"| '''Summary'''|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>. |}
{{Mark|Removed in Version 7.3:}} new index supports both fuzzy and wildcard queries.===MIXUPDATES===
{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|WILDCARDS [boolean]MIXUPDATES}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"| '''Summary'''|Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for more details.|} ===BINDINGS=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|BINDINGS [vars]}}|- valign="top"| '''Default'''|''empty''|- valign="top"
| '''Summary'''
|Contains external variables to be bound to a query. The string must comply with the following rules:* Variable names and values must be separated by equality signs.* Multiple variables must be delimited by commas.* Commas in values must be duplicated.* Variables may optionally be introduced with a leading dollar sign.* If a 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>.|- valign="top"| '''Examples'''|* <code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a* <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.* In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable {{Code|$GREETING}}:<syntaxhighlight lang="xquery">SET BINDINGS GREETING="hello world!"XQUERY declare variable $GREETING external; $GREETING</syntaxhighlight>
|}
===SCORINGINLINELIMIT=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|INLINELIMIT}}|- valign="top"| '''Default'''|{{Code|50}}|- valign="top"| '''Summary'''|This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to speed up query evaluation.* Inlining will only take place if a function body is not too large (i.e., if it does not contain too many expressions).* With this option, this maximum number of expressions can be specified.* Function inlining can be turned off by setting the value to {{Code|0}}.* The limit can be locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (follow the link to get more information on function inlining).|}
{{Mark|Removed in Version 7.3:}} new scoring model will focus on lengths of text nodes and match options.===UNROLLLIMIT===
{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|SCORING [mode]UNROLLLIMIT}}|-valign="top"
| '''Default'''
|{{Code|05}}|-valign="top"
| '''Summary'''
|A new full-text index will pre-calculate full-text scores. This option enables TF/IDF/based scores in full-text queries and increases main controls the unroll limit:* Loops with few iterations are ''unrolled'' by the XQuery compiler to enable further optimizations.* If the limit is increased, more optimizations will take place, but the memory consumption while indexingand compile time will increase. * See the [[Full-TextXQuery Optimizations#ScoringLoop Unrolling|ScoringLoop Unrolling]] for more information on different scoring typesdetails.
|}
=Query Options==ENFORCEINDEX===
===QUERYINFO==={|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|QUERYINFO ENFORCEINDEX [boolean]}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Prints more information on internal query Enforces index rewritings, optimizations, and performancein path expressions. The query info will always be printed in the [[GUI#Visualizations|Info View]] in the GUI, or it can be activated with the See [[Startup_OptionsIndexes#BaseX_StandaloneEnforce Rewritings|-V flagEnforce Rewritings]] on command linefor details.
|}
===XQUERY3COPYNODE=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|XQUERY3COPYNODE [boolean]}}|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Enables all When creating new nodes in XQuery via [[XQuery 3https://www.w3.0org/TR/xquery-31/#id-constructors Node Constructors]] features supported by BaseX, copies of all enclosed nodes will be created, and the copied nodes get new node identities. As a result, the following query yields <code>false</code>:<syntaxhighlight lang="xquery">let $a := <a/>let $b := <b>{ $a }</b>return $b/a is $a</syntaxhighlight>This step can be very expensive and memory consuming. If this the option is set disabled, child nodes will only be linked to {{Code|false}}the new parent nodes, and the XQuery parser will only accept expressions upper query returns <code>true</code>.<br>The option should be used carefully as it changes the semantics of the XQuery 1.0 specificationIt should preferably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].
|}
===BINDINGSTAILCALLS=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|BINDINGS [vars]TAILCALLS}}|-valign="top"
| '''Default'''
|''empty''{{Code|256}}|-valign="top"
| '''Summary'''
|Contains external variables to be bound to a query:* Variable names and values are separated by equality signs, and multiple variables are delimited by commas.* Variables may optionally be introduced with a leading dollar sign.* Commas that occur in the value itself are encoded by duplication.* If a variable uses a namespace different to the default namespace, it can be specified with the Specifies how many stack frames of [httphttps://www.jclarken.com/xml/xmlns.htm Clark Notation] or [http://www.w3wikipedia.org/TR/xquery-30wiki/#idTail_call tail-basics Expanded QName Notationcalls].* This option can also be used are allowed on [[Startup Options#BaseX Standalone|command line]] with the flag <code>-b</code>stack at any time.|When this limit is reached, tail-| '''Examples'''|<code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} call optimization takes place and {{Code|2}} to the variables $a and $b<br/><code>a=1,,2</code> &nbsp; binds some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1,2}} to the variable $a<br/><code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.
|}
===QUERYPATHWITHDB=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|QUERYPATH [path]WITHDB}}|-valign="top"
| '''Default'''
|''empty''{{Code|true}}|-valign="top"
| '''Summary'''
|Contains By default, resources specified via {{Code|fn:doc}} and {{Code|fn:collection}} are looked up both in the path (''base URI'') database and in the file system. If you always use {{Function|Database|db:get}} to access databases, it is recommendable to disable this option:* No locks will be created for the executed query two functions (default: ''empty''see [[Transaction Management#Limitations|limitations of database locking]] for more details). This directory * Access to local and external resources will be used to resolve relative paths to documentsfaster, query modules, and other resources addressed in a queryas the database lookup will be skipped.
|}
===CACHEQUERYDEFAULTDB=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|CACHEQUERY [boolean]DEFAULTDB}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Caches If this option is turned on, paths specified in the query results before returning them to the client. This option may be set to {{Code|truefn:doc}} and {{Code|fn:collection}} if functions will first be resolved against a database that has been opened in the whole result is needed for further operations global context outside the query (such as is e.g. by the {{Command|OPEN}} command). If the case path does not match any existing resources, it will be resolved as described in the GUI of BaseX)article on [[Databases#Access Resources|accessing database resources]].
|}
===FORCECREATE===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|FORCECREATE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"| '''Summary'''|By activating this option, database instances will be created with the XQuery functions {{Code|fn:doc}} and {{Code|fn:collection}}.|} ===CHECKSTRINGS=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|CHECKSTRINGS [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;). The option affects [[Java Bindings]] and string conversion and input functions such as {{Function|Archive|archive:create}}, {{Function|Archive|archive:extract-text}}, and {{Function|Archive|archive:update}}.|} ===WRAPJAVA=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|WRAPJAVA [mode]}}|- valign="top"| '''Default'''|{{Code|some}}|- valign="top"
| '''Summary'''
|By activating this option, Defines the way how values that result from Java code invocation will be converted to XQuery items. Allowed values: {{Code|none}}, {{Code|all}}, {{Code|some}}, {{Code|doc()instance}} , and {{Code|collection()void}} functions will create database instances . See [[Java_Bindings#Conversion to XQuery|Java Bindings]] for the addressed input filesfurther details.
|}
===LSERROR===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|LSERROR [error]}}
|-valign="top"
| '''Default'''
|{{Code|0}}
|-valign="top"| '''Summary'''|This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if {{Code|0}} is assigned, the error value is calculated dynamically. See [[Full-Text#Fuzzy_Querying|Fuzzy Querying]] for more details.|} ===RUNQUERY=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|RUNQUERY [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"
| '''Summary'''
|Specifies if a query will be executed or parsed only. This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option. See the page can also be changed on [[FullCommand-TextLine Options#Fuzzy_QueryingBaseX Standalone|Full-Textscommand line]] for more information on fuzzy queryingvia <code>-R</code>.
|}
===RUNS===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|RUNS [num]}}
|-valign="top"
| '''Default'''
|{{Code|1}}
|-valign="top"
| '''Summary'''
|Specify number of runs Specifies how often a query is executed by the [[Commands#XQUERY|XQUERY]] commandwill be evaluated. The result is serialized only serialized once, and the measured times are averages of all runs. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-r</code>.
|}
===SERIALIZE===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|SERIALIZE [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.
|}
===SERIALIZER===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|SERIALIZER [params]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Contains parameters Parameters for serializing queries; see [[Serialization|serializing]] for more details. Keys query results:* Variable names and values are separated by equality signs, and multiple parameters .* Multiple variables are delimited by commas.* Commas must be duplicated if they appear as literals in values.The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.|-valign="top"| '''ExampleExamples'''|* <code>indent=yes</code> : enables automatic indentation of XML nodes. This is recommended if whitespaces have been stripped from a document (see {{Options|STRIPWS}}).* <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.* <code>item-separator=,,</code> : separates serialized items by a single comma.
|}
===EXPORTER===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|EXPORTER [params]}}
|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''Summary'''
|Contains parameters for exporting all resources of a database; see [[Serialization]] for more detailsand writing files after updates via the {{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[Serialization]] for more details.|- valign="top"| '''Examples'''|* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
|}
===XMLPLAN===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|XMLPLAN [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-| '''Summary'''|Prints the execution plan of an XQuery expression in its XML representation.|} valign===COMPPLAN==={||-| width='90' | '''Signature'''|{{Code|COMPPLAN [boolean]}}|-| '''Default'''|{{Code|true}}|-"top"
| '''Summary'''
|Creates Prints the query execution plan before or after the compilation stepof an XQuery expression in its XML representation. 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='90' | '''Signature'''|{{Code|DOTPLAN [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file in the query directory.|}
===DOTCOMPACT==={|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|DOTCOMPACT FULLPLAN [boolean]}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-| '''Summary'''|Chooses a compact dot representation.|} valign===DOTDISPLAY==={||-| width='90' | '''Signature'''|{{Code|DOTDISPLAY [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Visualizes the dot representation after the query execution.|} ===DOTTY==={||-| width='90' | '''Signature'''|{{Code|DOTTY [path]}}|-| '''Default'''|{{Code|dotty}}|-"top"
| '''Summary'''
|Location Attaches the file path, line and column of the {{Code|dotty}} executableexpressions in the original query string to the query plan. Values (items and sequences) have no input information attached.
|}
===AUTOFLUSH===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|AUTOFLUSH [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the [[Commands#FLUSH{{Command|FLUSH]] }} command.
|}
===WRITEBACK===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|WRITEBACK [boolean]}}
|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Updates Propagates updates on XML nodes are written main-memory instances of files that have been retrieved via {{Code|fn:doc}} and {{Code|fn:collection}} back to the input files. disk:* This option can also be activated on [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>. Note * Please take in mind that no backups of backup will be created from your original files will .* The serialization options can be created if this controlled via the {{Option|EXPORTER}} option is turned on.
|}
===MAXSTAT===
 {|width='100%'|-valign="top"| width='90120' | '''Signature'''
|{{Code|MAXSTAT [num]}}
|-valign="top"
| '''Default'''
|{{Code|30}}
|-valign="top"
| '''Summary'''
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO{{Command|INFO INDEX]]</code> }} command.
|}
=Changelog=
 
;Version 10.0
* Removed: <code>COMPPLAN</code>, <code>IGNOREHOSTNAME</code>
* Updated: {{Option|IGNORECERT}}: Additionally disable hostname verification.
* Updated: {{Option|CATALOG}}: Renamed (before: {{Code|CATFILE}}).
* Updated: {{Option|STRIPWS}}: Renamed (before: {{Code|CHOP}}), new default: false.
 
;Version 9.7
* Updated: {{Option|GZIP}}: Support for POST and PUT requests.
 
;Version 9.6
* Added: {{Option|UNROLLLIMIT}}, {{Option|WRAPJAVA}}
 
;Version 9.5
* Updated: {{Option|INLINELIMIT}}: default reduced to 50.
* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response
 
;Version 9.4
* Added: {{Option|LOGTRACE}}
 
;Version 9.3
* Added: {{Option|WITHDB}}, {{Option|GZIP}}
 
;Version 9.2
* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}
* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
 
;Version 9.0
* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
 
;Version 8.6
* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}
* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)
* Removed: {{Code|QUERYPATH}} (will now be internally assigned)
* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ)
 
;Version 8.5
* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added.
 
;Version 8.4
* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}
* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)
* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code>
 
;Version 8.3
* Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}}
 
;Version 8.2
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
 
;Version 8.1
* Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}}
 
;Version 8.0
* Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}}
* Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored.
 
;Version 7.8.1
* Updated: {{Option|ADDARCHIVES}}: parsing of TAR and TGZ files.
 
;Version 7.8
 
* Added: {{Option|CSVPARSER}}, {{Option|JSONPARSER}}, {{Option|TEXTPARSER}}, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}}
* Updated: {{Option|WRITEBACK}} only applies to main-memory document instances.
* Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions.
* Updated: default of {{Option|INTPARSE}} is now {{Code|false}}.
* Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
 
;Version 7.7
* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}}
 
;Version 7.6
* Added: {{Option|GLOBALLOCK}}
* Added: store local options in configuration file after {{Code|# Local Options}} comments.
;Version 7.5
 
* Added: options can now be set via system properties
* Added: a pragma expression can be used to locally change database options
* Added: <code>[[#USER{{Option|USER]]</code>}}, <code>[[#PASSWORD{{Option|PASSWORD]]</code>}}, <code>[[#LOG{{Option|LOG]]</code>}}, <code>[[#LOGMSGMAXLEN{{Option|LOGMSGMAXLEN]]</code>}}, <code>[[#WEBPATH{{Option|WEBPATH]]</code>}}, <code>[[#RESTXQPATH{{Option|RESTXQPATH]]</code><code>[[#HTTPLOCAL}}{{Option|HTTPLOCAL]]</code>}}, <code>[[#CREATEONLY{{Option|CREATEONLY]]</code>}}, <code>[[#STRIPNS{{Option|STRIPNS]]</code>}}
* Removed: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: {{Code|jetty.xml}} configuration file is used instead
* Removed: global options cannot be changed anymore during the lifetime of a BaseX instance
;Version 7.3
 * Updated: <code>[[#KEEPALIVE{{Option|KEEPALIVE]]</code>}}, <code>[[#TIMEOUT{{Option|TIMEOUT]]</code>}}: default values changed
* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries
* Removed: {{Code|SCORING}}; new scoring model will focus on lengths of text nodes and match options
;Version 7.2
 * Added: <code>[[#PROXYHOST{{Option|PROXYHOST]]</code>}}, <code>[[#PROXYPORT{{Option|PROXYPORT]]</code>}}, <code>[[#NONPROXYHOSTS{{Option|NONPROXYHOSTS]]</code>}}, <code>[[#HTMLOPT{{Option|HTMLOPT]]</code>}}* Updated: <code>[[#TIMEOUT{{Option|TIMEOUT]]</code>}}: ignore timeout for admin users
;Version 7.1
 * Added: <code>[[#ADDRAW{{Option|ADDRAW]]</code>}}, <code>[[#MAXLEN{{Option|MAXLEN]]</code>}}, <code>[[#MAXCATS{{Option|MAXCATS]]</code>}}, <code>[[#UPDINDEX{{Option|UPDINDEX]]</code>}}* Updated: <code>[[#BINDINGS{{Option|BINDINGS]]</code>}}
;Version 7.0
 * Added: <code>[[#SERVERHOST{{Option|SERVERHOST]]</code>}}, <code>[[#KEEPALIVE{{Option|KEEPALIVE]]</code>}}, <code>[[#AUTOFLUSH{{Option|AUTOFLUSH]]</code>}}, <code>[[#QUERYPATH{{Option|QUERYPATH]]</code>}}
CG
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Retrieved from "http://docs.basex.org/wiki/Special:MobileDiff/8477...16210"

Navigation menu