Bureaucrats, editor, reviewer, Administrators
13,551
edits
Changes
Jump to navigation
Jump to search
A [[Options_(Snapshot)|preview page]] contains all options offered by the [http://files.basex.org/releases/latest/ latest stable snapshot].
no edit summary
The options listed on this page can be requested with the [[Commands#GET|GET]] command and changed with the [[Commands#SET|SET]] command. Three data types exist: strings, numbers, and booleans, which can be turned ON and OFF. If options are internally changed by the [[GUI_Tutorial|GUI]] of BaseX, they will be listed in the [[GUI_Tutorial#Visualizations|Info View]].
=Main Options=
|-
| valign='top' | '''Summary'''
|Points to the HTTP root directory, in which query HTML files are may be stored, which are and query files that will be evaluated by the [[REST]] service.
|}
|}
=Database Create Options=
===CHOP===
| valign='top' | '''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===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>ADDRAW</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|If this option is activated, and if new resources are added to a database, all files that are not filtered by the [[#CREATEFILTER|CREATEFILTER]] option will be added as ''raw'' files (i.e., in their binary representation).
|}
| valign='top' | '''Summary'''
|Defines parser-specific options; see [[Parsers]] for more information.
|}
=Database Options=
===MAINMEM===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>MAINMEM</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''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 BaseX is shut down. The value of this option will be assigned once to a new database, and cannot be changed after that.
|}
|}
===WRITEBACKMAXLEN==={||-| valign='top' width='90' | '''Signature'''|<code>MAXLEN</code>|-| valign='top' | '''Default'''|<code>96</code>|-| valign='top' | '''Summary'''|Specifies the maximum length of strings that are to be indexed by the name, path, value, and full-text index structures. The value of this option will be assigned once to a new database, and cannot be changed after that.|} ===MAXCATS===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>WRITEBACKMAXCATS</code>
|-
| valign='top' | '''Default'''
|<code>false100</code>
|-
| valign='top' | '''Summary'''
|Updates on XML nodes are written back to Specifies the input filesmaximum number of distinct values (categories) that will be remembered for a particular tag/attribute name or unique path. Note that, if The value of this option is turned onwill be assigned once to a new database, no backups of your original files will and cannot be createdchanged after that.
|}
===MAINMEMUPDINDEX===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>MAINMEMUPDINDEX</code>
|-
| valign='top' | '''Default'''
|-
| valign='top' | '''Summary'''
|If this option is turned on, new databases incremental indexing will be exclusively created in main memoryactivated: all update operations will also update the value index structures (texts and attribute values). Most queries The value of this option will be evaluated faster in main memory modeassigned once to a new database, but all data and cannot be changed after that. The advantage of incremental indexes is lost if BaseX that the value index structures will always be up-to-date. The downside is shut downthat updates will take a little bit longer.
|}
===FORCECREATEWRITEBACK===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>FORCECREATEWRITEBACK</code>
|-
| valign='top' | '''Default'''
|-
| valign='top' | '''Summary'''
|By activating this option, the XQuery {{mono|doc()}} and {{mono|collection()}} functions will create database instances for Updates on XML nodes are written back to the addressed input files. Note that no backups of your original files will be created if this option is turned on.
|}
|This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option. See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information on fuzzy querying.
|}
=Query Options=
|-
| valign='top' | '''Summary'''
|Contains external variables to be bound to a query. Variable names and values are separated by equality signs, and multiple variables are delimited by commas. Variables may optionally be introduced with a leading dollar sign. Commas that occur in the value itself are encoded by duplication. 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].
|-
| valign='top' | '''Examples'''
|<code>$a=1,$b=2</code> : binds the values {{mono|1}} and {{mono|2}} to the variables $a and $b<br/><code>a=1,,2</code> binds the value {{mono|1,2}} to the variable $a<br/><code>{URI}a=x</code> or <code>'URI':a=x</code> binds the value {{Mono|x}} to the variable $a with the namespace {{Mono|URI}}.
|}
| valign='top' | '''Summary'''
|Caches the query results before returning them to the client. This option may be set to {{mono|true}} if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX).
|}
===FORCECREATE===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>FORCECREATE</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|By activating this option, the XQuery {{mono|doc()}} and {{mono|collection()}} functions will create database instances for the addressed input files.
|}
|Location of the {{mono|dotty}} executable.
|}
=Recent Changes=
==Version 7.1==
* Added: <code>[[#ADDRAW|ADDRAW]]</code>, <code>[[#MAXLEN|MAXLEN]]</code>, <code>[[#MAXCATS|MAXCATS]]</code>, <code>[[#UPDINDEX|UPDINDEX]]</code>
* Modified: <code>[[#BINDINGS|BINDINGS]]</code>
