Difference between revisions of "Options"

From BaseX Documentation
Jump to navigation Jump to search
Line 1: Line 1:
−
The options listed on this page can be requested with the [[Commands#GET|GET]] command and changed with the [[Commands#SET|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_Tutorial|GUI]] of BaseX, they will be listed in the [[GUI_Views|Info View]].
+
=Main Options=
  
−
A [[Options_(Snapshot)|preview page]] contains all options offered by the [http://files.basex.org/releases/latest/ latest stable snapshot].
+
===LANG===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>LANG [language]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Set the interface language. Currently, seven languages are available 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese' (default: <code>English</code>). BaseX needs to be restarted in order to activate the new language.
 +
|}
  
−
==Main Options==  
+
===LANGKEY===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>LANGKEY</code>
 +
|-
 +
| 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.
 +
|}
  
−
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:
+
===DBPATH===
−
+
{|
−
* <code>LANG [language]</code>
+
|-
−
: Set the interface language. Currently, seven languages are available 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese' (default: <code>English</code>). BaseX needs to be restarted in order to activate the new language.
+
| valign='top' width='90' | '''Signature'''
−
+
|<code>DBPATH [path]</code>
−
* <code>LANGKEY</code>
+
|-
−
: 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.
+
| valign='top' | '''Summary'''
−
+
|Set a new database path (default: <code>[[Configuration#Database Directory|{home}/BaseXData]]</code>). Note: if the database path is changed, existing databases have to be manually moved to the new location.
−
* <code>DBPATH [path]</code>
+
|}
−
: Set a new database path (default: <code>[[Configuration#Database Directory|{home}/BaseXData]]</code>). Note: if the database path is changed, existing databases have to be manually moved to the new location.
 
  
−
* <code>REPOPATH [path]</code>
+
===REPOPATH===
−
: this <code>path</code> points to the XQuery package repository (default: <code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>).
+
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>REPOPATH [path]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|this <code>path</code> points to the XQuery package repository (default: <code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>).
 +
|}
  
−
* <code>PARALLEL [number]</code>
+
===PARALLEL===
−
: Set the maximum <code>number</code> of parallel readers (default: <code>8</code>).
+
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>PARALLEL [number]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Set the maximum <code>number</code> of parallel readers (default: <code>8</code>).
 +
|}
  
−
* <code>DEBUG</code>
+
===DEBUG===
−
: Show internal debug info, usually used for development of new features (default: <code>false</code>).
+
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>DEBUG</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Show internal debug info, usually used for development of new features (default: <code>false</code>).
 +
|}
  
−
===Client/Server Architecture===
 
−
 
−
* <code>HOST [host]</code>
 
−
: Used by the client to connect the server (default: <code>localhost</code>).
 
−
 
−
* <code>PORT [port]</code>
 
−
: Used by the client to connect the server (default: <code>1984</code>).
 
−
 
−
* <code>SERVERPORT [port]</code>
 
−
: Port of the database server (default: <code>1984</code>).
 
−
 
−
* <code>EVENTPORT [port]</code>
 
−
: Port of the client, listening for server events. This port is only used if a client attaches itself to a database event (default: <code>1985</code>).
 
  
−
* <code>JAXRXPORT [port]</code>
+
=Client/Server Options=
−
: Port of the JAX-RX web server, usually Jetty (default: <code>8984</code>).
 
−
 
−
* <code>JAXRXPATH [path]</code>
 
−
: This local <code>path</code> points to the JAX-RX web directory (default: <code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code>).
 
  
−
* <code>TIMEOUT [time]</code>
+
===HOST===
−
: Server timeout in seconds. The timeout describes the maximum execution time of a client query. The timeout is deactivated if <code>time</code> is set to <code>0</code> (default: no timeout (<code>0</code>)).
+
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>HOST [host]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Used by the client to connect the server (default: <code>localhost</code>).
 +
|}
  
−
==Database Options==  
+
===PORT===
−
+
{|
−
* <code>CHOP</code>
+
|-
−
: 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% (default: <code>true</code>).
+
| valign='top' width='90' | '''Signature'''
 +
|<code>PORT [port]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Used by the client to connect the server (default: <code>1984</code>).
 +
|}
  
−
* <code>INTPARSE</code>
+
===SERVERPORT===
−
: 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. (default: <code>false</code>).
+
{|
−
+
|-
−
* <code>DTD</code>
+
| valign='top' width='90' | '''Signature'''
−
: Parse referenced DTDs and resolve XML entities (default: <code>false</code>).
+
|<code>SERVERPORT [port]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Port of the database server (default: <code>1984</code>).
 +
|}
  
−
* <code>CATFILE [path]</code>
+
===EVENTPORT===
−
: 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 (default: ''empty'').
+
{|
−
+
|-
−
* <code>CREATEFILTER [filter]</code>
+
| valign='top' width='90' | '''Signature'''
−
: Globbing syntax for filtering input documents (default: <code>*.xml</code>).
+
|<code>EVENTPORT [port]</code>
−
+
|-
−
* <code>ADDARCHIVES</code>
+
| valign='top' | '''Summary'''
−
: Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents (default: <code>true</code>).
+
|Port of the client, listening for server events. This port is only used if a client attaches itself to a database event (default: <code>1985</code>).
−
+
|}
−
* <code>SKIPCORRUPT</code>
 
−
: 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 (default: <code>false</code>).
 
  
−
* <code>PARSER [type]</code>
+
===JAXRXPORT===
−
: 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 (default: <code>XML</code>).
+
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>JAXRXPORT [port]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Port of the JAX-RX web server, usually Jetty (default: <code>8984</code>).
 +
|}
  
−
* <code>PARSEROPT [options]</code>
+
===JAXRXPATH===
−
: Define parser-specific options (default: ''empty''). See [[Parsers|parsers]] page for more information.
+
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>JAXRXPATH [path]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|This local <code>path</code> points to the JAX-RX web directory (default: <code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code>).
 +
|}
  
−
* <code>PATHINDEX</code>
+
===TIMEOUT===
−
: Create index for paths and speedup path based queries (default: <code>true</code>).
+
{|
−
+
|-
−
* <code>TEXTINDEX</code>
+
| valign='top' width='90' | '''Signature'''
−
: Create index for text nodes and speedup queries querying the entire text of a node (default: <code>true</code>).
+
|<code>TIMEOUT [time]</code>
−
+
|-
−
* <code>ATTRINDEX</code>
+
| valign='top' | '''Summary'''
−
: Create index for attribute values and speedup queries querying attribute values (default: <code>true</code>).
+
|Server timeout in seconds. The timeout describes the maximum execution time of a client query. The timeout is deactivated if <code>time</code> is set to <code>0</code> (default: no timeout (<code>0</code>)).
−
+
|}
−
* <code>FTINDEX</code>
 
−
: Create index for fulltext and speedup queries querying full text (default: <code>false</code>).
 
  
−
* <code>WRITEBACK</code>
 
−
: Write original files back after updates. As this will alter your input file make sure you have a backup before you use this option (default: <code>false</code>).
 
  
−
* <code>MAINMEM</code>
+
=Database Options=
−
: 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 (default: <code>false</code>).
 
  
−
* <code>FORCECREATE</code>
+
===CHOP===
−
: Force database creation for unknown documents specified in XQuery expressions (default: <code>false</code>).
+
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>CHOP</code>
 +
|-
 +
| 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% (default: <code>true</code>).
 +
|}
  
