Changes

Jump to navigation Jump to search
11,702 bytes added ,  27 May
m
Fixed typo if should be is
This page is linked from the [[Getting Started]] Section.
The options listed on this page influence the way how database [[Commands|commands]] are executed and XQuery expressions are evaluated. Options are divided into [[#Global Options|'''global options''']], which are valid for all BaseX instances, and '''local options''', which are specific to a client or session. Values Two kinds of options are either ''strings'', ''numbers'' or ''booleans''.exist:
The {{Code|.basex}} * '''[[Configuration#Configuration FilesGlobal Options|configuration fileGlobal Options]] ''' are valid for all BaseX instances in the same JVM. This is parsed by every new local BaseX instanceparticularly relevant if you are working with the client/server architecture. It contains * '''Local options''' (all global options and, optionally, local options at the end of the fileremaining ones) are specific to a client or session.
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:
* The current value of an option can be requested with the [[Commands#GET{{Command|GET]] }} command. Local options can be changed via [[Commands#{{Command|SET}} (all global options, except for {{Option|SET]]. All values are ''static'': They stay valid until they are DEBUG}}, can only be changed once again by another operationat startup time). If an option is of type ''boolean'', and if no value is specified, its current value will be inverted.
* Initial values for global options can also be specified via system properties, which can eThe {{Code|.g. be passed on with the basex}} [[http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.htmlConfiguration#options -D flagConfiguration Files|configuration file] 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 is parsed by every new local BaseX instance. The It contains all global options. Local options can be specified keys need to be prefixed with at the end of the file after the {{Code|org.basex.Local Options}}. An examplecomment:
<pre classsyntaxhighlight lang="brushperl"># General OptionsDEBUG = false... # Local OptionsCHOP = false</syntaxhighlight> * Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [https:bash//docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on command line, or using [https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example: <syntaxhighlight lang="perl">
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
CHOP: false
</presyntaxhighlight* 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:
* Local options can also be set in the prolog of an XQuery expression<syntaxhighlight lang="xml"><key>JVMOptions</key><array> <string>-Dorg. In the option declaration, options need to be bound to the [[Database Module]] namespacebasex. All values will be reset after the evaluation of a query:CHOP=false</string></array></syntaxhighlight>
<pre class="brush* In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:xquery">declare option db:chop 'false';...</pre>
* Beside that, local options can be applied locally by using pragmas:<syntaxhighlight lang="xml"><context-param> <param-name>org.basex.chop</param-name> <param-value>false</param-value></context-param></syntaxhighlight>
<pre class="brush:xquery">(* In XQuery, local options can be set via option declarations and [[XQuery Extensions# db:chop false #) { parse-xml('<xml> hi </xml>') }</pre>Pragmas|pragmas]].
If options are implicitly 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]].
==GeneralOptions==
===DEBUG===
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> or <code>[[Configuration#Database Directory|{home}/data]]</code>
|-
| '''Summary'''
|Points to the directory in which all databases are located.
|}
 
===LOGPATH===
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|LOGPATH [path]}}
|-
| '''Default'''
|<code>.logs</code>
|-
| '''Summary'''
|Points to the directory in which all [[Logging|log files]] are stored. Relative paths will be resolved against the {{Option|DBPATH}} directory.
|}
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXReporepo]]</code>
|-
| '''Summary'''
|}
===GLOBALLOCKFAIRLOCK===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|GLOBALLOCK FAIRLOCK [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Controls 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 local the limit of parallel transactions (databasespecified via {{Option|PARALLEL}}) or global (process) locking will has been reached. This prevents update operations from blocking all other requests. For example, the DBA can further be used for managing 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. The article on |} ===CACHETIMEOUT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CACHETIMEOUT [seconds]}}|-| '''Default'''|{{Code|3600}}|-| '''Summary'''|Specifies how many seconds the results of queries, which have been queued by the [Transaction Management[Jobs Module|asynchronously executed]] provides more details on concurrency control, will be cached in main memory.
|}
|-
| '''Summary'''
|Represents a password, 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.
|-
| '''Summary'''
|Specifies the HTTP Authenticationdefault authentication method, which will be proposed used by the [[Web Application|HTTP server]] if a client sends an unauthorized requestfor negotiating credentials. Allowed values are {{Code|Basic}} , {{Code|Digest}}, and {{Code|DigestCustom}}:<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 server will not do any authentication.
|}
| '''Summary'''
|This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored.
|}
 
