Options

From BaseX Documentation
Jump to navigation Jump to 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. Two kinds of options exist:

  • Global Options are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/server architecture.
  • Local options (all remaining ones) are specific to a client or session.

Values of options are either strings, numbers or booleans. Options are static and not bound to a single operation (for example, the next command). Various ways exist to access and change options:

  • The current value of an option can be requested with the SHOW OPTIONS command. Local options can be changed via SET (all global options, except for DEBUG, can only be changed at startup time). If an option is of type boolean, and if no value is specified, its current value will be inverted.
  • The .basex configuration file is parsed by every new local BaseX instance. It contains all global options. Local options can be specified at the end of the file after the Local Options comment:
# General Options
DEBUG = false
...

# Local Options
CATALOG = etc/w3-catalog.xml
  • Initial values for global options can also be specified via system properties, which can be passed on with the -D flag on the command line, or with System.setProperty() before creating a BaseX instance. The specified keys need to be prefixed with org.basex.. An example:
java -Dorg.basex.CATALOG=etc/w3-catalog.xml -cp basex.jar org.basex.BaseX -c"SHOW OPTIONS catalog"
CATALOG: etc/w3-catalog.xml
  • If the Mac OS X packaged application is used, 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.CATALOG=etc/w3-catalog.xml</string>
</array>
  • In a Web Application, the default can be adjusted in the web.xml file as follows:
<context-param>
  <param-name>org.basex.catalog</param-name>
  <param-value>etc/w3-catalog.xml</param-value>
</context-param>
  • In XQuery, local options can be set via option declarations and pragmas.

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

Contents

Global Options[edit]

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

DEBUG[edit]

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

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

LOGPATH[edit]

Signature LOGPATH [path]
Default .logs
Summary Points to the directory in which all log files are stored. Relative paths will be resolved against the DBPATH directory.

REPOPATH[edit]

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

LANG[edit]

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

FAIRLOCK[edit]

Signature FAIRLOCK [boolean]
Default false
Summary Defines the locking strategy:
  • By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the limit of parallel transactions (specified via PARALLEL) has been reached. This prevents update operations from blocking all other requests. For example, the DBA can further be used to see which jobs are running, even if the queue is full.
  • If fair locking is enabled, read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it should be used if the prompt evaluation of update operations is critical.

CACHETIMEOUT[edit]

Signature CACHETIMEOUT [seconds]
Default 3600
Summary Specifies how many seconds the results of queries, which have been queued by the asynchronously executed, will be cached in main memory.

Client/Server Architecture[edit]

HOST[edit]

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

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

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

Signature USER [name]
Default empty
Summary Represents a username, 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.

PASSWORD[edit]

Signature PASSWORD [password]
Default empty
Summary Represents a password, which is used for accessing the server:
  • The default value will be overwritten if a client specifies its own credentials.
  • If the default value is empty, authentication will only be possible if the client supplies 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.

AUTHMETHOD[edit]

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.

SERVERHOST[edit]

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

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

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

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

Updated with Version 10: Additionally disable hostname verification.

Signature IGNORECERT [boolean]
Default false
Summary Disable SSL hostname verification and ignore untrusted certificates when connecting to servers.

TIMEOUT[edit]

Signature TIMEOUT [seconds]
Default 30
Summary Specifies the maximum time a transaction triggered by a client may take. If an operation takes longer than the specified number of seconds, it will be aborted. Active update operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to 0. It is ignored for operations with admin permissions.

KEEPALIVE[edit]

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

Signature PARALLEL [number]
Default 8
Summary Denotes the maximum allowed number of parallel transactions:
  • If FAIRLOCK is enabled, the number of parallel transactions will never exceed the specified value.
  • If the option is disabled (which is the default), the limit only applies to transactions that access databases.
  • The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.

LOG[edit]

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

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

LOGTRACE[edit]

Signature LOGTRACE [boolean]
Default true
Summary If BaseX is running as Web Application, trace output (generated via fn:trace, prof:dump and similar functions) is written to the database logs. If this option is disabled, trace output will be redirected to standard error, as it is known from the standalone version of BaseX.

HTTP Services[edit]

