Difference between revisions of "Options"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replace - "| valign='top' | " to "| ")
Line 13: Line 13:
 
|<code>DBPATH [path]</code>
 
|<code>DBPATH [path]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>[[Configuration#Database Directory|{home}/BaseXData]] or [[Configuration#Database Directory|{home}/data]]</code>
 
|<code>[[Configuration#Database Directory|{home}/BaseXData]] or [[Configuration#Database Directory|{home}/data]]</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Points to the directory in which all databases are located.<br/> '''Note:''' this option can only be changed if no database is currently opened. If the option is changed, existing databases will not be moved to the new location.
 
|Points to the directory in which all databases are located.<br/> '''Note:''' this option can only be changed if no database is currently opened. If the option is changed, existing databases will not be moved to the new location.
 
|}
 
|}
Line 26: Line 26:
 
|<code>REPOPATH [path]</code>
 
|<code>REPOPATH [path]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>
 
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Points to the [[Repository]], in which all XQuery modules are located.<br/>'''Note:''' if the option is changed, BaseX needs to be restarted in order to activate existing packages and avoid side effects.
 
|Points to the [[Repository]], in which all XQuery modules are located.<br/>'''Note:''' if the option is changed, BaseX needs to be restarted in order to activate existing packages and avoid side effects.
 
|}
 
|}
Line 39: Line 39:
 
|<code>DEBUG</code>
 
|<code>DEBUG</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes.
 
|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes.
 
|}
 
|}
Line 52: Line 52:
 
|<code>LANG [language]</code>
 
|<code>LANG [language]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>English</code>
 
|<code>English</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. BaseX needs to be restarted in order to activate the new language.
 
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. BaseX needs to be restarted in order to activate the new language.
 
|}
 
|}
Line 65: Line 65:
 
|<code>LANGKEY</code>
 
|<code>LANGKEY</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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. BaseX needs to be restarted in order to activate this option.
 
|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. BaseX needs to be restarted in order to activate this option.
 
|}
 
|}
Line 80: Line 80:
 
|<code>HOST [host]</code>
 
|<code>HOST [host]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>localhost</code>
 
|<code>localhost</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This host name is used by the client when connecting to a server.
 
|This host name is used by the client when connecting to a server.
 
|}
 
|}
Line 93: Line 93:
 
|<code>PORT [port]</code>
 
|<code>PORT [port]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>1984</code>
 
|<code>1984</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This port is used by the client when connecting to a server.
 
|This port is used by the client when connecting to a server.
 
|}
 
|}
Line 106: Line 106:
 
|<code>SERVERPORT [port]</code>
 
|<code>SERVERPORT [port]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>1984</code>
 
|<code>1984</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This is the port the database server will be listening to.
 
|This is the port the database server will be listening to.
 
|}
 
|}
Line 119: Line 119:
 
|<code>SERVERHOST [host&#x7c;ip]</code>
 
|<code>SERVERHOST [host&#x7c;ip]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|''empty'' (''wildcard'')
 
|''empty'' (''wildcard'')
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This is the host name or ip address the server is bound to. The server will be open to all clients if the option is set to an empty string.
 
|This is the host name or ip address the server is bound to. The server will be open to all clients if the option is set to an empty string.
 
|}
 
|}
Line 132: Line 132:
 
|<code>EVENTPORT [port]</code>
 
|<code>EVENTPORT [port]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>1985</code>
 
|<code>1985</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This port is used by the client to listen for [[Events|server events]]. This port will only be bound if a client attaches itself to a database event.
 
|This port is used by the client to listen for [[Events|server events]]. This port will only be bound if a client attaches itself to a database event.
 
|}
 
|}
Line 145: Line 145:
 
|<code>HTTPPORT [port]</code>
 
|<code>HTTPPORT [port]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>8984</code>
 
|<code>8984</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This is the port the [[Startup#BaseX HTTP Server|HTTP Server]] will be listening to.
 
|This is the port the [[Startup#BaseX HTTP Server|HTTP Server]] will be listening to.
 
|}
 
|}
Line 158: Line 158:
 
|<code>STOPPORT [port]</code>
 
|<code>STOPPORT [port]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>8985</code>
 
|<code>8985</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed.
 
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed.
 
|}
 
|}
Line 171: Line 171:
 
