Options

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.

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.