Difference between revisions of "Options"
Line 7: | Line 7: | ||
Various ways exist to access and change options: | 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 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 [http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.html#options -D flag] on command line, or using [http://docs.oracle.com/javase/6/docs/api/java/lang/System.html#setProperty(java.lang.String,%20java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example: | * Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.html#options -D flag] on command line, or using [http://docs.oracle.com/javase/6/docs/api/java/lang/System.html#setProperty(java.lang.String,%20java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example: | ||
Line 291: | Line 291: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted. Write 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 | + | |Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted. Write 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 319: | Line 319: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Denotes the maximum allowed | + | |Denotes the maximum allowed number of parallel [[Transaction Management|transactions]].<br/>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. |
|} | |} | ||
Line 379: | Line 379: | ||
|- | |- | ||
| '''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. |
|} | |} | ||
Line 407: | Line 407: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the | + | |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. |
|} | |} | ||
Line 542: | Line 542: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is activated, and if new resources are added to a database, all files that are not filtered by the | + | |If this option is activated, and if new resources are added to a database, all files that are not filtered by the {{Option|CREATEFILTER}} option will be added as ''raw'' files (i.e., in their binary representation). |
|} | |} | ||
Line 628: | Line 628: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Many XML documents include whitespaces that have been added to improve readability. | + | |Many XML documents include whitespaces that have been added to improve readability. This option controls the [http://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 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>. | * The flag can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>. | ||
Line 682: | Line 682: | ||
|- | |- | ||
| '''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. |
|} | |} | ||
Line 696: | Line 696: | ||
|- | |- | ||
| '''Summary''' | | '''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 | + | |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}}). |
|} | |} | ||
Line 873: | Line 873: | ||
| '''Summary''' | | '''Summary''' | ||
|If turned on, incremental indexing will be enabled: | |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 | + | * 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())]]. |
* 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. | * 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]]. | * Find more details in the article on [[Index#Updates|Index Structures]]. | ||
Line 893: | Line 893: | ||
* As a result, the index structures will always be up-to-date. | * As a result, the index structures will always be up-to-date. | ||
* However, updates can take much longer, so this option should only be activated for medium-sized databases. | * However, updates can take much longer, so this option should only be activated for medium-sized databases. | ||
− | * The value of this option will be assigned once to a new database. It can be reassigned by running | + | * 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]]. |
|} | |} | ||
Line 937: | Line 937: | ||
|- | |- | ||
| '''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 [[ | + | |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. |
|} | |} | ||
Line 951: | Line 951: | ||
|- | |- | ||
| '''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 [[ | + | |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. |
|} | |} | ||
Line 965: | Line 965: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |If set to {{Code|true}}, diacritics will be preserved during full-text indexing. By default, diacritics will be removed. See [[ | + | |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. |
|} | |} | ||
Line 979: | Line 979: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |The specified language will influence the way how an input text will be tokenized. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages. See [[ | + | |The specified language will influence the way how an input text will be tokenized. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages. See [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
Line 993: | Line 993: | ||
|- | |- | ||
| '''Summary''' | | '''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 [[ | + | |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 [[Indexes#Full-Text Index|Full-Text Index]] for more details. |
|} | |} | ||
Line 1,124: | Line 1,124: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |If this option is turned on, paths specified in the | + | |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]]. |
|} | |} | ||
Line 1,138: | Line 1,138: | ||
|- | |- | ||
| '''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 1,168: | Line 1,168: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option. | + | |This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option. See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information on fuzzy querying. |
|} | |} | ||
Line 1,277: | Line 1,277: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Generates the query plan, which can be activated via | + | |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>. |
|} | |} | ||
Line 1,321: | Line 1,321: | ||
|- | |- | ||
| '''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. |
|} | |} | ||
Line 1,335: | Line 1,335: | ||
|- | |- | ||
| '''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 note that, when turning this option on, your original files will not be backed up. |
|} | |} | ||
Line 1,349: | Line 1,349: | ||
|- | |- | ||
| '''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. |
|} | |} | ||
Line 1,356: | Line 1,356: | ||
;Version 8.4 | ;Version 8.4 | ||
− | * Added: | + | * Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}} |
;Version 8.3 | ;Version 8.3 | ||
− | * Added: | + | * Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}} |
;Version 8.2 | ;Version 8.2 | ||
Line 1,368: | Line 1,368: | ||
;Version 8.1 | ;Version 8.1 | ||
− | * Added: | + | * Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}} |
;Version 8.0 | ;Version 8.0 | ||
− | * Added: | + | * Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}} |
− | * Updated: | + | * Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored. |
;Version 7.8.1 | ;Version 7.8.1 | ||
− | * Updated: | + | * 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. |
− | * Updated: default of | + | * Updated: default of {{Option|INTPARSE}} is now {{Code|false}}. |
− | * Removed: <code>HTMLOPT</code> (replaced with | + | * 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: | + | * Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}} |
;Version 7.6 | ;Version 7.6 | ||
− | * Added: | + | * Added: {{Option|GLOBALLOCK}} |
* Added: store local options in configuration file after {{Code|# Local Options}} comments. | * Added: store local options in configuration file after {{Code|# Local Options}} comments. | ||
Line 1,399: | Line 1,399: | ||
* 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 | ||
Line 1,405: | Line 1,405: | ||
;Version 7.3 | ;Version 7.3 | ||
− | * Updated: | + | * Updated: {{Option|KEEPALIVE}}, {{Option|TIMEOUT}}: default values changed |
* 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 | ||
Line 1,411: | Line 1,411: | ||
;Version 7.2 | ;Version 7.2 | ||
− | * Added: | + | * Added: {{Option|PROXYHOST}}, {{Option|PROXYPORT}}, {{Option|NONPROXYHOSTS}}, {{Option|HTMLOPT}} |
− | * Updated: | + | * Updated: {{Option|TIMEOUT}}: ignore timeout for admin users |
;Version 7.1 | ;Version 7.1 | ||
− | * Added: | + | * Added: {{Option|ADDRAW}}, {{Option|MAXLEN}}, {{Option|MAXCATS}}, {{Option|UPDINDEX}} |
− | * Updated: | + | * Updated: {{Option|BINDINGS}} |
;Version 7.0 | ;Version 7.0 | ||
− | * Added: | + | * Added: {{Option|SERVERHOST}}, {{Option|KEEPALIVE}}, {{Option|AUTOFLUSH}}, {{Option|QUERYPATH}} |
Revision as of 12:41, 23 January 2016
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 XQuery, local options can be set via option declarations and pragmas (see XQuery Extensions).
If options are implicitly 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. |
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. |
GLOBALLOCK
Signature | GLOBALLOCK [boolean]
|
Default | false
|
Summary | Controls if local (database) or global (process) locking will be used for managing read and write operations. The article on Transaction Management provides more details on concurrency control. |
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 or an HTTP service:
|
AUTHMETHOD
Signature | AUTHMETHOD [method]
|
Default | Basic |
Summary | Specifies the HTTP Authentication, which will be proposed by the HTTP server if a client sends an unauthorized request. Allowed values are Basic and Digest .
|
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 read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted. Write 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.
|
CACHERESTXQ
Signature | CACHERESTXQ
|
Default | false
|
Summary | Caches RESTXQ modules once when starting the web application. The option is helpful in productive environments with a high load, but files should not be replaced while the web server is running. |
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. The available options are listed in the CSV Module. |
JSONPARSER
Signature | JSONPARSER [options]
|
Default | empty |
Summary | Specifies the way how JSON data will be parsed. The available options are listed in the JSON Module. |
HTMLPARSER
Signature | HTMLPARSER [options]
|
Default | empty |
Summary | Specifies the way how HTML data will be parsed. Available options are listed in the Parsers article. |
TEXTPARSER
Signature | TEXTPARSER [options]
|
Default | empty |
Summary | Specifies the way how TEXT data will be parsed. Available options are listed in the Parsers article. |
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. The internal parser is faster, more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for parsing DTDs. |
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:
|
INDEXSPLITSIZE
Signature | INDEXSPLITSIZE [num]
|
Default | 0
|
Summary | This option affects the construction of new text and attribute indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied. By setting the value to its maximum (2147483647), the index will never be split. |
FTINDEXSPLITSIZE
Signature | FTINDEXSPLITSIZE [num]
|
Default | 0
|
Summary | This option affects the construction of new full-text indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied. By setting the value to its maximum (2147483647), the index will never be split. |
Full-Text
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 an input text will be tokenized. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages. 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 |
QUERYPATH
Signature | QUERYPATH [path]
|
Default | empty |
Summary | Contains the path (base URI) to the executed query (default: empty). This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a query. |
INLINELIMIT
Signature | INLINELIMIT
|
Default | 100
|
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. Function inlining can be turned off by setting the value to 0 . The limit can be locally overridden via the %basex:inline annotation.
|
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 | If this option is turned off, strings from external sources will be adopted as is, i. e., without being checked for valid XML characters:
|
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.4
- Added:
TOKENINDEX
,TOKENINCLUDE
- 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