|<code>HTTPPATH [path]</code>
 
|<code>HTTPPATH [path]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>[[Configuration#Database Directory|{home}/BaseXHTTP]]</code>
 
|<code>[[Configuration#Database Directory|{home}/BaseXHTTP]]</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Points to the HTTP root directory, in which HTML files may be stored, and query files that will be evaluated by the [[REST]] service.
 
|Points to the HTTP root directory, in which HTML files may be stored, and query files that will be evaluated by the [[REST]] service.
 
|}
 
|}
Line 185: Line 185:
 
|<code>PROXYHOST [host]</code>
 
|<code>PROXYHOST [host]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|
 
|
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This is the host name of a proxy server.
 
|This is the host name of a proxy server.
 
|}
 
|}
Line 199: Line 199:
 
|<code>PROXYPORT [port]</code>
 
|<code>PROXYPORT [port]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>80</code>
 
|<code>80</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This is the port number of a proxy server.
 
|This is the port number of a proxy server.
 
|}
 
|}
Line 213: Line 213:
 
|<code>NONPROXYHOSTS [hosts]</code>
 
|<code>NONPROXYHOSTS [hosts]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|
 
|
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This is a list of hosts that should be directly accessed.
 
|This is a list of hosts that should be directly accessed.
 
|}
 
|}
Line 226: Line 226:
 
|<code>PARALLEL [number]</code>
 
|<code>PARALLEL [number]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>8</code>
 
|<code>8</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Denotes the maximum allowed <code>number</code> of parallel read [[Transaction Management|transactions]].
 
|Denotes the maximum allowed <code>number</code> of parallel read [[Transaction Management|transactions]].
 
|}
 
|}
Line 239: Line 239:
 
|<code>TIMEOUT [seconds]</code>
 
|<code>TIMEOUT [seconds]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>0</code> (''no timeout'')
 
|<code>0</code> (''no timeout'')
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted.<br/>Write operations will not be affected by this timeout, as this would corrupt the integrity of the database.<br/>The timeout is deactivated if the timeout is set to {{mono|0}}. Since {{Version|7.2}}, it is ignored for {{Mono|ADMIN}} operations.
 
|Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted.<br/>Write operations will not be affected by this timeout, as this would corrupt the integrity of the database.<br/>The timeout is deactivated if the timeout is set to {{mono|0}}. Since {{Version|7.2}}, it is ignored for {{Mono|ADMIN}} operations.
 
|}
 
|}
Line 255: Line 255:
 
|<code>AUTHTIMEOUT [seconds]</code>
 
|<code>AUTHTIMEOUT [seconds]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>10</code>
 
|<code>10</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Specifies the maximum time reserved for creating a new session. If authentication takes longer than the specified timeout, the connection will be closed.<br/>The timeout is deactivated if the timeout is set to {{mono|0}}.
 
|Specifies the maximum time reserved for creating a new session. If authentication takes longer than the specified timeout, the connection will be closed.<br/>The timeout is deactivated if the timeout is set to {{mono|0}}.
 
|}
 
|}
Line 268: Line 268:
 
|<code>KEEPALIVE [seconds]</code>
 
|<code>KEEPALIVE [seconds]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>0</code> (''no timeout'')
 
|<code>0</code> (''no timeout'')
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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 {{mono|0}}.
 
|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 {{mono|0}}.
 
|}
 
|}
Line 283: Line 283:
 
|<code>CHOP</code>
 
|<code>CHOP</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. This option often reduces the database size by up to 50%.
 
|Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. This option often reduces the database size by up to 50%.
 
|}
 
|}
Line 296: Line 296:
 
|<code>INTPARSE</code>
 
|<code>INTPARSE</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 309: Line 309:
 
|<code>DTD</code>
 