−
==Full-Text Options==  
+
===INTPARSE===
−
+
{|
−
* <code>WILDCARDS</code>
+
|-
−
: Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions (default: <code>false</code>).
+
| valign='top' width='90' | '''Signature'''
−
+
|<code>INTPARSE</code>
−
* <code>STEMMING</code>
+
|-
−
: 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 (default: <code>false</code>).
+
| 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. (default: <code>false</code>).
−
* <code>CASESENS</code>
+
|}
−
: 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 (default: <code>false</code>).
 
−
 
−
* <code>DIACRITICS</code>
 
−
: 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 (default: <code>false</code>).
 
−
 
−
* <code>LANGUAGE [lang]</code>
 
−
: Language for full-text search index, e.g. <code>LANG</code> can be set to <code>English</code> or <code>German</code> (default: ''empty'').
 
−
 
−
* <code>SCORING [mode]</code>
 
−
: 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 (default: <code>0</code>).
 
−
 
−
* <code>STOPWORDS [path]</code>
 
−
: 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> (default: ''empty'').
 
−
 
−
* <code>LSERROR [error]</code>
 
−
: Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOption, e.g. error could be <code>2</code> (default: <code>0</code>).
 
  
−
==Query Options==  
+
===DTD===
−
+
{|
−
* <code>QUERYINFO</code>
+
|-
−
: Show (all) process info (default: <code>false</code>).
+
| valign='top' width='90' | '''Signature'''
 +
|<code>DTD</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Parse referenced DTDs and resolve XML entities (default: <code>false</code>).
 +
|}
  
