Changes

Jump to navigation Jump to search
1,089 bytes removed ,  12:41, 23 January 2016
no edit summary
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#SET{{Command|SET]]}}. All values are ''static'': They stay valid until they are changed once again by another operation. 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 e.g. be passed on with the [http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.html#options -D flag] on command line, or using [http://docs.oracle.com/javase/6/docs/api/java/lang/System.html#setProperty(java.lang.String,%20java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example:
|-
| '''Summary'''
|Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted. Write 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]].<br/>Note that 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'''
|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the [[#WEBPATH{{Option|WEBPATH]] }} directory.
|}
|-
| '''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'''
|If this option is activated, and if new resources are added to a database, all files that are not filtered by the [[#CREATEFILTER{{Option|CREATEFILTER]] }} option will be added as ''raw'' files (i.e., in their binary representation).
|}
|-
| '''Summary'''
|Many XML documents include whitespaces that have been added to improve readability. The {{Code|CHOP}} This option controls the [http://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>.
|-
| '''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'''
|If turned on, incremental indexing will be enabled:
* The current value of this option will be assigned to new databases. It can be 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 (ALL)]] }} or [[Database_Module#db:optimize|db:optimize]].
|}
|-
| '''Summary'''
|If {{Code|true}}, all tokens will be stemmed during full-text indexing, using a language-specific stemmer implementation. By default, tokens will not be stemmed. See [[Full-Text#Indexes#Full-Text Index|Indexes#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 [[Full-Text#Indexes#Full-Text Index|Indexes#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 [[Full-Text#Indexes#Full-Text Index|Indexes#Full-Text Index]] for more details.
|}
|-
| '''Summary'''
|The specified language will influence the way how an input text will be tokenized. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages. See [[Full-Text#Indexes#Full-Text Index|Indexes#Full-Text Index]] for more details.
|}
|-
| '''Summary'''
|A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. See [[Full-Text#Indexes#Full-Text Index|Indexes#Full-Text Index]] for more details.
|}
|-
| '''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'''
|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.
|}
|-
| '''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>.
|}
|-
| '''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 that, when turning this option on, your original files will not be backed up.
|}
|-
| '''Summary'''
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO{{Command|INFO INDEX]]</code> }} command.
|}
;Version 8.4
* Added: <code>[[#TOKENINDEX{{Option|TOKENINDEX]]</code>}}, <code>[[#TOKENINCLUDE{{Option|TOKENINCLUDE]]</code>}}
;Version 8.3
* Added: <code>[[#CACHERESTXQ{{Option|CACHERESTXQ]]</code>}}, <code>[[#TEXTINCLUDE{{Option|TEXTINCLUDE]]</code>}}, <code>[[#ATTRINCLUDE{{Option|ATTRINCLUDE]]</code>}}, <code>[[#FTINCLUDE{{Option|FTINCLUDE]]</code>}}, <code>[[#ARCHIVENAME{{Option|ARCHIVENAME]]</code>}}
;Version 8.2
;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.
* 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>}}
Bureaucrats, editor, reviewer, Administrators
12,234

edits

Navigation menu