|<code>DTD</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{mono|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The [[#CATFILE|CATFILE]] option can be changed to locally resolve DTDs.
 
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{mono|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The [[#CATFILE|CATFILE]] option can be changed to locally resolve DTDs.
 
|}
 
|}
Line 322: Line 322:
 
|<code>CATFILE [path]</code>
 
|<code>CATFILE [path]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|''empty''
 
|''empty''
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Specifies a catalog file to locally resolve DTDs; see the entry on [[Catalog Resolver]]s for more details.
 
|Specifies a catalog file to locally resolve DTDs; see the entry on [[Catalog Resolver]]s for more details.
 
|}
 
|}
Line 335: Line 335:
 
|<code>CREATEFILTER [filter]</code>
 
|<code>CREATEFILTER [filter]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>*.xml</code>
 
|<code>*.xml</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
 
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
 
|}
 
|}
Line 348: Line 348:
 
|<code>ADDARCHIVES</code>
 
|<code>ADDARCHIVES</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|If this option is set to {{mono|true}}, files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a database.
 
|If this option is set to {{mono|true}}, files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a database.
 
|}
 
|}
Line 361: Line 361:
 
|<code>SKIPCORRUPT</code>
 
|<code>SKIPCORRUPT</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 374: Line 374:
 
|<code>ADDRAW</code>
 
|<code>ADDRAW</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|If this option is activated, and if new resources are added to a database, all files that are not filtered by the [[#CREATEFILTER|CREATEFILTER]] option will be added as ''raw'' files (i.e., in their binary representation).
 
|If this option is activated, and if new resources are added to a database, all files that are not filtered by the [[#CREATEFILTER|CREATEFILTER]] option will be added as ''raw'' files (i.e., in their binary representation).
 
|}
 
|}
Line 387: Line 387:
 
|<code>PARSER [type]</code>
 
|<code>PARSER [type]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>XML</code>
 
|<code>XML</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is not found in the classpath.
 
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is not found in the classpath.
 
|}
 
|}
Line 400: Line 400:
 
|<code>PARSEROPT [options]</code>
 
|<code>PARSEROPT [options]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|''empty''
 
|''empty''
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Defines parser-specific options; see [[Parsers]] for more information.
 
|Defines parser-specific options; see [[Parsers]] for more information.
 
|}
 
|}
Line 414: Line 414:
 
|<code>HTMLOPT [options]</code>
 
|<code>HTMLOPT [options]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|''empty''
 
|''empty''
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Allows to specify TagSoup options for HTML parsing; see [[Parsers#HTML Parser|HTML Parser]] for more information.
 
|Allows to specify TagSoup options for HTML parsing; see [[Parsers#HTML Parser|HTML Parser]] for more information.
 
|}
 
|}
Line 429: Line 429:
 
|<code>MAINMEM</code>
 
|<code>MAINMEM</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 442: Line 442:
 
|<code>PATHINDEX</code>
 
|<code>PATHINDEX</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Creates a path index whenever a new database is created. A path index helps to optimize location paths; see [[Indexes]] for more details.
 
|Creates a path index whenever a new database is created. A path index helps to optimize location paths; see [[Indexes]] for more details.
 
|}
 
|}
Line 455: Line 455:
 
|<code>TEXTINDEX</code>
 
|<code>TEXTINDEX</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 468: Line 468:
 
|<code>ATTRINDEX</code>
 
|<code>ATTRINDEX</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 481: Line 481:
 
|<code>FTINDEX</code>
 
|<code>FTINDEX</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 494: Line 494:
 
|<code>MAXLEN</code>
 
|<code>MAXLEN</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>96</code>
 
|<code>96</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 507: Line 507:
 
|<code>MAXCATS</code>
 
|<code>MAXCATS</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>100</code>
 
|<code>100</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that.
 
|Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that.
 
|}
 
|}
Line 520: Line 520:
 
|<code>UPDINDEX</code>
 
|<code>UPDINDEX</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|If turned on, incremental indexing will be activated: all update operations will also update the value index structures (texts and attribute values). The value of this option will be assigned once to a new database, and cannot be changed after that. The advantage of incremental indexes is that the value index structures will always be up-to-date. The downside is that updates will take a little bit longer.
 
|If turned on, incremental indexing will be activated: all update operations will also update the value index structures (texts and attribute values). The value of this option will be assigned once to a new database, and cannot be changed after that. The advantage of incremental indexes is that the value index structures will always be up-to-date. The downside is that updates will take a little bit longer.
 
|}
 
|}
Line 533: Line 533:
 
|<code>WRITEBACK</code>
 
|<code>WRITEBACK</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Updates on XML nodes are written back to the input files. Note that no backups of your original files will be created if this option is turned on.
 