−
* <code>QUERY3</code>
+
===CATFILE===
−
: Enable/disable [http://www.w3.org/TR/xquery-30/ XQuery 3.0] functions (default: <code>true</code>).
+
{|
−
+
|-
−
* <code>SERIALIZE</code>
+
| valign='top' width='90' | '''Signature'''
−
: Flag for serialization of query results. I.e. there are any results printed if serialization is turned off (default: <code>true</code>).
+
|<code>CATFILE [path]</code>
 +
|-
 +
| 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 (default: ''empty'').
 +
|}
  
−
* <code>BINDINGS [vars]</code>
+
===CREATEFILTER===
−
: Contains external variables to be bound to the query. Keys and values are separated by equality signs, multiple variables are separated by commas (default: ''empty'').
+
{|
−
: Example: <code>var1=Hello,var2=World</code>
+
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>CREATEFILTER [filter]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Globbing syntax for filtering input documents (default: <code>*.xml</code>).
 +
|}
  
−
* <code>SERIALIZER [params]</code>
+
===ADDARCHIVES===
−
: Parameters for serializing queries; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are separated by commas (default: ''empty'').
+
{|
−
: Example: <code>method=xml,encoding=CP1252</code>
+
|-
−
+
| valign='top' width='90' | '''Signature'''
−
* <code>EXPORTER [params]</code>
+
|<code>ADDARCHIVES</code>
−
: Parameters for exporting the documents; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are separated by commas (default: ''empty'').
+
|-
−
+
| valign='top' | '''Summary'''
−
* <code>RUNS [num]</code>
+
|Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents (default: <code>true</code>).
−
: Specify number of runs a query is executed. Results are printed a single time and evaluation times are averages of all runs (default: <code>1</code>).
+
|}
  
−
==Serialization Options==  
+
===SKIPCORRUPT===
−
+
{|
−
* <code>DOTPLAN</code>
+
|-
−
: Create query plans visualized with [http://www.graphviz.org dotty], see <code>'plan.dot'</code> file in your project folder (default: <code>false</code>).
+
| valign='top' width='90' | '''Signature'''
−
+
|<code>SKIPCORRUPT</code>
−
* <code>DOTCOMPACT</code>
+
|-
−
: Compact dot representation (default: <code>false</code>).
+
| 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 (default: <code>false</code>).
−
* <code>DOTDISPLAY</code>
+
|}
−
: Display dot representation after query execution (default: <code>true</code>).
 
−
 
−
* <code>DOTTY [path]</code>
 
−
: Program <code>PATH</code> of dotty executable (default: <code>dotty</code>).
 
  
−
* <code>XMLPLAN</code>
+
===PARSER===
−
: Print query plan as xml document (default: <code>false</code>).
+
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>PARSER [type]</code>
 +
|-
 +
| 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 (default: <code>XML</code>).
 +
|}
  
−
* <code>COMPPLAN</code>
+
===PARSEROPT===
−
: Create query plan before or after compilation - query plan might change due to optimizations (default: <code>true</code>).
+
{|
−
+
|-
−
* <code>CACHEQUERY</code>
+
| valign='top' width='90' | '''Signature'''
−
: Cache the query results (default: <code>false</code>).
+
|<code>PARSEROPT [options]</code>
−
+
|-
−
* <code>MAXSTAT [num]</code>
+
| valign='top' | '''Summary'''
−
: Set maximum number of index occurrences to print through the command <code>info index</code> (default: <code>15</code>).
+
|Define parser-specific options (default: ''empty''). See [[Parsers|parsers]] page for more information.
 +
|}
 +
 
 +
===PATHINDEX===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>PATHINDEX</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Create index for paths and speedup path based queries (default: <code>true</code>).
 +
|}
 +
 
 +
