Difference between revisions of "Options"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
The following options are available and can be requested and changed with the [[Commands#GET|GET]] and [[Commands#SET|SET]] commands. | The following options are available and can be requested and changed with the [[Commands#GET|GET]] and [[Commands#SET|SET]] commands. | ||
− | They can either be turned ON/OFF, or a value can be assigned | + | They can either be turned ON/OFF, or a value can be assigned. |
− | + | ||
===General options=== | ===General options=== | ||
Revision as of 19:00, 3 March 2011
The following options are available and can be requested and changed with the GET and SET commands. They can either be turned ON/OFF, or a value can be assigned.
Contents
General options
DEBUG
- Show internal debug info, usually used for development of new features (default:
false
).
LANG [language]
- Set the interface language. Currently, seven languages are available 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese' (default:
English
).
MAINMEM
- Use main-memory mode. Now all data is stored exclusively in main memory and enables even faster evaluation times, but the data is lost after shut down of BaseX (default:
false
).
Server options
TIMEOUT [time]
- Set server timeout in seconds. The timeout describes the maximum execution time of a query at BaseX server. The timeout is deactivated if
time
is set to0
(default: no timeout (0
)).
PARALLEL [number]
Version 6.5.1
- Set the maximum
number
of parallel readers (default:8
).
SERVERPORT [port]
- Client/server communication:
port
, used for starting the server (default:1984
).
HOST [host]
- Client/server communication:
host
, used for connecting new clients (default:localhost
).
PORT [port]
- Client/server communication:
port
, used for connecting new clients (default:1984
).
JAXRXPORT [port]
Version 6.5.1
- Client/server communication:
port
, used for starting the JAX-RX server (default:8984
).
JAXRXPATH [path]
Version 6.5.1
- Client/server communication:
path
, used for over the JAX-RX interface accessible files (default:{home directory}/BaseXWeb
).
Database options
DBPATH [path]
- Set a new database path (default:
{home directory}/BaseXData
). Note: After having changed the database path, all existing databases have to be manually moved to the new location.
CHOP
- Chop all XML whitespace nodes and reduce the memory consumption of the database without lack of information (default:
true
).
INTPARSE
- Use internal XML parser instead of standard Java XML parser and reduce main memory consumption (default:
false
).
ENTITY
- Internal parser parses XML entities (default:
false
).
DTD
- Internal parser parses a DTD and checks the parsed XML data against the DTD (default:
false
).
CATFILE [path]
- Set
PATH
to XML catalog file (default: empty).
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
).
CREATEFILTER [filter]
- Globbing syntax for filtering input documents (default:
*.xml
).
FORCECREATE
- Force database creation for unknown documents specified in XQuery expressions (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]
Version 6.5.1
- Define parser-specific options (default: empty). See parsers page for more information.
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
).
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 toEnglish
orGerman
(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 to1
for document based scoring,2
for text node based scoring and0
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
).
WRAPOUTPUT
- Serialize query results as XML, i.e. the result output is a valid xml document (default:
false
).
BINDINGS [vars]
Version 6.5.1
- 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
).
TABLEMEM
- Loading database table into main memory and speedup evaluation times (default:
false
).
Print query 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
).
DeepFS options
FSMETA
- Import file metadata (default:
true
).
FSCONT
- Import file content (default:
false
).
FSXML
- Import xml contents (default:
false
).
FSTEXTMAX [size]
- Maximal size of textual imports, e.g.
SIZE
could be1024
for importing less equal 1024 bytes (default:10240
).
FSVERBOSE
- Verbose debug informations for file system traversal (default:
false
).
FUSE
- Fuse support (default:
false
).
SPOTLIGHT
- Spotlight integration on Mac platforms, i.e. the spotlight index is used instead of the internal parser implementations (default:
false
).