Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
This preview page contains all options offered by the [http://files.basex.org/releases/latest/ latest stable snapshot].There is also a * '''[[#Global Options|main pageGlobal Options]], which lists ''' are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/server architecture.* '''Local options of the official version''' (all remaining ones) are specific to a client or session.
=Main Values of options are either ''strings'', ''numbers'' or ''booleans''. Options=are ''static'' and not bound to a single operation (for example, the next command). Various ways exist to access and change options:
| valign='top' | '''Default'''|<code>English</code>{{Code|false}}
| valign='top' | '''Summary'''|Set the interface languageSends internal debug info to STDERR. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', This option can be turned on to get additional information for development and 'Vietnamese'debugging purposes. It can also be triggered on [[Command-Line Options#BaseX needs to be restarted in order to activate the new languageStandalone|command line]] via <code>-d</code>.
| valign='top' | '''Default'''|<code>false<code>[[Configuration#Database Directory|{home}/data]]</code>
| valign='top' | '''Summary'''|Prefix all texts with Points to the internal language keys. This option is helpful for creating new translations. BaseX needs to be restarted directory in order to activate this optionwhich all databases are located.
| valign='top' | '''Default'''|<code>[[Configuration#Database Directory|{home}/BaseXData]].logs</code>
| valign='top' | '''Summary'''|Set a new database pathPoints to the directory in which all [[Logging|log files]] are stored. Note: if the database path is changed, existing databases have to Relative paths will be manually moved to resolved against the new location{{Option|DBPATH}} directory.
| valign='top' | '''Default'''|<code>[[Configuration#Database Directory|{home}/BaseXReporepo]]</code>
| valign='top' | '''Summary'''|This <code>path</code> points Points to the [[Repository]], in which all XQuery package repositorymodules are located.
| valign='top' | '''Default'''|<code>false</code>{{Code|3600}}
| valign='top' | '''Summary'''|Show internal debug infoSpecifies how many seconds the results of queries, usually used for development of new featureswhich have been queued by the [[Jobs Module|asynchronously executed]], will be cached in main memory.
| valign='top' | '''Default'''|<code>{{Code|localhost</code>}}
| valign='top' | '''Summary'''|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
| valign='top' | '''Default'''|<code>{{Code|1984</code>}}
| valign='top' | '''Summary'''|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
| valign='top' | '''Default'''|<code>1984</code>''empty''
| valign='top' | '''Default'''|''empty'' (''wildcard'')
| valign='top' | '''Summary'''|Host This is the host name or ip address the server is bound to. Introduced with {{Version|7.0}}If the option is set to an empty string (which is the default), the server will be open to all clients.
| valign='top' | '''Default'''|<code>1985</code>''empty''
| valign='top' | '''Summary'''|Port This is the host name of the client, listening for a proxy server events. This port If the value is only used if a client attaches itself to a database eventan empty string, it will be ignored.
| valign='top' | '''Default'''|<code>8984</code>{{Code|0}}
| valign='top' | '''Summary'''|Port This is the port number of a proxy server. If the HTTP server value is set to address the [[WebDAV]] and [[REST]] services{{Code|0}}, it will be ignored.
| valign='top' | '''Default'''|<code>[[Configuration#Database Directory|{home}/BaseXHTTP]]</code>''empty''
| valign='top' | '''Summary'''|This local <code>path</code> points to is a list of hosts that should be directly accessed. If the HTTP directoryvalue is an empty string, which is used by the [[REST]] serviceit will be ignored.
| valign='top' | '''Default'''|<code>8</code>{{Code|false}}
| valign='top' | '''Summary'''|Set This option can be turned on to ignore untrusted certificates when connecting to servers. Use {{Option|IGNOREHOSTNAME}} to suppress only the maximum <code>number</code> of parallel readershostname verification.
| valign='top' | '''Default'''|<code>0</code> (''no timeout''){{Code|30}}
| valign='top' | '''Summary'''|Client timeoutSpecifies the maximum time a transaction triggered by a client may take. If a client process an operation takes longer than the specified timeoutnumber of seconds, it will be aborted. Database updates Active update operations will not be affected by this timeout, as they this would endanger corrupt the integrity of the database integrity. The timeout is deactivated if <code>seconds</code> the timeout is set to <code>{{Code|0</code>}}. It is ignored for operations with [[User Management|admin permissions]].
| valign='top' | '''Default'''|<code>0</code> (''no timeout''){{Code|8}}
| valign='top' | '''Summary'''|Keepalive timeout. Denotes the maximum allowed number of parallel [[Transaction Management|transactions]]:* If there has been no interaction with a client for a longer time than specified by this timeout{{Option|FAIRLOCK}} is enabled, it the number of parallel transactions will be disconnectednever exceed the specified value. Running operations will not be affected by this timeout* If the option is disabled (which is the default), the limit only applies to transactions that access databases. * The keepalive check is deactivated if <code>seconds</code> main reason for allowing parallel operations is set to <code>0</code>prevent slow transactions from blocking all other operations. Introduced with {{Version|7A higher number of parallel operations may increase disk activity and thus slow down queries.0}}In some cases, a single transaction may even give you better results than any parallel activity.
| valign='top' | '''Default'''|<code>true</code>{{Code|1000}}
| valign='top' | '''Summary'''|Chop all leading and trailing whitespaces from text nodes while building Specifies the maximum length of a database, and discard empty text nodes. This option often reduces the database size by up to 50%single [[Logging|log message]].
| valign='top' | '''Default'''|<code>true[[Configuration#Database Directory|{home}/webapp]]</code>
| valign='top' | '''Summary'''|Use internal XML parser instead of Points to the directory in which all the standard Java XML parser. [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:* The internal parser option is faster, more fault tolerant and supports common HTML entities out-of-ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].* It cannot be assigned via the-box{{Code|web.xml}} file, but as it does not support all features needed for parsing DTDswill be evaluated before the configuration files are parsed.
| valign='top' | '''Default'''
| valign='top' | '''Default'''
| valign='top' | '''Summary'''|Specify a catalog file Points to locally resolve DTDs; see the Wikipedia entry on directory which contains XQuery files and command scripts, which can be evaluated via the [http://en[REST#GET Requests|REST run operation]].wikipedia.org/wiki/XML_Catalog XML Catalogs] for more detailsRelative paths will be resolved against the {{Option|WEBPATH}} directory.
| valign='top' | '''Default'''|<code>{{Code|*.xml</code>}}
| valign='top' | '''Summary'''|Glob syntax for filtering files that are processed by File filter in the [[Commands#CREATEGlob Syntax|CREATEGlob Syntax]] , which is applied whenever new databases are created, or [[Commands#ADD|ADD]] commandsresources are added to a database.
| valign='top' | '''Default'''|<code>true</code>{{Code|false}}
| valign='top' | '''Summary'''|Parse files within If this option is set to {{Code|true}}, the file name of parsed archives (ZIP, DOCX, GZIP, etc.) while creating a database or adding new documentswill be included in the document paths.
| valign='top' | '''Summary'''|Skip corrupt (i.e., non-well-formed) files while creating a database or adding new documents. If this option is usedenabled, all resources that are filtered out by the {{Option|CREATEFILTER}} option while being added to a database creation is slowed down, will be stored as all [[Binary Data|raw files will be parsed twice]] instead (i.e. Next, main memory consumption will be higher as parsed files will be cached in main memorytheir binary representation).
| valign='top' | '''Default'''|<code>{{Code|XML</code>}}
| valign='top' | '''Summary'''|Define import Defines a [[Parsers|parser]]for importing new files to the database. As <code>TYPE</code> Available parsers are available '{{Code|XML'}}, {{Code|JSON}}, '{{Code|CSV' or '}}, {{Code|TEXT'}}, {{Code|HTML}}, and {{Code|RAW}}. If HTML input will be parsed as XML documents if [http://home.ccil.org/~cowan/XML/tagsoup/ [Parsers#HTML_Parser|Tagsoup]] is not found in the classpath, 'HTML' is also available.
| valign='top' | '''Default'''
| valign='top' | '''Default'''|<code>true</code>{{Code|false}}
| valign='top' | '''Summary'''|Create index for paths Parses referenced DTDs and speedup path based queriesresolves XML entities. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The {{Option|CATFILE}} option can be changed to locally resolve DTDs.
| valign='top' | '''Default'''|<code>{{Code|true</code>}}
| valign='top' | '''Summary'''|Create Creates a text index for whenever a new database is created. A text nodes and speedup index speeds up queries querying the entire with equality comparisons on text of a nodenodes. See [[Index#Text Index|Text Index]] for more details.
| valign='top' | '''Default'''|<code>{{Code|true</code>}}
| valign='top' width='90' | '''SignatureSummary'''|Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<code>FTINDEX<br/code>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===TOKENINCLUDE=== {| width='100%'
| valign='top' | '''Summary'''|Create index Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for fulltext and speedup queries querying full textmore details.
| valign='top' | '''Default'''|<code>false</code>''empty''
| valign='top' | '''Summary'''|Write original files back after updatesDefines name patterns for the parent elements of texts that are indexed. As this By default, all text nodes will alter your input file make sure you have a backup before you use this optionbe indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
| valign='top' | '''Default'''|<code>false</code>{{Code|96}}
| valign='top' | '''Summary'''|Use mainSpecifies the maximum length of strings that are to be indexed by the name, path, value, and full-memory mode. Now all data is exclusively stored in main memorytext index structures. Some queries The value of this option will be evaluated even fasterassigned once to a new database, but the data is lost if BaseX is shut downand cannot be changed after that.
| valign='top' | '''Default'''|<code>false</code>{{Code|100}}
| valign='top' | '''Summary'''|Force Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database creation for unknown documents specified in XQuery expressions, and cannot be changed after that.
| valign='top' | '''Default'''|<code>true</code>{{Code|false}}
| valign='top' | '''Summary'''|Flush database buffers to disk after each update. If turned on, incremental indexing will be enabled:* The current value of this option is set will be assigned to <code>false</code>new databases. It can be changed for existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or [[Database_Module#db:optimize|db:optimize($db, some true())]].* After each update , the value indexes will be evaluated much faster, but the chance of data loss increases if refreshed as well. Incremental updates are currently not available for the full-text index and database is always open and not explicitly flushed via statistics.* Find more details in the article on [[Commands (Snapshot)Index#FLUSHUpdates|FLUSHIndex Structures]] command. Introduced with {{Version|7.0}}.
| valign='top' | '''Default'''|<code>30</code>{{Code|false}}
| valign='top' | '''Summary'''|Set maximum number of index occurrences If turned on, auto optimization will be applied to print through new databases:* With each update, outdated indexes and database statistics will be recreated.* As a result, the command <code>info index</code>structures will always be up-to-date.* However, updates can take much longer, so this option should only be activated for medium-sized databases.* The value of this option will be assigned once to a new database. It can be reassigned by running {{Command|OPTIMIZE}} or [[Database_Module#db:optimize|db:optimize]].
===WILDCARDS==={|width='100%'
| valign='top' | '''Default'''|<code>false</code>{{Code|0}}
| valign='top' | '''Summary'''|Create wildcard optimized full text This option affects the [[Indexes#Performance|construction]] of new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk:* By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption. Usually, this works fine.* If explicit garbage collection is disabled when running Java (e.g. via the JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to choose a custom split size.* You can e. g. start with {{Code|1000000}} (one million) index operations and adjust this value in the next steps.* The larger the assigned value is especially tuned for querying full text using wildcards expressions, the less splits will take place, and the more main memory will be required.
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
| valign='top' | '''Summary'''|Stemm full text If {{Code|true}}, all tokens before indexing and decrease index size. Should only will be assigned for stemmed during full -text queries indexing, using stemminga language-specific stemmer implementation. By default, otherwise the full text index could tokens will not be assigned stemmed. See [[Indexes#Full-Text Index|Full-Text Index]] for query speedupsmore details.
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
| valign='top' | '''Summary'''|Diacritic sensitive If set to {{Code|true}}, diacritics will be preserved during full -text indexing. By default, idiacritics will be removed.e. full text tokens are stored with diacritics and enables the assignment of the full text index See [[Indexes#Full-Text Index|Full-Text Index]] for diacritic queriesmore details.
| valign='top' | '''Default'''|<code>0</code>{{Code|false}}
| valign='top' | '''Summary'''|Precalculation of full text scores Allows queries to both contain updating and storage within the full text index structurenon-updating expressions. Enables TF/IDF based scores in full text queries All updating constraints will be turned off, and increases memory consumption while indexingnodes to be returned will be copied before they are modified by an updating expression. <code>MODE</code> can be By default, in compliance with the XQuery Update Facility, this option is set to <code>1</code> for document based scoring, <code>2</code> for text node based scoring and <code>0</code> {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for non scoringmore details.
| valign='top' | '''Default'''
| valign='top' | '''Default'''|<code>0</code>{{Code|256}}
| valign='top' | '''Summary'''|Levenshtein default error used for fuzzy search with BaseX specialized own FTMatchOptionSpecifies how many stack frames of [http://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this limit is reached, e.gtail-call optimization takes place and some call frames are eliminated. error could The feature can be <code>2</code>turned off by setting the value to {{Code|-1}}.
=Query Options={{Mark|Introduced with Version 9.3.}}
===QUERYINFO==={|width='100%'
| valign='top' | '''Default'''|<code>false</code>{{Code|true}}
| valign='top' | '''Summary'''|Show By default, URIs specified in the [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] functions will also be resolved against existing databases. If {{Function|Database|db:open}} is consistently used to access database documents, it is recommendable to disable this option:* Access to local and external resources will be faster, as the database lookup will be skipped.* No locks will be created by the two functions (allsee [[Transaction Management#Limitations|limitations of database locking]] for more details) process info.
| valign='top' | '''Default'''|<code>true</code>{{Code|false}}
| valign='top' | '''Summary'''|Enable/disable If this option is turned on, paths specified in the [[Databases#XML Documents|fn:doc]] and [[httpDatabases#XML Documents|fn://wwwcollection]] functions will first be resolved against a database that has been opened in the global context outside the query (e.w3g.org/TR/xquery-30/ XQuery 3by the {{Command|OPEN}} command).0If the path does not match any existing resources, it will be resolved as described in the article on [[Databases#Access Resources|accessing database resources]] functions.
| valign='top' | '''Default'''|<code>true</code>{{Code|false}}
| valign='top' | '''Summary'''|Flag for serialization of query results. I.e. there are any results printed if serialization is turned offBy activating this option, database instances will be created with the XQuery functions [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]].
| valign='top' | '''Default'''|''empty''{{Code|true}}
| valign='top' | '''Summary'''|Contains By default, characters from external variables sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>, these characters will be bound to replaced with the queryUnicode replacement character <code>FFFD</code> (�). Keys The option affects [[Java Bindings]] and values are separated by equality signsstring conversion and input functions such as [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], [[Archive Module#archive:update|archive:update]], multiple variables are separated by commasand [[ZIP Module#zip:text-entry|zip:text-entry]].
| valign='top' | '''Default'''|''empty''{{Code|0}}
| valign='top' | '''Summary'''|Parameters This option specifies the maximum Levenshtein error for serializing queries; see the BaseX-specific fuzzy match option. See the page on [[SerializationFull-Text#Fuzzy_Querying|Full-Texts]] for more details. Keys and values are separated by equality signs, multiple parameters are separated by commasinformation on fuzzy querying.
| valign='top' | '''Default'''|''empty''{{Code|true}}
| valign='top' | '''Summary'''|Parameters for exporting the documents; see Specifies if a query will be executed or parsed only. This option can also be changed on [[SerializationCommand-Line Options#BaseX Standalone|command line]] for more details. Keys and values are separated by equality signs, multiple parameters are separated by commasvia <code>-R</code>.
| valign='top' | '''Default'''|''empty''{{Code|1}}
| valign='top' | '''Summary'''|Contains the path (''base uri'') to Specifies how often a query will be evaluated. The result is serialized only once, and the executed querymeasured times are averages of all runs. Introduced with {{VersionThis option can also be changed on [[Command-Line Options#BaseX Standalone|7.0}} (default: ''empty'')command line]] via <code>-r</code>.
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
| valign='top' | '''Summary'''|Caches the query results before returning them to the clientEnforces index rewritings in path expressions (see [[Indexes#Enforce Rewritings|Enforce Rewritings]] for details).
| valign='top' | '''Default'''|<code>1</code>{{Code|true}}
| valign='top' | '''Summary'''|Specify number of runs a query is executedWhen creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], all enclosed nodes will be copied, and all resulting nodes will get new node identities. Results are printed a single time This step can be very expensive, and evaluation times are averages it can be disabled with this option. The option should be used carefully, as it changes the standard behavior of all runsXQuery. It should preferrably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
| valign='top' | '''Summary'''|Print query Prints the execution plan as xml documentof an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.
| valign='top' | '''Default'''|<code>{{Code|true</code>}}
| valign='top' | '''Summary'''|Create Generates the query plan , which can be activated via {{Option|XMLPLAN}}, before or after query compilation . This option can also be activated on [[Command- query plan might change due to optimizationsLine Options#BaseX Standalone|command line]] via <code>-X</code>.
| valign='top' | '''Default'''|<code>{{Code|false</code>}}
| valign='top' | '''Summary'''|Create Attaches the file path, line and column of the expressions in the original query string to the query plans visualized with [http://www.graphviz.org dotty], see <code>'plan.dot'</code> file in your project folderValues (items and sequences) have no input information attached.
| valign='top' | '''Default'''|<code>false</code>{{Code|true}}
| valign='top' | '''Summary'''|Compact dot representationFlushes database buffers to disk after each update. If this option is set to {{Code|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the {{Command|FLUSH}} command.
| valign='top' | '''Default'''|<code>true</code>{{Code|false}}
| valign='top' | '''Summary'''|Display dot representation after query executionPropagates updates on main-memory instances of files that have been retrieved via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] back to disk:* This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>.* Please take in mind that no backup will be created from your original files.* The serialization options can be controlled via the {{Option|EXPORTER}} option.
| valign='top' | '''Default'''|<code>dotty</code>{{Code|30}}
| valign='top' | '''Summary'''|Program <code>PATH</code> Specifies the maximum number of dotty executableindex occurrences printed by the {{Command|INFO INDEX}} command.
→GZIP
This page is linked from the [[Getting Started]] Section.
The options listed on this page can be requested with influence the way how database [[Commands#GET|GETcommands]] command are executed and changed with the [[Commands#SET|SET]] commandXQuery expressions are evaluated. Three data types Two kinds of options 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 main current value of an option can be requested with the {{Command|GET}} command. Local options are only available in the [[Standalone Tutorialcan be changed via {{Command|standalone]] and [[Server TutorialSET}} (all global options, except for {{Option|server]] instance DEBUG}}, can only be changed at startup time). If an option is of BaseX; they cannot type ''boolean'', and if no value is specified, its current value will be changed by database clients:inverted.
* The {{Code|.basex}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance. It contains all global options. Local options can be specified at the end of the file after the {{Code|Local Options}} comment: <pre class="brush:perl"># General OptionsDEBUG =false... # Local OptionsCHOP =false</pre> * Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.html#options -D flag] on command line, or using [http://docs.oracle.com/javase/6/docs/api/java/lang/System.html#setProperty(java.lang.String,%20java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example: <pre class=LANG"brush:xquery">java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"CHOP: false</pre> * If using the Mac OS X packaged application then global options can be set within the Info.plist file within the Contents folder of the application package. For example: <pre class="brush:xml"><key>JVMOptions</key><array> <string>-Dorg.basex.CHOP=false</string></array></pre> * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows: <pre class="brush:xml"><context-param> <param-name>org.basex.chop</param-name> <param-value>false</param-value></context-param></pre> * In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]]. If options are changed by operations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/> =Global Options= Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception is the [[#debug|DEBUG]] option, which can also be changed at runtime by users with [[User Management|admin permissions]]. ==General Options== ===DEBUG=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>LANG {{Code|DEBUG [languageboolean]</code>}}
|-
|-
|}
===LANGKEYDBPATH=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>LANGKEY</code>{{Code|DBPATH [path]}}
|-
|-
|}
===DBPATHLOGPATH=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DBPATH {{Code|LOGPATH [path]</code>}}
|-
|-
|}
===REPOPATH===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|REPOPATH [path]</code>}}
|-
|-
|}
===DEBUGLANG=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LANG [language]}}|-| '''Default'''|{{Code|English}}|-| '''Summary'''|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.|} ===LANGKEY=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LANGKEY [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed.|} ===FAIRLOCK=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|FAIRLOCK [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Defines the locking strategy:* By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the limit of parallel transactions (specified via {{Option|PARALLEL}}) has been reached. This prevents update operations from blocking all other requests. For example, the DBA can further be used to see which jobs are running, even if the queue is full.* If fair locking is enabled, read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it should be used if the prompt evaluation of update operations is critical.|} ===CACHETIMEOUT=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DEBUG</code>{{Code|CACHETIMEOUT [seconds]}}
|-
|-
|}
===HOST===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|HOST [host]</code>}}
|-
|-
|}
===PORT===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|PORT [port]</code>}}
|-
|-
|}
===SERVERPORT===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|SERVERPORT [port]}}|-| '''Default'''|{{Code|1984}}|-| '''Summary'''|This is the port the database server will be listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-p</code>.|} ===USER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|USER [name]}}|-| '''Default'''|''empty''|-| '''Summary'''|Represents a user name, which is used for accessing the server or an HTTP service:* The default value will be overwritten if a client specifies its own credentials.* If the default value is empty, login will only be possible if the client specifies credentials.* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-U</code>.|} ===PASSWORD=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SERVERPORT {{Code|PASSWORD [portpassword]</code>}}
|-
|-
| valign'''Summary'''|Represents a password, which is used for accessing the server:* The default value will be overwritten if a client specifies its own credentials.* If the default value is empty, login will only be possible if the client specifies credentials.* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>.* Please note that it is a security risk to specify your password in plain text.|} ===AUTHMETHOD=== {| width='100%'|-| width='top120' | '''Signature'''|{{Code|AUTHMETHOD [method]}}|-| '''Default'' '|''Basic''|-| '''Summary'''|Specifies the default authentication method, which will be used by the [[Web Application|HTTP server]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}:<br/>* If basic access is chosen, the client can still request digest authentication.* This is different for digest access, which cannot be overwritten.* With custom authentication, the port the database server will be listening tonot do any authentication.
|}
===SERVERHOST===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|SERVERHOST [host|ip]</code>}}
|-
|-
|}
===EVENTPORTPROXYHOST=== {|width='100%' width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>EVENTPORT {{Code|PROXYHOST [porthost]</code>}}
|-
|-
|}
===HTTPPORTPROXYPORT=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>HTTPPORT {{Code|PROXYPORT [port]</code>}}
|-
|-
|}
===HTTPPATHNONPROXYHOSTS=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>HTTPPATH {{Code|NONPROXYHOSTS [pathhosts]</code>}}
|-
|-
|}
===PARALLELIGNOREHOSTNAME=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|IGNOREHOSTNAME [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|If this option is enabled, hostnames of certificates will not be verified. Use {{Option|IGNORECERT}} to completely disable certificate verification.|} ===IGNORECERT=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>PARALLEL {{Code|IGNORECERT [numberboolean]</code>}}
|-
|-
|}
===TIMEOUT===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|TIMEOUT [seconds]</code>}}
|-
|-
|}
===KEEPALIVE===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|KEEPALIVE [seconds]}}|-| '''Default'''|{{Code|600}}|-| '''Summary'''|Specifies the maximum time a client will be remembered by the server. 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 option. The keepalive check is deactivated if the value is set to {{Code|0}}.|} ===PARALLEL=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>KEEPALIVE {{Code|PARALLEL [secondsnumber]</code>}}
|-
|-
|}
=Database Options==LOG===
{| width='100%'|-| width='120' | '''Signature'''|{{Code|LOG [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.|} ===CHOPLOGMSGMAXLEN=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>CHOP</code>{{Code|LOGMSGMAXLEN [length]}}
|-
|-
|}
==HTTP Services=INTPARSE= Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that will be set before the web server is started: ===WEBPATH=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>INTPARSE</code>{{Code|WEBPATH [path]}}
|-
|-
|}
===DTDGZIP=== {{Mark|Introduced with Version 9.3:}} {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DTD</code>{{Code|GZIP [boolean]}}
|-
|<code>false</code>
|-
| valign'''Summary'''|Jetty provides a [https://www.eclipse.org/jetty/documentation/current/gzip-filter.html Gzip handler] for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the [[Web Application|BaseX HTTP Server]]:* The option can also be enabled on [[Command-Line Options#HTTP Server|command line]] via <code>-g</code>.* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.* The [https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 sane defaults] of the web server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).|} ===RESTXQPATH=== {| width='top100%' |-| width='120' | '''Signature'''|{{Code|RESTXQPATH [path]}}|-| '''Default'''|''empty''|-| '''Summary'''|Parse referenced DTDs and resolve XML entitiesPoints to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
|}
===CATFILEPARSERESTXQ=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|PARSERESTXQ}}|-|'''Default'''|{{Code|3}}|-| '''Summary'''|Timeout after which the RESTXQ directory will be parsed for changes:* If {{Code|0}} is specified, the directory will be parsed every time a RESTXQ function is called.* A positive value defines the idle time in seconds after which parsing will be enforced. The default value is {{Code|3}}: Changes in the RESTXQ directory will be detected after 3 seconds without RESTXQ function calls.* Monitoring is completely disabled if a negative value is specified. See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details.|} ===RESTXQERRORS=== {{Mark|Introduced with Version 9.2.}} {| width='100%'|-| width='120' | '''Signature'''|{{Code|RESTXQERRORS}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Reports parsing errors in XQuery modules in the RESTXQ directory back to the client. By default, this option is enabled. On productive systems, it can be disabled in order to suppress errors that should not be seen by the client.|} ===RESTPATH=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>CATFILE {{Code|RESTPATH [path]</code>}}
|-
|''empty''
|-
|}
===HTTPLOCAL===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|HTTPLOCAL [boolean]}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|By default, if BaseX is run as [[Web Application]], the database server instance will be started in addition, which can then be addressed by [[Clients]] via the database port (see {{Option|PORT}}).<br/>If the option is set to {{Code|true}}, no database server will be launched.
|}
===STOPPORT===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|STOPPORT [port]}}
|-
| '''Default'''
|{{Code|8985}}
|-
| '''Summary'''
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:
* The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}.
* The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].
* This option can also be changed when running the HTTP server on [[Command-Line Options#BaseX Server|command line]] via <code>-s</code>.
|}
=Create Options=
==General==
===MAINMEM===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|MAINMEM [boolean]}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|If this option is turned on, new databases will be created in main memory:
* Most queries will be evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down.
* It is not possible to store binary resources in a main-memory database.
* A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new database from the exported file in a second step.
* This option will not be available for [[Database Module#db:create|db:create]], because the database would not be accessible anymore after database creation, i. e., outside the query scope.
|}
===ADDCACHE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|ADDCACHE [boolean]}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|If this option is activated, data structures of documents will first be cached to disk before being added to the final database. This option is helpful when larger documents need to be added, and if the existing heuristics cannot estimate the input size (e.g. when adding directories or sending input streams).
|}
==Parsing==
===CREATEFILTER===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|CREATEFILTER [filter]</code>}}
|-
|-
|}
===ADDARCHIVES===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|ADDARCHIVES [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc.) are parsed whenever new databases are created or resources are added to a database.|} ===ARCHIVENAME=== {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>ADDARCHIVES</code>{{Code|ARCHIVENAME [boolean]}}
|-
|-
|}
===SKIPCORRUPT===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|SKIPCORRUPT [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>SKIPCORRUPT</code>{{Code|false}}
|-
| valign'''Summary'''|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are 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.|} ===ADDRAW=== {| width='top100%' |-| width='120' | '''Signature'''|{{Code|ADDRAW [boolean]}}|-| '''Default'''|<code>{{Code|false</code>}}
|-
|}
===PARSER===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|PARSER [type]</code>}}
|-
|-
|}
===PARSEROPTCSVPARSER=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>PARSEROPT {{Code|CSVPARSER [options]</code>}}
|-
|''empty''
|-
| valign'''Summary'''|Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]].|-| '''Examples'''|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.|} ===JSONPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|JSONPARSER [options]}}|-| '''Default'''|''empty''|-| '''Summary'''|Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]].|-| '''Examples'''|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.|} ===HTMLPARSER=== {| width='100%'|-| width='top120' | '''Signature'''|{{Code|HTMLPARSER [options]}}|-| '''Default'''|' 'empty''|-| '''Summary'''|Define parserSpecifies the way how HTML data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are described in the [[Parsers#Options|Parsers]] article.|-| '''Examples'''|* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.* <code>lexical=true</code> preserves comments.|} ===TEXTPARSER=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TEXTPARSER [options]}}|-| '''Default'''|''empty''|-specific | '''Summary'''|Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple optionsare delimited with <code>,</code>. See The available options are listed in the [[Parsers]] article.|-| '''Examples'''|<code>lines=true</code> creates a single element for each line of text.|} ==XML Parsing== ===CHOP=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CHOP [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Many XML documents include whitespaces that have been added to improve readability. This option controls the [http://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:* With the default value {{Code|true}}, leading and trailing whitespaces from text nodes will be chopped and all empty text nodes will be discarded.* The flag should be turned off if a document contains [[Full-Text#Mixed Content|mixed content]].* The flag can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>.* If the <code>xml:space="preserve"</code> attribute is attached to an element, chopping will be turned off for all descendant text nodes. In the following example document, the whitespaces in the text nodes of the {{Code|text}} element will not be chopped:<pre class="brush:xml"><xml> <title> Demonstrating the CHOP flag </title> <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text></xml></pre>It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option; otherwise the serialized documents will automatically be indented.|} ===STRIPNS=== {| width='100%'|-| width='120' | '''Signature'''|parsers{{Code|STRIPNS [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Strips all namespaces from an XML document and all elements while parsing.|} ===INTPARSE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|INTPARSE [boolean] page }}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for more informationusing the internal parser:* Performance: Documents (in particular small ones) will be parsed faster* Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (�)* Entities: around 250 HTML entities will be detected and decodedYou will be able to correctly parse most XML documents with the internal parser. Java’s Xerces parser is still used as default, however, because it supports all features of the XML standard and advanced DTD features, such as recursive entity expansion.
|}
===PATHINDEXDTD=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>PATHINDEX</code>{{Code|DTD [boolean]}}
|-
|-
|}
===XINCLUDE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|XINCLUDE [boolean]}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is switched to {{Code|true}}. This option is only available if the standard Java XML Parser is used (see {{Option|INTPARSE}}).
|}
===CATFILE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|CATFILE [path]}}
|-
| '''Default'''
|''empty''
|-
| '''Summary'''
|Semicolon-separated list of XML catalog files to resolve URIs. See [[Catalog Resolver]]s for more details.
|}
==Indexing==
The following options control the creation of index structures. The current values will be considered if a new database is created. See [[Indexes]] for more details.
===TEXTINDEX===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|TEXTINDEX</code>[boolean]}}
|-
|-
|}
===ATTRINDEX===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|ATTRINDEX</code>[boolean]}}
|-
|-
| valign'''Summary'''|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[Index#Attribute Index|Attribute Index]] for more details.|} ===TOKENINDEX=== {| width='100%'|-| width='top120' | '''Signature''' |{{Code|TOKENINDEX [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Create Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values and speedup queries querying attribute values. See [[Index#Token Index|Token Index]] for more details.
|}
===FTINDEX===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|FTINDEX [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions. See [[Index#Full-Text Index|Full-Text Index]] for more details.|} ===TEXTINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TEXTINCLUDE [names]}}|-| '''Default'''|''empty''|-| '''Summary'''|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===ATTRINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|ATTRINCLUDE [names]}}|-| '''Default'''|''empty''
|-
|-
| valignwidth='top120' | '''Signature'''|{{Code|TOKENINCLUDE [names]}}|-| '''Default'''|<code>false</code>''empty''
|-
|}
===WRITEBACKFTINCLUDE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>WRITEBACK</code>{{Code|FTINCLUDE [names]}}
|-
|-
|}
===MAINMEMMAXLEN=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>MAINMEM</code>{{Code|MAXLEN [int]}}
|-
|-
|}
===FORCECREATEMAXCATS=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>FORCECREATE</code>{{Code|MAXCATS [int]}}
|-
|-
|}
===AUTOFLUSHUPDINDEX=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>AUTOFLUSH</code>{{Code|UPDINDEX [boolean]}}
|-
|-
|}
===MAXSTATAUTOOPTIMIZE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>MAXSTAT {{Code|AUTOOPTIMIZE [numboolean]</code>}}
|-
|-
|}
=Full-Text Options==SPLITSIZE===
|-
| valign='top' width='90120' | '''Signature'''|<code>WILDCARDS</code>{{Code|SPLITSIZE [num]}}
|-
|-
|}
==Full-Text Indexing==
===STEMMING===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|STEMMING</code>[boolean]}}
|-
|-
|}
===CASESENS===
{|width='100%' | width='120' | '''Signature'''|{{Code|CASESENS [boolean]}}
|-
| valign='top' width='90' | '''SignatureDefault'''|<code>CASESENS</code>{{Code|false}}
|-
| valign='top' | '''DefaultSummary'''|<code>false</code>If {{Code|true}}, the case of tokens will be preserved during full-| valign='top' | '''Summary'''|Case sensitive full text indexing. By default, i.e. full text case will be ignored (all tokens are stored will be indexed in lower case sensitive and enables the assignment of the full text index ). See [[Indexes#Full-Text Index|Full-Text Index]] for case sensitive queriesmore details.
|}
===DIACRITICS===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|DIACRITICS</code>[boolean]}}
|-
|-
|}
===LANGUAGE===
{|width='100%'|-| width='120' | '''Signature'''|{{Code|LANGUAGE [lang]}}|-| '''Default'''|{{Code|en}}|-| '''Summary'''|The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} ===STOPWORDS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|STOPWORDS [path]}}
|-
| valign='top' width='90Default' | ''|'Signature'empty''|<code>LANGUAGE [lang]</code>
|-
| valign='top' | 'Summary''Default'|A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.|} =Query Options= ===QUERYINFO=== {| width='100%'|<code>en</code>
|-
| valignwidth='top120' | '''Signature'''|{{Code|QUERYINFO [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Language used for creating a new full-text search indexPrints more information on internal query rewritings, optimizations, and performance. Can e.gBy default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be set to activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>de</code> or <code>German-V</code>.
|}
===SCORINGMIXUPDATES=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SCORING [mode]</code>{{Code|MIXUPDATES}}
|-
|-
|}
===STOPWORDSBINDINGS=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>STOPWORDS {{Code|BINDINGS [pathvars]</code>}}
|-
|''empty''
|-
| valign='top' 'Summary'''|Contains external variables to be bound to a query. The string must comply with the following rules:* Variable names and values must be separated by equality signs.* Multiple variables must be delimited by commas.* Commas in values must be duplicated.* Variables may optionally be introduced with a leading dollar sign.* If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [http://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>.|-| '''SummaryExamples'''|Specify stop word list at * <code>PATH$a=1,$b=2</code> binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b* <code>a=1,, that could be used e.g. 2</code> binds the value {{Code|1,2}} to decrease the full text index size. The standard stopword list (english) is provided at variable $a* <code>'etc{URI}a=x</code> binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.* In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable $GREETING:<pre class="brush:xml/stopWords'">SET BINDINGS GREETING="hello world!"XQUERY declare variable $GREETING external; $GREETING</codepre>|} ===INLINELIMIT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|INLINELIMIT}}|-| '''Default'''|{{Code|100}}|-| '''Summary'''|This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to speed up query evaluation.* Inlining will only take place if a function body is not too large (i.e., if it does not contain too many expressions).* With this option, this maximum number of expressions can be specified.* Function inlining can be turned off by setting the value to {{Code|0}}.* The limit can be locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (follow the link to get more information on function inlining).
|}
===LSERRORTAILCALLS=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>LSERROR [error]</code>{{Code|TAILCALLS}}
|-
|-
|}
===WITHDB===
|-
| valign='top' width='90120' | '''Signature'''|<code>QUERYINFO</code>{{Code|WITHDB}}
|-
|-
|}
===QUERY3DEFAULTDB=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>QUERY3</code>{{Code|DEFAULTDB}}
|-
|-
|}
===SERIALIZEFORCECREATE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SERIALIZE</code>{{Code|FORCECREATE [boolean]}}
|-
|-
|}
===BINDINGSCHECKSTRINGS=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>BINDINGS {{Code|CHECKSTRINGS [varsboolean]</code>}}
|-
|-
|}
===SERIALIZERLSERROR=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>SERIALIZER {{Code|LSERROR [paramserror]</code>}}
|-
|-
|}
===EXPORTERRUNQUERY=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>EXPORTER {{Code|RUNQUERY [paramsboolean]</code>}}
|-
|-
|}
===QUERYPATHRUNS=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>QUERYPATH {{Code|RUNS [pathnum]</code>}}
|-
|-
|}
===CACHEQUERYENFORCEINDEX=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>CACHEQUERY</code>{{Code|ENFORCEINDEX [boolean]}}
|-
|-
|}
===RUNSCOPYNODE=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>RUNS {{Code|COPYNODE [numboolean]</code>}}
|-
|-
|}
=Serialization Options=
===SERIALIZE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|SERIALIZE [boolean]}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.
|}
===SERIALIZER===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|SERIALIZER [params]}}
|-
| '''Default'''
|''empty''
|-
| '''Summary'''
|Parameters for [[Serialization|serializing]] query results. The string must comply with the following rules:
* Variable names and values must be separated by equality signs.
* Multiple variables must be delimited by commas.
* Commas in values must be duplicated.
The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
|-
| '''Examples'''
|
* <code>indent=no</code> : disables automatic indentation of XML nodes. This is usually a good choice when working with [[Full-Text#Mixed Content|Mixed-Content Data]].
* <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.
* <code>item-separator=,,</code> : separates serialized items by a single comma.
|}
===EXPORTER===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|EXPORTER [params]}}
|-
| '''Default'''
|''empty''
|-
| '''Summary'''
|Contains parameters for exporting resources of a database and writing files after updates via the {{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[Serialization]] for more details.
|-
| '''Examples'''
|
* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
|}
===XMLPLAN===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|XMLPLAN</code>[boolean]}}
|-
|-
|}
===COMPPLAN===
{|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>{{Code|COMPPLAN</code>[boolean]}}
|-
|-
|}
===DOTPLANFULLPLAN=== {{Mark|Introduced with Version 9.2:}} {| width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DOTPLAN</code>{{Code|FULLPLAN [boolean]}}
|-
|-
|}
=Other Options= ===DOTCOMPACTAUTOFLUSH=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DOTCOMPACT</code>{{Code|AUTOFLUSH [boolean]}}
|-
|-
|}
===DOTDISPLAYWRITEBACK=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DOTDISPLAY</code>{{Code|WRITEBACK [boolean]}}
|-
|-
|}
===DOTTYMAXSTAT=== {|width='100%'
|-
| valign='top' width='90120' | '''Signature'''|<code>DOTTY {{Code|MAXSTAT [pathnum]</code>}}
|-
|-
|}
=Changelog=
;Version 9.3
* Added: {{Option|WITHDB}}, {{Option|GZIP}}
;Version 9.2
* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}
* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
;Version 9.0
* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
;Version 8.6
* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}
* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)
* Removed: {{Code|QUERYPATH}} (will now be internally assigned)
* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ)
;Version 8.5
* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added.
;Version 8.4
* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}
* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)
* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code>
;Version 8.3
* Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}}
;Version 8.2
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
;Version 8.1
* Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}}
;Version 8.0
* Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}}
* Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored.
;Version 7.8.1
* Updated: {{Option|ADDARCHIVES}}: parsing of TAR and TGZ files.
;Version 7.8
* Added: {{Option|CSVPARSER}}, {{Option|JSONPARSER}}, {{Option|TEXTPARSER}}, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}}
* Updated: {{Option|WRITEBACK}} only applies to main-memory document instances.
* Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions.
* Updated: default of {{Option|INTPARSE}} is now {{Code|false}}.
* Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
;Version 7.7
* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}}
;Version 7.6
* Added: {{Option|GLOBALLOCK}}
* Added: store local options in configuration file after {{Code|# Local Options}} comments.
;Version 7.5
* Added: options can now be set via system properties
* Added: a pragma expression can be used to locally change database options
* Added: {{Option|USER}}, {{Option|PASSWORD}}, {{Option|LOG}}, {{Option|LOGMSGMAXLEN}}, {{Option|WEBPATH}}, {{Option|RESTXQPATH}}{{Option|HTTPLOCAL}}, {{Option|CREATEONLY}}, {{Option|STRIPNS}}
* Removed: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: {{Code|jetty.xml}} configuration file is used instead
* Removed: global options cannot be changed anymore during the lifetime of a BaseX instance
;Version 7.3
* Updated: {{Option|KEEPALIVE}}, {{Option|TIMEOUT}}: default values changed
* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries
* Removed: {{Code|SCORING}}; new scoring model will focus on lengths of text nodes and match options
;Version 7.2
* Added: {{Option|PROXYHOST}}, {{Option|PROXYPORT}}, {{Option|NONPROXYHOSTS}}, {{Option|HTMLOPT}}
* Updated: {{Option|TIMEOUT}}: ignore timeout for admin users
;Version 7.1
* Added: {{Option|ADDRAW}}, {{Option|MAXLEN}}, {{Option|MAXCATS}}, {{Option|UPDINDEX}}
* Updated: {{Option|BINDINGS}}
;Version 7.0
* Added: {{Option|SERVERHOST}}, {{Option|KEEPALIVE}}, {{Option|AUTOFLUSH}}, {{Option|QUERYPATH}}
