Changes

Jump to navigation Jump to search
6,497 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:
Various ways exist * '''[[#Global Options|Global Options]]''' 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''' (all remaining ones) are specific to access and change options:a client or session.
* The current value Values of an option can be requested with the {{Command|GET}} command. Local options can be changed via {{Command|SET}}. All values are either ''strings'', ''numbers'static' or ''booleans'': They stay valid until they . Options are changed once again by another operation. If an option is of type ''booleanstatic'', and if no value is specifiednot bound to a single operation (for example, its current value will be invertedthe next command).Various ways exist to access and change options:
* The current value of an option can be requested with the {{CodeCommand|GET}} command.basexLocal options can be changed via {{Command|SET}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance. It contains (all global options. Local options , except for {{Option|DEBUG}}, can only be specified changed at the end startup time). If an option is of the file after the "Location Options" comment:type ''boolean'', and if no value is specified, its current value will be 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 classsyntaxhighlight lang="brush:perl">
# General Options
DEBUG = false
# Local Options
CHOP = false
</presyntaxhighlight>
* Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [httphttps://docs.oracle.com/javaseen/1.4.2java/docsjavase/tooldocs11/windowstools/java.html#options -D flag] on command line, or using [httphttps://docs.oracle.com/en/java/javase/611/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,%20javajava.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example:
<pre classsyntaxhighlight lang="brush:xqueryperl">
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:
<pre classsyntaxhighlight lang="brush:xml">
<key>JVMOptions</key>
<array>
<string>-Dorg.basex.CHOP=false</string>
</array>
</presyntaxhighlight>
* In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:
<pre classsyntaxhighlight lang="brush:xml">
<context-param>
<param-name>org.basex.chop</param-name>
<param-value>false</param-value>
</context-param>
</presyntaxhighlight>
* In XQuery, local options can be set via option declarations and pragmas (see [[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/>
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> or <code>[[Configuration#Database Directory|{home}/data]]</code>
|-
| '''Summary'''
|-
| '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXReporepo]]</code>
|-
| '''Summary'''
===FAIRLOCK===
 
{{Mark|Introduced with Version 8.6:}}
{| width='100%'
| '''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 . 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.
|}
| '''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'''
|Denotes the maximum allowed 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. The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations.
|}
| '''Summary'''
|Specifies the maximum length of a single [[Logging|log message]].
|}
 
