Options

From BaseX Documentation
Revision as of 21:19, 28 July 2011 by CG (talk | contribs)
Jump to navigation Jump to search

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

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

Main Options

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

  • LANG [language]
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
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 [path]
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 [path]
this path points to the XQuery package repository (default: {home}/BaseXRepo).
  • PARALLEL [number]
Set the maximum number of parallel readers (default: 8).
  • DEBUG
Show internal debug info, usually used for development of new features (default: false).

Client/Server Architecture

  • HOST [host]
Used by the client to connect the server (default: localhost).
  • PORT [port]
Used by the client to connect the server (default: 1984).
  • SERVERPORT [port]
Port of the database server (default: 1984).
  • EVENTPORT [port]
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 [port]
Port of the JAX-RX web server, usually Jetty (default: 8984).
  • JAXRXPATH [path]
This local path points to the JAX-RX web directory (default: {home}/BaseXWeb).
  • TIMEOUT [time]
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
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
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
Parse referenced DTDs and resolve XML entities (default: false).
  • CATFILE [path]
Specify a catalog file to locally resolve DTDs; see the Wikipedia entry on XML Catalogs for more details (default: empty).
  • CREATEFILTER [filter]
Globbing syntax for filtering input documents (default: *.xml).
  • ADDARCHIVES
Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents (default: true).
  • SKIPCORRUPT
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 [type]
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 [options]
Define parser-specific options (default: empty). See parsers page for more information.
  • PATHINDEX
Create index for paths and speedup path based queries (default: true).
  • TEXTINDEX
Create index for text nodes and speedup queries querying the entire text of a node (default: true).
  • ATTRINDEX
Create index for attribute values and speedup queries querying attribute values (default: true).
  • FTINDEX
Create index for fulltext and speedup queries querying full text (default: false).
  • WRITEBACK
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
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
Force database creation for unknown documents specified in XQuery expressions (default: false).

Full-Text Options

  • WILDCARDS
Create wildcard optimized full text index that is especially tuned for querying full text using wildcards expressions (default: false).
  • STEMMING
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
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
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 [lang]
Language for full-text search index, e.g. LANG can be set to English or German (default: empty).
  • SCORING [mode]
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 [path]
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 [error]
Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOption, e.g. error could be 2 (default: 0).

Query Options

  • QUERYINFO
Show (all) process info (default: false).
  • QUERY3
Enable/disable XQuery 3.0 functions (default: true).
  • SERIALIZE
Flag for serialization of query results. I.e. there are any results printed if serialization is turned off (default: true).
  • BINDINGS [vars]
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: var1=Hello,var2=World
  • SERIALIZER [params]
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: method=xml,encoding=CP1252
  • EXPORTER [params]
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 [num]
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
Create query plans visualized with dotty, see 'plan.dot' file in your project folder (default: false).
  • DOTCOMPACT
Compact dot representation (default: false).
  • DOTDISPLAY
Display dot representation after query execution (default: true).
  • DOTTY [path]
Program PATH of dotty executable (default: dotty).
  • XMLPLAN
Print query plan as xml document (default: false).
  • COMPPLAN
Create query plan before or after compilation - query plan might change due to optimizations (default: true).
  • CACHEQUERY
Cache the query results (default: false).
  • MAXSTAT [num]
Set maximum number of index occurrences to print through the command info index (default: 15).