|Updates on XML nodes are written back to the input files. Note that no backups of your original files will be created if this option is turned on.
 
|}
 
|}
Line 546: Line 546:
 
|<code>AUTOFLUSH</code>
 
|<code>AUTOFLUSH</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Flushes database buffers to disk after each update. If this option is set to {{mono|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 [[Commands#FLUSH|FLUSH]] command.
 
|Flushes database buffers to disk after each update. If this option is set to {{mono|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 [[Commands#FLUSH|FLUSH]] command.
 
|}
 
|}
Line 559: Line 559:
 
|<code>MAXSTAT [num]</code>
 
|<code>MAXSTAT [num]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>30</code>
 
|<code>30</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO|INFO INDEX]]</code> command.
 
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO|INFO INDEX]]</code> command.
 
|}
 
|}
Line 574: Line 574:
 
|<code>STEMMING</code>
 
|<code>STEMMING</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 587: Line 587:
 
|<code>CASESENS</code>
 
|<code>CASESENS</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 600: Line 600:
 
|<code>DIACRITICS</code>
 
|<code>DIACRITICS</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 613: Line 613:
 
|<code>LANGUAGE [lang]</code>
 
|<code>LANGUAGE [lang]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>en</code>
 
|<code>en</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 626: Line 626:
 
|<code>STOPWORDS [path]</code>
 
|<code>STOPWORDS [path]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|''empty''
 
|''empty''
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. A standard stopword list for English texts is provided in the directory <code>etc/stopwords.txt</code> in the official releases.
 
|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 <code>etc/stopwords.txt</code> in the official releases.
 
|}
 
|}
Line 639: Line 639:
 
|<code>LSERROR [error]</code>
 
|<code>LSERROR [error]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>0</code>
 
|<code>0</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option.  See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information on fuzzy querying.
 
|This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option.  See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information on fuzzy querying.
 
|}
 
|}
Line 655: Line 655:
 
|<code>WILDCARDS</code>
 
|<code>WILDCARDS</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|If a new full-text index is created, it will be particularly optimized for wildcards expressions. See the page on [[Full-Text]]s for more information on XQuery Full Text.  
 
|If a new full-text index is created, it will be particularly optimized for wildcards expressions. See the page on [[Full-Text]]s for more information on XQuery Full Text.  
 
|}
 
|}
Line 671: Line 671:
 
|<code>SCORING [mode]</code>
 
|<code>SCORING [mode]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>0</code>
 
|<code>0</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|A new full-text index will pre-calculate full-text scores. This option enables TF/IDF/based scores in full-text queries and increases main memory consumption while indexing. See the [[Full-Text#Scoring|Scoring]] for more information on different scoring types.
 
|A new full-text index will pre-calculate full-text scores. This option enables TF/IDF/based scores in full-text queries and increases main memory consumption while indexing. See the [[Full-Text#Scoring|Scoring]] for more information on different scoring types.
 
|}
 
|}
Line 686: Line 686:
 
|<code>QUERYINFO</code>
 
|<code>QUERYINFO</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Prints more information on internal query rewritings, optimizations, and performance. The query info will always be printed in the [[GUI#Visualizations|Info View]] in the GUI, or it can be activated with the [[Startup_Options#BaseX_Standalone|-V flag]] on command line.
 
|Prints more information on internal query rewritings, optimizations, and performance. The query info will always be printed in the [[GUI#Visualizations|Info View]] in the GUI, or it can be activated with the [[Startup_Options#BaseX_Standalone|-V flag]] on command line.
 
|}
 
|}
Line 699: Line 699:
 
|<code>XQUERY3</code>
 
|<code>XQUERY3</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Enables all [[XQuery 3.0]] features supported by BaseX. If this option is set to {{mono|false}}, the XQuery parser will only accept expressions of the XQuery 1.0 specification.
 
|Enables all [[XQuery 3.0]] features supported by BaseX. If this option is set to {{mono|false}}, the XQuery parser will only accept expressions of the XQuery 1.0 specification.
 
|}
 
|}
Line 712: Line 712:
 
|<code>SERIALIZE</code>
 
|<code>SERIALIZE</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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 {{mono|false}}.
 
|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 {{mono|false}}.
 
|}
 
|}
Line 725: Line 725:
 
