Changes

A ===LANG==={||-| valign='top' width='90' | '''Signature'''|<code>LANG [[Options_(Snapshot)language]</code>|-| valign='top' | '''Summary'''|preview page]] contains all options offered by Set the [httpinterface language. Currently, seven languages are available 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese' (default:<code>English<//filescode>).basex.org/releases/latest/ latest stable snapshot]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===DBPATH==={|standalone]] and [[Server Tutorial|server]] instance of BaseX; they cannot be changed by database clients:- * <code>LANG [language]</code>: Set the interface language. Currently, seven languages are available | valign='Englishtop', width='German90', 'French', | 'Dutch', 'ItalianSignature', 'Japanese', and 'Vietnamese' (default: <code>English</code>). BaseX needs to be restarted in order to activate the new language. * <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. * |<code>DBPATH [path]</code>: |-| 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.|}

* ===REPOPATH==={||-| 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>).|}

* ===PARALLEL==={||-| 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>).|}

* ===DEBUG==={||-| 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>).|}

* <code>JAXRXPORT [port]<=Client/code>: 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>).Server Options=

* ===HOST==={||-| valign='top' width='90' | '''Signature'''|<code>TIMEOUT HOST [timehost]</code>: Server timeout in seconds. The timeout describes |-| valign='top' | '''Summary'''|Used by the maximum execution time of a client query. The timeout is deactivated if <code>time</code> is set to <code>0</code> connect the server (default: no timeout (<code>0localhost</code>)).|}

==Database Options=PORT= =={||- | valign='top' width='90' | '''Signature'''* |<code>CHOPPORT [port]</code>: Chop all leading and trailing whitespaces from text nodes while building a database, and discard empty text nodes. This option often reduces |-| valign='top' | '''Summary'''|Used by the database size by up client to 50% connect the server (default: <code>true1984</code>).|}

