Changes

Jump to navigation Jump to search

Options (edit)

Revision as of 11:25, 28 July 2022

30,449 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. Three data types Two kinds of options exist: strings, numbers, and booleans.
* Values can be changed with the '''[[Commands#SETGlobal Options|SETGlobal Options]] command and requested ''' are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the [[Commands#GET|GET]] commandclient/server architecture. All values are * '''Local options'statically bound'' (all remaining ones) are specific to a database client or session; they stay valid until they are changed once again by another operation. If an option is of type boolean, and if no value is specified, its existing value will be inverted.
* Values of options are either ''strings'', ''numbers'' or ''booleans''. Options can also be set in are ''static'' and not bound to a single operation (for example, the prolog of XQuery expressionsnext command). In the option declaration, keys need Various ways exist to be prefixed with {{Code|db:}}. All values will be reset after the evaluation of a queryaccess and change options:
* The current value of an option can be requested with the {{Command|SHOW OPTIONS}} command. Local options can be changed via {{Command|SET}} (all global options, except for {{Option|DEBUG}}, can only 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: <pre classsyntaxhighlight lang="brush:xqueryperl">declare option db:key 'value';# General OptionsDEBUG = false
...
</pre>
# Local OptionsCATALOG = etc/w3-catalog.xml</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 [https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{VersionCode|7org.basex.4}}. An example: <syntaxhighlight lang="perl">java -Dorg.basex.CATALOG=etc/w3-catalog.xml -cp basex.jar org.basex.BaseX -c"SHOW OPTIONS catalog"CATALOG: Options etc/w3-catalog.xml</syntaxhighlight> * If the Mac OS X packaged application is used, global options can be locally 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.CATALOG=etc/w3-catalog.xml</string></array></syntaxhighlight> * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows: <syntaxhighlight lang="xml"><context-param> <param-name>org.basex.catalog</param-name> <param-value>etc/w3-catalog.xml</param-value></context-param></syntaxhighlight> * In XQuery via pragma expressions. Note that, at least for now, local pragmas will have no effect on most options can be set via option declarations and [[UpdateXQuery Extensions#Pragmas|update pragmas]]. If options are changed by operationsin the [[GUI]], as these the underlying commands will be evaluated at listed in the very end of a query[[GUI#Visualizations|Info View]]. The following query preserves whitespaces from the parsed XML string:<br/><br/>
<pre class="brush:xquery">(# db:chop false #) { parse-xml('<xml> hi </xml>') }</pre>Global Options=
* If Global options are implicitly changed by operations constants. They can only be set in the configuration file or via system properties (see above). One exception is the [[GUI#debug|DEBUG]]option, the underlying commands will which can also be listed in the changed at runtime by users with [[GUI#VisualizationsUser Management|Info Viewadmin permissions]].<br/>&nbsp;
=Main =General Options==
The main options are only available from the [[Standalone Mode]] and [[Database Server]] instances of BaseX, i.e., they cannot be changed by database clients. They are stored in the [[Configuration#Configuration Files|.basex config file]], which is opened by every new BaseX instance:===DEBUG===
{| width='100%'|- valign=General"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. If the option is changed, existing databases will not be moved to the new location.
|}
===REPOPATHLOGPATH=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|REPOPATH 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.<br/>'''Note:''' if Relative paths will be resolved against the option is changed, BaseX needs to be restarted in order to activate existing packages and avoid side effects{{Option|DBPATH}} directory.
|}
===DEBUGREPOPATH=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|DEBUGREPOPATH [path]}}|-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'. BaseX needs to be restarted in order to activate the new language.
|}
===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'''
|Prefixes all texts with Defines the locking strategy:* By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the internal language keyslimit of parallel transactions (specified via {{Option|PARALLEL}}) has been reached. This option prevents update operations from blocking all other requests. For example, the DBA can further be used to see which jobs are running, even if the queue is helpful if BaseX full.* If fair locking is translated into another languageenabled, read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it should be used if you want to see where particular texts are displayedthe prompt evaluation of update operations is critical. BaseX needs to |} ===CACHETIMEOUT=== {| width='100%'|- 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 restarted cached in order to activate this optionmain 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>.
|}
===SERVERHOSTUSER=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|SERVERHOST USER [host&#x7c;ipname]}}|-valign="top"
| '''Default'''
|''empty'' (''wildcard'')|-valign="top"
| '''Summary'''
|This Represents a username, which is used for accessing the host name server or ip address an HTTP service:* The default value will be overwritten if a client specifies its own credentials.* If the server default value is bound to. The server empty, login will only be open to all clients possible if the client specifies credentials.* The option is set to an empty stringcan also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-U</code>.
|}
===EVENTPORTPASSWORD=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|EVENTPORT PASSWORD [portpassword]}}|-valign="top"
| '''Default'''
|{{Code|1985}}''empty''|-valign="top"
| '''Summary'''
|This port Represents a password, which is used by 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 to listen for supplies credentials.* The option can also be changed on [[EventsCommand-Line Options#BaseX Client|server eventscommand line]]via <code>-P</code>. This port will only be bound if * Please note that it is a client attaches itself security risk to a database eventspecify your password in plain text.
|}
===HTTPPORTAUTHMETHOD=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|HTTPPORT AUTHMETHOD [portmethod]}}|-valign="top"
| '''Default'''
|{{Code|8984}}''Basic''|-valign="top"
| '''Summary'''
|This is Specifies the port default authentication method, which will be used by the [[Startup#BaseX HTTP ServerWeb Application|HTTP Serverserver]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}:<br/>* If basic access is chosen, the client can still request digest authentication.* This is different for digest access, which cannot be overwritten.* With custom authentication, the server will be listening tonot do any authentication.
|}
===STOPPORTSERVERHOST==={||-| width='90' | '''Signature'''|{{Code|STOPPORT [port]}}|-| '''Default'''|{{Code|8985}}|-| '''Summary'''|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed.|}
===HTTPPATH==={|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|HTTPPATH SERVERHOST [pathhost&#x7c;ip]}}|-valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXHTTP]]</code>''empty''|-valign="top"
| '''Summary'''
|Points This is the host name or IP address the server is bound to . If the HTTP root directory, in option is set to an empty string (which HTML files may be storedis the default), and query files that the server will be evaluated by the [[REST]] serviceopen 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.
|}
===PARALLELIGNORECERT=== {{Announce|Updated with Version 10}}: Additionally disable hostname verification. {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|PARALLEL IGNORECERT [numberboolean]}}|-valign="top"
| '''Default'''
|{{Code|8false}}|-valign="top"
| '''Summary'''
|Denotes the maximum allowed {{Code|number}} of parallel read [[Transaction Management|transactions]]Disable 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.<br/>Write Active update operations will not be affected by this timeout, as this would corrupt the integrity of the database.<br/>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='120' | '''Signature'''
|{{Code|PARALLEL [number]}}
|- valign="top"
| '''Default'''
|{{Code|8}}
|- valign="top"
| '''Summary'''
|Denotes the maximum allowed number of parallel [[Transaction Management|transactions]]:
* If {{Option|FAIRLOCK}} is enabled, the number of parallel transactions will never exceed the specified value.
* If the option is disabled (which is the default), the limit only applies to transactions that access databases.
* The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.
|}
===LOG===
{{Mark|Introduced with Version 7.4}} {|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.4}} {|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 Services==
 
Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that will be set before the web server is started:
 
===WEBPATH===
 
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|WEBPATH [path]}}
|- valign="top"
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/webapp]]</code>
|- valign="top"
| '''Summary'''
|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:
* The option is ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].
* It cannot be assigned via the {{Code|web.xml}} file, as it 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===
 
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|RESTXQPATH [path]}}
|- valign="top"
| '''Default'''
|''empty''
|- valign="top"
| '''Summary'''
|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths 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'''
|Timeout after which the RESTXQ directory will be parsed for changes:
* If {{Code|0}} is specified, the directory will be parsed every time a RESTXQ function is called.
* A positive value defines the idle time in seconds after which parsing will be enforced. The default value is {{Code|3}}: Changes in the RESTXQ directory will be detected after 3 seconds without RESTXQ function calls.
* Monitoring is completely disabled if a negative value is specified.
 
See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details.
|}
 
===RESTXQERRORS===
 
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|RESTXQERRORS}}
|- valign="top"
| '''Default'''
|{{Code|true}}
|- valign="top"
| '''Summary'''
|Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.
|}
 