===TEXTINDEX===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>TEXTINDEX</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Create index for text nodes and speedup queries querying the entire text of a node (default: <code>true</code>).
 +
|}
 +
 
 +
===ATTRINDEX===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>ATTRINDEX</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Create index for attribute values and speedup queries querying attribute values (default: <code>true</code>).
 +
|}
 +
 
 +
===FTINDEX===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>FTINDEX</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Create index for fulltext and speedup queries querying full text (default: <code>false</code>).
 +
|}
 +
 
 +
===WRITEBACK===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>WRITEBACK</code>
 +
|-
 +
| 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 (default: <code>false</code>).
 +
|}
 +
 
 +
===MAINMEM===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>MAINMEM</code>
 +
|-
 +
| 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 (default: <code>false</code>).
 +
|}
 +
 
 +
===FORCECREATE===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>FORCECREATE</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Force database creation for unknown documents specified in XQuery expressions (default: <code>false</code>).
 +
|}
 +
 
 +
 
 +
=Full-Text Options=
 +
 
 +
===WILDCARDS===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>WILDCARDS</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions (default: <code>false</code>).
 +
|}
 +
 
 +
===STEMMING===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>STEMMING</code>
 +
|-
 +
| 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 (default: <code>false</code>).
 +
|}
 +
 
 +
===CASESENS===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>CASESENS</code>
 +
|-
 +
| 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 (default: <code>false</code>).
 +
|}
 +
 
 +
===DIACRITICS===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>DIACRITICS</code>
 +
|-
 +
| 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 (default: <code>false</code>).
 +
|}
 +
 
 +
===LANGUAGE===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>LANGUAGE [lang]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Language for full-text search index, e.g. <code>LANG</code> can be set to <code>English</code> or <code>German</code> (default: ''empty'').
 +
|}
 +
 
 +
===SCORING===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>SCORING [mode]</code>
 +
|-
 +
| 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 (default: <code>0</code>).
 +
|}
 +
 
 +
===STOPWORDS===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>STOPWORDS [path]</code>
 +
|-
 +
| 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> (default: ''empty'').
 +
|}
 +
 
 +
===LSERROR===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>LSERROR [error]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOption, e.g. error could be <code>2</code> (default: <code>0</code>).
 +
|}
 +
 
 +
 
 +
=Query Options=
 +
 
 +
===QUERYINFO===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>QUERYINFO</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Show (all) process info (default: <code>false</code>).
 +
|}
 +
 
 +
===QUERY3===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>QUERY3</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Enable/disable [http://www.w3.org/TR/xquery-30/ XQuery 3.0] functions (default: <code>true</code>).
 +
|}
 +
 
 +
===SERIALIZE===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>SERIALIZE</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Flag for serialization of query results. I.e. there are any results printed if serialization is turned off (default: <code>true</code>).
 +
|}
 +
 
 +
===BINDINGS===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>BINDINGS [vars]</code>
 +
|-
 +
| 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 (default: ''empty'').
 +
