Options

From BaseX Documentation

Jump to: navigation, search

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:

java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
CHOP: false
<key>JVMOptions</key>
<array>
  <string>-Dorg.basex.CHOP=false</string>
</array>
<context-param>
  <param-name>org.basex.chop</param-name>
  <param-value>false</param-value>
</context-param>

If options are changed by operations in the GUI, the underlying commands will be listed in the Info View.

Contents

[edit] 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.

[edit] General Options

[edit] 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.

[edit] DBPATH

Signature DBPATH [path]
Default {home}/BaseXData or {home}/data
Summary Points to the directory in which all databases are located.

[edit] LOGPATH

Updated with Version 8.5:

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.

[edit] REPOPATH

Signature REPOPATH [path]
Default {home}/BaseXRepo
Summary Points to the Repository, in which all XQuery modules are located.

[edit] LANG

Signature LANG [language]
Default English
Summary Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.

[edit] 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.

[edit] 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.

[edit] CACHETIMEOUT

Introduced with Version 8.5:

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.

[edit] Client/Server Architecture

[edit] 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.

[edit] 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.

[edit] 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.

[edit] USER

Signature USER [name]
Default empty
Summary Represents a user name, which is used for accessing the server or an HTTP service:
  • 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.
  • The option can also be changed on command line via -U.

[edit] PASSWORD

Signature PASSWORD [password]
Default empty
Summary Represents a password, which is used for accessing the server or an HTTP service:
  • 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.
  • The option can also be changed on command line via -P.
  • Please note that it is a security risk to specify your password in plain text.

[edit] AUTHMETHOD

Updated with Version 8.5: custom value added.

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:
  • If basic access is chosen, the client can still request digest authentication.
  • This is different for digest access, which cannot be overwritten.
  • With custom authentication, the server will not do any authentication.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] LOGMSGMAXLEN

Signature LOGMSGMAXLEN [length]
Default 1000
Summary Specifies the maximum length of a single log message.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] CACHERESTXQ

Signature CACHERESTXQ
Default false
Summary Disables the timestamp check when parsing RESTXQ files. See RESTXQ Preliminaries for more details.

[edit] 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.

[edit] 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.

[edit] STOPPORT

Signature STOPPORT [port]
Default 8985
Summary This is the port on which the HTTP Server can be locally closed:
  • The listener for stopping the web server will only be started if the specified value is greater than 0.
  • The option is ignored if BaseX is used as a Web Application or started via Maven.
  • This option can also be changed when running the HTTP server on command line via -s.

[edit] Create Options

[edit] General

[edit] 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.

[edit] 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).

[edit] Parsing

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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).

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] XML Parsing

[edit] 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:
  • With the default value 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 mixed content.
  • The flag can also be turned off on command line via -w.
  • If the xml:space="preserve" attribute is attached to an element, chopping will be turned off for all descendant text nodes. In the following example document, the whitespaces in the text nodes of the text element will not be chopped:
<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>

[edit] STRIPNS

Signature STRIPNS [boolean]
Default false
Summary Strips all namespaces from an XML document and all elements while parsing.

[edit] 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:
  • Performance: Documents (in particular small ones) will be parsed faster
  • Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character FFFD (�)
  • 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.

[edit] 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.

[edit] 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).

[edit] CATFILE

Signature CATFILE [path]
Default empty
Summary Specifies a catalog file to locally resolve DTDs. See the entry on Catalog Resolvers for more details.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] UPDINDEX

Signature UPDINDEX [boolean]
Default false
Summary 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 OPTIMIZE with the ALL keyword or 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.
  • Find more details in the article on Index Structures.

[edit] AUTOOPTIMIZE

Signature AUTOOPTIMIZE [boolean]
Default false
Summary If turned on, auto optimization will be applied to new databases:
  • With each update, outdated indexes and database statistics will be recreated.
  • As a result, the index structures will always be up-to-date.
  • However, updates can take much longer, so this option should only be activated for medium-sized databases.
  • The value of this option will be assigned once to a new database. It can be reassigned by running OPTIMIZE or db:optimize.

[edit] 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:
  • The larger the assigned value is, the less splits will take place, and the more main memory will be required.
  • By default, if the value is set to 0, some heuristics are applied, based on the current memory consumption.

[edit] Full-Text Indexing

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] Query Options

[edit] 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.

[edit] 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.

[edit] 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.

[edit] BINDINGS

Signature BINDINGS [vars]
Default empty
Summary Contains external variables to be bound to a query. The string must comply with the following rules:
  • Variable names and values must be separated by equality signs.
  • Multiple variables must be delimited by commas.
  • Commas in values must be duplicated.
  • Variables may optionally be introduced with a leading dollar sign.
  • If a variable uses a namespace different to the default namespace, it can be specified with the Clark Notation or Expanded QName Notation.

This option can also be used on command line with the flag -b.

Examples
  • $a=1,$b=2   binds the values 1 and 2 to the variables $a and $b
  • a=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.
  • In the following Command Script, the value hello world! is bound to the variable $GREETING:
SET BINDINGS GREETING="hello world!"
XQUERY declare variable $GREETING external; $GREETING

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] Serialization Options

[edit] 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.

[edit] SERIALIZER

Signature SERIALIZER [params]
Default empty
Summary Parameters for serializing query results. The string must comply with the following rules:
  • Variable names and values must be separated by equality signs.
  • Multiple variables must be delimited by commas.
  • Commas in values must be duplicated.

The option can also be used on command line with the flag -s.

Examples
  • encoding=US-ASCII,omit-xml-declaration=no : sets the encoding to US-ASCII and prints the XML declaration.
  • item-separator=,, : separates serialized items by a single comma.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] DOTCOMPACT

Signature DOTCOMPACT [boolean]
Default false
Summary Chooses a compact dot representation.

[edit] Other Options

[edit] 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.

[edit] 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.

[edit] MAXSTAT

Signature MAXSTAT [num]
Default 30
Summary Specifies the maximum number of index occurrences printed by the INFO INDEX command.

[edit] Changelog

Version 8.6
Version 8.5
Version 8.4
Version 8.3
Version 8.2
Version 8.1
Version 8.0
Version 7.8.1
Version 7.8
Version 7.7
Version 7.6
Version 7.5
Version 7.3
Version 7.2
Version 7.1
Version 7.0
Personal tools
Namespaces
Variants
Actions
Navigation
Print/export