Difference between revisions of "Options"
(260 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
This page is linked from the [[Getting Started]] Section. | 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. | + | The options listed on this page influence the way how database [[Commands|commands]] are executed and XQuery expressions are evaluated. Two kinds of options exist: |
− | + | * '''[[#Global Options|Global Options]]''' are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/server architecture. | |
+ | * '''Local options''' (all remaining ones) are specific to a client or session. | ||
− | 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 | + | * The current value of an option can be requested with the {{Command|GET}} 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: |
− | < | + | <syntaxhighlight lang="perl"> |
+ | # General Options | ||
+ | DEBUG = false | ||
+ | ... | ||
+ | |||
+ | # Local Options | ||
+ | CHOP = false | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | * Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on command line, or using [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 {{Code|org.basex.}}. An example: | ||
+ | |||
+ | <syntaxhighlight lang="perl"> | ||
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop" | java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop" | ||
CHOP: false | CHOP: false | ||
− | </ | + | </syntaxhighlight> |
− | * | + | * If using the Mac OS X packaged application then global options can be set within the Info.plist file within the Contents folder of the application package. For example: |
− | < | + | <syntaxhighlight lang="xml"> |
− | + | <key>JVMOptions</key> | |
− | .. | + | <array> |
− | </ | + | <string>-Dorg.basex.CHOP=false</string> |
+ | </array> | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows: | ||
− | + | <syntaxhighlight lang="xml"> | |
+ | <context-param> | ||
+ | <param-name>org.basex.chop</param-name> | ||
+ | <param-value>false</param-value> | ||
+ | </context-param> | ||
+ | </syntaxhighlight> | ||
− | + | * In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]]. | |
− | |||
− | |||
− | If options are | + | If options are changed by operations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/> |
=Global Options= | =Global Options= | ||
− | Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception | + | Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception is the [[#debug|DEBUG]] option, which can also be changed at runtime by users with [[User Management|admin permissions]]. |
− | ==General== | + | ==General Options== |
===DEBUG=== | ===DEBUG=== | ||
Line 52: | Line 71: | ||
===DBPATH=== | ===DBPATH=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 58: | Line 78: | ||
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |<code> | + | |<code><code>[[Configuration#Database Directory|{home}/data]]</code> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
|Points to the directory in which all databases are located. | |Points to the directory in which all databases are located. | ||
+ | |} | ||
+ | |||
+ | ===LOGPATH=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|LOGPATH [path]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |<code>.logs</code> | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Points to the directory in which all [[Logging|log files]] are stored. Relative paths will be resolved against the {{Option|DBPATH}} directory. | ||
|} | |} | ||
===REPOPATH=== | ===REPOPATH=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 71: | Line 106: | ||
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |<code>[[Configuration#Database Directory|{home}/ | + | |<code>[[Configuration#Database Directory|{home}/repo]]</code> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
Line 78: | Line 113: | ||
===LANG=== | ===LANG=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 91: | Line 127: | ||
===LANGKEY=== | ===LANGKEY=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 103: | Line 140: | ||
|} | |} | ||
− | === | + | ===FAIRLOCK=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|FAIRLOCK [boolean]}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
Line 114: | Line 151: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Defines the locking strategy: |
+ | * By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the limit of parallel transactions (specified via {{Option|PARALLEL}}) has been reached. This prevents update operations from blocking all other requests. For example, the DBA can further be used to see which jobs are running, even if the queue is full. | ||
+ | * If fair locking is enabled, read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it should be used if the prompt evaluation of update operations is critical. | ||
+ | |} | ||
+ | |||
+ | ===CACHETIMEOUT=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|CACHETIMEOUT [seconds]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|3600}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Specifies how many seconds the results of queries, which have been queued by the [[Jobs Module|asynchronously executed]], will be cached in main memory. | ||
|} | |} | ||
Line 120: | Line 173: | ||
===HOST=== | ===HOST=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 133: | Line 187: | ||
===PORT=== | ===PORT=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 146: | Line 201: | ||
===SERVERPORT=== | ===SERVERPORT=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 158: | Line 214: | ||
|} | |} | ||
− | === | + | ===USER=== |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 188: | Line 232: | ||
===PASSWORD=== | ===PASSWORD=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 197: | Line 242: | ||
|- | |- | ||
| '''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 will be overwritten if a client specifies its own credentials. | * The default value will be overwritten if a client specifies its own credentials. | ||
* If the default value is empty, login will only be possible if the client specifies credentials. | * If the default value is empty, login will only be possible if the client specifies credentials. | ||
* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>. | * The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>. | ||
* Please note that it is a security risk to specify your password in plain text. | * Please note that it is a security risk to specify your password in plain text. | ||
+ | |} | ||
+ | |||
+ | ===AUTHMETHOD=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|AUTHMETHOD [method]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |''Basic'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Specifies the default authentication method, which will be used by the [[Web Application|HTTP server]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}:<br/> | ||
+ | * If basic access is chosen, the client can still request digest authentication. | ||
+ | * This is different for digest access, which cannot be overwritten. | ||
+ | * With custom authentication, the server will not do any authentication. | ||
|} | |} | ||
===SERVERHOST=== | ===SERVERHOST=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 218: | Line 281: | ||
===PROXYHOST=== | ===PROXYHOST=== | ||
+ | |||
{| width='100%' width='100%' | {| width='100%' width='100%' | ||
|- | |- | ||
Line 227: | Line 291: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |This is the host name of a proxy server. | + | |This is the host name of a proxy server. If the value is an empty string, it will be ignored. |
|} | |} | ||
===PROXYPORT=== | ===PROXYPORT=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 237: | Line 302: | ||
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |{{Code| | + | |{{Code|0}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |This is the port number of a proxy server. | + | |This is the port number of a proxy server. If the value is set to {{Code|0}}, it will be ignored. |
|} | |} | ||
===NONPROXYHOSTS=== | ===NONPROXYHOSTS=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 253: | Line 319: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |This is a list of hosts that should be directly accessed. | + | |This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored. |
+ | |} | ||
+ | |||
+ | ===IGNOREHOSTNAME=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|IGNOREHOSTNAME [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|false}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |If this option is enabled, hostnames of certificates will not be verified. Use {{Option|IGNORECERT}} to completely disable certificate verification. | ||
+ | |} | ||
+ | |||
+ | ===IGNORECERT=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|IGNORECERT [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|false}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |This option can be turned on to ignore untrusted certificates when connecting to servers. Use {{Option|IGNOREHOSTNAME}} to suppress only the hostname verification. | ||
|} | |} | ||
===TIMEOUT=== | ===TIMEOUT=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 266: | Line 361: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the maximum time a | + | |Specifies the maximum time a transaction triggered by a client may take. If an operation takes longer than the specified number of seconds, it will be aborted. Active update operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to {{Code|0}}. It is ignored for operations with [[User Management|admin permissions]]. |
|} | |} | ||
===KEEPALIVE=== | ===KEEPALIVE=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 283: | Line 379: | ||
===PARALLEL=== | ===PARALLEL=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 292: | Line 389: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Denotes the maximum allowed | + | |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=== | ===LOG=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 309: | Line 410: | ||
===LOGMSGMAXLEN=== | ===LOGMSGMAXLEN=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 321: | Line 423: | ||
|} | |} | ||
− | ==HTTP | + | ===LOGTRACE=== |
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|LOGTRACE [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|true}} | ||
+ | |- | ||
+ | | '''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=== | ===WEBPATH=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 332: | Line 449: | ||
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |<code>[[Configuration#Database Directory|{home}/ | + | |<code>[[Configuration#Database Directory|{home}/webapp]]</code> |
+ | |- | ||
+ | | '''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=== | ||
+ | |||
+ | {{Mark|Updated with Version 10:}} Support for POST and PUT requests. | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|GZIP [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| '''Summary''' | | '''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=== | ===RESTXQPATH=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 348: | Line 487: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the [[# | + | |Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the {{Option|WEBPATH}} directory. |
+ | |} | ||
+ | |||
+ | ===PARSERESTXQ=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|PARSERESTXQ}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|3}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Timeout after which the RESTXQ directory will be parsed for changes: | ||
+ | * If {{Code|0}} is specified, the directory will be parsed every time a RESTXQ function is called. | ||
+ | * A positive value defines the idle time in seconds after which parsing will be enforced. The default value is {{Code|3}}: Changes in the RESTXQ directory will be detected after 3 seconds without RESTXQ function calls. | ||
+ | * Monitoring is completely disabled if a negative value is specified. | ||
+ | |||
+ | See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details. | ||
+ | |} | ||
+ | |||
+ | ===RESTXQERRORS=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|RESTXQERRORS}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|true}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details. | ||
+ | |} | ||
+ | |||
+ | ===RESTPATH=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|RESTPATH [path]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |''empty'' | ||
+ | |- | ||
+ | | '''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=== | ===HTTPLOCAL=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 361: | Line 548: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |By default, | + | |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=== | ===STOPPORT=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 385: | Line 573: | ||
===MAINMEM=== | ===MAINMEM=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 394: | Line 583: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is turned on, new databases will be | + | |If this option is turned on, new databases will be created in main memory: |
+ | * Most queries will be evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down. | ||
+ | * It is not possible to store binary resources in a main-memory database. | ||
+ | * A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new database from the exported file in a second step. | ||
+ | * This option will not be available for [[Database Module#db:create|db:create]], because the database would not be accessible anymore after database creation, i. e., outside the query scope. | ||
|} | |} | ||
Line 408: | Line 601: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is activated, documents | + | |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). |
|} | |} | ||
Line 414: | Line 607: | ||
===CREATEFILTER=== | ===CREATEFILTER=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 427: | Line 621: | ||
===ADDARCHIVES=== | ===ADDARCHIVES=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 436: | Line 631: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new | + | |If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc.) are parsed whenever new databases are created or resources are added to a database. |
+ | |} | ||
+ | |||
+ | ===ARCHIVENAME=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|ARCHIVENAME [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|false}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |If this option is set to {{Code|true}}, the file name of parsed archives will be included in the document paths. | ||
|} | |} | ||
===SKIPCORRUPT=== | ===SKIPCORRUPT=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 453: | Line 663: | ||
===ADDRAW=== | ===ADDRAW=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 462: | Line 673: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is | + | |If this option is enabled, all resources that are filtered out by the {{Option|CREATEFILTER}} option while being added to a database will be stored as [[Binary Data|raw files]] instead (i.e., in their binary representation). |
|} | |} | ||
===PARSER=== | ===PARSER=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 475: | Line 687: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Defines a [[Parsers|parser]] for importing new files to the database. | + | |Defines a [[Parsers|parser]] for importing new files to the database. Available parsers are {{Code|XML}}, {{Code|JSON}}, {{Code|CSV}}, {{Code|TEXT}}, {{Code|HTML}}, and {{Code|RAW}}. HTML input will be parsed as XML documents if [[Parsers#HTML_Parser|Tagsoup]] is not found in the classpath. |
|} | |} | ||
===CSVPARSER=== | ===CSVPARSER=== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 491: | Line 701: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the way how CSV data | + | |Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]]. |
+ | |- | ||
+ | | '''Examples''' | ||
+ | |<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header. | ||
|} | |} | ||
===JSONPARSER=== | ===JSONPARSER=== | ||
− | + | {| width='100%' | |
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|JSONPARSER [options]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |''empty'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]]. | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | |<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing. | ||
+ | |} | ||
+ | |||
+ | ===HTMLPARSER=== | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|HTMLPARSER [options]}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
Line 507: | Line 735: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the way how | + | |Specifies the way how HTML data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are described in the [[Parsers#Options|Parsers]] article. |
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces. | ||
+ | * <code>lexical=true</code> preserves comments. | ||
|} | |} | ||
===TEXTPARSER=== | ===TEXTPARSER=== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 523: | Line 754: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the way how TEXT data | + | |Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are listed in the [[Parsers]] article. |
+ | |- | ||
+ | | '''Examples''' | ||
+ | |<code>lines=true</code> creates a single element for each line of text. | ||
|} | |} | ||
Line 529: | Line 763: | ||
===CHOP=== | ===CHOP=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 538: | Line 773: | ||
|- | |- | ||
| '''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: |
+ | * With the default value {{Code|true}}, leading and trailing whitespaces from text nodes will be chopped and all empty text nodes will be discarded. | ||
+ | * The flag should be turned off if a document contains [[Full-Text#Mixed Content|mixed content]]. | ||
+ | * The flag can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>. | ||
+ | * If the <code>xml:space="preserve"</code> attribute is attached to an element, chopping will be turned off for all descendant text nodes. | ||
+ | |||
+ | In the following example document, the whitespaces in the text nodes of the {{Code|text}} element will not be chopped: | ||
+ | <syntaxhighlight lang="xml"> | ||
+ | <xml> | ||
+ | <title> | ||
+ | Demonstrating the CHOP flag | ||
+ | </title> | ||
+ | <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text> | ||
+ | </xml> | ||
+ | </syntaxhighlight> | ||
+ | It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option; otherwise the serialized documents will automatically be indented. | ||
+ | |} | ||
+ | |||
+ | ===STRIPNS=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|STRIPNS [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|false}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Strips all namespaces from an XML document and all elements while parsing. | ||
|} | |} | ||
===INTPARSE=== | ===INTPARSE=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 548: | Line 813: | ||
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |{{Code| | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Uses the internal XML parser instead of the standard Java XML parser. | + | |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> (�) | ||
+ | * Entities: around 250 HTML entities will be detected and decoded | ||
+ | You will be able to correctly parse most XML documents with the internal parser. Java’s Xerces parser is still used as default, however, because it supports all features of the XML standard and advanced DTD features, such as recursive entity expansion. | ||
|} | |} | ||
===DTD=== | ===DTD=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 564: | Line 834: | ||
|- | |- | ||
| '''Summary''' | | '''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 | + | |Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The {{Option|CATFILE}} option can be changed to locally resolve DTDs. |
+ | |} | ||
+ | |||
+ | ===XINCLUDE=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|XINCLUDE [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|true}} | ||
+ | |- | ||
+ | | '''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}}). | ||
|} | |} | ||
===CATFILE=== | ===CATFILE=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 577: | Line 862: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Semicolon-separated list of XML catalog files to resolve URIs. See [[Catalog Resolver]]s for more details. |
|} | |} | ||
==Indexing== | ==Indexing== | ||
− | The current | + | The following options control the creation of index structures. The current values will be considered if a new database is created. See [[Indexes]] for more details. |
===TEXTINDEX=== | ===TEXTINDEX=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 594: | Line 880: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes | + | |Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes. See [[Index#Text Index|Text Index]] for more details. |
|} | |} | ||
===ATTRINDEX=== | ===ATTRINDEX=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 607: | Line 894: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values | + | |Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[Index#Attribute Index|Attribute Index]] for more details. |
+ | |} | ||
+ | |||
+ | ===TOKENINDEX=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|TOKENINDEX [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|true}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See [[Index#Token Index|Token Index]] for more details. | ||
|} | |} | ||
===FTINDEX=== | ===FTINDEX=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 620: | Line 922: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions | + | |Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions. See [[Index#Full-Text Index|Full-Text Index]] for more details. |
+ | |} | ||
+ | |||
+ | ===TEXTINCLUDE=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|TEXTINCLUDE [names]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |''empty'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details. | ||
+ | |} | ||
+ | |||
+ | ===ATTRINCLUDE=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|ATTRINCLUDE [names]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |''empty'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details. | ||
+ | |} | ||
+ | |||
+ | ===TOKENINCLUDE=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|TOKENINCLUDE [names]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |''empty'' | ||
+ | |- | ||
+ | | '''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%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|FTINCLUDE [names]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |''empty'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details. | ||
|} | |} | ||
===MAXLEN=== | ===MAXLEN=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 633: | Line 992: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the maximum length | + | |Specifies the maximum length for strings to be stored in [[Indexes|index structures]]. The value of this option will be assigned once to a new database, and can only be changed by creating a new database or doing a [[Commands#OPTIMIZE|full optimization]]. |
|} | |} | ||
===MAXCATS=== | ===MAXCATS=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 650: | Line 1,010: | ||
===UPDINDEX=== | ===UPDINDEX=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 659: | Line 1,020: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |If turned on, incremental indexing will be | + | |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 [[Database_Module#db:optimize|db:optimize($db, true())]]. | |
− | * The value of this option will be assigned | + | * 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%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|AUTOOPTIMIZE [boolean]}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |{{Code| | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''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 [[Database_Module#db:optimize|db:optimize]]. | ||
|} | |} | ||
− | === | + | ===SPLITSIZE=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|SPLITSIZE [num]}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
Line 691: | Line 1,055: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |This option affects the [[Indexes# | + | |This option affects the [[Indexes#Performance|construction]] of new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk: |
+ | * By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption. Usually, this works fine. | ||
+ | * If explicit garbage collection is disabled when running Java (e.g. via the JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to choose a custom split size. | ||
+ | * You can e. g. start with {{Code|1000000}} (one million) index operations and adjust this value in the next steps. | ||
+ | * The larger the assigned value is, the less splits will take place, and the more main memory will be required. | ||
|} | |} | ||
− | ==Full-Text== | + | ==Full-Text Indexing== |
===STEMMING=== | ===STEMMING=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 706: | Line 1,075: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |If {{Code|true}}, all tokens will be 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. |
|} | |} | ||
===CASESENS=== | ===CASESENS=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
− | + | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
|{{Code|CASESENS [boolean]}} | |{{Code|CASESENS [boolean]}} | ||
Line 719: | Line 1,089: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |If {{Code|true}}, the case of tokens will be preserved during full-text indexing. By default, case will be ignored (all tokens will be indexed in lower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
===DIACRITICS=== | ===DIACRITICS=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 732: | Line 1,103: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |If set to {{Code|true}}, diacritics will be preserved during full-text indexing. By default, diacritics will be removed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
===LANGUAGE=== | ===LANGUAGE=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 745: | Line 1,117: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
===STOPWORDS=== | ===STOPWORDS=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 758: | Line 1,131: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index is created. A stopword list may decrease the size of the full text index and speed up your queries. See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
Line 764: | Line 1,137: | ||
===QUERYINFO=== | ===QUERYINFO=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 776: | Line 1,150: | ||
|} | |} | ||
− | === | + | ===MIXUPDATES=== |
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|MIXUPDATES}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |{{Code| | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for more details. |
|} | |} | ||
===BINDINGS=== | ===BINDINGS=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 799: | Line 1,175: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Contains external variables to be bound to a query: | + | |Contains external variables to be bound to a query. The string must comply with the following rules: |
− | * Variable names and values | + | * 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. | * 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-30/#id-basics Expanded QName Notation]. | |
− | * 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 [ | + | This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>. |
− | |||
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
− | |<code>$a=1,$b=2</code> binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b | + | | |
+ | * <code>$a=1,$b=2</code> binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b | ||
+ | * <code>a=1,,2</code> binds the value {{Code|1,2}} to the variable $a | ||
+ | * <code>{URI}a=x</code> binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}. | ||
+ | * In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable {{Code|$GREETING}}: | ||
+ | <syntaxhighlight lang="xquery"> | ||
+ | SET BINDINGS GREETING="hello world!" | ||
+ | XQUERY declare variable $GREETING external; $GREETING | ||
+ | </syntaxhighlight> | ||
+ | |} | ||
+ | |||
+ | ===INLINELIMIT=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|INLINELIMIT}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|50}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |This option controls inlining of XQuery functions: | ||
+ | * The XQuery compiler inlines functions to speed up query evaluation. | ||
+ | * Inlining will only take place if a function body is not too large (i.e., if it does not contain too many expressions). | ||
+ | * With this option, this maximum number of expressions can be specified. | ||
+ | * Function inlining can be turned off by setting the value to {{Code|0}}. | ||
+ | * The limit can be locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (follow the link to get more information on function inlining). | ||
|} | |} | ||
− | === | + | ===UNROLLLIMIT=== |
+ | |||
+ | {{Mark|Introduced with Version 9.6:}} | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|UNROLLLIMIT}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | | | + | |{{Code|5}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |This option controls the unroll limit: |
+ | * Loops with few iterations are ''unrolled'' by the XQuery compiler to enable further optimizations. | ||
+ | * If the limit is increased, more optimizations will take place, but the memory consumption and compile time will increase. | ||
+ | * See [[XQuery Optimizations#Loop Unrolling|Loop Unrolling]] for more details. | ||
|} | |} | ||
− | === | + | ===ENFORCEINDEX=== |
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|ENFORCEINDEX [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|false}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Enforces index rewritings in path expressions. See [[Indexes#Enforce Rewritings|Enforce Rewritings]] for details. | ||
+ | |} | ||
− | + | ===COPYNODE=== | |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|COPYNODE [boolean]}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |{{Code| | + | |{{Code|true}} |
|- | |- | ||
| '''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 will be created, and the copied nodes get new node identities. As a result, the following query yields <code>false</code>: |
+ | <syntaxhighlight lang="xquery"> | ||
+ | let $a := <a/> | ||
+ | let $b := <b>{ $a }</b> | ||
+ | return $b/a is $a | ||
+ | </syntaxhighlight> | ||
+ | This step can be very expensive and memory consuming. If the option is disabled, child nodes will only be linked to the new parent nodes, and the upper query returns <code>true</code>.<br>The option should be used carefully as it changes the semantics of XQuery. It should preferably be used in [[XQuery Extensions#Database Pragmas|Pragmas]]. | ||
|} | |} | ||
===TAILCALLS=== | ===TAILCALLS=== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 852: | Line 1,278: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies how many stack frames of [ | + | |Specifies how many stack frames of [https://en.wikipedia.org/wiki/Tail_call 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 {{Code|-1}}. |
|} | |} | ||
− | === | + | ===WITHDB=== |
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|WITHDB}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |{{Code| | + | |{{Code|true}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |By default, resources specified via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] are looked up both in the database and in the file system. If you always use {{Function|Database|db:open}} to access databases, it is recommendable to disable this option: |
+ | * No locks will be created for the two functions (see [[Transaction Management#Limitations|limitations of database locking]] for more details). | ||
+ | * Access to local and external resources will be faster, as the database lookup will be skipped. | ||
|} | |} | ||
− | === | + | ===DEFAULTDB=== |
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|DEFAULTDB}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
Line 881: | Line 1,308: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |If this option is turned on, paths specified in the [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|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 will be resolved as described in the article on [[Databases#Access Resources|accessing database resources]]. |
|} | |} | ||
===FORCECREATE=== | ===FORCECREATE=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 894: | Line 1,322: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |By activating this option, the XQuery | + | |By activating this option, database instances will be created with the XQuery functions [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]]. |
|} | |} | ||
Line 908: | Line 1,336: | ||
|- | |- | ||
| '''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 will be replaced with the Unicode replacement character <code>FFFD</code> (�). The option affects [[Java Bindings]] and string conversion and input functions such as [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], [[Archive Module#archive:update|archive:update]], and [[ZIP Module#zip:text-entry|zip:text-entry]]. |
− | + | |} | |
− | + | ||
+ | ===WRAPJAVA=== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|WRAPJAVA [mode]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|some}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Defines the way how values that result from Java code invocation will be converted to XQuery items. Allowed values: {{Code|none}}, {{Code|all}}, {{Code|some}}, {{Code|instance}}, and {{Code|void}}. See [[Java_Bindings#Conversion to XQuery|Java Bindings]] for further details. | ||
|} | |} | ||
===LSERROR=== | ===LSERROR=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 923: | Line 1,364: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |This option specifies the maximum Levenshtein error for the | + | |This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if {{Code|0}} is assigned, the error value is calculated dynamically. See [[Full-Text#Fuzzy_Querying|Fuzzy Querying]] for more details. |
|} | |} | ||
===RUNQUERY=== | ===RUNQUERY=== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 939: | Line 1,378: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies if a query will be executed or parsed only. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>. |
|} | |} | ||
===RUNS=== | ===RUNS=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 952: | Line 1,392: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies how often a query will be 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 958: | Line 1,398: | ||
===SERIALIZE=== | ===SERIALIZE=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 971: | Line 1,412: | ||
===SERIALIZER=== | ===SERIALIZER=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 980: | Line 1,422: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Parameters for [[Serialization|serializing]] query results. The string must comply with the following rules: |
− | * | + | * Variable names and values must be separated by equality signs. |
− | * Multiple | + | * Multiple variables must be delimited by commas. |
− | * The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>. | + | * Commas in values must be duplicated. |
+ | The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>. | ||
|- | |- | ||
− | | ''' | + | | '''Examples''' |
− | |<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration. | + | | |
+ | * <code>indent=no</code> : disables automatic indentation of XML nodes. This is usually a good choice when working with [[Full-Text#Mixed Content|Mixed-Content Data]]. | ||
+ | * <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration. | ||
+ | * <code>item-separator=,,</code> : separates serialized items by a single comma. | ||
|} | |} | ||
===EXPORTER=== | ===EXPORTER=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 999: | Line 1,446: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Contains parameters for exporting | + | |Contains parameters for exporting resources of a database and writing files after updates via the {{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[Serialization]] for more details. |
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration. | ||
|} | |} | ||
===XMLPLAN=== | ===XMLPLAN=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 1,016: | Line 1,468: | ||
===COMPPLAN=== | ===COMPPLAN=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 1,025: | Line 1,478: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Generates the query plan, which can be activated via {{Option|XMLPLAN}}, before or after query compilation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>. |
|} | |} | ||
− | === | + | ===FULLPLAN=== |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|FULLPLAN [boolean]}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
Line 1,051: | Line 1,492: | ||
|- | |- | ||
| '''Summary''' | | '''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. |
|} | |} | ||
Line 1,057: | Line 1,498: | ||
===AUTOFLUSH=== | ===AUTOFLUSH=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 1,066: | Line 1,508: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the | + | |Flushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the {{Command|FLUSH}} command. |
|} | |} | ||
===WRITEBACK=== | ===WRITEBACK=== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 1,082: | Line 1,522: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Propagates updates on main-memory instances of files that have been retrieved via | + | |Propagates updates on main-memory instances of files that have been retrieved via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] back to disk: |
+ | * This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>. | ||
+ | * Please take in mind that no backup will be created from your original files. | ||
+ | * The serialization options can be controlled via the {{Option|EXPORTER}} option. | ||
|} | |} | ||
===MAXSTAT=== | ===MAXSTAT=== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 1,095: | Line 1,539: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the maximum number of index occurrences printed by the | + | |Specifies the maximum number of index occurrences printed by the {{Command|INFO INDEX}} command. |
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 10 | ||
+ | * Updated: {{Option|GZIP}}: Support for POST and PUT requests. | ||
+ | |||
+ | ;Version 9.6 | ||
+ | * Added: {{Option|UNROLLLIMIT}}, {{Option|WRAPJAVA}} | ||
+ | |||
+ | ;Version 9.5 | ||
+ | * Updated: {{Option|INLINELIMIT}}: default reduced to 50. | ||
+ | * Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response | ||
+ | |||
+ | ;Version 9.4 | ||
+ | * Added: {{Option|LOGTRACE}} | ||
+ | |||
+ | ;Version 9.3 | ||
+ | * Added: {{Option|WITHDB}}, {{Option|GZIP}} | ||
+ | |||
+ | ;Version 9.2 | ||
+ | * Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}} | ||
+ | * Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code> | ||
+ | |||
+ | ;Version 9.0 | ||
+ | * Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}} | ||
+ | |||
+ | ;Version 8.6 | ||
+ | * Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}} | ||
+ | * Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock) | ||
+ | * Removed: {{Code|QUERYPATH}} (will now be internally assigned) | ||
+ | * Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ) | ||
+ | |||
+ | ;Version 8.5 | ||
+ | * Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}} | ||
+ | * Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added. | ||
+ | |||
+ | ;Version 8.4 | ||
+ | * Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}} | ||
+ | * Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>) | ||
+ | * Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code> | ||
+ | |||
+ | ;Version 8.3 | ||
+ | * Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}} | ||
+ | |||
+ | ;Version 8.2 | ||
+ | * Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code> | ||
+ | |||
+ | ;Version 8.1 | ||
+ | * Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}} | ||
+ | |||
+ | ;Version 8.0 | ||
+ | * Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}} | ||
+ | * Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored. | ||
+ | |||
+ | ;Version 7.8.1 | ||
+ | * Updated: {{Option|ADDARCHIVES}}: parsing of TAR and TGZ files. | ||
;Version 7.8 | ;Version 7.8 | ||
− | * Added: | + | * Added: {{Option|CSVPARSER}}, {{Option|JSONPARSER}}, {{Option|TEXTPARSER}}, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}} |
− | * Updated: | + | * Updated: {{Option|WRITEBACK}} only applies to main-memory document instances. |
− | * Updated: | + | * Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions. |
− | * Removed: <code>HTMLOPT</code> (replaced with | + | * Updated: default of {{Option|INTPARSE}} is now {{Code|false}}. |
+ | * Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code> | ||
;Version 7.7 | ;Version 7.7 | ||
− | + | * Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}} | |
− | * Added: | ||
;Version 7.6 | ;Version 7.6 | ||
− | + | * Added: {{Option|GLOBALLOCK}} | |
− | * Added: | ||
* Added: store local options in configuration file after {{Code|# Local Options}} comments. | * Added: store local options in configuration file after {{Code|# Local Options}} comments. | ||
;Version 7.5 | ;Version 7.5 | ||
− | |||
* Added: options can now be set via system properties | * Added: options can now be set via system properties | ||
* Added: a pragma expression can be used to locally change database options | * Added: a pragma expression can be used to locally change database options | ||
− | * Added: | + | * 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: {{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 | * Removed: global options cannot be changed anymore during the lifetime of a BaseX instance | ||
;Version 7.3 | ;Version 7.3 | ||
− | + | * Updated: {{Option|KEEPALIVE}}, {{Option|TIMEOUT}}: default values changed | |
− | * Updated: | ||
* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries | * 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 | * Removed: {{Code|SCORING}}; new scoring model will focus on lengths of text nodes and match options | ||
;Version 7.2 | ;Version 7.2 | ||
− | + | * Added: {{Option|PROXYHOST}}, {{Option|PROXYPORT}}, {{Option|NONPROXYHOSTS}}, {{Option|HTMLOPT}} | |
− | * Added: | + | * Updated: {{Option|TIMEOUT}}: ignore timeout for admin users |
− | * Updated: | ||
;Version 7.1 | ;Version 7.1 | ||
− | + | * Added: {{Option|ADDRAW}}, {{Option|MAXLEN}}, {{Option|MAXCATS}}, {{Option|UPDINDEX}} | |
− | * Added: | + | * Updated: {{Option|BINDINGS}} |
− | * Updated: | ||
;Version 7.0 | ;Version 7.0 | ||
− | + | * Added: {{Option|SERVERHOST}}, {{Option|KEEPALIVE}}, {{Option|AUTOFLUSH}}, {{Option|QUERYPATH}} | |
− | * Added: |
Revision as of 15:01, 12 November 2021
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
GET
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 will be 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
CHOP = false </syntaxhighlight>
- Initial values for global options can also be specified via system properties, which can e.g. be passed on with the -D flag on command line, or using 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.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop" CHOP: false </syntaxhighlight>
- If using the Mac OS X packaged application then global options can be set within the Info.plist file within the Contents folder of the application package. For example:
<syntaxhighlight lang="xml"> <key>JVMOptions</key> <array>
<string>-Dorg.basex.CHOP=false</string>
</array> </syntaxhighlight>
- In a Web Application, the default can be adjusted in the
web.xml
file as follows:
<syntaxhighlight lang="xml"> <context-param>
<param-name>org.basex.chop</param-name> <param-value>false</param-value>
</context-param> </syntaxhighlight>
- In XQuery, local options can be set via option declarations and pragmas.
If options are changed by operations in the GUI, the underlying commands will be listed 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 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 via -d .
|
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 in which all log files are stored. Relative paths will be 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. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. |
LANGKEY
Signature | LANGKEY [boolean]
|
Default | false
|
Summary | Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed. |
FAIRLOCK
Signature | FAIRLOCK [boolean]
|
Default | false
|
Summary | Defines the locking strategy:
|
CACHETIMEOUT
Signature | CACHETIMEOUT [seconds]
|
Default | 3600
|
Summary | Specifies how many seconds the results of queries, which have been queued by the asynchronously executed, will be 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 will be 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 user name, 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, which will be 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 will be open to 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 will be 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 will be 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 will be ignored. |
IGNOREHOSTNAME
Signature | IGNOREHOSTNAME [boolean]
|
Default | false
|
Summary | If this option is enabled, hostnames of certificates will not be verified. Use IGNORECERT to completely disable certificate verification.
|
IGNORECERT
Signature | IGNORECERT [boolean]
|
Default | false
|
Summary | This option can be turned on to ignore untrusted certificates when connecting to servers. Use IGNOREHOSTNAME to suppress only the hostname verification.
|
TIMEOUT
Signature | TIMEOUT [seconds]
|
Default | 30
|
Summary | Specifies the maximum time a transaction triggered by a client may take. If an operation takes longer than the specified number of seconds, it will be aborted. Active update operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to 0 . It is ignored for operations with admin permissions.
|
KEEPALIVE
Signature | KEEPALIVE [seconds]
|
Default | 600
|
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 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 Web Application, trace output (generated via fn:trace , prof:dump and similar functions) is written to the 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 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
Template:Mark Support for POST and PUT requests.
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 will be resolved against the WEBPATH directory.
|
PARSERESTXQ
Signature | PARSERESTXQ
|
Default | 3
|
Summary | Timeout after which the RESTXQ directory will be 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 will be 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 will be 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 will be launched.
|
STOPPORT
Signature | STOPPORT [port]
|
Default | 8985
|
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 will be created 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 will be 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 will be parsed twice. Next, main memory consumption will be 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 will be 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 will be parsed as XML documents if Tagsoup is not found in the classpath.
|
CSVPARSER
Signature | CSVPARSER [options]
|
Default | empty |
Summary | Specifies the way how CSV data will be 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 will be 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 will be parsed. Keys and values are delimited with = , and multiple options are delimited with , . The available options are described in the Parsers article.
|
Examples |
|
TEXTPARSER
Signature | TEXTPARSER [options]
|
Default | empty |
Summary | Specifies the way how TEXT data will be parsed. Keys and values are delimited with = , and multiple options are delimited with , . The available options are listed in the Parsers article.
|
Examples | lines=true creates a single element for each line of text.
|
XML Parsing
CHOP
Signature | CHOP [boolean]
|
Default | true
|
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:
In the following example document, the whitespaces in the text nodes of the <title> Demonstrating the CHOP flag </title> <text xml:space="preserve">To be, or not to be, that is the question.</text> </xml>
</syntaxhighlight>
It is recommendable to additionally assign |
STRIPNS
Signature | STRIPNS [boolean]
|
Default | false
|
Summary | Strips all namespaces from an XML document and all elements while parsing. |
INTPARSE
Signature | INTPARSE [boolean]
|
Default | false
|
Summary | Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the internal parser:
You will be able to correctly parse most XML documents with the internal parser. Java’s Xerces parser is still used as default, however, because it supports all features of the XML standard and advanced DTD features, such as recursive entity expansion. |
DTD
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 CATFILE 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 ).
|
CATFILE
Signature | CATFILE [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 will be 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 will be 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 will be 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 will be 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 will be 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 will be 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 will be stored together with the element/attribute names or unique paths in the Name Index or Path Index. The value of this option will be assigned once to a new database, and cannot be changed after that. |
UPDINDEX
Signature | UPDINDEX [boolean]
|
Default | false
|
Summary | If turned on, incremental indexing will be enabled:
|
AUTOOPTIMIZE
Signature | AUTOOPTIMIZE [boolean]
|
Default | false
|
Summary | If turned on, auto optimization will be 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 will be 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 will be preserved during full-text indexing. By default, case will be ignored (all tokens will be indexed in lower case). See Full-Text Index for more details.
|
DIACRITICS
Signature | DIACRITICS [boolean]
|
Default | false
|
Summary | If set to true , diacritics will be preserved during full-text indexing. By default, diacritics will be removed. See Full-Text Index for more details.
|
LANGUAGE
Signature | LANGUAGE [lang]
|
Default | en
|
Summary | The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See 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 will be ignored when a full-text index is created. A stopword list may decrease the size of the full text index and speed up your queries. See 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 will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to 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 will be 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 very 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:open 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 will be resolved as described in the article on accessing database resources.
|
FORCECREATE
Signature | FORCECREATE [boolean]
|
Default | false
|
Summary | By activating this option, database instances will be created with the XQuery functions fn:doc and fn:collection. |
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 will be 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, archive:update, and zip:text-entry.
|
WRAPJAVA
Signature | WRAPJAVA [mode]
|
Default | some
|
Summary | Defines the way how values that result from Java code invocation will be 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 will be 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 will be 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 will be 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 string must comply with the following rules:
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 .
|
COMPPLAN
Signature | COMPPLAN [boolean]
|
Default | true
|
Summary | Generates the query plan, which can be activated via XMLPLAN , before or after query compilation. 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) will be 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 10
- 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