Changes

Jump to navigation Jump to search
1,015 bytes added ,  27 May
m
Fixed typo if should be is
</syntaxhighlight>
* 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:
<syntaxhighlight lang="perl">
===LOGTRACE===
 
{{Mark|Introduced with Version 9.4:}}
{| width='100%'
|-
| '''Summary'''
|If BaseX is running as [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and similar functions) if 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.
|}
===GZIP===
 
{{Mark|Introduced with Version 9.3:}}
{| width='100%'
===RESTXQERRORS===
 
{{Mark|Updated with BaseX 9.5:}} Additionally suppress stack trace in HTTP response.
{| width='100%'
|-
| '''Summary'''
|Reports parsing errors in XQuery modules in the RESTXQ directory back and returns the full error message and stack trace to the client. By default, this option is enabled. On productive systemsIn a production environment, it can be disabled in order to suppress errors that should not be seen by the clientuser 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'''
|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]].
|}
===INLINELIMIT===
 
{{Mark|Updated with Version 9.5:}} default reduced to 50.
{| width='100%'
|-
| '''Default'''
|{{Code|10050}}
|-
| '''Summary'''
|}
===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.
|}
===WITHDBENFORCEINDEX=== {{Mark|Introduced with Version 9.3.}}
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|WITHDBENFORCEINDEX [boolean]}}
|-
| '''Default'''
|{{Code|truefalse}}
|-
| '''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 Enforces index rewritings in the file systempath expressions. 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 See [[Transaction ManagementIndexes#LimitationsEnforce Rewritings|limitations of database lockingEnforce Rewritings]] for more details).* Access to local and external resources will be faster, as the database lookup will be skipped.
|}
===DEFAULTDBCOPYNODE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|DEFAULTDBCOPYNODE [boolean]}}
|-
| '''Default'''
|{{Code|falsetrue}}
|-
| '''Summary'''
|If this option is turned on, paths specified When creating new nodes in the XQuery via [[Databases#XML Documents|fnhttps:doc]] and [[Databases//www.w3.org/TR/xquery-31/#XML Documents|fn:collectionid-constructors Node Constructors]] functions , all enclosed nodes will first be resolved against a database that has been opened in the global context outside the query (ecopied, and all resulting nodes will get new node identities.gThis step can be very expensive, and it can be disabled with this option. by The option should be used carefully, as it changes the {{Command|OPEN}} command)standard behavior of XQuery. If the path does not match any existing resources, it will It should preferrably be resolved as described used in the article on [[DatabasesXQuery Extensions#Access ResourcesDatabase Pragmas|accessing database resourcesPragmas]].
|}
===FORCECREATETAILCALLS===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|FORCECREATE [boolean]TAILCALLS}}
|-
| '''Default'''
|{{Code|false256}}
|-
| '''Summary'''
|By activating Specifies how many stack frames of [https://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this optionlimit is reached, database instances will tail-call optimization takes place and some call frames are eliminated. The feature can be created with turned off by setting the XQuery functions [[Databases#XML Documentsvalue to {{Code|fn:doc]] and [[Databases#XML Documents|fn:collection]]-1}}.
|}
===CHECKSTRINGSWITHDB===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|CHECKSTRINGS [boolean]WITHDB}}
|-
| '''Default'''
|-
| '''Summary'''
|By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;). The option affects [[Java Bindings]] and string conversion and input functions such as resources specified via [[Archive ModuleDatabases#archive:createXML Documents|archivefn:createdoc]], and [[Archive ModuleDatabases#archive:extract-textXML Documents|archivefn:extract-textcollection]], [[Archive Module#archive:updateare looked up both in the database and in the file system. If you always use {{Function|Database|archivedb:update]]open}} to access databases, and it is recommendable to disable this option:* No locks will be created for the two functions (see [[ZIP ModuleTransaction Management#zip:text-entryLimitations|zip:text-entrylimitations of database locking]]for more details).* Access to local and external resources will be faster, as the database lookup will be skipped.
|}
===LSERRORDEFAULTDB===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|LSERROR [error]DEFAULTDB}}
|-
| '''Default'''
|{{Code|0false}}
|-
| '''Summary'''
|This If this option specifies is turned on, paths specified in the maximum Levenshtein error for [[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 BaseX-specific fuzzy {{Command|OPEN}} command). If the path does not match option. See any existing resources, it will be resolved as described in the page article on [[Full-TextDatabases#Fuzzy_QueryingAccess Resources|Full-Textsaccessing database resources]] for more information on fuzzy querying.
|}
===RUNQUERYFORCECREATE===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|RUNQUERY FORCECREATE [boolean]}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|By activating this option, database instances will be created with the XQuery functions [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]].|} ===CHECKSTRINGS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|CHECKSTRINGS [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Specifies if a query By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>, these characters will be executed or parsed onlyreplaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;). This The option can also be changed on affects [[Java Bindings]] and string conversion and input functions such as [[Archive Module#archive:create|archive:create]], [[CommandArchive Module#archive:extract-Line Optionstext|archive:extract-text]], [[Archive Module#BaseX Standalonearchive:update|command linearchive:update]] via <code>, and [[ZIP Module#zip:text-entry|zip:text-R</code>entry]].
|}
===RUNSLSERROR===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|RUNS LSERROR [numerror]}}
|-
| '''Default'''
|{{Code|10}}
|-
| '''Summary'''
|Specifies how often a query will be evaluatedThis option specifies the maximum Levenshtein error for fuzzy full-text matching. The result By default, if {{Code|0}} is serialized only onceassigned, and the measured times are averages of all runserror value is calculated dynamically. This option can also be changed on See [[CommandFull-Line OptionsText#BaseX StandaloneFuzzy_Querying|command lineFuzzy Querying]] via <code>-r</code>for more details.
|}
===ENFORCEINDEXRUNQUERY===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|ENFORCEINDEX RUNQUERY [boolean]}}
|-
| '''Default'''
|{{Code|falsetrue}}
|-
| '''Summary'''
|Enforces index rewritings in path expressions (see Specifies if a query will be executed or parsed only. This option can also be changed on [[IndexesCommand-Line Options#Enforce RewritingsBaseX Standalone|Enforce Rewritingscommand line]] for details)via <code>-R</code>.
|}
===COPYNODERUNS===
{| width='100%'
|-
| width='120' | '''Signature'''
|{{Code|COPYNODE RUNS [booleannum]}}
|-
| '''Default'''
|{{Code|true1}}
|-
| '''Summary'''
|When creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], all enclosed nodes Specifies how often a query will be copiedevaluated. The result is serialized only once, and the measured times are averages of all resulting nodes will get new node identitiesruns. This step can be very expensive, and it option can also be disabled with this option. The option should be used carefully, as it changes the standard behavior of XQuery. It should preferrably be used in changed on [[XQuery ExtensionsCommand-Line Options#Database PragmasBaseX Standalone|Pragmascommand line]]via <code>-r</code>.
|}
|}
===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=
{| width='100%';Version 9.6|-| width='120' | '''Signature'''|* Added: {{CodeOption|MAXSTAT [num]}UNROLLLIMIT}|-| '''Default'''|{{Code|30}}|-| '''Summary'''|Specifies the maximum number of index occurrences printed by the {{Command|INFO INDEX}} command.|}
=Changelog=;Version 9.5* Updated: {{Option|INLINELIMIT}}: default reduced to 50.* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response
;Version 9.34
* Added: {{Option|LOGTRACE}}
;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
4

edits

Navigation menu