Difference between revisions of "Options"

From BaseX Documentation
Jump to navigation Jump to search
Line 7: Line 7:
 
=Main Options=
 
=Main Options=
  
−
The main options are only available in the [[Standalone Tutorial|standalone]] and [[Server Tutorial|server]] instance of BaseX; they cannot be changed by database clients:
+
The main options are only available in the [[Standalone Tutorial|standalone]] and [[Server Tutorial|server]] instance of BaseX, i.e., they cannot be changed by database clients:
  
−
===LANG===
+
===DBPATH===
 
{|
 
{|
 
|-
 
|-
 
| valign='top' width='90' | '''Signature'''
 
| valign='top' width='90' | '''Signature'''
−
|<code>LANG [language]</code>
+
|<code>DBPATH [path]</code>
 
|-
 
|-
 
| valign='top' | '''Default'''
 
| valign='top' | '''Default'''
−
|<code>English</code>
+
|<code>[[Configuration#Database Directory|{home}/BaseXData]] or [[Configuration#Database Directory|{home}/data]]</code>
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Set 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.
+
|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.
 
|}
 
|}
  
−
===LANGKEY===
+
===REPOPATH===
 
{|
 
{|
 
|-
 
|-
 
| valign='top' width='90' | '''Signature'''
 
| valign='top' width='90' | '''Signature'''
−
|<code>LANGKEY</code>
+
|<code>REPOPATH [path]</code>
 
|-
 
|-
 
| valign='top' | '''Default'''
 
| valign='top' | '''Default'''
−
|<code>false</code>
+
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Prefix all texts with the internal language keys. This option is helpful for creating new translations. BaseX needs to be restarted in order to activate this option.
+
|Points to the repository directory, in which all [[Packaging|XQuery Packages]] are located.<br/>'''Note:''' if the option is changed, BaseX needs to be restarted in order to activate existing packages and avoid side effects.
 
|}
 
|}
  
−
===DBPATH===
+
===DEBUG===
 
{|
 
{|
 
|-
 
|-
 
| valign='top' width='90' | '''Signature'''
 
| valign='top' width='90' | '''Signature'''
−
|<code>DBPATH [path]</code>
+
|<code>DEBUG</code>
 
|-
 
|-
 
| valign='top' | '''Default'''
 
| valign='top' | '''Default'''
−
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</code>
+
|<code>false</code>
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Set a new database path. Note: if the database path is changed, existing databases have to be manually moved to the new location.
+
|Sends internal debug info to STDERR. This option can be turned of to get additional information for development and debugging purposes.
 
|}
 
|}
  
−
===REPOPATH===
+
===LANG===
 
{|
 
{|
 
|-
 
|-
 
| valign='top' width='90' | '''Signature'''
 
| valign='top' width='90' | '''Signature'''
−
|<code>REPOPATH [path]</code>
+
|<code>LANG [language]</code>
 
|-
 
|-
 
| valign='top' | '''Default'''
 
| valign='top' | '''Default'''
−
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>
+
|<code>English</code>
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|This <code>path</code> points to the XQuery package repository.
+
|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.
 
|}
 
|}
  
−
===DEBUG===
+
===LANGKEY===
 
{|
 
{|
 
|-
 
|-
 
| valign='top' width='90' | '''Signature'''
 
| valign='top' width='90' | '''Signature'''
−
|<code>DEBUG</code>
+
|<code>LANGKEY</code>
 
|-
 
|-
 
| valign='top' | '''Default'''
 
| valign='top' | '''Default'''
Line 71: Line 71:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Show internal debug info, usually used for development of new features.
+
|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 125: Line 125:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Host name or ip address the server is bound to. Introduced with {{Version|7.0}}.
+
|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 138: Line 138:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Port of the client, listening for server events. This port is only used 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 151: Line 151:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Port of the HTTP server to address the [[WebDAV]] and [[REST]] services.
+
|This port is used by the [[Startup#BaseX HTTP Server|HTTP Server]], which offers the [[WebDAV]] and [[REST]] services.
 
|}
 
|}
  
Line 164: Line 164:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|This local <code>path</code> points to the HTTP directory, which is used by the [[REST]] service.
+
|Points to the HTTP directory, in which query files are stored, which are evaluated by the [[REST]] service.
 
|}
 
|}
  
Line 177: Line 177:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Set the maximum <code>number</code> of parallel readers.
+
|Denotes the maximum allowed <code>number</code> of parallel read [[Transaction Management|transactions]].
 
|}
 
|}
  