|}
 +
 
 +
===SERIALIZER===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>SERIALIZER [params]</code>
 +
|-
 +
| 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 (default: ''empty'').
 +
|}
 +
 
 +
===EXPORTER===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>EXPORTER [params]</code>
 +
|-
 +
| 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 (default: ''empty'').
 +
|}
 +
 
 +
===RUNS===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>RUNS [num]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Specify number of runs a query is executed. Results are printed a single time and evaluation times are averages of all runs (default: <code>1</code>).
 +
|}
 +
 
 +
 
 +
=Serialization Options=
 +
 
 +
===DOTPLAN===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>DOTPLAN</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Create query plans visualized with [http://www.graphviz.org dotty], see <code>'plan.dot'</code> file in your project folder (default: <code>false</code>).
 +
|}
 +
 
 +
===DOTCOMPACT===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>DOTCOMPACT</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Compact dot representation (default: <code>false</code>).
 +
|}
 +
 
 +
===DOTDISPLAY===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>DOTDISPLAY</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Display dot representation after query execution (default: <code>true</code>).
 +
|}
 +
 
 +
===DOTTY===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>DOTTY [path]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Program <code>PATH</code> of dotty executable (default: <code>dotty</code>).
 +
|}
 +
 
 +
===XMLPLAN===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>XMLPLAN</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Print query plan as xml document (default: <code>false</code>).
 +
|}
 +
 
 +
===COMPPLAN===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>COMPPLAN</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Create query plan before or after compilation - query plan might change due to optimizations (default: <code>true</code>).
 +
|}
 +
 
 +
===CACHEQUERY===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>CACHEQUERY</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Cache the query results (default: <code>false</code>).
 +
|}
 +
 
 +
