Difference between revisions of "Options"
(30 intermediate revisions by the same user not shown) | |||
Line 23: | Line 23: | ||
<string>-Dorg.basex.CHOP=false</string> | <string>-Dorg.basex.CHOP=false</string> | ||
</array> | </array> | ||
+ | </pre> | ||
+ | |||
+ | * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows: | ||
+ | |||
+ | <pre class="brush:xml"> | ||
+ | <context-param> | ||
+ | <param-name>org.basex.chop</param-name> | ||
+ | <param-value>false</param-value> | ||
+ | </context-param> | ||
</pre> | </pre> | ||
* In XQuery, local options can be set via option declarations and pragmas (see [[XQuery Extensions]]). | * In XQuery, local options can be set via option declarations and pragmas (see [[XQuery Extensions]]). | ||
− | 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= | ||
Line 64: | Line 73: | ||
===LOGPATH=== | ===LOGPATH=== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 121: | Line 128: | ||
|} | |} | ||
− | === | + | ===FAIRLOCK=== |
+ | |||
+ | {{Mark|Introduced with Version 8.6:}} | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|FAIRLOCK [boolean]}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
Line 132: | Line 141: | ||
|- | |- | ||
| '''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='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|CACHETIMEOUT [seconds]}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
Line 148: | Line 157: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies how | + | |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 223: | Line 232: | ||
|- | |- | ||
| '''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. | ||
Line 231: | Line 240: | ||
===AUTHMETHOD=== | ===AUTHMETHOD=== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 330: | Line 337: | ||
|- | |- | ||
| '''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]]. |
|} | |} | ||
Line 421: | Line 428: | ||
|} | |} | ||
− | === | + | ===PARSERESTXQ=== |
+ | |||
+ | {{Mark|Introduced with Version 8.6}}: replacing {{Code|CACHERESTXQ}}. | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signature''' | | width='120' | '''Signature''' | ||
− | |{{Code| | + | |{{Code|PARSERESTXQ}} |
|- | |- | ||
| '''Default''' | | '''Default''' | ||
− | |{{Code| | + | |{{Code|3}} |
|- | |- | ||
| '''Summary''' | | '''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. | ||
|} | |} | ||
Line 595: | Line 609: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if [ | + | |Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if [[Parsers#HTML_Parser|Tagsoup]] is not found in the classpath. |
|} | |} | ||
Line 609: | Line 623: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |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 are | + | |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''' | | '''Examples''' | ||
Line 626: | Line 640: | ||
|- | |- | ||
| '''Summary''' | | '''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 are | + | |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''' | | '''Examples''' | ||
Line 643: | Line 657: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |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>. | + | |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]] article. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 660: | Line 674: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. | + | |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''' | | '''Examples''' | ||
Line 719: | Line 733: | ||
|- | |- | ||
| '''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. | ||
|} | |} | ||
Line 959: | Line 977: | ||
|} | |} | ||
− | ==Full-Text== | + | ==Full-Text Indexing== |
===STEMMING=== | ===STEMMING=== | ||
Line 1,104: | Line 1,122: | ||
XQUERY declare variable $GREETING external; $GREETING | XQUERY declare variable $GREETING external; $GREETING | ||
</pre> | </pre> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Line 1,131: | Line 1,135: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |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. | + | |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#basex:inline|%basex:inline]] annotation (follow the link to get more information on function inlining). | ||
|} | |} | ||
Line 1,187: | Line 1,196: | ||
|- | |- | ||
| '''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]]. |
− | |||
− | |||
|} | |} | ||
Line 1,388: | Line 1,395: | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;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 | ;Version 8.5 | ||
− | * Added: {{Option| | + | * Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}} |
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added. | * Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added. | ||
Revision as of 11:22, 1 March 2017
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. Options are divided into global options, which are valid for all BaseX instances, and local options, which are specific to a client or session. Values of options are either strings, numbers or booleans.
The .basex
configuration file is parsed by every new local BaseX instance. It contains all global options and, optionally, local options at the end of the file.
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 values are static: They stay valid until they are changed once again by another operation. If an option is of type boolean, and if no value is specified, its current value will be inverted.
- 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:
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop" CHOP: false
- 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:
<key>JVMOptions</key> <array> <string>-Dorg.basex.CHOP=false</string> </array>
- In a Web Application, the default can be adjusted in the
web.xml
file as follows:
<context-param> <param-name>org.basex.chop</param-name> <param-value>false</param-value> </context-param>
- In XQuery, local options can be set via option declarations and pragmas (see XQuery Extensions).
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 | {home}/BaseXData or {home}/data
|
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}/BaseXRepo
|
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. |
IGNORECERT
Signature | IGNORECERT [boolean]
|
Default | false
|
Summary | This option can be turned on to ignore untrusted certificates when connecting to servers. Please use this option carefully. |
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. Note that 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. The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. |
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. |
HTTP Services
If BaseX is run as web servlet, the HTTP options must be specified in the webapp/WEB-INF
directory and the jetty.xml
and web.xml
configuration files.
WEBPATH
Signature | WEBPATH [path]
|
Default | {home}/BaseXWeb or {home}/webapp
|
Summary | Points to the directory in which all the Web Application contents are stored, including XQuery, Script, RESTXQ and configuration files. This option is ignored if BaseX is deployed as web servlet. |
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
Template:Mark: replacing CACHERESTXQ
.
Signature | PARSERESTXQ
|
Default | 3
|
Summary | Timeout after which the RESTXQ directory will be parsed for changes:
See RESTXQ Preliminaries 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, a database server instance will be started as soon as the first HTTP service is called. The server can then be addressed by other BaseX clients in parallel to the HTTP services. If the option is set to false , the database server will be disabled.
|
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 exclusively created in main memory. Most queries will be evaluated faster in main memory mode, but all data is lost if BaseX is shut down. The value of this option will be assigned once to a new database, and cannot be changed after that. |
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 activated, and if new resources are added to a database, all files that are not filtered by the CREATEFILTER option will be added as raw files (i.e., in their binary representation).
|
PARSER
Signature | PARSER [type]
|
Default | XML
|
Summary | Defines a parser for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files 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 | encoding=Shift-JIS,nons=true parses the input as Sihft-JIS and suppresses namespaces.
|
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:
<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> |
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 | Specifies a catalog file to locally resolve DTDs. See the entry on 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 of strings that are to be indexed by the name, path, value, and full-text index structures. The value of this option will be assigned once to a new database, and cannot be changed after that. |
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 | A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. 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 .
|
XQUERY3
Signature | XQUERY3
|
Default | true
|
Summary | Enables all XQuery 3.0 features supported by BaseX. If this option is set to false , the XQuery parser will only accept expressions of the XQuery 1.0 specification.
|
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, this option is set to false , because the XQuery Update Facility does not allow an updating query to return results.
|
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 |
SET BINDINGS GREETING="hello world!" XQUERY declare variable $GREETING external; $GREETING |
INLINELIMIT
Signature | INLINELIMIT
|
Default | 100
|
Summary | This option controls inlining of XQuery functions:
|
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 .
|
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.
|
LSERROR
Signature | LSERROR [error]
|
Default | 0
|
Summary | This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option. See the page on Full-Texts for more information on fuzzy querying. |
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 all resources of a database. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See Serialization for more details. |
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 .
|
DOTPLAN
Signature | DOTPLAN [boolean]
|
Default | false
|
Summary | Saves the query plan of an XQuery expression as .dot file in the current working directory, using the graph description language. The output file can e.g. be visualized with Graphviz.
|
DOTCOMPACT
Signature | DOTCOMPACT [boolean]
|
Default | false
|
Summary | Chooses a compact dot representation. |
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. This option can also be activated on command line via -u . Please note that, when turning this option on, your original files will not be backed up.
|
MAXSTAT
Signature | MAXSTAT [num]
|
Default | 30
|
Summary | Specifies the maximum number of index occurrences printed by the INFO INDEX command.
|
Changelog
- 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