===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 Services==
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/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}/BaseXWeb]]</code> or <code>[[Configuration#Database Directory|{home}/webapp]]</code>
|-
| '''Summary'''
|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files. This :* The option is ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.
|}
===RESTXQPATHGZIP===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|GZIP [boolean]}}|-| '''Default'''|<code>false</code>|-| '''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 same defaults] of the web server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).|} ===RESTXQPATH=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|RESTXQPATH [path]}}
|-
| '''Default'''
===PARSERESTXQ===
 
{{Mark|Introduced with Version 8.6}}: replacing {{Code|CACHERESTXQ}}.
{| width='100%'
See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details.
|}
 
===RESTXQERRORS===
 
{{Mark|Updated with BaseX 9.5:}} Additionally suppress stack trace in HTTP response.
 
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|RESTXQERRORS}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Reports parsing errors in XQuery modules in the RESTXQ directory and returns the full error message and stack trace to the client. By default, this option is 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 the database logs). See [[RESTXQ#Error Handling|RESTXQ Error Handling]] for more details.
|}
|-
| '''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 activatedenabled, and if new all resources are added to a database, all files that are not filtered out by the {{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 [[Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.
|}
|-
| '''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'''
|Many XML documents include whitespaces that have been added to improve readability. This option controls the [httphttps://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 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'''
|Specifies a Semicolon-separated list of XML catalog file files to locally resolve DTDsURIs. See the entry on [[Catalog Resolver]]s 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'''
|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, the less splits will take place, and the more main memory will be required.
* By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption.
|}
|-
| '''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. See [[Indexes#Full-Text Index|Full-Text Index]] for more 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%'
|-
| '''Default'''
|{{Code|10050}}
|-
| '''Summary'''
* 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#basex:inlineFunction Inlining|%basex:inline]] annotation (follow the link to get more information on function inlining).
|}
===TAILCALLSUNROLLLIMIT=== {{Mark|Introduced with Version 9.6:}}
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|TAILCALLSUNROLLLIMIT}}
|-
| '''Default'''
|{{Code|2565}}
|-
| '''Summary'''
|Specifies how many stack frames of [httpThis option controls the unroll limit://en.wikipedia.org/wiki/Tail_call tail-calls] * Loops with few iterations are allowed on ''unrolled'' by the stack at any timeXQuery compiler to enable further optimizations. When this * If the limit is reachedincreased, tail-call optimization takes more optimizations will take place , but the memory consumption and some call frames are eliminatedcompile time will increase. The feature can be turned off by setting the value to {{Code* See [[XQuery Optimizations#Loop Unrolling|-1}}Loop Unrolling]] for more details.
|}
===DEFAULTDBENFORCEINDEX===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|DEFAULTDBENFORCEINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|If this option is turned on, paths specified Enforces index rewritings in the [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] functions will first be resolved against a database that has been opened in the global context outside the query (epath expressions.g. by the {{Command|OPEN}} command). If the path does not match any existing resources, it will be resolved as described in the article on See [[DatabasesIndexes#Access ResourcesEnforce Rewritings|accessing database resourcesEnforce Rewritings]]for details.
|}
===FORCECREATECOPYNODE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|FORCECREATE COPYNODE [boolean]}}
|-
| '''Default'''
|{{Code|falsetrue}}
|-
| '''Summary'''
|By activating this optionWhen creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], all enclosed nodes will be copied, database instances and all resulting nodes will get new node identities. This step can be created very expensive, and it can be disabled with this option. The option should be used carefully, as it changes the standard behavior of XQuery functions . It should preferrably be used in [[DatabasesXQuery Extensions#XML DocumentsDatabase Pragmas|fn:doc]] and [[Databases#XML Documents|fn:collectionPragmas]].
|}
===CHECKSTRINGSTAILCALLS===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|CHECKSTRINGS [boolean]TAILCALLS}}
|-
| '''Default'''
|{{Code|true256}}
|-
| '''Summary'''
|By default, characters from external sources that are invalid in XML will trigger an errorSpecifies how many stack frames of [https://en.wikipedia. If the option is set to <code>false<org/wiki/code>, these characters will be replaced with Tail_call tail-calls] are allowed on the Unicode replacement character <code>FFFD</code> (&#xFFFD;)stack at any time. The option affects [[Java Bindings]] and string conversion and input functions such as [[Archive Module#archive:create|archive:create]]When this limit is reached, [[Archive Module#archive:extract-text|archive:extracttail-text]], [[Archive Module#archive:update|archive:update]], call optimization takes place and [[ZIP Module#zip:text-entrysome call frames are eliminated. The feature can be turned off by setting the value to {{Code|zip:text-entry]]1}}.
|}
===LSERRORWITHDB===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|LSERROR [error]WITHDB}}
|-
| '''Default'''
|{{Code|0true}}
|-
| '''Summary'''
|This option specifies By default, resources specified via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] are looked up both in the maximum Levenshtein error for database and in the BaseX-specific fuzzy match file system. If you always use {{Function|Database|db:open}} to access databases, it is recommendable to disable this option. See :* No locks will be created for the page on two functions (see [[Full-TextTransaction Management#Fuzzy_QueryingLimitations|Full-Textslimitations of database locking]] for more information on fuzzy queryingdetails).* Access to local and external resources will be faster, as the database lookup will be skipped.
|}
===RUNQUERYDEFAULTDB===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|RUNQUERY [boolean]DEFAULTDB}}
|-
| '''Default'''
|{{Code|truefalse}}
|-
| '''Summary'''
|Specifies if If this option is turned on, paths specified in the [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the {{Command|OPEN}} command). If the path does not match any existing resources, it will be executed or parsed only. This option can also be changed resolved as described in the article on [[Command-Line OptionsDatabases#BaseX StandaloneAccess Resources|command lineaccessing database resources]] via <code>-R</code>.
|}
===RUNSFORCECREATE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|RUNS FORCECREATE [numboolean]}}
|-
| '''Default'''
|{{Code|1false}}
|-
| '''Summary'''
|Specifies how often a query By activating this option, database instances will be evaluated. The result is serialized only once, created with the XQuery functions [[Databases#XML Documents|fn:doc]] and the measured times are averages of all runs. This option can also be changed on [[Command-Line OptionsDatabases#BaseX StandaloneXML Documents|command linefn:collection]] via <code>-r</code>.
|}
=Serialization Options= ===SERIALIZECHECKSTRINGS===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|SERIALIZE CHECKSTRINGS [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Results of XQuery expressions By default, characters from external sources that are invalid in XML will be serialized if this trigger an error. If the option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|<code>false}}</code>, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;). It can also be turned off on The option affects [[Java Bindings]] and string conversion and input functions such as [[Archive Module#archive:create|archive:create]], [[CommandArchive Module#archive:extract-text|archive:extract-Line Optionstext]], [[Archive Module#BaseX Standalonearchive:update|command linearchive:update]] via <code>, and [[ZIP Module#zip:text-entry|zip:text-z</code>entry]].
|}
===SERIALIZERLSERROR===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|SERIALIZER LSERROR [paramserror]}}
|-
| '''Default'''
|''empty''{{Code|0}}
|-
| '''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 This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with specifies the flag <code>maximum Levenshtein error for fuzzy full-s</code>text matching.|-| '''Examples'''|* <code>encoding=US-ASCIIBy default,omit-xml-declaration=no</code> : sets the encoding to if {{Code|US-ASCII0}} and prints is assigned, the XML declarationerror value is calculated dynamically.* <code>itemSee [[Full-separator=,,</code> : separates serialized items by a single commaText#Fuzzy_Querying|Fuzzy Querying]] for more details.
|}
===EXPORTERRUNQUERY===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|EXPORTER RUNQUERY [paramsboolean]}}
|-
| '''Default'''
|''empty''{{Code|true}}
|-
| '''Summary'''
|Contains parameters for exporting all resources of Specifies if a databasequery will be executed or parsed only. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See This option can also be changed on [[SerializationCommand-Line Options#BaseX Standalone|command line]] for more detailsvia <code>-R</code>.
|}
===XMLPLANRUNS===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|XMLPLAN RUNS [booleannum]}}
|-
| '''Default'''
|{{Code|false1}}
|-
| '''Summary'''
|Prints Specifies how often a query will be evaluated. The result is serialized only once, and the execution plan measured times are averages of an XQuery expression in its XML representationall runs. This option can also be activated changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-xr</code>.
|}
=Serialization Options= =COMPPLAN==SERIALIZE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|COMPPLAN SERIALIZE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Generates the query planResults of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, which this option can be activated via set to {{OptionCode|XMLPLANfalse}}, before or after query compilation. This option It can also be activated turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-Xz</code>.
|}
===DOTPLANSERIALIZER===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|DOTPLAN SERIALIZER [booleanparams]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|Saves the Parameters for [[Serialization|serializing]] query plan of an XQuery expression as {{Code|results.dot}} file in The string must comply with the current working directory, using the [httpsfollowing rules://en* Variable names and values must be separated by equality signs.wikipedia* Multiple variables must be delimited by commas.org/wiki/DOT_(graph_description_language) graph description language]* Commas in values must be duplicated. The output file option can ealso be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.g|-| '''Examples'''|* <code>indent=no</code> : disables automatic indentation of XML nodes. be visualized This is usually a good choice when working with [http[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=,,<//www.graphviz.org Graphviz]code> : separates serialized items by a single comma.
|}
===DOTCOMPACTEXPORTER===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|DOTCOMPACT EXPORTER [booleanparams]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|Chooses Contains parameters for exporting resources of a compact dot representationdatabase 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.
|}
=Other Options= ===AUTOFLUSHXMLPLAN===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|AUTOFLUSH XMLPLAN [boolean]}}
|-
| '''Default'''
|{{Code|truefalse}}
|-
| '''Summary'''
|Flushes database buffers to disk after each updatePrints the execution plan of an XQuery expression in its XML representation. If this This option is set to can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>. |} ===COMPPLAN=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|falseCOMPPLAN [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Generates the query plan, bulk operations (multiple single updates) will which can be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed activated via the {{CommandOption|FLUSHXMLPLAN}} , before or after query compilation. This option can also be activated on [[Command-Line Options#BaseX Standalone|commandline]] via <code>-X</code>.
|}
===WRITEBACKFULLPLAN===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|WRITEBACK FULLPLAN [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Propagates updates on main-memory instances Attaches the file path, line and column of files that have been retrieved via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] back the expressions in the original query string to diskthe query plan. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>. Please note that, when turning this option on, your original files will not be backed upValues (items and sequences) have no input information attached.
|}
=Other Options= ===AUTOFLUSH=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|AUTOFLUSH [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''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 {{Command|FLUSH}} command.|} ===WRITEBACK=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|WRITEBACK [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Propagates 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.|} ===MAXSTAT=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|MAXSTAT [num]}}|-| '''Default'''|{{Code|30}}|-| '''Summary'''|Specifies the maximum number of index occurrences printed by the {{Command|INFO INDEX}} 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}}
{| width='100%'|-| width='120' | '''Signature''';Version 9.2|* Added: {{CodeOption|MAXSTAT [num]RESTXQERRORS}}|-| '''Default'''|, {{CodeOption|30FULLPLAN}}|-| '''Summary'''|Specifies the maximum number of index occurrences printed by the {{Command|INFO INDEX}} command.|}* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
=Changelog=;Version 9.0* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
;Version 8.6
;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>)
;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.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
;Version 7.3
 
* Updated: {{Option|KEEPALIVE}}, {{Option|TIMEOUT}}: default values changed
* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries
;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}}
administrator, editor
5

edits

Navigation menu