|<code>BINDINGS [vars]</code>
 
|<code>BINDINGS [vars]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|''empty''
 
|''empty''
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Contains external variables to be bound to a query. Variable names and values are separated by equality signs, and multiple variables are delimited by commas. Variables may optionally be introduced with a leading dollar sign. Commas that occur in the value itself are encoded by duplication. If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [http://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].
 
|Contains external variables to be bound to a query. Variable names and values are separated by equality signs, and multiple variables are delimited by commas. Variables may optionally be introduced with a leading dollar sign. Commas that occur in the value itself are encoded by duplication. If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [http://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].
 
|-
 
|-
| valign='top' | '''Examples'''
+
| '''Examples'''
 
|<code>$a=1,$b=2</code> &nbsp; binds the values {{mono|1}} and {{mono|2}} to the variables $a and $b<br/><code>a=1,,2</code> &nbsp; binds the value {{mono|1,2}} to the variable $a<br/><code>{URI}a=x</code> or <code>'URI':a=x</code> &nbsp; binds the value {{Mono|x}} to the variable $a with the namespace {{Mono|URI}}.
 
|<code>$a=1,$b=2</code> &nbsp; binds the values {{mono|1}} and {{mono|2}} to the variables $a and $b<br/><code>a=1,,2</code> &nbsp; binds the value {{mono|1,2}} to the variable $a<br/><code>{URI}a=x</code> or <code>'URI':a=x</code> &nbsp; binds the value {{Mono|x}} to the variable $a with the namespace {{Mono|URI}}.
 
|}
 
|}
Line 741: Line 741:
 
|<code>SERIALIZER [params]</code>
 
|<code>SERIALIZER [params]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|''empty''
 
|''empty''
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Contains parameters for serializing queries; see [[Serialization]] for more details. Keys and values are separated by equality signs, and multiple parameters are delimited by commas.
 
|Contains parameters for serializing queries; see [[Serialization]] for more details. Keys and values are separated by equality signs, and multiple parameters are delimited by commas.
 
|-
 
|-
| valign='top' | '''Example'''
+
| '''Example'''
 
|<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{mono|US-ASCII}} and prints the XML declaration.
 
|<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{mono|US-ASCII}} and prints the XML declaration.
 
|}
 
|}
Line 757: Line 757:
 
|<code>EXPORTER [params]</code>
 
|<code>EXPORTER [params]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|''empty''
 
|''empty''
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 770: Line 770:
 
|<code>QUERYPATH [path]</code>
 
|<code>QUERYPATH [path]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|''empty''
 
|''empty''
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''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.
 
|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.
 
|}
 
|}
Line 783: Line 783:
 
|<code>CACHEQUERY</code>
 
|<code>CACHEQUERY</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Caches the query results before returning them to the client. This option may be set to {{mono|true}} if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX).
 
|Caches the query results before returning them to the client. This option may be set to {{mono|true}} if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX).
 
|}
 
|}
Line 796: Line 796:
 
|<code>FORCECREATE</code>
 
|<code>FORCECREATE</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|By activating this option, the XQuery {{mono|doc()}} and  {{mono|collection()}} functions will create database instances for the addressed input files.
 
|By activating this option, the XQuery {{mono|doc()}} and  {{mono|collection()}} functions will create database instances for the addressed input files.
 
|}
 
|}
Line 809: Line 809:
 
|<code>RUNS [num]</code>
 
|<code>RUNS [num]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>1</code>
 
|<code>1</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Specify number of runs a query is executed. Results are printed a single time and evaluation times are averages of all runs.
 
|Specify number of runs a query is executed. Results are printed a single time and evaluation times are averages of all runs.
 
|}
 
|}
Line 824: Line 824:
 
|<code>XMLPLAN</code>
 
|<code>XMLPLAN</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Prints the execution plan of an XQuery expression in its XML representation.
 
|Prints the execution plan of an XQuery expression in its XML representation.
 
|}
 
|}
Line 837: Line 837:
 
|<code>COMPPLAN</code>
 
|<code>COMPPLAN</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Creates the query plan before or after the compilation step. Query plans might change due to optimizations.
 