Line 190: Line 190:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Client timeout. If a client process takes longer than the specified timeout, it will be aborted. Database updates will not be affected by this timeout, as they would endanger the database integrity. The timeout is deactivated if <code>seconds</code> is set to <code>0</code>.
+
|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 {{mono|0}}.
 
|}
 
|}
  
Line 203: Line 203:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Keepalive timeout. 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 timeout. The keepalive check is deactivated if <code>seconds</code> is set to <code>0</code>. Introduced with {{Version|7.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 218: Line 218:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Chop all leading and trailing whitespaces from text nodes while building a database, and discard 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 231: Line 231:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Use 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 244: Line 244:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Parse referenced DTDs and resolve XML entities.
+
|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 257: Line 257:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Specify a catalog file to locally resolve DTDs; see the Wikipedia entry on [http://en.wikipedia.org/wiki/XML_Catalog XML Catalogs] for more details.
+
|Specifies a catalog file to locally resolve DTDs; see the entry on [[Catalog Resolver]]s for more details.
 
|}
 
|}
  
Line 270: Line 270:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Glob syntax for filtering files that are processed by the [[Commands#CREATE|CREATE]] or [[Commands#ADD|ADD]] commands.
+
|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 283: Line 283:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents.
+
|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 296: Line 296:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Skip corrupt (i.e., non-well-formed) files while creating a database or adding new documents. If this option is used, database creation is 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 309: Line 309:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Define import [[Parsers|parser]]. As <code>TYPE</code> are available 'XML', 'CSV' or 'TEXT'. If [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is found in the classpath, 'HTML' is also available.
+
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'XML', '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 322: Line 322:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Define parser-specific options. See [[Parsers|parsers]] page for more information.
+
|Defines parser-specific options; see [[Parsers]] for more information.
 
|}
 
|}
  
Line 335: Line 335:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Create index for paths and speedup path based queries.
+
|Creates a path index whenever a new database is created. A path index helps to optimize location paths; see [[Indexes]] for more details.
 
|}
 
|}
  
Line 348: Line 348:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Create index for text nodes and speedup queries querying the entire text of a node.
+
|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 361: Line 361:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Create index for attribute values and speedup queries querying attribute values.
+
|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 374: Line 374:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Create index for fulltext and speedup queries querying full text.
+
|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 387: Line 387:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Write original files back after updates. As this will alter your input file make sure you have a backup before you use this option.
+
|Updates on XML nodes are written back to the input files. Note that, if this option is turned on, no backups of your original files will be created.
 
|}
 
|}
  
Line 400: Line 400:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Use main-memory mode. Now all data is exclusively stored in main memory. Some queries will be evaluated even faster, but the data is lost if BaseX is shut down.
+
|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.
 
|}
 
|}
  
Line 413: Line 413:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Force database creation for unknown documents specified in XQuery expressions.
+
|By activating this option, the XQuery {{mono|doc()}} and  {{mono|collection()}} functions will create database instances for the addressed input files.
 
|}
 
|}
  
Line 426: Line 426:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Flush database buffers to disk after each update. If this option is set to <code>false</code>, some update will be evaluated much faster, but the chance of data loss increases if the database is always open and not explicitly flushed via the [[Commands (Snapshot)#FLUSH|FLUSH]] command. Introduced with {{Version|7.0}}.
+
|Flushes database buffers to disk after each update. If this option is set to {{mono|false}}, some update operations will be evaluated much faster. As a drawback, the chance of data loss increases if the database is kept open and not explicitly flushed via the [[Commands#FLUSH|FLUSH]] command.
 
|}
 
|}
  
Line 439: Line 439:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Set maximum number of index occurrences to print through the command <code>info index</code>.
+
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO|INFO INDEX]]</code> command.
 
|}
 
|}
  