===IGNOREHOSTNAME===
 
{| 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.
|}
|-
| '''Summary'''
|This option can be turned on to ignore untrusted certificates when connecting to servers. Please use this option carefullyUse {{Option|IGNOREHOSTNAME}} to suppress only the hostname verification.
|}
|-
| '''Summary'''
|Specifies the maximum time a read-only transaction triggered by a client may take. If an operation takes longer than the specified timeoutnumber of seconds, it will be aborted. Write Active update operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to {{Code|0}}. It is ignored for {{Codeoperations with [[User Management|ADMIN}} operationsadmin permissions]].
|}
|-
| '''Summary'''
|Denotes the maximum allowed {{Code|number}} of parallel [[Transaction Management|transactions]]:* If {{Option|FAIRLOCK}} is enabled, the number of parallel transactions will never exceed the specified value.<br/>Note * If the option is disabled (which is the default), the limit only applies to transactions that a access databases.* The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.
|}
|}
===LOGTRACE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|LOGTRACE [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|If BaseX is running as [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and similar functions) is written to the [[Logging|database logs]]. If this option is disabled, trace output will be redirected to standard error, as it is known from the standalone version of BaseX.|} ==HTTP OptionsServices==
If BaseX is run as web servlet, the Most HTTP options must be specified are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex-api/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory and . Some additional BaseX-specific options exist that will be set before the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files.server is started:
===WEBPATH===
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXWebwebapp]]</code> or <code>|-| '''Summary'''|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:* The option is ignored if BaseX is deployed as [[ConfigurationWeb Application#Database DirectoryServlet_Container|web servlet]].* It cannot be assigned via the {home{Code|web.xml}/webapp]} file, as it will be evaluated before the configuration files are parsed.|} ===GZIP=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|GZIP [boolean]}}|-| '''Default'''|<code>false</code>
|-
| '''Summary'''
|Points to the directory in which all 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]] contents are stored, including XQuery, Script, :* The option can also be enabled on [[RESTXQCommand-Line Options#HTTP Server|command line]] and via <code>-g</code>.* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration filesare parsed. This option is ignored if BaseX is deployed as * The [[Web Applicationhttps://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#Servlet_Container|L187-L211 same defaults] of the web servlet]]server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).
|}
|-
| '''Summary'''
|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the {{Option|WEBPATH}} directory.|} ===PARSERESTXQ=== {| 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#WEBPATHPreliminaries|WEBPATHRESTXQ Preliminaries]] directoryfor more details.
|}
===CACHERESTXQRESTXQERRORS===
{{Mark|Introduced Updated with Version 8BaseX 9.35:}}:Additionally suppress stack trace in HTTP response.
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|CACHERESTXQRESTXQERRORS}}
|-
| '''Default'''
|{{Code|falsetrue}}
|-
| '''Summary'''
|Caches [[Reports parsing errors in XQuery modules in the RESTXQ]] modules once when starting directory and returns the full error message and stack trace to the web applicationclient. This By default, this option is particularly helpful enabled. In a production environment, it can be disabled to suppress errors that should not be seen by the user of an API (the full error information can still be looked up in productive environments with a high loadthe database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.
|}
|-
| '''Summary'''
|Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the [[#WEBPATH{{Option|WEBPATH]] }} directory.
|}
|-
| '''Summary'''
|By default, if BaseX is run as [[Web Application]], a the database server instance will be started as soon as the first HTTP service is called. The server in addition, which can then be addressed by other BaseX clients in parallel to [[Clients]] via the HTTP servicesdatabase port (see {{Option|PORT}}).<br/>If the option is set to {{Code|falsetrue}}, the no database server will be disabledlaunched.
|}
|-
| '''Summary'''
|If this option is turned on, new databases will be exclusively 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. The value of this option * It is not possible to store binary resources in a main-memory database.* A main-memory database will be assigned once have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new databasefrom the exported file in a second step.* This option will not be available for [[Database Module#db:create|db:create]], and cannot because the database would not be changed accessible anymore after thatdatabase creation, i. e., outside the query scope.
|}
| '''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%'
|-
| width='120' | '''Signature'''
|{{Code|ARCHIVENAME [boolean]}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|If this option is set to {{Code|true}}, the file name of parsed archives will be included in the document paths.
|}
|-
| '''Summary'''
|If this option is activatedenabled, and if new all resources are added to a database, all files that are not filtered out by the [[#CREATEFILTER{{Option|CREATEFILTER]] }} option while being added to a database will be added stored as ''[[Binary Data|raw'' files ]] instead (i.e., in their binary representation).
|}
|-
| '''Summary'''
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'Available parsers are {{Code|XML'}}, '{{Code|JSON'}}, '{{Code|CSV'}}, '{{Code|TEXT'}}, '{{Code|HTML' are available as parsers}}, and {{Code|RAW}}. HTML input will be parsed as normal XML files documents if [http://home.ccil.org/~cowan/XML/tagsoup/ [Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.
|}
|-
| '''Summary'''
|Specifies the way how CSV data is to 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 listed 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.
|}
|-
| '''Summary'''
|Specifies the way how JSON data is to 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 listed 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='120' | '''Signature'''|{{Code|HTMLPARSER [options]}}|-| '''Default'''|''empty''|-| '''Summary'''|Specifies 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.
|}
|-
| '''Summary'''
|Specifies the way how TEXT data is to will be parsed. Available Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are listed in the article on [[Parsers]]article.|-| '''Examples'''|<code>lines=true</code> creates a single element for each line of text.
|}
|-
| '''Summary'''
|Many XML documents include whitespaces that have been added to improve readability. The {{Code|CHOP}} This option controls the [httphttps://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:* By With the default, this option is set to value {{Code|true}}. This way, 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 classsyntaxhighlight lang="brush:xml">
<xml>
<title>
<text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text>
</xml>
</presyntaxhighlight>It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option; otherwise the serialized documents will automatically be indented.
|}
|-
| '''Summary'''
|Uses the internal XML parser instead of the standard Java XML parser. The Here are some reasons for using the internal parser is :* Performance: Documents (in particular small ones) will be parsed faster, more fault tolerant and supports common * Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;)* Entities: around 250 HTML entities out-of-will be detected and decodedYou will be able to correctly parse most XML documents with the-boxinternal parser. Java’s Xerces parser is still used as default, but however, because it does not support supports all features needed for parsing DTDsof the XML standard and advanced DTD features, such as recursive entity expansion.
|}
|-
| '''Summary'''
|Parses referenced DTDs and resolves 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 [[#CATFILE{{Option|CATFILE]] }} option can be changed to locally resolve DTDs.
|}
|-
| '''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 [[#INTPARSE{{Option|INTPARSE]]}}).
|}
|-
| '''Summary'''
|Specifies a Semicolon-separated list of XML catalog file files to locally resolve DTDs; see the entry on URIs. See [[Catalog Resolver]]s for more details.
|}
==Indexing==
The following options control the creation of index structures. The current index and full-text index options values will be stored in considered if a new database, and take effect if indexes are rebuilt via the is created. See [[Commands#OPTIMIZE|OPTIMIZEIndexes]]for more details.
===TEXTINDEX===
|-
| '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see . See [[IndexesIndex#Text Index|Text Index]] for more details.
|}
|-
| '''Summary'''
|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values; see . See [[IndexesIndex#Attribute Index|Attribute Index]] for more details.|} ===TOKENINDEX=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TOKENINDEX [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See [[Index#Token Index|Token Index]] for more details.
|}
|-
| '''Summary'''
|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions; see . 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''|-| '''Summary'''|Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.|} ===TOKENINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TOKENINCLUDE [names]}}|-| '''Default'''|''empty''|-| '''Summary'''|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 more details.|} ===FTINCLUDE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|FTINCLUDE [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.
|}
|-
| '''Summary'''
|Specifies the maximum length of for strings that are to be indexed by the name, path, value, and full-text stored in [[Indexes|index structures]]. The value of this option will be assigned once to a new database, and cannot can only be changed after thatby creating a new database or doing a [[Commands#OPTIMIZE|full optimization]].
|}
|-
| '''Summary'''
|If turned on, incremental indexing will be applied to new databasesenabled:* With each update, the text and attributes indexes will be refreshed as well.* The advantage is that the value index structures will always be up-to-date.* However, updates will usually take longer (the article on [[Index#Updates|Index Structures]] provides more details).* The current value of this option will be assigned once to a new databasedatabases. It can be reassigned changed for existing databases by running [[Commands#{{Command|OPTIMIZE}} with the {{Code|OPTIMIZE ALL]] }} keyword or [[Database_Module#db:optimize|db:optimize($db, true())]].* After each update, the value indexes will be refreshed as well. Incremental updates are currently not available for the full-text index and database statistics.* Find more details in the article on [[Index#Updates|Index Structures]].
|}
* As a result, the index 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 [[Commands#OPTIMIZE{{Command|OPTIMIZE]] }} or [[Database_Module#db:optimize|db:optimize]].|} ===INDEXSPLITSIZE=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|INDEXSPLITSIZE [num]}}|-| '''Default'''|{{Code|0}}|-| '''Summary'''|This option affects the [[Indexes#Index Construction|construction]] of new text and attribute indexes. It specifies the number of index build operations that are performed before writing partial index data to disk. By default, if the value is set to 0, some dynamic split heuristics are applied. By setting the value to its maximum (2147483647), the index will never be split.
|}
===FTINDEXSPLITSIZESPLITSIZE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|FTINDEXSPLITSIZE SPLITSIZE [num]}}
|-
| '''Default'''
|-
| '''Summary'''
|This option affects the [[Indexes#Index ConstructionPerformance|construction]] of new full-text value indexes. It specifies 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 dynamic split heuristics are applied, based on the current memory consumption. By setting Usually, this works fine.* If explicit garbage collection is disabled when running Java (e.g. via the value JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to its maximum choose a custom split size.* You can e. g. start with {{Code|1000000}} (2147483647one million)index operations and adjust this value in the next steps.* The larger the assigned value is, the index less splits will take place, and the more main memory will never be splitrequired.
|}
==Full-TextIndexing==
===STEMMING===
|-
| '''Summary'''
|If {{Code|true}}, all tokens will be stemmed during full-text indexing, using a language-specific stemmer implementation. By default, token tokens will not be stemmed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
|-
| '''Summary'''
|If {{Code|true}}, the case of tokens will be preserved during full-text indexing. By default, case will be ignored (all tokens will be indexed in lower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
|-
| '''Summary'''
|If set to {{Code|true}}, diacritics will be preserved during full-text indexing. By default, diacritics will be removed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
|-
| '''Summary'''
|The specified language will influence the way how an input text texts will be tokenizedand stemmed. This option is mainly important if tokens are to It can be stemmed, or if the tokenization name of a language differs from Western languagesor a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
|-
| '''Summary'''
|A new If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index will drop tokens that are listed in the specified stopword listis created. A stopword list may decrease the size of the full text indexand speed up your queries. A standard stopword list See [[Indexes#Full-Text Index|Full-Text Index]] for English texts is provided in the directory {{Code|etc/stopwords.txt}} in the official releases or available online at http://files.basex.org/etc/stopwords.txtmore details.
|}
| '''Summary'''
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.
|}
 
===XQUERY3===
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|XQUERY3}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Enables all [[XQuery 3.0]] features supported by BaseX. If this option is set to {{Code|false}}, the XQuery parser will only accept expressions of the XQuery 1.0 specification.
|}
|-
| '''Summary'''
|Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}, because the XQuery Update Facility does not allow an updating query to . See [[XQuery Update#Returning Results|return resultsReturning Results]]for more details.
|}
* 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 [httphttps://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>.
|-
* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a
* <code>{URI}a=x</code> &nbsp; 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 {{Code|$GREETING}}:<pre classsyntaxhighlight lang="brush:xmlxquery">
SET BINDINGS GREETING="hello world!"
XQUERY declare variable $GREETING external; $GREETING
</presyntaxhighlight>|} ===INLINELIMIT=== {{Mark|Updated with Version 9.5:}} default reduced to 50. {| width='100%'|-| width='120' | '''Signature'''|{{Code|INLINELIMIT}}|-| '''Default'''|{{Code|50}}|-| '''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).|} ===UNROLLLIMIT=== {{Mark|Introduced with Version 9.6:}} {| width='100%'|-| width='120' | '''Signature'''|{{Code|UNROLLLIMIT}}|-| '''Default'''|{{Code|5}}|-| '''Summary'''|This option controls the unroll limit:* Loops with few iterations are ''unrolled'' by the XQuery compiler to enable further optimizations.* If the limit is increased, more optimizations will take place, but the memory consumption and compile time will increase.* See [[XQuery Optimizations#Loop Unrolling|Loop Unrolling]] for more details.
|}
===QUERYPATHENFORCEINDEX===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|QUERYPATH ENFORCEINDEX [pathboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Contains the Enforces index rewritings in path (''base URI'') to the executed query (default: ''empty'')expressions. This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a querySee [[Indexes#Enforce Rewritings|Enforce Rewritings]] for details.
|}
===INLINELIMITCOPYNODE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|INLINELIMITCOPYNODE [boolean]}}
|-
| '''Default'''
|{{Code|100true}}
|-
| '''Summary'''
|The When creating new nodes in XQuery compiler inlines functions to speed up query evaluationvia [https://www. Inlining w3.org/TR/xquery-31/#id-constructors Node Constructors], all enclosed nodes will be copied, and all resulting nodes will only take place if a function body is not too large (i.eget new node identities.This step can be very expensive, if and it does not contain too many expressions). With can be disabled with this option, this maximum number of expressions can be specified.<br/>Function inlining can The option should be turned off by setting used carefully, as it changes the value to {{Code|0}}standard behavior of XQuery. The limit can It should preferrably be locally overridden via the <code>used in [[XQuery_3.0XQuery Extensions#AnnotationsDatabase Pragmas|%basex:inlinePragmas]]</code> annotation.
|}
|-
| '''Summary'''
|Specifies how many stack frames of [httphttps://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1}}.|} ===WITHDB=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|WITHDB}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|By default, resources specified via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] are looked up both in the database and in the file system. If you always use {{Function|Database|db:open}} to access databases, it is recommendable to disable this option:* No locks will be created for the two functions (see [[Transaction Management#Limitations|limitations of database locking]] for more details).* Access to local and external resources will be faster, as the database lookup will be skipped.
|}
|-
| '''Summary'''
|If this option is turned on, paths specified in the {{Code[[Databases#XML Documents|fn:doc}} ]] and {{Code[[Databases#XML Documents|fn:collections}} collection]] functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the [[Commands#OPEN{{Command|OPEN]] }} command). If the path does not match any existing resources, it will be resolved as described in the article on [[Databases#Access Resources|accessing database resources]].
|}
|-
| '''Summary'''
|By activating this option, database instances will be created with the XQuery {{Codefunctions [[Databases#XML Documents|fn:doc()}} ]] and {{Code[[Databases#XML Documents|fn:collection()}} functions will create database instances for the addressed input files]].
|}
|-
| '''Summary'''
|If this option is turned offBy default, strings characters from external sources that are invalid in XML will be adopted as trigger an error. If the option isset to <code>false</code>, i. ethese characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;)., without being checked for valid XML characters:* This The option affects [[Java Bindings]] and the string 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]], [[Conversion Module#convert:binary-to-string|convert:binary-to-string]], [[Fetch Module#fetch:text|fetch:text]], [[File Module#file:read-text|file:read-text]], and [[ZIP Module#zip:text-entry|zip:text-entry]].* Please be aware that an inconsiderate use of this option may cause unexpected behavior when storing or outputting strings.
|}
|-
| '''Summary'''
|This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if {{Code|0}} is assigned, the BaseX-specific fuzzy match optionerror value is calculated dynamically. See the page on [[Full-Text#Fuzzy_Querying|Full-TextsFuzzy Querying]] for more information on fuzzy queryingdetails.
|}
| '''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.
|-
| '''Summary'''
|Contains parameters for exporting all resources of a database; see [[Serialization]] for more detailsand 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.
|}
|-
| '''Summary'''
|Generates the query plan, which can be activated via [[#XMLPLAN{{Option|XMLPLAN]}}, before or after query compilation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>. |} ===DOTPLAN=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|DOTPLAN [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file in the query directory.
|}
===DOTCOMPACTFULLPLAN===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|DOTCOMPACT FULLPLAN [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Chooses a compact dot representationAttaches the file path, line and column of the expressions in the original query string to the query plan. Values (items and sequences) have no input information attached.
|}
|-
| '''Summary'''
|Flushes 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 [[Commands#FLUSH{{Command|FLUSH]] }} command.
|}
|-
| '''Summary'''
|Propagates updates on main-memory instances of files that have been retrieved via {{Code[[Databases#XML Documents|fn:doc}} or {{Code]] 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 note take in mind that, when turning this option on, no backup will be created from your original files will not .* The serialization options can be backed upcontrolled via the {{Option|EXPORTER}} option.
|}
|-
| '''Summary'''
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO{{Command|INFO INDEX]]</code> }} command.
|}
=Changelog=
 
;Version 9.6
* Added: {{Option|UNROLLLIMIT}}
 
;Version 9.5
* Updated: {{Option|INLINELIMIT}}: default reduced to 50.
* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response
 
;Version 9.4
* Added: {{Option|LOGTRACE}}
 
;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: <code>[[#{{Option|CACHERESTXQ}}, {{Option|CACHERESTXQ]]</code>TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}}
;Version 8.2
 
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
;Version 8.1
 * Added: <code>[[#IGNORECERT{{Option|IGNORECERT]]</code>}}, <code>[[#RESTPATH{{Option|RESTPATH]]</code>}}
;Version 8.0
 * Added: <code>[[#MIXUPDATES{{Option|MIXUPDATES]]</code>}}, <code>[[#AUTOOPTIMIZE{{Option|AUTOOPTIMIZE]]</code>}}, <code>[[#AUTHMETHOD{{Option|AUTHMETHOD]]</code>}}, <code>[[#XINCLUDE{{Option|XINCLUDE]]</code>}}* Updated: <code>[[#PROXYPORT{{Option|PROXYPORT]]</code>}}: default set to 0; will be ignored. <code>[[#PROXYHOST{{Option|PROXYHOST]]</code>}}, <code>[[#NONPROXYHOSTS{{Option|NONPROXYHOSTS]]</code>}}: empty strings will be ignored.
;Version 7.8.1
* Updated: <code>[[#ADDARCHIVES{{Option|ADDARCHIVES]]</code>}}: parsing of TAR and TGZ files.
;Version 7.8
* Added: <code>[[#CSVPARSER{{Option|CSVPARSER]]</code>}}, <code>[[#JSONPARSER{{Option|JSONPARSER]]</code>}}, <code>[[#TEXTPARSER{{Option|TEXTPARSER]]</code>}}, <code>[[#HTMLPARSER{{Option|HTMLPARSER]]</code>}}, <code>[[#INLINELIMIT{{Option|INLINELIMIT]]</code>}}, <code>[[#TAILCALLS{{Option|TAILCALLS]]</code>}}, <code>[[#DEFAULTDB{{Option|DEFAULTDB]]</code>}}, <code>[[#RUNQUERY{{Option|RUNQUERY]]</code>}}* Updated: <code>[[#WRITEBACK{{Option|WRITEBACK]]</code> }} only applies to main-memory document instances.* Updated: <code>[[#DEBUG{{Option|DEBUG]]</code> }} option can be changed at runtime by users with admin permissions.* Updated: default of <code>[[#INTPARSE{{Option|INTPARSE]]</code> }} is now {{Code|false}}.* Removed: <code>HTMLOPT</code> (replaced with <code>[[#HTMLPARSER{{Option|HTMLPARSER]]</code>}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
;Version 7.7
 * Added: <code>[[#ADDCACHE{{Option|ADDCACHE]]</code>}}, <code>[[#CHECKSTRINGS{{Option|CHECKSTRINGS]]</code>}}, <code>[[#FTINDEXSPLITSIZE{{Option|FTINDEXSPLITSIZE]]</code>}}, <code>[[#INDEXSPLITSIZE{{Option|INDEXSPLITSIZE]]</code>}}
;Version 7.6
 * Added: <code>[[#GLOBALLOCK{{Option|GLOBALLOCK]]</code>}}
* 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: <code>[[#USER{{Option|USER]]</code>}}, <code>[[#PASSWORD{{Option|PASSWORD]]</code>}}, <code>[[#LOG{{Option|LOG]]</code>}}, <code>[[#LOGMSGMAXLEN{{Option|LOGMSGMAXLEN]]</code>}}, <code>[[#WEBPATH{{Option|WEBPATH]]</code>}}, <code>[[#RESTXQPATH{{Option|RESTXQPATH]]</code><code>[[#HTTPLOCAL}}{{Option|HTTPLOCAL]]</code>}}, <code>[[#CREATEONLY{{Option|CREATEONLY]]</code>}}, <code>[[#STRIPNS{{Option|STRIPNS]]</code>}}
* 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: <code>[[#KEEPALIVE{{Option|KEEPALIVE]]</code>}}, <code>[[#TIMEOUT{{Option|TIMEOUT]]</code>}}: 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: <code>[[#PROXYHOST{{Option|PROXYHOST]]</code>}}, <code>[[#PROXYPORT{{Option|PROXYPORT]]</code>}}, <code>[[#NONPROXYHOSTS{{Option|NONPROXYHOSTS]]</code>}}, <code>[[#HTMLOPT{{Option|HTMLOPT]]</code>}}* Updated: <code>[[#TIMEOUT{{Option|TIMEOUT]]</code>}}: ignore timeout for admin users
;Version 7.1
 * Added: <code>[[#ADDRAW{{Option|ADDRAW]]</code>}}, <code>[[#MAXLEN{{Option|MAXLEN]]</code>}}, <code>[[#MAXCATS{{Option|MAXCATS]]</code>}}, <code>[[#UPDINDEX{{Option|UPDINDEX]]</code>}}* Updated: <code>[[#BINDINGS{{Option|BINDINGS]]</code>}}
;Version 7.0
 * Added: <code>[[#SERVERHOST{{Option|SERVERHOST]]</code>}}, <code>[[#KEEPALIVE{{Option|KEEPALIVE]]</code>}}, <code>[[#AUTOFLUSH{{Option|AUTOFLUSH]]</code>}}, <code>[[#QUERYPATH{{Option|QUERYPATH]]</code>}}
administrator, editor
4

edits

Navigation menu