Difference between revisions of "Options"
Jump to navigation
Jump to search
Line 2: | Line 2: | ||
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_Tutorial#Visualizations|Info View]]. | 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_Tutorial#Visualizations|Info View]]. | ||
− | + | ||
− | + | This preview page contains all options offered by the [http://files.basex.org/releases/latest/ latest stable snapshot]. | |
+ | There is also a [[Options|main page]], which lists the options of the official version. | ||
=Main Options= | =Main Options= | ||
Line 14: | Line 15: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>LANG [language]</code> | |<code>LANG [language]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>English</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Set the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese' | + | |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. |
|} | |} | ||
Line 24: | Line 28: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>LANGKEY</code> | |<code>LANGKEY</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
Line 34: | Line 41: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>DBPATH [path]</code> | |<code>DBPATH [path]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Set a new database path | + | |Set a new database path. Note: if the database path is changed, existing databases have to be manually moved to the new location. |
|} | |} | ||
Line 45: | Line 55: | ||
|<code>REPOPATH [path]</code> | |<code>REPOPATH [path]</code> | ||
|- | |- | ||
− | | valign='top' | ''' | + | | valign='top' | '''Default''' |
− | | | + | |<code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |This <code>path</code> points to the XQuery package repository. |
|} | |} | ||
Line 64: | Line 67: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>DEBUG</code> | |<code>DEBUG</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Show internal debug info, usually used for development of new features | + | |Show internal debug info, usually used for development of new features. |
|} | |} | ||
Line 76: | Line 82: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>HOST [host]</code> | |<code>HOST [host]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>localhost</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |This host name is used by the client when connecting to a server. |
|} | |} | ||
Line 86: | Line 95: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>PORT [port]</code> | |<code>PORT [port]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>1984</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |This port is used by the client when connecting to a server. |
|} | |} | ||
Line 96: | Line 108: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>SERVERPORT [port]</code> | |<code>SERVERPORT [port]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>1984</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |This is the port the database server will be listening to. |
+ | |} | ||
+ | |||
+ | ===SERVERHOST=== | ||
+ | {| | ||
+ | |- | ||
+ | | valign='top' width='90' | '''Signature''' | ||
+ | |<code>SERVERHOST [host|ip]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |''empty'' (''wildcard'') | ||
+ | |- | ||
+ | | valign='top' | '''Summary''' | ||
+ | |Host name or ip address the server is bound to. Introduced with {{Version|7.0}}. | ||
|} | |} | ||
Line 106: | Line 134: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>EVENTPORT [port]</code> | |<code>EVENTPORT [port]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>1985</code> | ||
|- | |- | ||
| 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 | + | |Port of the client, listening for server events. This port is only used if a client attaches itself to a database event. |
|} | |} | ||
− | === | + | ===HTTPPORT=== |
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>HTTPPORT [port]</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>8984</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Port of the | + | |Port of the HTTP server to address the [[WebDAV]] and [[REST]] services. |
|} | |} | ||
− | === | + | ===HTTPPATH=== |
+ | {| | ||
+ | |- | ||
+ | | valign='top' width='90' | '''Signature''' | ||
+ | |<code>HTTPPATH [path]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>[[Configuration#Database Directory|{home}/BaseXHTTP]]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Summary''' | ||
+ | |This local <code>path</code> points to the HTTP directory, which is used by the [[REST]] service. | ||
+ | |} | ||
+ | |||
+ | ===PARALLEL=== | ||
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>PARALLEL [number]</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>8</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |Set the maximum <code>number</code> of parallel readers. |
|} | |} | ||
Line 135: | Line 185: | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code>TIMEOUT [ | + | |<code>TIMEOUT [seconds]</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>0</code> (''no timeout'') | ||
|- | |- | ||
| 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>. |
|} | |} | ||
+ | ===KEEPALIVE=== | ||
+ | {| | ||
+ | |- | ||
+ | | valign='top' width='90' | '''Signature''' | ||
+ | |<code>KEEPALIVE [seconds]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>0</code> (''no timeout'') | ||
+ | |- | ||
+ | | 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}}. | ||
+ | |} | ||
=Database Options= | =Database Options= | ||
Line 149: | Line 214: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>CHOP</code> | |<code>CHOP</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| 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% | + | |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%. |
|} | |} | ||
Line 159: | Line 227: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>INTPARSE</code> | |<code>INTPARSE</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| 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 | + | |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. |
|} | |} | ||
Line 169: | Line 240: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>DTD</code> | |<code>DTD</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Parse referenced DTDs and resolve XML entities | + | |Parse referenced DTDs and resolve XML entities. |
|} | |} | ||
Line 179: | Line 253: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>CATFILE [path]</code> | |<code>CATFILE [path]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |''empty'' | ||
|- | |- | ||
| 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 | + | |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. |
|} | |} | ||
Line 189: | Line 266: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>CREATEFILTER [filter]</code> | |<code>CREATEFILTER [filter]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>*.xml</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |Glob syntax for filtering files that are processed by the [[Commands#CREATE|CREATE]] or [[Commands#ADD|ADD]] commands. |
|} | |} | ||
Line 199: | Line 279: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>ADDARCHIVES</code> | |<code>ADDARCHIVES</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents | + | |Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents. |
|} | |} | ||
Line 209: | Line 292: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>SKIPCORRUPT</code> | |<code>SKIPCORRUPT</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| 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 | + | |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. |
|} | |} | ||
Line 219: | Line 305: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>PARSER [type]</code> | |<code>PARSER [type]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>XML</code> | ||
|- | |- | ||
| 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 | + | |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. |
|} | |} | ||
Line 229: | Line 318: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>PARSEROPT [options]</code> | |<code>PARSEROPT [options]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |''empty'' | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Define parser-specific options | + | |Define parser-specific options. See [[Parsers|parsers]] page for more information. |
|} | |} | ||
Line 239: | Line 331: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>PATHINDEX</code> | |<code>PATHINDEX</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Create index for paths and speedup path based queries | + | |Create index for paths and speedup path based queries. |
|} | |} | ||
Line 249: | Line 344: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>TEXTINDEX</code> | |<code>TEXTINDEX</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Create index for text nodes and speedup queries querying the entire text of a node | + | |Create index for text nodes and speedup queries querying the entire text of a node. |
|} | |} | ||
Line 259: | Line 357: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>ATTRINDEX</code> | |<code>ATTRINDEX</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Create index for attribute values and speedup queries querying attribute values | + | |Create index for attribute values and speedup queries querying attribute values. |
|} | |} | ||
Line 269: | Line 370: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>FTINDEX</code> | |<code>FTINDEX</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Create index for fulltext and speedup queries querying full text | + | |Create index for fulltext and speedup queries querying full text. |
|} | |} | ||
Line 279: | Line 383: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>WRITEBACK</code> | |<code>WRITEBACK</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| 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 | + | |Write original files back after updates. As this will alter your input file make sure you have a backup before you use this option. |
|} | |} | ||
Line 289: | Line 396: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>MAINMEM</code> | |<code>MAINMEM</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| 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 | + | |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. |
|} | |} | ||
Line 299: | Line 409: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>FORCECREATE</code> | |<code>FORCECREATE</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Force database creation for unknown documents specified in XQuery expressions | + | |Force database creation for unknown documents specified in XQuery expressions. |
|} | |} | ||
+ | ===AUTOFLUSH=== | ||
+ | {| | ||
+ | |- | ||
+ | | valign='top' width='90' | '''Signature''' | ||
+ | |<code>AUTOFLUSH</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
+ | |- | ||
+ | | 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}}. | ||
+ | |} | ||
+ | |||
+ | ===MAXSTAT=== | ||
+ | {| | ||
+ | |- | ||
+ | | valign='top' width='90' | '''Signature''' | ||
+ | |<code>MAXSTAT [num]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>30</code> | ||
+ | |- | ||
+ | | valign='top' | '''Summary''' | ||
+ | |Set maximum number of index occurrences to print through the command <code>info index</code>. | ||
+ | |} | ||
=Full-Text Options= | =Full-Text Options= | ||
Line 312: | Line 450: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>WILDCARDS</code> | |<code>WILDCARDS</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions | + | |Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions. |
|} | |} | ||
Line 322: | Line 463: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>STEMMING</code> | |<code>STEMMING</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| 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 | + | |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. |
|} | |} | ||
Line 332: | Line 476: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>CASESENS</code> | |<code>CASESENS</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| 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 | + | |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. |
|} | |} | ||
Line 342: | Line 489: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>DIACRITICS</code> | |<code>DIACRITICS</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| 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 | + | |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. |
|} | |} | ||
Line 352: | Line 502: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>LANGUAGE [lang]</code> | |<code>LANGUAGE [lang]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>en</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Language for full-text search index | + | |Language used for creating a new full-text search index. Can e.g. be set to <code>de</code> or <code>German</code>. |
|} | |} | ||
Line 362: | Line 515: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>SCORING [mode]</code> | |<code>SCORING [mode]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>0</code> | ||
|- | |- | ||
| 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 | + | |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. |
|} | |} | ||
Line 372: | Line 528: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>STOPWORDS [path]</code> | |<code>STOPWORDS [path]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |''empty'' | ||
|- | |- | ||
| 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> | + | |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>. |
|} | |} | ||
Line 382: | Line 541: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>LSERROR [error]</code> | |<code>LSERROR [error]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>0</code> | ||
|- | |- | ||
| 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> | + | |Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOption, e.g. error could be <code>2</code>. |
|} | |} | ||
Line 395: | Line 557: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>QUERYINFO</code> | |<code>QUERYINFO</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Show (all) process info | + | |Show (all) process info. |
|} | |} | ||
Line 405: | Line 570: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>QUERY3</code> | |<code>QUERY3</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Enable/disable [http://www.w3.org/TR/xquery-30/ XQuery 3.0] functions | + | |Enable/disable [http://www.w3.org/TR/xquery-30/ XQuery 3.0] functions. |
|} | |} | ||
Line 415: | Line 583: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>SERIALIZE</code> | |<code>SERIALIZE</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Flag for serialization of query results. I.e. there are any results printed if serialization is turned off | + | |Flag for serialization of query results. I.e. there are any results printed if serialization is turned off. |
|} | |} | ||
Line 425: | Line 596: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>BINDINGS [vars]</code> | |<code>BINDINGS [vars]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |''empty'' | ||
|- | |- | ||
| 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 the query. Keys and values are separated by equality signs, multiple variables are separated by commas. |
|} | |} | ||
Line 435: | Line 609: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>SERIALIZER [params]</code> | |<code>SERIALIZER [params]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |''empty'' | ||
|- | |- | ||
| 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 | + | |Parameters for serializing queries; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are separated by commas. |
|} | |} | ||
Line 445: | Line 622: | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
|<code>EXPORTER [params]</code> | |<code>EXPORTER [params]</code> | ||
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |''empty'' | ||
|- | |- | ||
| 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 | + | |Parameters for exporting the documents; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are separated by commas. |
|} | |} | ||
− | === | + | ===QUERYPATH=== |
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>QUERYPATH [path]</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |''empty'' | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |Contains the path (''base uri'') to the executed query. Introduced with {{Version|7.0}} (default: ''empty''). |
|} | |} | ||
− | + | ===CACHEQUERY=== | |
− | = | ||
− | |||
− | = | ||
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>CACHEQUERY</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |Caches the query results before returning them to the client. |
|} | |} | ||
− | === | + | ===RUNS=== |
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>RUNS [num]</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>1</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | 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. |
|} | |} | ||
− | === | + | =Serialization Options= |
+ | |||
+ | ===XMLPLAN=== | ||
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>XMLPLAN</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |Print query plan as xml document. |
|} | |} | ||
− | === | + | ===COMPPLAN=== |
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>COMPPLAN</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |Create query plan before or after compilation - query plan might change due to optimizations. |
|} | |} | ||
− | === | + | ===DOTPLAN=== |
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>DOTPLAN</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| 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. |
|} | |} | ||
− | === | + | ===DOTCOMPACT=== |
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>DOTCOMPACT</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>false</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |Compact dot representation. |
|} | |} | ||
− | === | + | ===DOTDISPLAY=== |
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>DOTDISPLAY</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>true</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |Display dot representation after query execution. |
|} | |} | ||
− | === | + | ===DOTTY=== |
{| | {| | ||
|- | |- | ||
| valign='top' width='90' | '''Signature''' | | valign='top' width='90' | '''Signature''' | ||
− | |<code> | + | |<code>DOTTY [path]</code> |
+ | |- | ||
+ | | valign='top' | '''Default''' | ||
+ | |<code>dotty</code> | ||
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | | | + | |Program <code>PATH</code> of dotty executable. |
|} | |} |
Revision as of 14:15, 14 October 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.
This preview page contains all options offered by the latest stable snapshot. There is also a main page, which lists the options of the official version.
Contents
Main Options
The main options are only available in the standalone and server instance of BaseX; they cannot be changed by database clients:
LANG
Signature | LANG [language]
|
Default | English
|
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. |
LANGKEY
Signature | LANGKEY
|
Default | false
|
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]
|
Default | {home}/BaseXData
|
Summary | Set a new database path. Note: if the database path is changed, existing databases have to be manually moved to the new location. |
REPOPATH
Signature | REPOPATH [path]
|
Default | {home}/BaseXRepo
|
Summary | This path points to the XQuery package repository.
|
DEBUG
Signature | DEBUG
|
Default | false
|
Summary | Show internal debug info, usually used for development of new features. |
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 | Host name or ip address the server is bound to. Introduced with Version 7.0. |
EVENTPORT
Signature | EVENTPORT [port]
|
Default | 1985
|
Summary | Port of the client, listening for server events. This port is only used if a client attaches itself to a database event. |
HTTPPORT
Signature | HTTPPORT [port]
|
Default | 8984
|
Summary | Port of the HTTP server to address the WebDAV and REST services. |
HTTPPATH
Signature | HTTPPATH [path]
|
Default | {home}/BaseXHTTP
|
Summary | This local path points to the HTTP directory, which is used by the REST service.
|
PARALLEL
Signature | PARALLEL [number]
|
Default | 8
|
Summary | Set the maximum number of parallel readers.
|
TIMEOUT
Signature | TIMEOUT [seconds]
|
Default | 0 (no timeout)
|
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 seconds is set to 0 .
|
KEEPALIVE
Signature | KEEPALIVE [seconds]
|
Default | 0 (no timeout)
|
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 seconds is set to 0 . Introduced with Version 7.0.
|
Database Options
CHOP
Signature | CHOP
|
Default | true
|
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%. |
INTPARSE
Signature | INTPARSE
|
Default | true
|
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. |
DTD
Signature | DTD
|
Default | false
|
Summary | Parse referenced DTDs and resolve XML entities. |
CATFILE
Signature | CATFILE [path]
|
Default | empty |
Summary | Specify a catalog file to locally resolve DTDs; see the Wikipedia entry on XML Catalogs for more details. |
CREATEFILTER
Signature | CREATEFILTER [filter]
|
Default | *.xml
|
Summary | Glob syntax for filtering files that are processed by the CREATE or ADD commands. |
ADDARCHIVES
Signature | ADDARCHIVES
|
Default | true
|
Summary | Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents. |
SKIPCORRUPT
Signature | SKIPCORRUPT
|
Default | false
|
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. |
PARSER
Signature | PARSER [type]
|
Default | XML
|
Summary | Define import parser. As TYPE are available 'XML', 'CSV' or 'TEXT'. If Tagsoup is found in the classpath, 'HTML' is also available.
|
PARSEROPT
Signature | PARSEROPT [options]
|
Default | empty |
Summary | Define parser-specific options. See parsers page for more information. |
PATHINDEX
Signature | PATHINDEX
|
Default | true
|
Summary | Create index for paths and speedup path based queries. |
TEXTINDEX
Signature | TEXTINDEX
|
Default | true
|
Summary | Create index for text nodes and speedup queries querying the entire text of a node. |
ATTRINDEX
Signature | ATTRINDEX
|
Default | true
|
Summary | Create index for attribute values and speedup queries querying attribute values. |
FTINDEX
Signature | FTINDEX
|
Default | false
|
Summary | Create index for fulltext and speedup queries querying full text. |
WRITEBACK
Signature | WRITEBACK
|
Default | false
|
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. |
MAINMEM
Signature | MAINMEM
|
Default | false
|
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. |
FORCECREATE
Signature | FORCECREATE
|
Default | false
|
Summary | Force database creation for unknown documents specified in XQuery expressions. |
AUTOFLUSH
Signature | AUTOFLUSH
|
Default | true
|
Summary | Flush database buffers to disk after each update. If this option is set to false , 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 FLUSH command. Introduced with Version 7.0.
|
MAXSTAT
Signature | MAXSTAT [num]
|
Default | 30
|
Summary | Set maximum number of index occurrences to print through the command info index .
|
Full-Text Options
WILDCARDS
Signature | WILDCARDS
|
Default | false
|
Summary | Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions. |
STEMMING
Signature | STEMMING
|
Default | false
|
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. |
CASESENS
Signature | CASESENS
|
Default | false
|
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. |
DIACRITICS
Signature | DIACRITICS
|
Default | false
|
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. |
LANGUAGE
Signature | LANGUAGE [lang]
|
Default | en
|
Summary | Language used for creating a new full-text search index. Can e.g. be set to de or German .
|
SCORING
Signature | SCORING [mode]
|
Default | 0
|
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.
|
STOPWORDS
Signature | STOPWORDS [path]
|
Default | empty |
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' .
|
LSERROR
Signature | LSERROR [error]
|
Default | 0
|
Summary | Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOption, e.g. error could be 2 .
|
Query Options
QUERYINFO
Signature | QUERYINFO
|
Default | false
|
Summary | Show (all) process info. |
QUERY3
Signature | QUERY3
|
Default | true
|
Summary | Enable/disable XQuery 3.0 functions. |
SERIALIZE
Signature | SERIALIZE
|
Default | true
|
Summary | Flag for serialization of query results. I.e. there are any results printed if serialization is turned off. |
BINDINGS
Signature | BINDINGS [vars]
|
Default | empty |
Summary | Contains external variables to be bound to the query. Keys and values are separated by equality signs, multiple variables are separated by commas. |
SERIALIZER
Signature | SERIALIZER [params]
|
Default | empty |
Summary | Parameters for serializing queries; see Serialization for more details. Keys and values are separated by equality signs, multiple parameters are separated by commas. |
EXPORTER
Signature | EXPORTER [params]
|
Default | empty |
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. |
QUERYPATH
Signature | QUERYPATH [path]
|
Default | empty |
Summary | Contains the path (base uri) to the executed query. Introduced with Version 7.0 (default: empty). |
CACHEQUERY
Signature | CACHEQUERY
|
Default | false
|
Summary | Caches the query results before returning them to the client. |
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 | Print query plan as xml document. |
COMPPLAN
Signature | COMPPLAN
|
Default | true
|
Summary | Create query plan before or after compilation - query plan might change due to optimizations. |
DOTPLAN
Signature | DOTPLAN
|
Default | false
|
Summary | Create query plans visualized with dotty, see 'plan.dot' file in your project folder.
|
DOTCOMPACT
Signature | DOTCOMPACT
|
Default | false
|
Summary | Compact dot representation. |
DOTDISPLAY
Signature | DOTDISPLAY
|
Default | true
|
Summary | Display dot representation after query execution. |
DOTTY
Signature | DOTTY [path]
|
Default | dotty
|
Summary | Program PATH of dotty executable.
|