Difference between revisions of "Options"
m (Text replace - "| width='90'" to "| width='120'") |
|||
Line 39: | Line 39: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|DBPATH [path]}} | |{{Code|DBPATH [path]}} | ||
|- | |- | ||
Line 52: | Line 52: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|REPOPATH [path]}} | |{{Code|REPOPATH [path]}} | ||
|- | |- | ||
Line 65: | Line 65: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|DEBUG [boolean]}} | |{{Code|DEBUG [boolean]}} | ||
|- | |- | ||
Line 78: | Line 78: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|LANG [language]}} | |{{Code|LANG [language]}} | ||
|- | |- | ||
Line 91: | Line 91: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|LANGKEY [boolean]}} | |{{Code|LANGKEY [boolean]}} | ||
|- | |- | ||
Line 105: | Line 105: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|GLOBALLOCK [boolean]}} | |{{Code|GLOBALLOCK [boolean]}} | ||
|- | |- | ||
Line 120: | Line 120: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|HOST [host]}} | |{{Code|HOST [host]}} | ||
|- | |- | ||
Line 133: | Line 133: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|PORT [port]}} | |{{Code|PORT [port]}} | ||
|- | |- | ||
Line 146: | Line 146: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|SERVERPORT [port]}} | |{{Code|SERVERPORT [port]}} | ||
|- | |- | ||
Line 159: | Line 159: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|EVENTPORT [port]}} | |{{Code|EVENTPORT [port]}} | ||
|- | |- | ||
Line 172: | Line 172: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|USER [name]}} | |{{Code|USER [name]}} | ||
|- | |- | ||
Line 188: | Line 188: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|PASSWORD [password]}} | |{{Code|PASSWORD [password]}} | ||
|- | |- | ||
Line 205: | Line 205: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|SERVERHOST [host|ip]}} | |{{Code|SERVERHOST [host|ip]}} | ||
|- | |- | ||
Line 218: | Line 218: | ||
{| width='100%' width='100%' | {| width='100%' width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|PROXYHOST [host]}} | |{{Code|PROXYHOST [host]}} | ||
|- | |- | ||
Line 231: | Line 231: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|PROXYPORT [port]}} | |{{Code|PROXYPORT [port]}} | ||
|- | |- | ||
Line 244: | Line 244: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|NONPROXYHOSTS [hosts]}} | |{{Code|NONPROXYHOSTS [hosts]}} | ||
|- | |- | ||
Line 257: | Line 257: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|TIMEOUT [seconds]}} | |{{Code|TIMEOUT [seconds]}} | ||
|- | |- | ||
Line 270: | Line 270: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|KEEPALIVE [seconds]}} | |{{Code|KEEPALIVE [seconds]}} | ||
|- | |- | ||
Line 283: | Line 283: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|PARALLEL [number]}} | |{{Code|PARALLEL [number]}} | ||
|- | |- | ||
Line 296: | Line 296: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|LOG [boolean]}} | |{{Code|LOG [boolean]}} | ||
|- | |- | ||
Line 309: | Line 309: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|LOGMSGMAXLEN [length]}} | |{{Code|LOGMSGMAXLEN [length]}} | ||
|- | |- | ||
Line 326: | Line 326: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|WEBPATH [path]}} | |{{Code|WEBPATH [path]}} | ||
|- | |- | ||
Line 339: | Line 339: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|RESTXQPATH [path]}} | |{{Code|RESTXQPATH [path]}} | ||
|- | |- | ||
Line 352: | Line 352: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|HTTPLOCAL [boolean]}} | |{{Code|HTTPLOCAL [boolean]}} | ||
|- | |- | ||
Line 365: | Line 365: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|STOPPORT [port]}} | |{{Code|STOPPORT [port]}} | ||
|- | |- | ||
Line 385: | Line 385: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|MAINMEM [boolean]}} | |{{Code|MAINMEM [boolean]}} | ||
|- | |- | ||
Line 401: | Line 401: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|ADDCACHE [boolean]}} | |{{Code|ADDCACHE [boolean]}} | ||
|- | |- | ||
Line 416: | Line 416: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|CREATEFILTER [filter]}} | |{{Code|CREATEFILTER [filter]}} | ||
|- | |- | ||
Line 429: | Line 429: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|ADDARCHIVES [boolean]}} | |{{Code|ADDARCHIVES [boolean]}} | ||
|- | |- | ||
Line 442: | Line 442: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|SKIPCORRUPT [boolean]}} | |{{Code|SKIPCORRUPT [boolean]}} | ||
|- | |- | ||
Line 455: | Line 455: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|ADDRAW [boolean]}} | |{{Code|ADDRAW [boolean]}} | ||
|- | |- | ||
Line 468: | Line 468: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|PARSER [type]}} | |{{Code|PARSER [type]}} | ||
|- | |- | ||
Line 481: | Line 481: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|PARSEROPT [options]}} | |{{Code|PARSEROPT [options]}} | ||
|- | |- | ||
Line 494: | Line 494: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|HTMLOPT [options]}} | |{{Code|HTMLOPT [options]}} | ||
|- | |- | ||
Line 509: | Line 509: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|CHOP [boolean]}} | |{{Code|CHOP [boolean]}} | ||
|- | |- | ||
Line 522: | Line 522: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|INTPARSE [boolean]}} | |{{Code|INTPARSE [boolean]}} | ||
|- | |- | ||
Line 535: | Line 535: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|DTD [boolean]}} | |{{Code|DTD [boolean]}} | ||
|- | |- | ||
Line 548: | Line 548: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|CATFILE [path]}} | |{{Code|CATFILE [path]}} | ||
|- | |- | ||
Line 565: | Line 565: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|TEXTINDEX [boolean]}} | |{{Code|TEXTINDEX [boolean]}} | ||
|- | |- | ||
Line 578: | Line 578: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|ATTRINDEX [boolean]}} | |{{Code|ATTRINDEX [boolean]}} | ||
|- | |- | ||
Line 591: | Line 591: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|FTINDEX [boolean]}} | |{{Code|FTINDEX [boolean]}} | ||
|- | |- | ||
Line 604: | Line 604: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|MAXLEN [int]}} | |{{Code|MAXLEN [int]}} | ||
|- | |- | ||
Line 617: | Line 617: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|MAXCATS [int]}} | |{{Code|MAXCATS [int]}} | ||
|- | |- | ||
Line 630: | Line 630: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|UPDINDEX [boolean]}} | |{{Code|UPDINDEX [boolean]}} | ||
|- | |- | ||
Line 650: | Line 650: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|INDEXSPLITSIZE [num]}} | |{{Code|INDEXSPLITSIZE [num]}} | ||
|- | |- | ||
Line 666: | Line 666: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|FTINDEXSPLITSIZE [num]}} | |{{Code|FTINDEXSPLITSIZE [num]}} | ||
|- | |- | ||
Line 681: | Line 681: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|STEMMING [boolean]}} | |{{Code|STEMMING [boolean]}} | ||
|- | |- | ||
Line 694: | Line 694: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|CASESENS [boolean]}} | |{{Code|CASESENS [boolean]}} | ||
|- | |- | ||
Line 707: | Line 707: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|DIACRITICS [boolean]}} | |{{Code|DIACRITICS [boolean]}} | ||
|- | |- | ||
Line 720: | Line 720: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|LANGUAGE [lang]}} | |{{Code|LANGUAGE [lang]}} | ||
|- | |- | ||
Line 733: | Line 733: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|STOPWORDS [path]}} | |{{Code|STOPWORDS [path]}} | ||
|- | |- | ||
Line 748: | Line 748: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|QUERYINFO [boolean]}} | |{{Code|QUERYINFO [boolean]}} | ||
|- | |- | ||
Line 761: | Line 761: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|XQUERY3}} | |{{Code|XQUERY3}} | ||
|- | |- | ||
Line 774: | Line 774: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|BINDINGS [vars]}} | |{{Code|BINDINGS [vars]}} | ||
|- | |- | ||
Line 795: | Line 795: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|QUERYPATH [path]}} | |{{Code|QUERYPATH [path]}} | ||
|- | |- | ||
Line 808: | Line 808: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|CACHEQUERY [boolean]}} | |{{Code|CACHEQUERY [boolean]}} | ||
|- | |- | ||
Line 821: | Line 821: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|FORCECREATE [boolean]}} | |{{Code|FORCECREATE [boolean]}} | ||
|- | |- | ||
Line 836: | Line 836: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|CHECKSTRINGS [boolean]}} | |{{Code|CHECKSTRINGS [boolean]}} | ||
|- | |- | ||
Line 851: | Line 851: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|LSERROR [error]}} | |{{Code|LSERROR [error]}} | ||
|- | |- | ||
Line 864: | Line 864: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|RUNS [num]}} | |{{Code|RUNS [num]}} | ||
|- | |- | ||
Line 879: | Line 879: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|SERIALIZE [boolean]}} | |{{Code|SERIALIZE [boolean]}} | ||
|- | |- | ||
Line 892: | Line 892: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|SERIALIZER [params]}} | |{{Code|SERIALIZER [params]}} | ||
|- | |- | ||
Line 911: | Line 911: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|EXPORTER [params]}} | |{{Code|EXPORTER [params]}} | ||
|- | |- | ||
Line 924: | Line 924: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|XMLPLAN [boolean]}} | |{{Code|XMLPLAN [boolean]}} | ||
|- | |- | ||
Line 937: | Line 937: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|COMPPLAN [boolean]}} | |{{Code|COMPPLAN [boolean]}} | ||
|- | |- | ||
Line 950: | Line 950: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|DOTPLAN [boolean]}} | |{{Code|DOTPLAN [boolean]}} | ||
|- | |- | ||
Line 963: | Line 963: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|DOTCOMPACT [boolean]}} | |{{Code|DOTCOMPACT [boolean]}} | ||
|- | |- | ||
Line 976: | Line 976: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|DOTDISPLAY [boolean]}} | |{{Code|DOTDISPLAY [boolean]}} | ||
|- | |- | ||
Line 989: | Line 989: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|DOTTY [path]}} | |{{Code|DOTTY [path]}} | ||
|- | |- | ||
Line 1,004: | Line 1,004: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|AUTOFLUSH [boolean]}} | |{{Code|AUTOFLUSH [boolean]}} | ||
|- | |- | ||
Line 1,017: | Line 1,017: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|WRITEBACK [boolean]}} | |{{Code|WRITEBACK [boolean]}} | ||
|- | |- | ||
Line 1,030: | Line 1,030: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signature''' |
|{{Code|MAXSTAT [num]}} | |{{Code|MAXSTAT [num]}} | ||
|- | |- |
Revision as of 14:08, 15 June 2013
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 is used to store options to disk:
- Global options can only be set via the configuration file or system properties (see below).
- Local options can also be specified in the configuration file after the
# Local Options
comment.
Various ways exist to access and change options:
- The current value of an option can be requested with the GET and changed with the SET command. 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 existing value will be inverted.
- Initial values for 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 needs to be prefixed with
org.basex.
. An example:
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop" CHOP: false
- Options can also be set in the prolog of an XQuery expression. In the option declaration, options need to be bound to the Database Module namespace. All values will be reset after the evaluation of a query:
declare option db:chop 'false'; ...
(# db:chop false #) { parse-xml('<xml> hi </xml>') }
If options are implicitly changed by operations in the GUI, the underlying commands will be listed in the Info View.
Contents
Global Options
General
DBPATH
Signature | DBPATH [path]
|
Default | {home}/BaseXData or {home}/data
|
Summary | Points to the directory in which all databases are located. Note: this option can only be changed if no database is currently opened. |
REPOPATH
Signature | REPOPATH [path]
|
Default | {home}/BaseXRepo
|
Summary | Points to the Repository, in which all XQuery modules are located. |
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 .
|
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 .
|
EVENTPORT
Signature | EVENTPORT [port]
|
Default | 1985
|
Summary | This port is used by the client to listen for server events. It will only be bound if a client attaches itself to a database event. This option can also be changed when running the server on command line via -e .
|
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:
|
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. |
PROXYPORT
Signature | PROXYPORT [port]
|
Default | 80
|
Summary | This is the port number of a proxy server. |
NONPROXYHOSTS
Signature | NONPROXYHOSTS [hosts]
|
Default | empty |
Summary | This is a list of hosts that should be directly accessed. |
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 ADMIN operations.
|
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 read 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. |
HTTP Options
If BaseX is run as Web Application, the HTTP options are either determined by the web server, or 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. |
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. |
HTTPLOCAL
Signature | HTTPLOCAL [boolean]
|
Default | false
|
Summary | By default, a database server instance will be opened along with the web server. If the flag is set to true , all commands will be executed in an embedded database context.If BaseX is run as Web Application, and if the flag is false , the server will be started as soon as the first HTTP service is called.
|
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, documents that are added via ADD will first be cached to disk before being added to the final database. This option is helpful when larger documents are to be imported, and if the existing heuristics cannot estimate the size of the input (e.g. when adding directories). |
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, DOCX, etc.) are parsed whenever new database are created or resources are added to a database.
|
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. |
PARSEROPT
Signature | PARSEROPT [options]
|
Default | empty |
Summary | Defines parser-specific options; see Parsers for more information. |
HTMLOPT
Signature | HTMLOPT [options]
|
Default | empty |
Summary | Allows to specify TagSoup options for HTML parsing; see HTML Parser for more information. |
XML Parsing
CHOP
Signature | CHOP [boolean]
|
Default | true
|
Summary | Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. By default, this option is set to true , as it often reduces the database size by up to 50%. It can also be turned off on command line via -w .
|
INTPARSE
Signature | INTPARSE [boolean]
|
Default | true
|
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.
|
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 current index and full-text index options will be stored in a new database, and take effect if indexes are rebuilt via the OPTIMIZE.
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 Indexes 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 Indexes 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 Indexes 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 activated:
|
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. |
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. |
Full-Text
STEMMING
Signature | STEMMING [boolean]
|
Default | false
|
Summary | A new full-text index will stem all tokens and speed up queries on stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this index. |
CASESENS
Signature | CASESENS [boolean]
|
Default | false
|
Summary | A new full-text index will preserve the case of all tokens. The same case normalization will be applied to all query tokens that are checked against tokens in this index. |
DIACRITICS
Signature | DIACRITICS [boolean]
|
Default | false
|
Summary | A new full-text index will preserve the diacritics of all tokens. The same diacritics normalization will be applied to all query tokens that are checked against tokens in this index. |
LANGUAGE
Signature | LANGUAGE [lang]
|
Default | en
|
Summary | A new full-text index will use the given language to normalize all tokens. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages. |
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. A standard stopword list for English texts is provided in the directory etc/stopwords.txt in the official releases.
|
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.
|
BINDINGS
Signature | BINDINGS [vars]
|
Default | empty |
Summary | Contains external variables to be bound to a query:
|
Examples | $a=1,$b=2 binds the values 1 and 2 to the variables $a and $ba=1,,2 binds the value 1,2 to the variable $a{URI}a=x binds the value x to the variable $a with the namespace URI .
|
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. |
CACHEQUERY
Signature | CACHEQUERY [boolean]
|
Default | false
|
Summary | Caches the query results before returning them to the client. This option may be set to true if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX).
|
FORCECREATE
Signature | FORCECREATE [boolean]
|
Default | false
|
Summary | By activating this option, the XQuery doc() and collection() functions will create database instances for the addressed input files.
|
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. |
RUNS
Signature | RUNS [num]
|
Default | 1
|
Summary | Specify number of runs a query is executed by the XQUERY command. The result is only serialized once, and the measured times are averages of all runs. |
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 | Contains parameters for serializing query results:
|
Example | encoding=US-ASCII,omit-xml-declaration=no : sets the encoding to US-ASCII and prints the XML declaration.
|
EXPORTER
Signature | EXPORTER [params]
|
Default | empty |
Summary | Contains parameters for exporting all resources of a database; see Serialization for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas. |
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 | Creates the query plan before or after the compilation step. Query plans might change due to optimizations. |
DOTPLAN
Signature | DOTPLAN [boolean]
|
Default | false
|
Summary | Visualizes the execution plan of an XQuery expression with dotty and saves its dot file in the query directory. |
DOTCOMPACT
Signature | DOTCOMPACT [boolean]
|
Default | false
|
Summary | Chooses a compact dot representation. |
DOTDISPLAY
Signature | DOTDISPLAY [boolean]
|
Default | true
|
Summary | Visualizes the dot representation after the query execution. |
DOTTY
Signature | DOTTY [path]
|
Default | dotty
|
Summary | Location of the dotty executable.
|
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 | Updates on XML nodes are written back to the input files. No backups of your original files will be created if this option is turned on. This option can also be activated on command line via -u .
|
MAXSTAT
Signature | MAXSTAT [num]
|
Default | 30
|
Summary | Specifies the maximum number of index occurrences printed by the INFO INDEX command.
|
Changelog
- 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