* ===SERVERPORT==={||-| valign='top' width='90' | '''Signature'''|<code>INTPARSESERVERPORT [port]</code>: 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|-| valign='top' | '''Summary'''|Port of-the-box, but it does not support all features needed for parsing DTDs. database server (default: <code>false1984</code>). * <code>DTD</code>: Parse referenced DTDs and resolve XML entities (default: <code>false</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: | valign='top' width='90' | '''Signature'empty''). * |<code>CREATEFILTER EVENTPORT [filterport]</code>: Globbing syntax for filtering input documents (default: <code>*.xml</code>).|- | valign='top' | '''Summary'''* <code>ADDARCHIVES</code>: Parse files within archives (ZIP|Port of the client, DOCX, GZIP, etclistening for server events.) while creating This port is only used if a client attaches itself to a database or adding new documents event (default: <code>true1985</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>).|}

* ===JAXRXPORT==={||-| valign='top' width='90' | '''Signature'''|<code>PARSER JAXRXPORT [typeport]</code>: Define import [[Parsers|parser]]. As <code>TYPE</code> are available -| valign='top' | 'XML', 'CSVSummary' or 'TEXT'. If [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is found in |Port of the classpathJAX-RX web server, 'HTML' is also available usually Jetty (default: <code>XML8984</code>).|}

* ===JAXRXPATH==={||-| valign='top' width='90' | '''Signature'''|<code>PARSEROPT JAXRXPATH [optionspath]</code>: Define parser|-specific options (default: | valign='top' | '''Summary'empty''). See |This local <code>path</code> points to the JAX-RX web directory (default: <code>[[ParsersConfiguration#Database Directory|parsers{home}/BaseXWeb]] page for more information</code>).|}

* <code>PATHINDEX</code>===TIMEOUT==={||-| valign='top' width='90' | '''Signature''': Create index for paths and speedup path based queries (default: |<code>trueTIMEOUT [time]</code>). |-* <code>TEXTINDEX</code>| valign='top' | '''Summary''': Create index for text nodes and speedup queries querying |Server timeout in seconds. The timeout describes the entire text maximum execution time of a node (default: client query. The timeout is deactivated if <code>truetime</code>). * is set to <code>ATTRINDEX0</code>: Create index for attribute values and speedup queries querying attribute values (default: no timeout (<code>true0</code>)). * <code>FTINDEX</code>: Create index for fulltext and speedup queries querying full text (default: <code>false</code>).|}

* ===CHOP==={||-| valign='top' width='90' | '''Signature'''|<code>FORCECREATECHOP</code>: Force |-| 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 creation for unknown documents specified in XQuery expressions size by up to 50% (default: <code>falsetrue</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>STEMMINGINTPARSE</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>).|- * <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: | valign='top' | '''Summary'empty''). * <code>SCORING [mode]</code>: Precalculation |Use internal XML parser instead of full text scores and storage within the full text index structurestandard Java XML parser. 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 scoringThe internal parser is faster, <code>2</code> for text node based scoring more fault tolerant and <code>0</code> for non scoring (default: <code>0</code>). * <code>STOPWORDS [path]</code>: Specify stop word list at <code>PATH</code>supports common HTML entities out-of-the-box, 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 but it does not support all features needed for fuzzy search with BaseX specialized own FTMatchOption, eparsing DTDs.g. error could be <code>2</code> (default: <code>0false</code>).|}

==Query Options=DTD= =={| |-* | valign='top' width='90' | '''Signature'''|<code>QUERYINFODTD</code>: Show (all) process info |-| valign='top' | '''Summary'''|Parse referenced DTDs and resolve XML entities (default: <code>false</code>).|}

* ===CATFILE==={||-| valign='top' width='90' | '''Signature'''|<code>QUERY3CATFILE [path]</code>: Enable/disable |-| valign='top' | '''Summary'''|Specify a catalog file to locally resolve DTDs; see the Wikipedia entry on [http://wwwen.w3wikipedia.org/TRwiki/xquery-30/ XQuery 3.0XML_Catalog XML Catalogs] functions for more details (default: <code>true</code>''empty''). * <code>SERIALIZE</code>: Flag for serialization of query results. I.e. there are any results printed if serialization is turned off (default: <code>true</code>).|}

* ===CREATEFILTER==={||-| valign='top' width='90' | '''Signature'''|<code>BINDINGS CREATEFILTER [varsfilter]</code>: Contains external variables to be bound to the query. Keys and values are separated by equality signs, multiple variables are separated by commas (default: |-| valign='top' | '''Summary'empty'').: Example|Globbing syntax for filtering input documents (default: <code>var1=Hello,var2=World*.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: | valign='top' width='90' | '''Signature'empty'').: Example: |<code>method=xml,encoding=CP1252ADDARCHIVES</code> |-* <code>EXPORTER [params]</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: | valign='top' | '''Summary'empty''). * <code>RUNS [num]</code>: Specify number of runs a query is executed|Parse files within archives (ZIP, DOCX, GZIP, etc. Results are printed ) while creating a single time and evaluation times are averages of all runs database or adding new documents (default: <code>1true</code>).|}

==Serialization Options=SKIPCORRUPT=== {|* <code>DOTPLAN</code>|-: Create query plans visualized with [http://www.graphviz.org dotty], see <code>| valign='top' width='90' | '''Signature''plan.dot'|</code> file in your project folder (default: <code>falseSKIPCORRUPT</code>). |-* <code>DOTCOMPACT</code>| valign='top' | '''Summary''': Compact dot representation |Skip corrupt (default: <code>false</code>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. * <code>DOTDISPLAY</code>: Display dot representation after query execution Next, main memory consumption will be higher as parsed files will be cached in main memory (default: <code>truefalse</code>). * <code>DOTTY [path]</code>: Program <code>PATH</code> of dotty executable (default: <code>dotty</code>).|}

* ===PARSER==={||-| valign='top' width='90' | '''Signature'''|<code>XMLPLANPARSER [type]</code>|-| valign='top' | '''Summary'''|Define import [[Parsers|parser]]. As <code>TYPE</code> are available 'XML', 'CSV' or 'TEXT'. If [http: Print query plan as xml document //home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is found in the classpath, 'HTML' is also available (default: <code>falseXML</code>).|}

* ===PARSEROPT==={||-| valign='top' width='90' | '''Signature'''|<code>PARSEROPT [options]</code>|-| valign='top' | '''Summary'''|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>).|}