Difference between revisions of "Options"
Line 8: | Line 8: | ||
Values of options are either ''strings'', ''numbers'' or ''booleans''. Options are ''static'' and not bound to a single operation (for example, the next command). Various ways exist to access and change options: | Values of options are either ''strings'', ''numbers'' or ''booleans''. Options are ''static'' and not bound to a single operation (for example, the next command). Various ways exist to access and change options: | ||
− | * The 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 | + | * 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 is 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: | * 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: | ||
Line 48: | Line 48: | ||
* In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]]. | * In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]]. | ||
− | If options are changed by operations in the [[GUI]], the underlying commands | + | If options are changed by operations in the [[GUI]], the underlying commands are output in the [[GUI#Visualizations|Info View]].<br/> |
=Global Options= | =Global Options= | ||
Line 153: | Line 153: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies how many seconds the results of | + | |Specifies how many seconds the results of [[Job Module|asynchronously executed jobs]] are cached in main memory. |
|} | |} | ||
Line 197: | Line 197: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |This is the port the database server | + | |This is the port the database server is listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-p</code>. |
|} | |} | ||
Line 212: | Line 212: | ||
| '''Summary''' | | '''Summary''' | ||
|Represents a username, which is used for accessing the server or an HTTP service: | |Represents a username, which is used for accessing the server or an HTTP service: | ||
− | * The default value | + | * The default value is overwritten if a client specifies its own credentials. |
* If the default value is empty, login will only be possible if the client specifies credentials. | * If the default value is empty, login will only be possible if the client specifies credentials. | ||
* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-U</code>. | * The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-U</code>. | ||
Line 229: | Line 229: | ||
| '''Summary''' | | '''Summary''' | ||
|Represents a password, which is used for accessing the server: | |Represents a password, which is used for accessing the server: | ||
− | * The default value | + | * The default value is overwritten if a client specifies its own credentials. |
* If the default value is empty, authentication will only be possible if the client supplies 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>. | * The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>. | ||
Line 246: | Line 246: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the default authentication method | + | |Specifies the default authentication method used by the [[Web Application|HTTP server]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}: |
* If basic access is chosen, the client can still request digest authentication. | * If basic access is chosen, the client can still request digest authentication. | ||
* This is different for digest access, which cannot be overwritten. | * This is different for digest access, which cannot be overwritten. | ||
Line 263: | Line 263: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |This is the host name or IP address the server is bound to. If the option is set to an empty string (which is the default), the server | + | |This is the host name or IP address the server is bound to. If the option is set to an empty string (which is the default), the server accepts requests from all clients. |
|} | |} | ||
Line 277: | Line 277: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |This is the host name of a proxy server. If the value is an empty string, it | + | |This is the host name of a proxy server. If the value is an empty string, it is ignored. |
|} | |} | ||
Line 291: | Line 291: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |This is the port number of a proxy server. If the value is set to {{Code|0}}, it | + | |This is the port number of a proxy server. If the value is set to {{Code|0}}, it is ignored. |
|} | |} | ||
Line 305: | Line 305: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |This is a list of hosts that should be directly accessed. If the value is an empty string, it | + | |This is a list of hosts that should be directly accessed. If the value is an empty string, it is ignored. |
|} | |} | ||
Line 335: | Line 335: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the maximum time a transaction triggered by a client may take. | + | |Specifies the maximum time a transaction triggered by a client may take. An operation is interrupted when it takes longer than the specified number of seconds. Running update operations are not affected by this timeout, as this would corrupt the integrity of the database. The timeout is disabled if the timeout is set to {{Code|0}}. It is ignored for operations with [[User Management|admin permissions]]. |
|} | |} | ||
Line 349: | Line 349: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the maximum time a client | + | |Specifies the maximum time a client is remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The check is disabled if the value is set to {{Code|0}}. |
|} | |} | ||
Line 408: | Line 408: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''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 BaseX is running as a [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and similar functions) is written to the [[Logging|database logs]]. When this option is disabled, trace output is redirected to standard error, as it is known from the standalone version of BaseX. |
|} | |} | ||
Line 444: | Line 444: | ||
|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]]: | |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>. | * 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 cannot be assigned via the {{Code|web.xml}} file, as the option is evaluated before the configuration files are parsed. |
* In addition to the [https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 Jetty defaults] (GET requests, exclusion of binaries, MSIE 6.0, etc.), POST and PUT requests are supported. | * 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. | ||
|} | |} | ||
Line 459: | Line 459: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths | + | |Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths are resolved against the {{Option|WEBPATH}} directory. |
|} | |} | ||
Line 473: | Line 473: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Timeout after which the RESTXQ directory | + | |Timeout after which the RESTXQ directory is parsed for changes: |
− | * If {{Code|0}} is specified, the directory | + | * If {{Code|0}} is specified, the directory is parsed every time a RESTXQ function is called. |
− | * A positive value defines the idle time in seconds after which parsing | + | * A positive value defines the idle time, in seconds, after which parsing is enforced. The default value is {{Code|3}}: Changes in the RESTXQ directory is detected after 3 seconds without RESTXQ function calls. |
* Monitoring is completely disabled if a negative value is specified. | * Monitoring is completely disabled if a negative value is specified. | ||
Line 506: | Line 506: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''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 | + | |Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths are resolved against the {{Option|WEBPATH}} directory. |
|} | |} | ||
Line 520: | Line 520: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |By default, if BaseX is run as [[Web Application]], the database server instance | + | |By default, if BaseX is run as [[Web Application]], the database server instance is started in addition, which can then be addressed by [[Clients]] via the database port (see {{Option|PORT}}). If the option is set to {{Code|true}}, no database server is launched. |
|} | |} | ||
Line 555: | Line 555: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is turned on, new databases | + | |If this option is turned on, new databases arecreated in main memory: |
− | * Most queries | + | * Most queries are evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down. |
* It is not possible to store binary resources in a main-memory database. | * It is not possible to store binary resources in a main-memory database. | ||
* A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new database from the exported file in a second step. | * A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new database from the exported file in a second step. | ||
− | * This option will not be available for {{Function|Database|db:create}} | + | * This option will not be available for {{Function|Database|db:create}} because the database would not be accessible anymore after database creation, i.e., outside the query scope. |
|} | |} | ||
Line 617: | Line 617: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is set to {{Code|true}}, the file name of parsed archives | + | |If this option is set to {{Code|true}}, the file name of parsed archives is included in the document paths. |
|} | |} | ||
Line 631: | Line 631: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''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 | + | |Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files are parsed twice. Next, main memory consumption is higher, as parsed files will be cached in main memory. |
|} | |} | ||
Line 645: | Line 645: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is enabled, all resources that are filtered out by the {{Option|CREATEFILTER}} option while being added to a database | + | |If this option is enabled, all resources that are filtered out by the {{Option|CREATEFILTER}} option while being added to a database are stored as [[Binary Data|raw files]] instead (i.e., in their binary representation). |
|} | |} | ||
Line 659: | Line 659: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''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 | + | |Defines a [[Parsers|parser]] for importing new files to the database. Available parsers are {{Code|XML}}, {{Code|JSON}}, {{Code|CSV}}, {{Code|TEXT}}, {{Code|HTML}}, and {{Code|RAW}}. HTML input is parsed as XML if [[Parsers#HTMLParser|Tagsoup]] is not found in the class path. |
|} | |} | ||
Line 673: | Line 673: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the way how CSV data | + | |Specifies the way how CSV data is parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]]. |
|- valign="top" | |- valign="top" | ||
| '''Examples''' | | '''Examples''' | ||
Line 690: | Line 690: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the way how JSON data | + | |Specifies the way how JSON data is parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]]. |
|- valign="top" | |- valign="top" | ||
| '''Examples''' | | '''Examples''' | ||
Line 707: | Line 707: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the way how HTML data | + | |Specifies the way how HTML data is parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are described in the [[Parsers#Options|Parsers]] article. |
|- valign="top" | |- valign="top" | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * <code>encoding=Shift-JIS,nons=true</code> parses the input as | + | * <code>encoding=Shift-JIS,nons=true</code> parses the input as Shift-JIS and suppresses namespaces. |
* <code>lexical=true</code> preserves comments. | * <code>lexical=true</code> preserves comments. | ||
|} | |} | ||
Line 731: | Line 731: | ||
| '''Summary''' | | '''Summary''' | ||
|Many XML documents include whitespaces that have been added to improve readability. This option controls the [https://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser: | |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 | + | * If the option is set to {{Code|true}}, leading and trailing whitespaces from text nodes are stripped and empty text nodes are discarded. |
* The flag should be disabled if a document contains [[Full-Text#Mixed Content|mixed content]]. | * The flag 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>. | * The flag can also be turned on via the [[Command-Line Options#BaseX Standalone|command line]] and <code>-w</code>. | ||
Line 826: | Line 826: | ||
==Indexing== | ==Indexing== | ||
− | The following options control the creation of index structures. The current values | + | The following options control the creation of index structures. The current values are considered if a new database is created. See [[Indexes]] for more details. |
===TEXTINDEX=== | ===TEXTINDEX=== | ||
Line 895: | Line 895: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes | + | |Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes are indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details. |
|} | |} | ||
Line 909: | Line 909: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Defines name patterns for the attributes to be indexed. By default, all attribute nodes | + | |Defines name patterns for the attributes to be indexed. By default, all attribute nodes are indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details. |
|} | |} | ||
Line 923: | Line 923: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes | + | |Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes are indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details. |
|} | |} | ||
Line 937: | Line 937: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes | + | |Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes are indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details. |
|} | |} | ||
Line 951: | Line 951: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the maximum length for strings to be stored in [[Indexes|index structures]]. The value of this option | + | |Specifies the maximum length for strings to be stored in [[Indexes|index structures]]. The value of this option is assigned once to a new database, and can only be changed by creating a new database or doing a [[Commands#OPTIMIZE|full optimization]]. |
|} | |} | ||
Line 965: | Line 965: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the maximum number of distinct values (categories) that | + | |Specifies the maximum number of distinct values (categories) that are stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option is assigned once to a new database, and cannot be changed after that. |
|} | |} | ||
Line 979: | Line 979: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If turned on, incremental indexing | + | |If turned on, incremental indexing is enabled: |
− | * The current value of this option | + | * The current value of this option is assigned to new databases. It can be changed for existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or {{Function|Database|db:optimize}} and {{Code|true()}} as second argument. |
− | * After each update, the value indexes | + | * After each update, the value indexes are refreshed as well. Incremental updates are currently not available for the full-text index and database statistics. |
* Find more details in the article on [[Index#Updates|Index Structures]]. | * Find more details in the article on [[Index#Updates|Index Structures]]. | ||
|} | |} | ||
Line 996: | Line 996: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If turned on, auto optimization | + | |If turned on, auto optimization is applied to new databases: |
− | * With each update, outdated indexes and database statistics | + | * With each update, outdated indexes and database statistics are recreated. |
* As a result, the index structures will always be up-to-date. | * 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. | * However, updates can take much longer, so this option should only be activated for medium-sized databases. | ||
− | * The value of this option | + | * The value of this option is assigned once to a new database. It can be reassigned by running {{Command|OPTIMIZE}} or {{Function|Database|db:optimize}}. |
|} | |} | ||
Line 1,017: | Line 1,017: | ||
* By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption. Usually, this works fine. | * 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. | * 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. | + | * 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 | + | * The larger the assigned value is, the fewer splits take place, and main-memory consumption increases. |
|} | |} | ||
Line 1,034: | Line 1,034: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If {{Code|true}}, all tokens | + | |If {{Code|true}}, all tokens are stemmed during full-text indexing, using a language-specific stemmer implementation. By default, tokens will not be stemmed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
Line 1,048: | Line 1,048: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If {{Code|true}}, the case of tokens | + | |If {{Code|true}}, the case of tokens is preserved during full-text indexing. By default, case is ignored (all tokens are indexed in lower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
Line 1,062: | Line 1,062: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If set to {{Code|true}}, diacritics | + | |If set to {{Code|true}}, diacritics are preserved during full-text indexing. By default, diacritics are removed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
Line 1,076: | Line 1,076: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |The specified language will influence the way how texts | + | |The specified language will influence the way how texts are tokenized and stemmed. It can be the name of a language or a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
Line 1,090: | Line 1,090: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If a text file with stop words is specified, frequently used terms contained in that file | + | |If a text file with stop words is specified, frequently used terms contained in that file are ignored when a full-text index is created. A stop word list may decrease the size of the full-text index and speed up your queries. See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
Line 1,120: | Line 1,120: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Allows queries to both contain updating and non-updating expressions. All updating constraints | + | |Allows queries to both contain updating and non-updating expressions. All updating constraints are turned off, and nodes to be returned are copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for more details. |
|} | |} | ||
Line 1,215: | Line 1,215: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |When creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], copies of all enclosed nodes | + | |When creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], copies of all enclosed nodes are created, and the copied nodes get new node identities. As a result, the following query yields <code>false</code>: |
<syntaxhighlight lang="xquery"> | <syntaxhighlight lang="xquery"> | ||
let $a := <a/> | let $a := <a/> | ||
Line 1,250: | Line 1,250: | ||
| '''Summary''' | | '''Summary''' | ||
|By default, resources specified via {{Code|fn:doc}} and {{Code|fn:collection}} are looked up both in the database and in the file system. If you always use {{Function|Database|db:get}} to access databases, it is recommendable to disable this option: | |By default, resources specified via {{Code|fn:doc}} and {{Code|fn:collection}} are looked up both in the database and in the file system. If you always use {{Function|Database|db:get}} to access databases, it is recommendable to disable this option: | ||
− | * No locks | + | * No locks are created for the two functions (see [[Transaction Management#Limitations|limitations of database locking]] for more details). |
− | * Access to local and external resources | + | * Access to local and external resources is faster, as the database lookup is skipped. |
|} | |} | ||
Line 1,265: | Line 1,265: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is turned on, paths specified in the {{Code|fn:doc}} and {{Code|fn:collection}} functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the {{Command|OPEN}} command). If the path does not match any existing resources, it | + | |If this option is turned on, paths specified in the {{Code|fn:doc}} and {{Code|fn:collection}} functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the {{Command|OPEN}} command). If the path does not match any existing resources, it is resolved as described in the article on [[Databases#Access Resources|accessing database resources]]. |
|} | |} | ||
Line 1,279: | Line 1,279: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |By | + | |By enabling this option, database instances are created if the XQuery functions {{Code|fn:doc}} and {{Code|fn:collection}} are called. |
|} | |} | ||
Line 1,293: | Line 1,293: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''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 | + | |By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>, these characters are replaced with the Unicode replacement character <code>FFFD</code> (�). 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}}. |
|} | |} | ||
Line 1,307: | Line 1,307: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Defines the way how values that result from Java code invocation | + | |Defines the way how values that result from Java code invocation are converted to XQuery items. Allowed values: {{Code|none}}, {{Code|all}}, {{Code|some}}, {{Code|instance}}, and {{Code|void}}. See [[Java_Bindings#Conversion to XQuery|Java Bindings]] for further details. |
|} | |} | ||
Line 1,335: | Line 1,335: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies if a query | + | |Specifies if a query is executed or parsed only. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>. |
|} | |} | ||
Line 1,349: | Line 1,349: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies how often a query | + | |Specifies how often a query is evaluated. The result is serialized only once, and the measured times are averages of all runs. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-r</code>. |
|} | |} | ||
Line 1,365: | Line 1,365: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Results of XQuery expressions | + | |Results of XQuery expressions are serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>. |
|} | |} | ||
Line 1,451: | Line 1,451: | ||
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
− | |Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) | + | |Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) are evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the {{Command|FLUSH}} command. |
|} | |} | ||
Line 1,467: | Line 1,467: | ||
|Propagates updates on main-memory instances of files that have been retrieved via {{Code|fn:doc}} and {{Code|fn:collection}} back to disk: | |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>. | * 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 | + | * Please take in mind that no backup is created from your original files. |
* The serialization options can be controlled via the {{Option|EXPORTER}} option. | * The serialization options can be controlled via the {{Option|EXPORTER}} option. | ||
|} | |} |
Revision as of 10:17, 28 July 2023
This page is linked from the Getting Started Section.
The options listed on this page influence the way how database commands are executed and XQuery expressions are evaluated. Two kinds of options exist:
- Global Options are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/server architecture.
- Local options (all remaining ones) are specific to a client or session.
Values of options are either strings, numbers or booleans. Options are static and not bound to a single operation (for example, the next command). Various ways exist to access and change options:
- The current value of an option can be requested with the
SHOW OPTIONS
command. Local options can be changed viaSET
(all global options, except forDEBUG
, can only be changed at startup time). If an option is of type boolean, and if no value is specified, its current value is inverted.
- The
.basex
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 theLocal Options
comment:
<syntaxhighlight lang="perl">
- General Options
DEBUG = false ...
- Local Options
CATALOG = etc/w3-catalog.xml </syntaxhighlight>
- Initial values for global options can also be specified via system properties, which can be passed on with the -D flag on the command line, or with System.setProperty() before creating a BaseX instance. The specified keys need to be prefixed with
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:
<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
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, local options can be set via option declarations and pragmas.
If options are changed by operations in the GUI, the underlying commands are output in the Info View.
Contents
Global Options
Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception is the DEBUG option, which can also be changed at runtime by users with admin permissions.
General Options
DEBUG
Signature | DEBUG [boolean]
|
Default | false
|
Summary | Sends debug information to STDERR. This option can be enabled to get additional information for development and debugging purposes. It can also be triggered on the command line via -d . Note that the amount of output can be overwhelming, so it should not be used productively.
|
DBPATH
Signature | DBPATH [path]
|
Default |
|
Summary | Points to the directory in which all databases are located. |
LOGPATH
Signature | LOGPATH [path]
|
Default | .logs
|
Summary | Points to the directory where log files are stored. Relative paths are resolved against the DBPATH directory.
|
REPOPATH
Signature | REPOPATH [path]
|
Default | {home}/repo
|
Summary | Points to the Repository, in which all XQuery modules are located. |
LANG
Signature | LANG [language]
|
Default | English
|
Summary | Specifies the interface language. |
FAIRLOCK
Signature | FAIRLOCK [boolean]
|
Default | false
|
Summary | Defines the locking strategy:
|
CACHETIMEOUT
Signature | CACHETIMEOUT [seconds]
|
Default | 3600
|
Summary | Specifies how many seconds the results of asynchronously executed jobs are cached in main memory. |
Client/Server Architecture
HOST
Signature | HOST [host]
|
Default | localhost
|
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 via -n .
|
PORT
Signature | PORT [port]
|
Default | 1984
|
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 via -p .
|
SERVERPORT
Signature | SERVERPORT [port]
|
Default | 1984
|
Summary | This is the port the database server is listening to. This option can also be changed when running the server on command line via -p .
|
USER
Signature | USER [name]
|
Default | empty |
Summary | Represents a username, which is used for accessing the server or an HTTP service:
|
PASSWORD
Signature | PASSWORD [password]
|
Default | empty |
Summary | Represents a password, which is used for accessing the server:
|
AUTHMETHOD
Signature | AUTHMETHOD [method]
|
Default | Basic |
Summary | Specifies the default authentication method used by the HTTP server for negotiating credentials. Allowed values are Basic , Digest , and Custom :
|
SERVERHOST
Signature | SERVERHOST [host|ip]
|
Default | empty |
Summary | This is the host name or IP address the server is bound to. If the option is set to an empty string (which is the default), the server accepts requests from all clients. |
PROXYHOST
Signature | PROXYHOST [host]
|
Default | empty |
Summary | This is the host name of a proxy server. If the value is an empty string, it is ignored. |
PROXYPORT
Signature | PROXYPORT [port]
|
Default | 0
|
Summary | This is the port number of a proxy server. If the value is set to 0 , it is ignored.
|
NONPROXYHOSTS
Signature | NONPROXYHOSTS [hosts]
|
Default | empty |
Summary | This is a list of hosts that should be directly accessed. If the value is an empty string, it is ignored. |
IGNORECERT
Updated with Version 10: Additionally disable hostname verification.
Signature | IGNORECERT [boolean]
|
Default | false
|
Summary | Disable SSL hostname verification and ignore untrusted certificates when connecting to servers. |
TIMEOUT
Signature | TIMEOUT [seconds]
|
Default | 30
|
Summary | Specifies the maximum time a transaction triggered by a client may take. An operation is interrupted when it takes longer than the specified number of seconds. Running update operations are not affected by this timeout, as this would corrupt the integrity of the database. The timeout is disabled if the timeout is set to 0 . It is ignored for operations with admin permissions.
|
KEEPALIVE
Signature | KEEPALIVE [seconds]
|
Default | 600
|
Summary | Specifies the maximum time a client is remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The check is disabled if the value is set to 0 .
|
PARALLEL
Signature | PARALLEL [number]
|
Default | 8
|
Summary | Denotes the maximum allowed number of parallel transactions:
|
LOG
Signature | LOG [boolean]
|
Default | true
|
Summary | Turns Logging of server operations and HTTP requests on/off. This option can also be changed when running the server on command line via -z .
|
LOGMSGMAXLEN
Signature | LOGMSGMAXLEN [length]
|
Default | 1000
|
Summary | Specifies the maximum length of a single log message. |
LOGTRACE
Signature | LOGTRACE [boolean]
|
Default | true
|
Summary | If BaseX is running as a Web Application, trace output (generated via fn:trace , prof:dump and similar functions) is written to the database logs. When this option is disabled, trace output is redirected to standard error, as it is known from the standalone version of BaseX.
|
HTTP Services
Most HTTP options are defined in the jetty.xml
and web.xml
configuration files in the webapp/WEB-INF
directory. Some additional BaseX-specific options exist that will be set before the web server is started:
WEBPATH
Signature | WEBPATH [path]
|
Default | {home}/webapp
|
Summary | Points to the directory in which all the Web Application contents are stored, including XQuery, Script, RESTXQ and configuration files:
|
GZIP
Signature | GZIP [boolean]
|
Default | false
|
Summary | Jetty provides a Gzip handler for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the BaseX HTTP Server:
|
RESTXQPATH
Signature | RESTXQPATH [path]
|
Default | empty |
Summary | Points to the directory which contains the RESTXQ modules of a web application. Relative paths are resolved against the WEBPATH directory.
|
PARSERESTXQ
Signature | PARSERESTXQ
|
Default | 3
|
Summary | Timeout after which the RESTXQ directory is parsed for changes:
See RESTXQ Preliminaries for more details. |
RESTXQERRORS
Signature | RESTXQERRORS
|
Default | true
|
Summary | Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See RESTXQ Error Handling for more details. |
RESTPATH
Signature | RESTPATH [path]
|
Default | empty |
Summary | Points to the directory which contains XQuery files and command scripts, which can be evaluated via the REST run operation. Relative paths are resolved against the WEBPATH directory.
|
HTTPLOCAL
Signature | HTTPLOCAL [boolean]
|
Default | false
|
Summary | By default, if BaseX is run as Web Application, the database server instance is started in addition, which can then be addressed by Clients via the database port (see PORT ). If the option is set to true , no database server is launched.
|
STOPPORT
Signature | STOPPORT [port]
|
Default | 8081
|
Summary | This is the port on which the HTTP Server can be locally closed:
|
Create Options
General
MAINMEM
Signature | MAINMEM [boolean]
|
Default | false
|
Summary | If this option is turned on, new databases arecreated in main memory:
|
ADDCACHE
Signature | ADDCACHE [boolean]
|
Default | false
|
Summary | If this option is activated, data structures of documents will first be cached to disk before being added to the final database. This option is helpful when larger documents need to be added, and if the existing heuristics cannot estimate the input size (e.g. when adding directories or sending input streams). |
Parsing
CREATEFILTER
Signature | CREATEFILTER [filter]
|
Default | *.xml
|
Summary | File filter in the Glob Syntax, which is applied whenever new databases are created, or resources are added to a database. |
ADDARCHIVES
Signature | ADDARCHIVES [boolean]
|
Default | true
|
Summary | If this option is set to 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
Signature | ARCHIVENAME [boolean]
|
Default | false
|
Summary | If this option is set to true , the file name of parsed archives is included in the document paths.
|
SKIPCORRUPT
Signature | SKIPCORRUPT [boolean]
|
Default | false
|
Summary | Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files are parsed twice. Next, main memory consumption is higher, as parsed files will be cached in main memory. |
ADDRAW
Signature | ADDRAW [boolean]
|
Default | false
|
Summary | If this option is enabled, all resources that are filtered out by the CREATEFILTER option while being added to a database are stored as raw files instead (i.e., in their binary representation).
|
PARSER
Signature | PARSER [type]
|
Default | XML
|
Summary | Defines a parser for importing new files to the database. Available parsers are XML , JSON , CSV , TEXT , HTML , and RAW . HTML input is parsed as XML if Tagsoup is not found in the class path.
|
CSVPARSER
Signature | CSVPARSER [options]
|
Default | empty |
Summary | Specifies the way how CSV data is parsed. Keys and values are delimited with = , and multiple options are delimited with , . The available options (except for the additional encoding option) are described in the CSV Module.
|
Examples | encoding=CP1252,header=true parses the input as CP1252 and the first line as header.
|
JSONPARSER
Signature | JSONPARSER [options]
|
Default | empty |
Summary | Specifies the way how JSON data is parsed. Keys and values are delimited with = , and multiple options are delimited with , . The available options (except for the additional encoding option) are described in the JSON Module.
|
Examples | format=jsonml,lax=yes interprets the input as JSONML and uses lax parsing.
|
HTMLPARSER
Signature | HTMLPARSER [options]
|
Default | empty |
Summary | Specifies the way how HTML data is parsed. Keys and values are delimited with = , and multiple options are delimited with , . The available options are described in the Parsers article.
|
Examples |
|
XML Parsing
STRIPWS
Updated with Version 10: Renamed (before: CHOP
), new default: false
.
Signature | STRIPWS [boolean]
|
Default | false
|
Summary | Many XML documents include whitespaces that have been added to improve readability. This option controls the white-space processing mode of the XML parser:
<syntaxhighlight lang="xml"> <xml> <title> Demonstrating the STRIPWS flag </title> <text xml:space="preserve">To be, or not to be, that is the question.</text> </xml>
</syntaxhighlight>
If whitespaces are stripped, |
STRIPNS
Signature | STRIPNS [boolean]
|
Default | false
|
Summary | Strips all namespaces from an XML document while parsing. |
INTPARSE
Signature | INTPARSE [boolean]
|
Default | false
|
Summary | Uses the internal XML parser instead of the standard Java XML parser. Reasons for using the internal parser are:
By default, Java’s Xerces parser is used as it supports all features of the XML standard, including |
DTD
Signature | DTD [boolean]
|
Default | false
|
Summary | Parses referenced DTDs and resolves XML entities. By default, this option is switched to false , as many DTDs are located externally, which may completely block the process of creating new databases. The CATALOG option can be changed to locally resolve DTDs.
|
XINCLUDE
Signature | XINCLUDE [boolean]
|
Default | true
|
Summary | Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is switched to true . This option is only available if the standard Java XML Parser is used (see INTPARSE ).
|
CATALOG
Updated with Version 10: Renamed from CATFILE
.
Signature | CATALOG [path]
|
Default | empty |
Summary | Semicolon-separated list of XML catalog files to resolve URIs. See Catalog Resolvers for more details. |
Indexing
The following options control the creation of index structures. The current values are considered if a new database is created. See Indexes for more details.
TEXTINDEX
Signature | TEXTINDEX [boolean]
|
Default | true
|
Summary | Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes. See Text Index for more details. |
ATTRINDEX
Signature | ATTRINDEX [boolean]
|
Default | true
|
Summary | Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See Attribute Index for more details. |
TOKENINDEX
Signature | TOKENINDEX [boolean]
|
Default | true
|
Summary | Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See Token Index for more details. |
FTINDEX
Signature | FTINDEX [boolean]
|
Default | false
|
Summary | Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions. See Full-Text Index for more details. |
TEXTINCLUDE
Signature | TEXTINCLUDE [names]
|
Default | empty |
Summary | Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes are indexed. Name patterns are separated by commas. See Selective Indexing for more details. |
ATTRINCLUDE
Signature | ATTRINCLUDE [names]
|
Default | empty |
Summary | Defines name patterns for the attributes to be indexed. By default, all attribute nodes are indexed. Name patterns are separated by commas. See Selective Indexing for more details. |
TOKENINCLUDE
Signature | TOKENINCLUDE [names]
|
Default | empty |
Summary | Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes are indexed. Name patterns are separated by commas. See Selective Indexing for more details. |
FTINCLUDE
Signature | FTINCLUDE [names]
|
Default | empty |
Summary | Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes are indexed. Name patterns are separated by commas. See Selective Indexing for more details. |
MAXLEN
Signature | MAXLEN [int]
|
Default | 96
|
Summary | Specifies the maximum length for strings to be stored in index structures. The value of this option is assigned once to a new database, and can only be changed by creating a new database or doing a full optimization. |
MAXCATS
Signature | MAXCATS [int]
|
Default | 100
|
Summary | Specifies the maximum number of distinct values (categories) that are stored together with the element/attribute names or unique paths in the Name Index or Path Index. The value of this option is assigned once to a new database, and cannot be changed after that. |
UPDINDEX
Signature | UPDINDEX [boolean]
|
Default | false
|
Summary | If turned on, incremental indexing is enabled:
|
AUTOOPTIMIZE
Signature | AUTOOPTIMIZE [boolean]
|
Default | false
|
Summary | If turned on, auto optimization is applied to new databases:
|
SPLITSIZE
Signature | SPLITSIZE [num]
|
Default | 0
|
Summary | This option affects the construction of new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk:
|
Full-Text Indexing
STEMMING
Signature | STEMMING [boolean]
|
Default | false
|
Summary | If true , all tokens are stemmed during full-text indexing, using a language-specific stemmer implementation. By default, tokens will not be stemmed. See Full-Text Index for more details.
|
CASESENS
Signature | CASESENS [boolean]
|
Default | false
|
Summary | If true , the case of tokens is preserved during full-text indexing. By default, case is ignored (all tokens are indexed in lower case). See Full-Text Index for more details.
|
DIACRITICS
Signature | DIACRITICS [boolean]
|
Default | false
|
Summary | If set to true , diacritics are preserved during full-text indexing. By default, diacritics are removed. See Full-Text Index for more details.
|
LANGUAGE
Signature | LANGUAGE [lang]
|
Default | en
|
Summary | The specified language will influence the way how texts are tokenized and stemmed. It can be the name of a language or a language code. See Full-Text Index for more details. |
STOPWORDS
Signature | STOPWORDS [path]
|
Default | empty |
Summary | If a text file with stop words is specified, frequently used terms contained in that file are ignored when a full-text index is created. A stop word list may decrease the size of the full-text index and speed up your queries. See Full-Text Index for more details. |
Query Options
QUERYINFO
Signature | QUERYINFO [boolean]
|
Default | false
|
Summary | Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the Info View in the GUI. It can also be activated on command line via -V .
|
MIXUPDATES
Signature | MIXUPDATES
|
Default | false
|
Summary | Allows queries to both contain updating and non-updating expressions. All updating constraints are turned off, and nodes to be returned are copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to false . See Returning Results for more details.
|
BINDINGS
Signature | BINDINGS [vars]
|
Default | empty |
Summary | Contains external variables to be bound to a query. The string must comply with the following rules:
This option can also be used on command line with the flag |
Examples |
<syntaxhighlight lang="xquery"> SET BINDINGS GREETING="hello world!" XQUERY declare variable $GREETING external; $GREETING </syntaxhighlight> |
INLINELIMIT
Signature | INLINELIMIT
|
Default | 50
|
Summary | This option controls inlining of XQuery functions:
|
UNROLLLIMIT
Signature | UNROLLLIMIT
|
Default | 5
|
Summary | This option controls the unroll limit:
|
ENFORCEINDEX
Signature | ENFORCEINDEX [boolean]
|
Default | false
|
Summary | Enforces index rewritings in path expressions. See Enforce Rewritings for details. |
COPYNODE
Signature | COPYNODE [boolean]
|
Default | true
|
Summary | When creating new nodes in XQuery via Node Constructors, copies of all enclosed nodes are created, and the copied nodes get new node identities. As a result, the following query yields false :
<syntaxhighlight lang="xquery">
let $a := <a/>
let $b := { $a }
return $b/a is $a
</syntaxhighlight>
This step can be expensive and memory consuming. If the option is disabled, child nodes will only be linked to the new parent nodes, and the upper query returns |
TAILCALLS
Signature | TAILCALLS
|
Default | 256
|
Summary | Specifies how many stack frames of tail-calls are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to -1 .
|
WITHDB
Signature | WITHDB
|
Default | true
|
Summary | By default, resources specified via fn:doc and fn:collection are looked up both in the database and in the file system. If you always use db:get to access databases, it is recommendable to disable this option:
|
DEFAULTDB
Signature | DEFAULTDB
|
Default | false
|
Summary | If this option is turned on, paths specified in the fn:doc and fn:collection functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the OPEN command). If the path does not match any existing resources, it is resolved as described in the article on accessing database resources.
|
FORCECREATE
Signature | FORCECREATE [boolean]
|
Default | false
|
Summary | By enabling this option, database instances are created if the XQuery functions fn:doc and fn:collection are called.
|
CHECKSTRINGS
Signature | CHECKSTRINGS [boolean]
|
Default | true
|
Summary | By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to false , these characters are replaced with the Unicode replacement character FFFD (�). The option affects Java Bindings and string conversion and input functions such as archive:create , archive:extract-text , and archive:update .
|
WRAPJAVA
Signature | WRAPJAVA [mode]
|
Default | some
|
Summary | Defines the way how values that result from Java code invocation are converted to XQuery items. Allowed values: none , all , some , instance , and void . See Java Bindings for further details.
|
LSERROR
Signature | LSERROR [error]
|
Default | 0
|
Summary | This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if 0 is assigned, the error value is calculated dynamically. See Fuzzy Querying for more details.
|
RUNQUERY
Signature | RUNQUERY [boolean]
|
Default | true
|
Summary | Specifies if a query is executed or parsed only. This option can also be changed on command line via -R .
|
RUNS
Signature | RUNS [num]
|
Default | 1
|
Summary | Specifies how often a query is evaluated. The result is serialized only once, and the measured times are averages of all runs. This option can also be changed on command line via -r .
|
Serialization Options
SERIALIZE
Signature | SERIALIZE [boolean]
|
Default | true
|
Summary | Results of XQuery expressions are serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to false . It can also be turned off on command line via -z .
|
SERIALIZER
Signature | SERIALIZER [params]
|
Default | empty |
Summary | Parameters for serializing query results:
The option can also be used on command line with the flag |
Examples |
|
EXPORTER
Signature | EXPORTER [params]
|
Default | empty |
Summary | Contains parameters for exporting resources of a database and writing files after updates via the WRITEBACK option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See Serialization for more details.
|
Examples |
|
XMLPLAN
Signature | XMLPLAN [boolean]
|
Default | false
|
Summary | Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on command line via -x .
|
FULLPLAN
Signature | FULLPLAN [boolean]
|
Default | false
|
Summary | Attaches the file path, line and column of the expressions in the original query string to the query plan. Values (items and sequences) have no input information attached. |
Other Options
AUTOFLUSH
Signature | AUTOFLUSH [boolean]
|
Default | true
|
Summary | Flushes database buffers to disk after each update. If this option is set to false , bulk operations (multiple single updates) are evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the FLUSH command.
|
WRITEBACK
Signature | WRITEBACK [boolean]
|
Default | false
|
Summary | Propagates updates on main-memory instances of files that have been retrieved via fn:doc and fn:collection back to disk:
|
MAXSTAT
Signature | MAXSTAT [num]
|
Default | 30
|
Summary | Specifies the maximum number of index occurrences printed by the INFO INDEX command.
|
Changelog
- Version 11.0
- Removed:
TEXTPARSER
- Version 10.0
- Removed:
COMPPLAN
,IGNOREHOSTNAME
- Updated:
IGNORECERT
: Additionally disable hostname verification. - Updated:
CATALOG
: Renamed (before:CATFILE
). - Updated:
STRIPWS
: Renamed (before:CHOP
), new default: false.
- Version 9.7
- Updated:
GZIP
: Support for POST and PUT requests.
- Version 9.6
- Added:
UNROLLLIMIT
,WRAPJAVA
- Version 9.5
- Updated:
INLINELIMIT
: default reduced to 50. - Updated:
RESTXQERRORS
: additionally suppress stack trace in HTTP response
- Version 9.4
- Added:
LOGTRACE
- Version 9.3
- Version 9.2
- Added:
RESTXQERRORS
,FULLPLAN
- Removed:
DOTPLAN
,DOTCOMPACT
- Version 9.0
- Added:
ENFORCEINDEX
,COPYNODE
,IGNOREHOSTNAME
- Version 8.6
- Added:
FAIRLOCK
,PARSERESTXQ
- Removed:
GLOBALLOCK
(exclusive use of database lock) - Removed:
QUERYPATH
(will now be internally assigned) - Removed:
CACHERESTXQ
(replaced with PARSERESTXQ)
- Version 8.5
- Added:
CACHETIMEOUT
,LOGPATH
- Updated:
AUTHMETHOD
:custom
value added.
- Version 8.4
- Added:
TOKENINDEX
,TOKENINCLUDE
- Added:
SPLITSIZE
(replacingINDEXSPLITSIZE
andFTINDEXSPLITSIZE
) - Removed:
INDEXSPLITSIZE
,FTINDEXSPLITSIZE
- Version 8.3
- Added:
CACHERESTXQ
,TEXTINCLUDE
,ATTRINCLUDE
,FTINCLUDE
,ARCHIVENAME
- Version 8.2
- Removed:
EVENTPORT
,CACHEQUERY
- Version 8.1
- Added:
IGNORECERT
,RESTPATH
- Version 8.0
- Added:
MIXUPDATES
,AUTOOPTIMIZE
,AUTHMETHOD
,XINCLUDE
- Updated:
PROXYPORT
: default set to 0; will be ignored.PROXYHOST
,NONPROXYHOSTS
: empty strings will be ignored.
- Version 7.8.1
- Updated:
ADDARCHIVES
: parsing of TAR and TGZ files.
- Version 7.8
- Added:
CSVPARSER
,JSONPARSER
, TEXTPARSER,HTMLPARSER
,INLINELIMIT
,TAILCALLS
,DEFAULTDB
,RUNQUERY
- Updated:
WRITEBACK
only applies to main-memory document instances. - Updated:
DEBUG
option can be changed at runtime by users with admin permissions. - Updated: default of
INTPARSE
is nowfalse
. - Removed:
HTMLOPT
(replaced withHTMLPARSER
),PARSEROPT
(replaced with parser-specific options),DOTDISPLAY
,DOTTY
- Version 7.7
- Added:
ADDCACHE
,CHECKSTRINGS
,FTINDEXSPLITSIZE
,INDEXSPLITSIZE
- Version 7.6
- Added:
GLOBALLOCK
- Added: store local options in configuration file after
# 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:
USER
,PASSWORD
,LOG
,LOGMSGMAXLEN
,WEBPATH
,RESTXQPATH
HTTPLOCAL
,CREATEONLY
,STRIPNS
- Removed:
HTTPPATH
;HTTPPORT
: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:
KEEPALIVE
,TIMEOUT
: default values changed - Removed:
WILDCARDS
; new index supports both fuzzy and wildcard queries - Removed:
SCORING
; new scoring model will focus on lengths of text nodes and match options
- Version 7.2
- Added:
PROXYHOST
,PROXYPORT
,NONPROXYHOSTS
,HTMLOPT
- Updated:
TIMEOUT
: ignore timeout for admin users
- Version 7.1
- Version 7.0
- Added:
SERVERHOST
,KEEPALIVE
,AUTOFLUSH
,QUERYPATH