Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
A [[Options_(Snapshot)|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.
no edit summary
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]].
=Main Options=
| valign='top' width='90' | '''Signature'''
|<code>LANG [language]</code>
|-
| valign='top' | '''Default'''
|<code>English</code>
|-
| valign='top' | '''Summary'''
|Set the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese' (default: <code>English</code>). BaseX needs to be restarted in order to activate the new language.
|}
| valign='top' width='90' | '''Signature'''
|<code>LANGKEY</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
| valign='top' width='90' | '''Signature'''
|<code>DBPATH [path]</code>
|-
| valign='top' | '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</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.
|}
|<code>REPOPATH [path]</code>
|-
| valign='top' | '''SummaryDefault'''|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 This <code>numberpath</code> of parallel readers (default: <code>8</code>)points to the XQuery package repository.
|}
| valign='top' width='90' | '''Signature'''
|<code>DEBUG</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Show internal debug info, usually used for development of new features (default: <code>false</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>HOST [host]</code>
|-
| valign='top' | '''Default'''
|<code>localhost</code>
|-
| valign='top' | '''Summary'''
|Used This host name is used by the client when connecting to connect the a server (default: <code>localhost</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>PORT [port]</code>
|-
| valign='top' | '''Default'''
|<code>1984</code>
|-
| valign='top' | '''Summary'''
|Used This port is used by the client when connecting to connect the a server (default: <code>1984</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>SERVERPORT [port]</code>
|-
| valign='top' | '''Default'''
|<code>1984</code>
|-
| valign='top' | '''Summary'''
|Port of This is the port the database server (default: will be listening to.|} ===SERVERHOST==={||-| valign='top' width='90' | '''Signature'''|<code>1984SERVERHOST [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}}.
|}
| valign='top' width='90' | '''Signature'''
|<code>EVENTPORT [port]</code>
|-
| valign='top' | '''Default'''
|<code>1985</code>
|-
| 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 (default: <code>1985</code>).
|}
===JAXRXPORTHTTPPORT===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>JAXRXPORT HTTPPORT [port]</code>|-| valign='top' | '''Default'''|<code>8984</code>
|-
| valign='top' | '''Summary'''
|Port of the JAX-RX web HTTP server, usually Jetty (default: <code>8984</code>)to address the [[WebDAV]] and [[REST]] services.
|}
===JAXRXPATHHTTPPATH==={||-| 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'''
|<code>JAXRXPATH PARALLEL [pathnumber]</code>|-| valign='top' | '''Default'''|<code>8</code>
|-
| valign='top' | '''Summary'''
|This local <code>path</code> points to Set the JAX-RX web directory (default: maximum <code>[[Configuration#Database Directory|{home}/BaseXWeb]]number</code>)of parallel readers.
|}
|-
| valign='top' width='90' | '''Signature'''
|<code>TIMEOUT [timeseconds]</code>|-| valign='top' | '''Default'''|<code>0</code> (''no timeout'')
|-
| valign='top' | '''Summary'''
|Server Client timeout in seconds. The If a client process takes longer than the specified timeout, it will be aborted. Database updates will not be affected by this timeout describes , as they would endanger the maximum execution time of a client querydatabase integrity. The timeout is deactivated if <code>timeseconds</code> is set to <code>0</code> (default: no timeout (<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=
| valign='top' width='90' | '''Signature'''
|<code>CHOP</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| 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% (default: <code>true</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>INTPARSE</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| 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. (default: <code>false</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>DTD</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Parse referenced DTDs and resolve XML entities (default: <code>false</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>CATFILE [path]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| 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 (default: ''empty'').
|}
| valign='top' width='90' | '''Signature'''
|<code>CREATEFILTER [filter]</code>
|-
| valign='top' | '''Default'''
|<code>*.xml</code>
|-
| valign='top' | '''Summary'''
|Globbing Glob syntax for filtering input documents (default: <code>*.xml</code>)files that are processed by the [[Commands#CREATE|CREATE]] or [[Commands#ADD|ADD]] commands.
|}
| valign='top' width='90' | '''Signature'''
|<code>ADDARCHIVES</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Parse files within archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documents (default: <code>true</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>SKIPCORRUPT</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| 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 (default: <code>false</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>PARSER [type]</code>
|-
| valign='top' | '''Default'''
|<code>XML</code>
|-
| 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 (default: <code>XML</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>PARSEROPT [options]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''
|Define parser-specific options (default: ''empty''). See [[Parsers|parsers]] page for more information.
|}
| valign='top' width='90' | '''Signature'''
|<code>PATHINDEX</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Create index for paths and speedup path based queries (default: <code>true</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>TEXTINDEX</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Create index for text nodes and speedup queries querying the entire text of a node (default: <code>true</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>ATTRINDEX</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Create index for attribute values and speedup queries querying attribute values (default: <code>true</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>FTINDEX</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Create index for fulltext and speedup queries querying full text (default: <code>false</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>WRITEBACK</code>
|-
| valign='top' | '''Default'''
|<code>false</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>).
|}
| valign='top' width='90' | '''Signature'''
|<code>MAINMEM</code>
|-
| valign='top' | '''Default'''
|<code>false</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>).
|}
| valign='top' width='90' | '''Signature'''
|<code>FORCECREATE</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Force database creation for unknown documents specified in XQuery expressions (default: <code>false</code>).
|}
===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=
| valign='top' width='90' | '''Signature'''
|<code>WILDCARDS</code>
|-
| valign='top' | '''Default'''
|<code>false</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>).
|}
| valign='top' width='90' | '''Signature'''
|<code>STEMMING</code>
|-
| valign='top' | '''Default'''
|<code>false</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>).
|}
| valign='top' width='90' | '''Signature'''
|<code>CASESENS</code>
|-
| valign='top' | '''Default'''
|<code>false</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>).
|}
| valign='top' width='90' | '''Signature'''
|<code>DIACRITICS</code>
|-
| valign='top' | '''Default'''
|<code>false</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>).
|}
| valign='top' width='90' | '''Signature'''
|<code>LANGUAGE [lang]</code>
|-
| valign='top' | '''Default'''
|<code>en</code>
|-
| valign='top' | '''Summary'''
|Language used for creating a new full-text search index, . Can e.g. <code>LANG</code> can be set to <code>Englishde</code> or <code>German</code> (default: ''empty'').
|}
| valign='top' width='90' | '''Signature'''
|<code>SCORING [mode]</code>
|-
| valign='top' | '''Default'''
|<code>0</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>).
|}
| valign='top' width='90' | '''Signature'''
|<code>STOPWORDS [path]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| 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'').
|}
| valign='top' width='90' | '''Signature'''
|<code>LSERROR [error]</code>
|-
| valign='top' | '''Default'''
|<code>0</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>).
|}
| valign='top' width='90' | '''Signature'''
|<code>QUERYINFO</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Show (all) process info (default: <code>false</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>QUERY3</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Enable/disable [http://www.w3.org/TR/xquery-30/ XQuery 3.0] functions (default: <code>true</code>).
|}
| valign='top' width='90' | '''Signature'''
|<code>SERIALIZE</code>
|-
| valign='top' | '''Default'''
|<code>true</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>).
|}
| valign='top' width='90' | '''Signature'''
|<code>BINDINGS [vars]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| 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'').
|}
| valign='top' width='90' | '''Signature'''
|<code>SERIALIZER [params]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| 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'').
|}
| valign='top' width='90' | '''Signature'''
|<code>EXPORTER [params]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| 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'').
|}
===RUNSQUERYPATH===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>RUNS QUERYPATH [numpath]</code>|-| valign='top' | '''Default'''|''empty''
|-
| valign='top' | '''Summary'''
|Specify number of runs a Contains the path (''base uri'') to the executed query is executed. Results are printed a single time and evaluation times are averages of all runs Introduced with {{Version|7.0}} (default: <code>1</code>''empty'').
|}
=Serialization Options= ===DOTPLANCACHEQUERY===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>DOTPLANCACHEQUERY</code>|-| valign='top' | '''Default'''|<code>false</code>
|-
| valign='top' | '''Summary'''
|Create Caches the query plans visualized with [http://www.graphviz.org dotty], see <code>'plan.dot'</code> file in your project folder (default: <code>false</code>)results before returning them to the client.
|}
===DOTCOMPACTRUNS===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>DOTCOMPACTRUNS [num]</code>|-| valign='top' | '''Default'''|<code>1</code>
|-
| valign='top' | '''Summary'''
|Compact dot representation (default: <code>false</code>)Specify number of runs a query is executed. Results are printed a single time and evaluation times are averages of all runs.
|}
=Serialization Options= =DOTDISPLAY==XMLPLAN===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>DOTDISPLAYXMLPLAN</code>|-| valign='top' | '''Default'''|<code>false</code>
|-
| valign='top' | '''Summary'''
|Display dot representation after Print query execution (default: <code>true</code>)plan as xml document.
|}
===DOTTYCOMPPLAN===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>DOTTY [path]COMPPLAN</code>|-| valign='top' | '''Default'''|<code>true</code>
|-
| valign='top' | '''Summary'''
|Program <code>PATH</code> of dotty executable (default: <code>dotty</code>)Create query plan before or after compilation - query plan might change due to optimizations.
|}
===XMLPLANDOTPLAN===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>XMLPLANDOTPLAN</code>|-| valign='top' | '''Default'''|<code>false</code>
|-
| valign='top' | '''Summary'''
|Print Create query plan as xml document (defaultplans visualized with [http: //www.graphviz.org dotty], see <code>false'plan.dot'</code>)file in your project folder.
|}
===COMPPLANDOTCOMPACT===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>COMPPLANDOTCOMPACT</code>|-| valign='top' | '''Default'''|<code>false</code>
|-
| valign='top' | '''Summary'''
|Create query plan before or after compilation - query plan might change due to optimizations (default: <code>true</code>)Compact dot representation.
|}
===CACHEQUERYDOTDISPLAY===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>CACHEQUERYDOTDISPLAY</code>|-| valign='top' | '''Default'''|<code>true</code>
|-
| valign='top' | '''Summary'''
|Cache the Display dot representation after query results (default: <code>false</code>)execution.
|}
===MAXSTATDOTTY===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>MAXSTAT DOTTY [numpath]</code>|-| valign='top' | '''Default'''|<code>dotty</code>
|-
| valign='top' | '''Summary'''
|Set maximum number of index occurrences to print through the command Program <code>info indexPATH</code> (default: <code>15</code>)of dotty executable.
|}