===RESTPATH===
 
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|RESTPATH [path]}}
|- valign="top"
| '''Default'''
|''empty''
|- valign="top"
| '''Summary'''
|Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
|}
 
===HTTPLOCAL===
 
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|HTTPLOCAL [boolean]}}
|- valign="top"
| '''Default'''
|{{Code|false}}
|- valign="top"
| '''Summary'''
|By default, if BaseX is run as [[Web Application]], the database server instance 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%'
|- valign="top"
| width='120' | '''Signature'''
|{{Code|STOPPORT [port]}}
|- valign="top"
| '''Default'''
|{{Code|8081}}
|- 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 changed 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.4:}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|CREATEONLYADDCACHE [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. 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%'|-valign="top"| width='90120' | '''Signature'''|{{Code|PARSEROPT CSVPARSER [options]}}|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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.|- valign="top"| '''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%'|-valign="top"| width='90120' | '''Signature'''|{{Code|HTMLOPT JSONPARSER [options]}}|-valign="top"
| '''Default'''
|''empty''
|-valign="top"
| '''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]].|- valign="top"| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.|} ===HTMLPARSER=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|HTMLPARSER [options]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|Specifies the way how HTML 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.|- 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.|} ===TEXTPARSER=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|TEXTPARSER [options]}}|- valign="top"| '''Default'''|''empty''|- valign="top"| '''Summary'''|HTML ParserSpecifies 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.|- valign="top"| '''Examples'''|<code>lines=true</code> creates a single element for more informationeach line of text.
|}
==XML Parsing==
===CHOPSTRIPWS=== {{Announce|Updated with Version 10:}} Renamed (before: {{Code|CHOP}}), new default: {{Code|false}}. {| width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|CHOPSTRIPWS [boolean]}}|-valign="top"
| '''Default'''
|{{Code|truefalse}}|-valign="top"
| '''Summary'''
|Chops all Many XML documents include whitespaces that have been added to improve readability. This option controls the [https://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:* If the option is set to {{Code|true}}, leading and trailing whitespaces from text nodes while building a databasewill be stripped, and discards empty text nodeswill be discarded. This * The flag should be disabled if a document contains [[Full-Text#Mixed Content|mixed content]].* The flag can also be turned on via the [[Command-Line Options#BaseX Standalone|command line]] and <code>-w</code>.* If the option often reduces is enabled, whitespaces of an element and its descendants can locally be preserved with the <code>xml:space="preserve"</code> attribute: <syntaxhighlight lang="xml"><xml> <title> Demonstrating the STRIPWS flag </title> <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the database size by up question.</text></xml></syntaxhighlight>If whitespaces are stripped, <code>indent=yes</code> can be assigned to the {{Option|SERIALIZER}} option to 50%get properly indented XML output.
|}
===INTPARSESTRIPNS=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|INTPARSESTRIPNS [boolean]}}|-valign="top"
| '''Default'''
|{{Code|truefalse}}|-valign="top"
| '''Summary'''
|Uses the internal Strips all namespaces from an XML parser instead of the standard Java XML parser. The internal parser is faster, more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for document while parsing DTDs.
|}
===STRIPNSINTPARSE==={{Mark|Introduced with Version 7.4:}}{|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|STRIPNSINTPARSE [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 [[#CATFILE{{Option|CATFILE]] CATALOG}} option can be changed to locally resolve DTDs.
|}
===CATFILEXINCLUDE=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|XINCLUDE [boolean]}}|- valign="top"| '''Default'''|{{Code|true}}|- valign="top"| '''Summary'''|Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is switched to {{Code|true}}. This option is only available if the standard Java XML Parser is used (see {{Option|INTPARSE}}).|} ===CATALOG=== {{Announce|Updated with Version 10:}} Renamed from <code>CATFILE </code>. {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|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. ===PATHINDEXTEXTINDEX=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|PATHINDEXTEXTINDEX [boolean]}}|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates a path text index whenever a new database is created. A path text index helps to optimize location paths; see speeds up queries with equality comparisons on text nodes. See [[IndexesIndex#Text Index|Text Index]] for more details.
|}
===TEXTINDEXATTRINDEX=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|TEXTINDEXATTRINDEX [boolean]}}|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Creates a text an attribute index whenever a new database is created. A text An attribute index speeds up queries with equality comparisons on text nodes; see attribute values. See [[IndexesIndex#Attribute Index|Attribute Index]] for more details.
|}
===ATTRINDEXTOKENINDEX=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|ATTRINDEXTOKENINDEX [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 . 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'''|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===MAXLEN===
 {|width='100%'|-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, auto optimization will be applied to new databases:* With each update, outdated indexes and database statistics will be recreated.* As a result, the index structures will always be up-to-date.* However, updates can take much longer, so this option should only be activated for medium-sized databases.* The value of this option will be assigned once to a new database. It can be reassigned by running {{Command|OPTIMIZE}} or {{Function|Database|db:optimize}}.|} ===SPLITSIZE=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|SPLITSIZE [num]}}|- valign="top"| '''Default'''|{{Code|0}}|- valign="top"
| '''Summary'''
|If turned onThis option affects the [[Indexes#Performance|construction]] of new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk:* By default, incremental indexing will be activated: all update operations will also update if the value index structures 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 (texts and attribute values)e.g. The value of this via the JVM option will be assigned once {{Code|-XX:+DisableExplicitGC}}), you may need to choose a new database, custom split size.* You can e. g. start with {{Code|1000000}} (one million) index operations and cannot be changed after thatadjust this value in the next steps. * The advantage of incremental indexes is that larger the assigned value index structures will always be up-to-date. The downside is that updates , the less splits will take a little bit longerplace, and the more main 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= ===WRITEBACKQUERYINFO=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|WRITEBACKQUERYINFO [boolean]}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Updates Prints more information on XML nodes are written back to internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the input filesGUI. Note that no backups of your original files will It can also be created if this option is turned activated on[[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.
|}
===WILDCARDSMIXUPDATES===
{{Mark|Removed in Version 7.3:}} new index supports both fuzzy and wildcard queries. {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|WILDCARDSMIXUPDATES}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|If a new fullAllows queries to both contain updating and non-text index is createdupdating expressions. All updating constraints will be turned off, it and nodes to be returned will be particularly optimized for wildcards expressionscopied 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 the page on [[Full-TextXQuery Update#Returning Results|Returning Results]]s for more information on XQuery Full Textdetails.
|}
===SCORINGBINDINGS===
{{Mark|Removed in Version 7.3:}} new scoring model will focus on lengths of text nodes and match options. {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|SCORING BINDINGS [modevars]}}|-valign="top"
| '''Default'''
|{{Code|0}}''empty''|-valign="top"
| '''Summary'''
|A new fullContains external variables to be bound to a query. The string must comply with the following rules:* Variable names and values must be separated by equality signs.* Multiple variables must be delimited by commas.* Commas in values must be duplicated.* Variables may optionally be introduced with a leading dollar sign.* If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [https://www.w3.org/TR/xquery-text index will pre30/#id-calculate full-text scoresbasics Expanded QName Notation]. This option enables TFcan also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</IDFcode>.|- valign="top"| '''Examples'''|* <code>$a=1,$b=2</based scores in full-text queries code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and increases main memory consumption while indexing$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}}. See * In the following [[Full-TextCommands#ScoringCommand_Scripts|ScoringCommand Script]] for more information on different scoring types., 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>
|}
=Query Options==INLINELIMIT===
===QUERYINFO==={|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|QUERYINFOINLINELIMIT}}|-valign="top"
| '''Default'''
|{{Code|false50}}|-valign="top"
| '''Summary'''
|Prints more information on internal This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to speed up query rewritingsevaluation.* Inlining will only take place if a function body is not too large (i.e., optimizationsif it does not contain too many expressions).* With this option, and performancethis maximum number of expressions can be specified. The query info will always * Function inlining can be printed in turned off by setting the [[GUI#Visualizationsvalue to {{Code|Info View]] in the GUI, or it 0}}.* The limit can be activated with locally overwritten via the [[Startup_OptionsXQuery Extensions#BaseX_StandaloneFunction Inlining|-V flag%basex:inline]] annotation (follow the link to get more information on command linefunction inlining).
|}
===XQUERY3UNROLLLIMIT=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|XQUERY3UNROLLLIMIT}}|-valign="top"
| '''Default'''
|{{Code|true5}}|-valign="top"
| '''Summary'''
|Enables all [[This option controls the unroll limit:* Loops with few iterations are ''unrolled'' by the XQuery 3.0]] features supported by BaseXcompiler to enable further optimizations. * If this option the limit is set to {{Code|false}}increased, more optimizations will take place, but the XQuery parser memory consumption and compile time will only accept expressions of the increase.* See [[XQuery 1.0 specificationOptimizations#Loop Unrolling|Loop Unrolling]] for more details.
|}
===SERIALIZEENFORCEINDEX=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|SERIALIZEENFORCEINDEX [boolean]}}|-valign="top"
| '''Default'''
|{{Code|truefalse}}|-valign="top"
| '''Summary'''
|Results of XQuery Enforces index rewritings in path expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{CodeSee [[Indexes#Enforce Rewritings|false}}Enforce Rewritings]] for details.
|}
===BINDINGSCOPYNODE=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|BINDINGS COPYNODE [varsboolean]}}|-valign="top"
| '''Default'''
|''empty''{{Code|true}}|-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 When creating new nodes 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 XQuery via [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [httphttps://www.w3.org/TR/xquery-3031/#id-basics Expanded QName Notationconstructors Node Constructors], 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>:|-| '''Examples'''|<codesyntaxhighlight lang="xquery">let $a:=1,<a/>let $b:=2</codeb> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and }</b>return $b<br/><code>a=1,,2is $a</codesyntaxhighlight> &nbsp; binds This step can be very expensive and memory consuming. If the value {{Code|1option is disabled,2}} child nodes will only be linked to the variable $a<br/>new parent nodes, and the upper query returns <code>{URI}a=xtrue</code> or .<codebr>'URI':a=x</code> &nbsp; binds The option should be used carefully as it changes the value {{Codesemantics of XQuery. It should preferably be used in [[XQuery Extensions#Database Pragmas|x}} to the variable $a with the namespace {{Code|URI}}Pragmas]].
|}
===SERIALIZERTAILCALLS=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|SERIALIZER [params]TAILCALLS}}|-valign="top"
| '''Default'''
|''empty''{{Code|256}}|-valign="top"
| '''Summary'''
|Contains parameters for serializing queries; see Specifies how many stack frames of [[Serializationhttps://en.wikipedia.org/wiki/Tail_call tail-calls]] for more detailsare allowed on the stack at any time. Keys and values are separated by equality signsWhen this limit is reached, tail-call optimization takes place and multiple parameters some call frames are delimited eliminated. The feature can be turned off by commas.|-| '''Example'''|<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets setting the encoding value to {{Code|US-ASCII1}} and prints the XML declaration.
|}
===EXPORTERWITHDB=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|EXPORTER [params]WITHDB}}|-valign="top"
| '''Default'''
|''empty''{{Code|true}}|-valign="top"
| '''Summary'''
|Contains parameters for exporting all By default, resources of a specified via {{Code|fn:doc}} and {{Code|fn:collection}} are looked up both in the database; and in the file system. If you always use {{Function|Database|db:get}} to access databases, it is recommendable to disable this option:* No locks will be created for the two functions (see [[SerializationTransaction Management#Limitations|limitations of database locking]] for more details). Keys * Access to local and values are separated by equality signsexternal resources will be faster, multiple parameters are delimited by commasas the database lookup will be skipped.
|}
===QUERYPATHDEFAULTDB==={||-| width='90' | '''Signature'''|{{Code|QUERYPATH [path]}}|-| '''Default'''|''empty''|-| '''Summary'''|Contains the path (''base URI'') to the executed query (default: ''empty''). This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a query.|}
===CACHEQUERY==={|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|CACHEQUERYDEFAULTDB}}|-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()}} functions will create database instances for the addressed input files.
|}
===AUTOFLUSHCHECKSTRINGS=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|AUTOFLUSHCHECKSTRINGS [boolean]}}|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Flushes database buffers to disk after each updateBy default, characters from external sources that are invalid in XML will trigger an error. If this the option is set to {{Code|<code>false}}</code>, bulk operations these characters will be replaced with the Unicode replacement character <code>FFFD</code> (multiple single updates&#xFFFD;) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the The option affects [[Commands#FLUSH|FLUSHJava Bindings]] commandand string conversion and input functions such as {{Function|Archive|archive:create}}, {{Function|Archive|archive:extract-text}}, and {{Function|Archive|archive:update}}.
|}
===MAXSTATWRAPJAVA=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|MAXSTAT WRAPJAVA [nummode]}}|-valign="top"
| '''Default'''
|{{Code|30some}}|-valign="top"
| '''Summary'''
|Specifies Defines the maximum number of index occurrences printed by 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|instance}}, and {{Code|void}}. See [[CommandsJava_Bindings#INFOConversion to XQuery|INFO INDEXJava Bindings]]</code> commandfor further 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 BaseX-specific fuzzy match optionerror value is calculated dynamically. See the page on [[Full-Text#Fuzzy_Querying|Full-TextsFuzzy Querying]] for more information 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 can also be changed on fuzzy querying[[Command-Line Options#BaseX Standalone|command line]] via <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>.
|}
=Serialization Options=
===XMLPLANSERIALIZE=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|XMLPLANSERIALIZE [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='120' | '''Signature'''|{{Code|SERIALIZER [params]}}|- valign="top"
| '''Default'''
|{{Code|false}}''empty''|-valign="top"
| '''Summary'''
|Prints Parameters for [[Serialization|serializing]] query results:* Variable names and values are separated by equality signs.* Multiple variables are delimited by commas.* Commas must be duplicated if they appear as literals in values.The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the execution plan flag <code>-s</code>.|- valign="top"| '''Examples'''|* <code>indent=yes</code> : enables automatic indentation of an XQuery expression in its XML representationnodes. 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.
|}
===COMPPLANEXPORTER=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|COMPPLANEXPORTER [params]}}|-valign="top"
| '''Default'''
|{{Code|true}}''empty''|-valign="top"
| '''Summary'''
|Creates the query plan before or Contains parameters for exporting resources of a database and writing files after updates via the compilation step{{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[Serialization]] for more details. Query plans might change due to optimizations|- valign="top"| '''Examples'''|* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
|}
===DOTPLANXMLPLAN=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|DOTPLANXMLPLAN [boolean]}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Visualizes Prints the execution plan of an XQuery expression with in its XML representation. This option can also be activated on [http:[Command-Line Options#BaseX Standalone|command line]] via <code>-x<//www.graphviz.org dotty] and saves its dot file in the query directorycode>.
|}
===DOTCOMPACTFULLPLAN=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|DOTCOMPACTFULLPLAN [boolean]}}|-valign="top"
| '''Default'''
|{{Code|false}}
|-valign="top"
| '''Summary'''
|Chooses a compact dot representationAttaches the file path, line and column of the expressions in the original query string to the query plan. Values (items and sequences) have no input information attached.
|}
=Other Options= ===DOTDISPLAYAUTOFLUSH=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|DOTDISPLAYAUTOFLUSH [boolean]}}|-valign="top"
| '''Default'''
|{{Code|true}}
|-valign="top"
| '''Summary'''
|Visualizes 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 dot representation after chance of data loss increases if the database is not explicitly flushed via the query execution{{Command|FLUSH}} command.
|}
===DOTTYWRITEBACK=== {|width='100%'|-valign="top"| width='90120' | '''Signature'''|{{Code|DOTTY WRITEBACK [pathboolean]}}|-valign="top"
| '''Default'''
|{{Code|dottyfalse}}|-valign="top"
| '''Summary'''
|Location Propagates updates on main-memory instances of files that have been retrieved via {{Code|fn:doc}} and {{Code|fn:collection}} back to disk:* This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>.* Please take in mind that no backup will be created from your original files.* The serialization options can be controlled via the {{Option|EXPORTER}} option.|} ===MAXSTAT=== {| width='100%'|- valign="top"| width='120' | '''Signature'''|{{Code|MAXSTAT [num]}}|- valign="top"| '''Default'''|{{Code|dotty30}}|- valign="top"| '''Summary'''|Specifies the maximum number of index occurrences printed by the {{Command|INFO INDEX}} executablecommand.
|}
=Changelog=
;Version 710.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.4
;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: pragma expression for temporarily setting {{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 optionslock)* 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>[[#STRIPNSINDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code> ;Version 8.3* Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|STRIPNS]]ARCHIVENAME}} ;Version 8.2* Removed: <code>EVENTPORT</code>, <code>[[#LOGMSGMAXLENCACHEQUERY</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|LOGMSGMAXLEN]]HTMLPARSER}}), <code>PARSEROPT</code>(replaced with parser-specific options), <code>[[#LOG|LOG]]DOTDISPLAY</code>, <code>[[#CREATEONLY|CREATEONLY]]DOTTY</code> ;Version 7.7* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}} ;Version 7.6* Added: {{Option|GLOBALLOCK}}* Added: store local options in configuration file after {{Code|# Local Options}} comments. ;Version 7.5* Added: options can now be set via system properties* Added: a pragma expression can be used to locally change database options* Added: {{Option|USER}}, {{Option|PASSWORD}}, {{Option|LOG}}, {{Option|LOGMSGMAXLEN}}, {{Option|WEBPATH}}, {{Option|RESTXQPATH}}{{Option|HTTPLOCAL}}, {{Option|CREATEONLY}}, {{Option|STRIPNS}}* Removed: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: {{Code|jetty.xml}} configuration file is used instead* Removed: global options cannot be changed anymore during the lifetime of a BaseX instance
;Version 7.3
 * Updated: <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/7942...16210"

Navigation menu