Most HTTP options are defined in the jetty.xml and web.xml configuration files in the webapp/WEB-INF directory. Some additional BaseX-specific options exist that will be set before the web server is started:

WEBPATH[edit]

Signature WEBPATH [path]
Default {home}/webapp
Summary Points to the directory in which all the Web Application contents are stored, including XQuery, Script, RESTXQ and configuration files:
  • The option is ignored if BaseX is deployed as web servlet.
  • It cannot be assigned via the web.xml file, as it will be evaluated before the configuration files are parsed.

GZIP[edit]

Signature GZIP [boolean]
Default false
Summary Jetty provides a Gzip handler for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the BaseX HTTP Server:
  • The option can also be enabled on command line via -g.
  • It cannot be assigned via the web.xml file, as it will be evaluated before the configuration files are parsed.
  • In addition to the Jetty defaults (GET requests, exclusion of binaries, MSIE 6.0, etc.), POST and PUT requests are supported.

RESTXQPATH[edit]

Signature RESTXQPATH [path]
Default empty
Summary Points to the directory which contains the RESTXQ modules of a web application. Relative paths will be resolved against the WEBPATH directory.

PARSERESTXQ[edit]

Signature PARSERESTXQ
Default 3
Summary Timeout after which the RESTXQ directory will be parsed for changes:
  • If 0 is specified, the directory will be parsed every time a RESTXQ function is called.
  • A positive value defines the idle time in seconds after which parsing will be enforced. The default value is 3: Changes in the RESTXQ directory will be detected after 3 seconds without RESTXQ function calls.
  • Monitoring is completely disabled if a negative value is specified.

See RESTXQ Preliminaries for more details.

RESTXQERRORS[edit]

Signature RESTXQERRORS
Default true
Summary Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in the database logs). See RESTXQ Error Handling for more details.

RESTPATH[edit]

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

Signature HTTPLOCAL [boolean]
Default false
Summary By default, if BaseX is run as Web Application, the database server instance will be started in addition, which can then be addressed by Clients via the database port (see PORT). If the option is set to true, no database server will be launched.

STOPPORT[edit]

Signature STOPPORT [port]
Default 8081
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.

Create Options[edit]

General[edit]

MAINMEM[edit]

Signature MAINMEM [boolean]
Default false
Summary If this option is turned on, new databases will be created in main memory:
  • Most queries will be evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down.
  • It is not possible to store binary resources in a main-memory database.
  • A main-memory database will have no disk representation. However, it is possible to export the database via the EXPORT command, and create a new database from the exported file in a second step.
  • This option will not be available for db:create, because the database would not be accessible anymore after database creation, i. e., outside the query scope.

ADDCACHE[edit]

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

CREATEFILTER[edit]

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

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

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

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

Signature ADDRAW [boolean]
Default false
Summary If this option is enabled, all resources that are filtered out by the CREATEFILTER option while being added to a database will be stored as raw files instead (i.e., in their binary representation).

PARSER[edit]

Signature PARSER [type]
Default XML
Summary Defines a parser for importing new files to the database. Available parsers are XML, JSON, CSV, TEXT, HTML, and RAW. HTML input will be parsed as XML documents if Tagsoup is not found in the classpath.

CSVPARSER[edit]

Signature CSVPARSER [options]
Default empty
Summary Specifies the way how CSV data will be parsed. Keys and values are delimited with =, and multiple options are delimited with ,. The available options (except for the additional encoding option) are described in the CSV Module.
Examples encoding=CP1252,header=true parses the input as CP1252 and the first line as header.

JSONPARSER[edit]

Signature JSONPARSER [options]
Default empty
Summary Specifies the way how JSON data will be parsed. Keys and values are delimited with =, and multiple options are delimited with ,. The available options (except for the additional encoding option) are described in the JSON Module.
Examples format=jsonml,lax=yes interprets the input as JSONML and uses lax parsing.

HTMLPARSER[edit]

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.
  • lexical=true preserves comments.

TEXTPARSER[edit]

Signature TEXTPARSER [options]
Default empty
Summary Specifies the way how TEXT data will be parsed. Keys and values are delimited with =, and multiple options are delimited with ,. The available options are listed in the Parsers article.
Examples lines=true creates a single element for each line of text.