===MAXSTAT===
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signature'''
 +
|<code>MAXSTAT [num]</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|Set maximum number of index occurrences to print through the command <code>info index</code> (default: <code>15</code>).
 +
|}

Revision as of 19:45, 30 August 2011

Main Options

LANG

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

LANGKEY

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

DBPATH

Signature DBPATH [path]
Summary Set a new database path (default: {home}/BaseXData). Note: if the database path is changed, existing databases have to be manually moved to the new location.

REPOPATH

Signature REPOPATH [path]
Summary this path points to the XQuery package repository (default: {home}/BaseXRepo).

PARALLEL

Signature PARALLEL [number]
Summary Set the maximum number of parallel readers (default: 8).

DEBUG

Signature DEBUG
Summary Show internal debug info, usually used for development of new features (default: false).


Client/Server Options

HOST

Signature HOST [host]
Summary Used by the client to connect the server (default: localhost).

PORT

Signature PORT [port]
Summary Used by the client to connect the server (default: 1984).

SERVERPORT

Signature SERVERPORT [port]
Summary Port of the database server (default: 1984).

EVENTPORT

Signature EVENTPORT [port]
Summary Port of the client, listening for server events. This port is only used if a client attaches itself to a database event (default: 1985).

JAXRXPORT

Signature JAXRXPORT [port]
Summary Port of the JAX-RX web server, usually Jetty (default: 8984).

JAXRXPATH

Signature JAXRXPATH [path]
Summary This local path points to the JAX-RX web directory (default: {home}/BaseXWeb).

TIMEOUT

Signature TIMEOUT [time]
Summary Server timeout in seconds. The timeout describes the maximum execution time of a client query. The timeout is deactivated if time is set to 0 (default: no timeout (0)).


Database Options

CHOP

Signature CHOP
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% (default: true).

INTPARSE

Signature INTPARSE
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. (default: false).

DTD

Signature DTD
Summary Parse referenced DTDs and resolve XML entities (default: false).

CATFILE

Signature CATFILE [path]
Summary Specify a catalog file to locally resolve DTDs; see the Wikipedia entry on XML Catalogs for more details (default: empty).

CREATEFILTER

Signature CREATEFILTER [filter]
Summary Globbing syntax for filtering input documents (default: *.xml).

ADDARCHIVES

Signature ADDARCHIVES
Summary Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents (default: true).

SKIPCORRUPT

Signature SKIPCORRUPT
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 (default: false).

PARSER

Signature PARSER [type]
Summary Define import parser. As TYPE are available 'XML', 'CSV' or 'TEXT'. If Tagsoup is found in the classpath, 'HTML' is also available (default: XML).

PARSEROPT

Signature PARSEROPT [options]
Summary Define parser-specific options (default: empty). See parsers page for more information.

PATHINDEX

Signature PATHINDEX
Summary Create index for paths and speedup path based queries (default: true).

TEXTINDEX

Signature TEXTINDEX
Summary Create index for text nodes and speedup queries querying the entire text of a node (default: true).

ATTRINDEX

Signature ATTRINDEX
Summary Create index for attribute values and speedup queries querying attribute values (default: true).

FTINDEX

Signature FTINDEX
Summary Create index for fulltext and speedup queries querying full text (default: false).

WRITEBACK

Signature WRITEBACK
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 (default: false).

MAINMEM

Signature MAINMEM
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 (default: false).

FORCECREATE

Signature FORCECREATE
Summary Force database creation for unknown documents specified in XQuery expressions (default: false).


Full-Text Options

WILDCARDS

Signature WILDCARDS
Summary Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions (default: false).

STEMMING

Signature STEMMING
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 (default: false).

CASESENS

Signature CASESENS
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 (default: false).

DIACRITICS

Signature DIACRITICS
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 (default: false).

LANGUAGE

Signature LANGUAGE [lang]
Summary Language for full-text search index, e.g. LANG can be set to English or German (default: empty).

SCORING

Signature SCORING [mode]
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. MODE can be set to 1 for document based scoring, 2 for text node based scoring and 0 for non scoring (default: 0).

STOPWORDS

Signature STOPWORDS [path]
Summary Specify stop word list at PATH, that could be used e.g. to decrease the full text index size. The standard stopword list (english) is provided at 'etc/xml/stopWords' (default: empty).

LSERROR

Signature LSERROR [error]
Summary Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOption, e.g. error could be 2 (default: 0).


Query Options

QUERYINFO

Signature QUERYINFO
Summary Show (all) process info (default: false).

QUERY3

Signature QUERY3
Summary Enable/disable XQuery 3.0 functions (default: true).

SERIALIZE

Signature SERIALIZE
Summary Flag for serialization of query results. I.e. there are any results printed if serialization is turned off (default: true).

BINDINGS

Signature BINDINGS [vars]
Summary Contains external variables to be bound to the query. Keys and values are separated by equality signs, multiple variables are separated by commas (default: empty).

SERIALIZER

Signature SERIALIZER [params]
Summary Parameters for serializing queries; see Serialization for more details. Keys and values are separated by equality signs, multiple parameters are separated by commas (default: empty).

EXPORTER

Signature EXPORTER [params]
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 (default: empty).

RUNS

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


Serialization Options

DOTPLAN

Signature DOTPLAN
Summary Create query plans visualized with dotty, see 'plan.dot' file in your project folder (default: false).

DOTCOMPACT

Signature DOTCOMPACT
Summary Compact dot representation (default: false).

DOTDISPLAY

Signature DOTDISPLAY
Summary Display dot representation after query execution (default: true).

DOTTY

Signature DOTTY [path]
Summary Program PATH of dotty executable (default: dotty).

XMLPLAN

Signature XMLPLAN
Summary Print query plan as xml document (default: false).

COMPPLAN

Signature COMPPLAN
Summary Create query plan before or after compilation - query plan might change due to optimizations (default: true).

CACHEQUERY

Signature CACHEQUERY
Summary Cache the query results (default: false).

MAXSTAT

Signature MAXSTAT [num]
Summary Set maximum number of index occurrences to print through the command info index (default: 15).
Retrieved from "http://docs.basex.org/index.php?title=Options&oldid=3992"