Line 454: Line 454:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions.
+
|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 467: Line 467:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Stemm full text tokens before indexing and decrease index size. Should only be assigned for full text queries using stemming, otherwise the full text index could not be assigned for query speedups.
+
|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 480: Line 480:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Case sensitive full text indexing, i.e. full text tokens are stored case sensitive and enables the assignment of the full text index for case sensitive queries.
+
|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 493: Line 493:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Diacritic sensitive full text indexing, i.e. full text tokens are stored with diacritics and enables the assignment of the full text index for diacritic queries.
+
|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 506: Line 506:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Language used for creating a new full-text search index. Can e.g. be set to <code>de</code> or <code>German</code>.
+
|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 519: Line 519:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Precalculation of full text scores and storage within the full text index structure. Enables TF/IDF based scores in full text queries and increases memory consumption while indexing. <code>MODE</code> can be set to <code>1</code> for document based scoring, <code>2</code> for text node based scoring and <code>0</code> for non scoring.
+
|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 532: Line 532:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Specify stop word list at <code>PATH</code>, that could be used e.g. to decrease the full text index size. The standard stopword list (english) is provided at <code>'etc/xml/stopWords'</code>.
+
|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 545: Line 545:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOption, e.g. error could be <code>2</code>.
+
|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 561: Line 561:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Show (all) process info.
+
|Prints more information on internal query rewritings, optimizations, and performance.
 
|}
 
|}
  
Line 574: Line 574:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Enable/disable [http://www.w3.org/TR/xquery-30/ XQuery 3.0] functions.
+
|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 587: Line 587:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Flag for serialization of query results. I.e. there are any results printed if serialization is turned off.
+
|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 600: Line 600:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Contains external variables to be bound to the query. Keys and values are separated by equality signs, multiple variables are separated by commas.
+
|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.
 +
|-
 +
| valign='top' | '''Examples'''
 +
|<code>$a=1,$b=2</code> : binds the values {{mono|1}} and {{mono|2}} to the variables $a and $b.
 
|}
 
|}
  
Line 613: Line 616:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Parameters for serializing queries; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are separated 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'''
 +
|<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{mono|US-ASCII}} and prints the XML declaration.
 
|}
 
|}
  
Line 626: Line 632:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Parameters for exporting the documents; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are separated 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 639: Line 645:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Contains the path (''base uri'') to the executed query. Introduced with {{Version|7.0}} (default: ''empty'').
+
|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 652: Line 658:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Caches the query results before returning them to the client.
+
|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 680: Line 686:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Print query plan as xml document.
+
|Prints the execution plan of an XQuery expression in its XML representation.
 
|}
 
|}
  
Line 693: Line 699:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Create query plan before or after compilation - query plan might change due to optimizations.
+
|Creates the query plan before or after the compilation step. Query plans might change due to optimizations.
 
|}
 
|}
  
Line 706: Line 712:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Create query plans visualized with [http://www.graphviz.org dotty], see <code>'plan.dot'</code> file in your project folder.
+
|Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file in the query directory.
 
|}
 
|}
  
Line 719: Line 725:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Compact dot representation.
+
|Chooses a compact dot representation.
 
|}
 
|}
  
Line 732: Line 738:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Display dot representation after query execution.
+
|Visualizes the dot representation after the query execution.
 
|}
 
|}
  
Line 745: Line 751:
 
|-
 
|-
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
−
|Program <code>PATH</code> of dotty executable.
+
|Location of the {{mono|dotty}} executable.
 
|}
 
|}

Revision as of 17:58, 13 November 2011

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.

A preview page contains all options offered by the latest stable snapshot.

Main Options

The main options are only available in the standalone and server instance of BaseX, i.e., they cannot be changed by database clients:

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 directory, in which all XQuery Packages 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 of 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 port is used by the HTTP Server, which offers the WebDAV and REST services.

HTTPPATH

Signature HTTPPATH [path]
Default {home}/BaseXHTTP
Summary Points to the HTTP directory, in which query files are stored, which are evaluated by the REST service.

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.

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.

Database 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 [[Commands#Glob Syntax|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.

PARSER

Signature PARSER [type]
Default XML
Summary Defines a parser for importing new files to the database. Currently, 'XML', '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.

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.

WRITEBACK

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

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.

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.

AUTOFLUSH

Signature AUTOFLUSH
Default true
Summary Flushes database buffers to disk after each update. If this option is set to false, some update operations will be evaluated much faster. As a drawback, the chance of data loss increases if the database is kept open and 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

WILDCARDS

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.

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.

SCORING

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.

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.


Query Options

QUERYINFO

Signature QUERYINFO
Default false
Summary Prints more information on internal query rewritings, optimizations, and performance.

QUERY3

Signature QUERY3
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.
Examples $a=1,$b=2 : binds the values 1 and 2 to the variables $a and $b.

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

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.
Retrieved from "http://docs.basex.org/index.php?title=Options&oldid=5173"