XML Parsing[edit]

STRIPWS[edit]

Updated with Version 10: Renamed (before: CHOP), new default: false.

Signature STRIPWS [boolean]
Default false
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:
  • If the option is set to true, leading and trailing whitespaces from text nodes will be stripped, and empty text nodes will be discarded.
  • The flag should be disabled if a document contains mixed content.
  • The flag can also be turned on via the command line and -w.
  • If the option is enabled, whitespaces of an element and its descendants can locally be preserved with the xml:space="preserve" attribute:
<xml>
  <title>
    Demonstrating the STRIPWS flag
  </title>
  <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text>
</xml>

If whitespaces are stripped, indent=yes can be assigned to the SERIALIZER option to get properly indented XML output.

STRIPNS[edit]

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

INTPARSE[edit]

Signature INTPARSE [boolean]
Default false
Summary Uses the internal XML parser instead of the standard Java XML parser. Reasons for using the internal parser are:
  • Performance: Documents, in particular small ones, are parsed faster.
  • Entity support: More than 2000 HTML character references are decoded.
  • Fault tolerance: Invalid characters are replaced with the Unicode replacement character FFFD (�).

By default, Java’s Xerces parser is used as it supports all features of the XML standard, including XINCLUDE, or recursive entity expansion if specified in DTDs.

DTD[edit]

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 CATALOG option can be changed to locally resolve DTDs.

XINCLUDE[edit]

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).

CATALOG[edit]

Updated with Version 10: Renamed from CATFILE.

Signature CATALOG [path]
Default empty
Summary Semicolon-separated list of XML catalog files to resolve URIs. See Catalog Resolvers for more details.

Indexing[edit]

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

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

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

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

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

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

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

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

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

Signature MAXLEN [int]
Default 96
Summary Specifies the maximum length for strings to be stored in index structures. The value of this option will be assigned once to a new database, and can only be changed by creating a new database or doing a full optimization.

MAXCATS[edit]

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

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 and true() as second argument.
  • 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.

AUTOOPTIMIZE[edit]

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.

SPLITSIZE[edit]

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:
  • By default, if the value is set to 0, some heuristics are applied, based on the current memory consumption. Usually, this works fine.
  • If explicit garbage collection is disabled when running Java (e.g. via the JVM option -XX:+DisableExplicitGC), you may need to choose a custom split size.
  • You can e. g. start with 1000000 (one million) index operations and adjust this value in the next steps.
  • The larger the assigned value is, the less splits will take place, and the more main memory will be required.

Full-Text Indexing[edit]

STEMMING[edit]

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

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

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

Signature LANGUAGE [lang]
Default en
Summary The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See Full-Text Index for more details.

STOPWORDS[edit]

Signature STOPWORDS [path]
Default empty
Summary If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index is created. A stopword list may decrease the size of the full text index and speed up your queries. See Full-Text Index for more details.

Query Options[edit]

QUERYINFO[edit]

Signature QUERYINFO [boolean]
Default false
Summary Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the Info View in the GUI. It can also be activated on command line via -V.

MIXUPDATES[edit]

Signature MIXUPDATES
Default false
Summary Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to false. See Returning Results for more details.

BINDINGS[edit]

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

INLINELIMIT[edit]

Signature INLINELIMIT
Default 50
Summary This option controls inlining of XQuery functions:
  • The XQuery compiler inlines functions to speed up query evaluation.
  • Inlining will only take place if a function body is not too large (i.e., if it does not contain too many expressions).
  • With this option, this maximum number of expressions can be specified.
  • Function inlining can be turned off by setting the value to 0.
  • The limit can be locally overwritten via the %basex:inline annotation (follow the link to get more information on function inlining).

UNROLLLIMIT[edit]

Signature UNROLLLIMIT
Default 5
Summary This option controls the unroll limit:
  • Loops with few iterations are unrolled by the XQuery compiler to enable further optimizations.
  • If the limit is increased, more optimizations will take place, but the memory consumption and compile time will increase.
  • See Loop Unrolling for more details.

ENFORCEINDEX[edit]