|Creates the query plan before or after the compilation step. Query plans might change due to optimizations.
 
|}
 
|}
Line 850: Line 850:
 
|<code>DOTPLAN</code>
 
|<code>DOTPLAN</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file in the query directory.
 
|Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file in the query directory.
 
|}
 
|}
Line 863: Line 863:
 
|<code>DOTCOMPACT</code>
 
|<code>DOTCOMPACT</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>false</code>
 
|<code>false</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Chooses a compact dot representation.
 
|Chooses a compact dot representation.
 
|}
 
|}
Line 876: Line 876:
 
|<code>DOTDISPLAY</code>
 
|<code>DOTDISPLAY</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>true</code>
 
|<code>true</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Visualizes the dot representation after the query execution.
 
|Visualizes the dot representation after the query execution.
 
|}
 
|}
Line 889: Line 889:
 
|<code>DOTTY [path]</code>
 
|<code>DOTTY [path]</code>
 
|-
 
|-
| valign='top' | '''Default'''
+
| '''Default'''
 
|<code>dotty</code>
 
|<code>dotty</code>
 
|-
 
|-
| valign='top' | '''Summary'''
+
| '''Summary'''
 
|Location of the {{mono|dotty}} executable.
 
|Location of the {{mono|dotty}} executable.
 
|}
 
|}

Revision as of 00:42, 26 May 2012

This page is linked from the Getting Started Section.

The options listed on this page can be requested with the GET command and changed with the SET command. Three data types exist: strings, numbers, and booleans, which can be turned ON and OFF. If options are internally changed by the GUI of BaseX, they will be listed in the Info View.

Main Options

The main options are only available from the Standalone Mode and Database Server instances of BaseX, i.e., they cannot be changed by database clients. They are stored in the .basex config file, which is opened by every new BaseX instance:

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. If the option is changed, existing databases will not be moved to the new location.

REPOPATH

Signature REPOPATH [path]
Default {home}/BaseXRepo
Summary Points to the Repository, in which all XQuery modules are located.
Note: if the option is changed, BaseX needs to be restarted in order to activate existing packages and avoid side effects.

DEBUG

Signature DEBUG
Default false
Summary Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes.

LANG

Signature LANG [language]
Default English
Summary Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. BaseX needs to be restarted in order to activate the new language.

LANGKEY

Signature LANGKEY
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. BaseX needs to be restarted in order to activate this option.

Client/Server Architecture

HOST

Signature HOST [host]
Default localhost
Summary This host name is used by the client when connecting to a server.

PORT

Signature PORT [port]
Default 1984
Summary This port is used by the client when connecting to a server.

SERVERPORT

Signature SERVERPORT [port]
Default 1984
Summary This is the port the database server will be listening to.

SERVERHOST

Signature SERVERHOST [host|ip]
Default empty (wildcard)
Summary This is the host name or ip address the server is bound to. The server will be open to all clients if the option is set to an empty string.

EVENTPORT

Signature EVENTPORT [port]
Default 1985
Summary This port is used by the client to listen for server events. This port will only be bound if a client attaches itself to a database event.

HTTPPORT

Signature HTTPPORT [port]
Default 8984
Summary This is the port the HTTP Server will be listening to.

STOPPORT

Signature STOPPORT [port]
Default 8985
Summary This is the port on which the HTTP Server can be locally closed.

HTTPPATH

Signature HTTPPATH [path]
Default {home}/BaseXHTTP
Summary Points to the HTTP root directory, in which HTML files may be stored, and query files that will be evaluated by the REST service.

PROXYHOST

Introduced with Version 7.2:

Signature PROXYHOST [host]
Default
Summary This is the host name of a proxy server.

PROXYPORT

Introduced with Version 7.2:

Signature PROXYPORT [port]
Default 80
Summary This is the port number of a proxy server.

NONPROXYHOSTS

Introduced with Version 7.2:

Signature NONPROXYHOSTS [hosts]
Default
Summary This is a list of hosts that should be directly accessed.

PARALLEL

Signature PARALLEL [number]
Default 8
Summary Denotes the maximum allowed number of parallel read transactions.

TIMEOUT

Signature TIMEOUT [seconds]
Default 0 (no timeout)
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. Since Version 7.2, it is ignored for ADMIN operations.