Signature ENFORCEINDEX [boolean]
Default false
Summary Enforces index rewritings in path expressions. See Enforce Rewritings for details.

COPYNODE[edit]

Signature COPYNODE [boolean]
Default true
Summary When creating new nodes in XQuery via Node Constructors, copies of all enclosed nodes will be created, and the copied nodes get new node identities. As a result, the following query yields false: 
let $a := <a/>
let $b := <b>{ $a }</b>
return $b/a is $a

This step can be expensive and memory consuming. If the option is disabled, child nodes will only be linked to the new parent nodes, and the upper query returns true.
The option should be used carefully as it changes the semantics of XQuery. It should preferably be used in Pragmas.

TAILCALLS[edit]

Signature TAILCALLS
Default 256
Summary Specifies how many stack frames of tail-calls are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to -1.

WITHDB[edit]

Signature WITHDB
Default true
Summary By default, resources specified via fn:doc and fn:collection are looked up both in the database and in the file system. If you always use db:get to access databases, it is recommendable to disable this option:
  • No locks will be created for the two functions (see limitations of database locking for more details).
  • Access to local and external resources will be faster, as the database lookup will be skipped.

DEFAULTDB[edit]

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

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

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, and archive:update.

WRAPJAVA[edit]

Signature WRAPJAVA [mode]
Default some
Summary Defines the way how values that result from Java code invocation will be converted to XQuery items. Allowed values: none, all, some, instance, and void. See Java Bindings for further details.

LSERROR[edit]

Signature LSERROR [error]
Default 0
Summary This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if 0 is assigned, the error value is calculated dynamically. See Fuzzy Querying for more details.

RUNQUERY[edit]

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

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

SERIALIZE[edit]

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

Signature SERIALIZER [params]
Default empty
Summary Parameters for serializing query results:
  • Variable names and values are separated by equality signs.
  • Multiple variables are delimited by commas.
  • Commas must be duplicated if they appear as literals in values.

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

Examples
  • indent=yes : enables automatic indentation of XML nodes. This is recommended if whitespaces have been stripped from a document (see Template:Options).
  • 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.

EXPORTER[edit]

Signature EXPORTER [params]
Default empty
Summary Contains parameters for exporting resources of a database and writing files after updates via the WRITEBACK option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See Serialization for more details.
Examples
  • indent=no,omit-xml-declaration=no : disables automatic indentation of XML nodes, outputs the XML declaration.

XMLPLAN[edit]

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.

FULLPLAN[edit]

Signature FULLPLAN [boolean]
Default false
Summary Attaches the file path, line and column of the expressions in the original query string to the query plan. Values (items and sequences) have no input information attached.

Other Options[edit]

AUTOFLUSH[edit]

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

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 take in mind that no backup will be created from your original files.
  • The serialization options can be controlled via the EXPORTER option.

MAXSTAT[edit]

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

Changelog[edit]

Version 10.0
  • Removed: COMPPLAN, IGNOREHOSTNAME
  • Updated: IGNORECERT: Additionally disable hostname verification.
  • Updated: CATALOG: Renamed (before: CATFILE).
  • Updated: STRIPWS: Renamed (before: CHOP), new default: false.
Version 9.7
  • Updated: GZIP: Support for POST and PUT requests.
Version 9.6
Version 9.5
  • Updated: INLINELIMIT: default reduced to 50.
  • Updated: RESTXQERRORS: additionally suppress stack trace in HTTP response
Version 9.4
Version 9.3
Version 9.2
Version 9.0
Version 8.6
  • Added: FAIRLOCK, PARSERESTXQ
  • Removed: GLOBALLOCK (exclusive use of database lock)
  • Removed: QUERYPATH (will now be internally assigned)
  • Removed: CACHERESTXQ (replaced with PARSERESTXQ)
Version 8.5
Version 8.4
Version 8.3
Version 8.2
  • Removed: EVENTPORT, CACHEQUERY
Version 8.1
Version 8.0
Version 7.8.1
Version 7.8
Version 7.7
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, RESTXQPATHHTTPLOCAL, 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
Version 7.1
Version 7.0
Retrieved from "http://docs.basex.org/index.php?title=Options&oldid=16524"