AUTHTIMEOUT

Introduced with Version 7.2.2:

Signature AUTHTIMEOUT [seconds]
Default 10
Summary Specifies the maximum time reserved for creating a new session. If authentication takes longer than the specified timeout, the connection will be closed.
The timeout is deactivated if the timeout is set to 0.

KEEPALIVE

Signature KEEPALIVE [seconds]
Default 0 (no timeout)
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.

Create Options

CHOP

Signature CHOP
Default true
Summary Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. This option often reduces the database size by up to 50%.

INTPARSE

Signature INTPARSE
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
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.

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

Introduced with Version 7.2:

Signature HTMLOPT [options]
Default empty
Summary Allows to specify TagSoup options for HTML parsing; see HTML Parser for more information.

Database Options

MAINMEM

Signature MAINMEM
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.

PATHINDEX

Signature PATHINDEX
Default true
Summary Creates a path index whenever a new database is created. A path index helps to optimize location paths; see Indexes for more details.

TEXTINDEX

Signature TEXTINDEX
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
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
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
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
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
Default false
Summary If turned on, incremental indexing will be activated: all update operations will also update the value index structures (texts and attribute values). The value of this option will be assigned once to a new database, and cannot be changed after that. The advantage of incremental indexes is that the value index structures will always be up-to-date. The downside is that updates will take a little bit longer.

WRITEBACK

Signature WRITEBACK
Default false
Summary Updates on XML nodes are written back to the input files. Note that no backups of your original files will be created if this option is turned on.

AUTOFLUSH

Signature AUTOFLUSH
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.

MAXSTAT

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

Full-Text Options

STEMMING

Signature STEMMING
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
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
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.

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.

WILDCARDS

Removed in Version 7.2.2: new index supports both fuzzy and wildcard queries.

Signature WILDCARDS
Default false
Summary If a new full-text index is created, it will be particularly optimized for wildcards expressions. See the page on Full-Texts for more information on XQuery Full Text.

SCORING

Removed in Version 7.2.2: new scoring model will focus on lengths of text nodes and match options.

Signature SCORING [mode]
Default 0
Summary A new full-text index will pre-calculate full-text scores. This option enables TF/IDF/based scores in full-text queries and increases main memory consumption while indexing. See the Scoring for more information on different scoring types.

Query Options

QUERYINFO

Signature QUERYINFO
Default false
Summary Prints more information on internal query rewritings, optimizations, and performance. The query info will always be printed in the Info View in the GUI, or it can be activated with the -V flag on command line.

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.

SERIALIZE

Signature SERIALIZE
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.

BINDINGS

Signature BINDINGS [vars]
Default empty
Summary Contains external variables to be bound to a query. Variable names and values are separated by equality signs, and multiple variables are delimited by commas. Variables may optionally be introduced with a leading dollar sign. Commas that occur in the value itself are encoded by duplication. If a variable uses a namespace different to the default namespace, it can be specified with the Clark Notation or Expanded QName Notation.
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 or 'URI':a=x   binds the value x to the variable $a with the namespace URI.

SERIALIZER

Signature SERIALIZER [params]
Default empty
Summary Contains parameters for serializing queries; see Serialization for more details. Keys and values are separated by equality signs, and multiple parameters are delimited by commas.
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.

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
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
Default false
Summary By activating this option, the XQuery doc() and collection() functions will create database instances for the addressed input files.

RUNS

Signature RUNS [num]
Default 1
Summary Specify number of runs a query is executed. Results are printed a single time and evaluation times are averages of all runs.

Serialization Options

XMLPLAN

Signature XMLPLAN
Default false
Summary Prints the execution plan of an XQuery expression in its XML representation.

COMPPLAN

Signature COMPPLAN
Default true
Summary Creates the query plan before or after the compilation step. Query plans might change due to optimizations.

DOTPLAN

Signature DOTPLAN
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
Default false
Summary Chooses a compact dot representation.

DOTDISPLAY

Signature DOTDISPLAY
Default true
Summary Visualizes the dot representation after the query execution.

DOTTY

Signature DOTTY [path]
Default dotty
Summary Location of the dotty executable.

Changelog

Version 7.2.2

  • Added: AUTHTIMEOUT
  • 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