Difference between revisions of "Commands"
(Add example on how to bind and use a variable for a Command Script) |
|||
Line 1: | Line 1: | ||
− | This | + | 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 of options are either ''strings'', ''numbers'' or ''booleans''. | |
− | + | The {{Code|.basex}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance. It contains all global options and, optionally, local options at the end of the file. | |
− | + | Various ways exist to access and change options: | |
− | + | * The current value of an option can be requested with the [[Commands#GET|GET]] and changed with the [[Commands#SET|SET]] command. 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 existing value will be inverted. | |
− | + | * Initial values for 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 needs to be prefixed with {{Code|org.basex.}}. An example: | |
− | <pre class="brush: | + | <pre class="brush:bash"> |
− | + | java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop" | |
− | + | CHOP: false | |
− | |||
− | |||
− | |||
</pre> | </pre> | ||
− | + | * Options can also be set in the prolog of an XQuery expression. In the option declaration, options need to be bound to the [[Database Module]] namespace. All values will be reset after the evaluation of a query: | |
− | + | <pre class="brush:xquery"> | |
− | + | declare option db:chop 'false'; | |
+ | ... | ||
+ | </pre> | ||
− | + | * Options can also be applied locally by using pragmas: | |
− | |||
− | <pre class="brush: | + | <pre class="brush:xquery"> |
− | + | (# db:chop false #) { parse-xml('<xml> hi </xml>') } | |
− | |||
− | |||
− | |||
− | |||
− | |||
</pre> | </pre> | ||
− | + | 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 (since {{Version|7.8}}) is the [[#debug|DEBUG]] option, which can also be changed at runtime by users with [[User Management|admin permissions]]. | |
− | |||
− | |||
− | == | + | ==General== |
− | + | ===DEBUG=== | |
− | + | {| width='100%' | |
− | + | |- | |
− | + | | width='120' | '''Signature''' | |
− | + | |{{Code|DEBUG [boolean]}} | |
− | + | |- | |
+ | | '''Default''' | ||
+ | |{{Code|false}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Command-Line Options#BaseX Standalone|command line]] via <code>-d</code>. | ||
+ | |} | ||
− | == | + | ===DBPATH=== |
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|DBPATH [path]}} | ||
+ | |- | ||
+ | | '''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. | ||
+ | |} | ||
− | + | ===REPOPATH=== | |
− | + | {| width='100%' | |
− | + | |- | |
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|REPOPATH [path]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |<code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code> | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Points to the [[Repository]], in which all XQuery modules are located. | ||
+ | |} | ||
− | == | + | ===LANG=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|LANG [language]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|English}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |'' | + | |Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. |
+ | |} | ||
+ | |||
+ | ===LANGKEY=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|LANGKEY [boolean]}} |
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | | | + | |Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed. |
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===GLOBALLOCK=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|GLOBALLOCK [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Controls if local (database) or global (process) locking will be used for managing read and write operations. The article on [[Transaction Management]] provides more details on concurrency control. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ==Client/Server Architecture== |
+ | ===HOST=== | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|HOST [host]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|localhost}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |'' | + | |This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>. |
+ | |} | ||
+ | |||
+ | ===PORT=== | ||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|PORT [port]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|1984}} | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |This | + | |This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===SERVERPORT=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|SERVERPORT [port]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|1984}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |This is the port the database server will be listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-p</code>. |
− | |||
− | |||
− | | | ||
|} | |} | ||
− | == | + | ===EVENTPORT=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|EVENTPORT [port]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|1985}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |This port is used by the client to listen for [[Events|server events]]. It will only be bound if a client attaches itself to a database event. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-e</code>. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===USER=== |
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|USER [name]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | |'' | + | |''empty'' |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Represents a user name, 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. | |
− | + | * The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-U</code>. | |
|} | |} | ||
− | == | + | ===PASSWORD=== |
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|PASSWORD [password]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | |'' | + | |''empty'' |
|- | |- | ||
| '''Summary''' | | '''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. | |
− | + | * The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>. | |
+ | * Please note that it is a security risk to specify your password in plain text. | ||
|} | |} | ||
− | = | + | ===SERVERHOST=== |
− | |||
− | == | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|SERVERHOST [host|ip]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |''empty'' |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |'' | + | |This is the host name or ip address the server is bound to. If the option is set to an empty string (which is the default), the server will be open to all clients. |
+ | |} | ||
+ | |||
+ | ===PROXYHOST=== | ||
+ | {| width='100%' width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|PROXYHOST [host]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |''empty'' |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | | | + | |This is the host name of a proxy server. |
− | |||
|} | |} | ||
− | == | + | ===PROXYPORT=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|PROXYPORT [port]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|80}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |This is the port number of a proxy server. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===NONPROXYHOSTS=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|NONPROXYHOSTS [hosts]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |''empty'' |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |' | + | |This is a list of hosts that should be directly accessed. |
+ | |} | ||
+ | |||
+ | ===TIMEOUT=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|TIMEOUT [seconds]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|30}} |
|- | |- | ||
− | | ''' | + | | '''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 {{Code|ADMIN}} operations. |
− | |||
|} | |} | ||
− | == | + | ===KEEPALIVE=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|KEEPALIVE [seconds]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|600}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===PARALLEL=== |
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|PARALLEL [number]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|8}} |
− | |||
− | | | ||
− | |||
|- | |- | ||
| '''Summary''' | | '''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. |
|} | |} | ||
− | == | + | ===LOG=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|LOG [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|true}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>. |
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===LOGMSGMAXLEN=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|LOGMSGMAXLEN [length]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|1000}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies the maximum length of a single [[Logging|log message]]. |
|} | |} | ||
− | == | + | ==HTTP Options== |
+ | |||
+ | If BaseX is run as [[Web Application]], the HTTP options are either determined by the web server, or specified in the <code>[https://github.com/BaseXdb/basex-api/tree/master/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory and the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files. | ||
+ | |||
+ | ===WEBPATH=== | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|WEBPATH [path]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |<code>[[Configuration#Database Directory|{home}/BaseXWeb]]</code> or <code>[[Configuration#Database Directory|{home}/webapp]]</code> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===RESTXQPATH=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|RESTXQPATH [path]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | |'' | + | |''empty'' |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the [[#WEBPATH|WEBPATH]] directory. |
− | |||
− | |||
− | | | ||
|} | |} | ||
− | == | + | ===HTTPLOCAL=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|HTTPLOCAL [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |By default, a database server instance will be opened along with the web server. If the flag is set to {{Code|true}}, all commands will be executed in an embedded database context.<br/>If BaseX is run as [[Web Application]], and if the flag is {{Code|false}}, the server will be started as soon as the first HTTP service is called. |
− | |||
− | | | ||
− | |||
|} | |} | ||
− | == | + | ===STOPPORT=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|STOPPORT [port]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|8985}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed: |
− | + | * The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}. | |
− | + | * The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]]. | |
− | + | * This option can also be changed when running the HTTP server on [[Command-Line Options#BaseX Server|command line]] via <code>-s</code>. | |
|} | |} | ||
− | = | + | =Create Options= |
− | == | + | ==General== |
+ | ===MAINMEM=== | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|MAINMEM [boolean]}} |
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|false}} | ||
+ | |- | ||
+ | | '''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. | ||
+ | |} | ||
+ | |||
+ | ===ADDCACHE=== | ||
+ | |||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|ADDCACHE [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |If this option is activated, documents that are added via [[Commands#ADD|ADD]] will first be cached to disk before being added to the final database. This option is helpful when larger documents are to be imported, and if the existing heuristics cannot estimate the size of the input (e.g. when adding directories). |
+ | |} | ||
+ | |||
+ | ==Parsing== | ||
+ | |||
+ | ===CREATEFILTER=== | ||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|CREATEFILTER [filter]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|*.xml}} | ||
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | | | + | |File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database. |
|} | |} | ||
− | == | + | ===ADDARCHIVES=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|ADDARCHIVES [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|true}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |' | + | |If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a database. |
+ | |} | ||
+ | |||
+ | ===SKIPCORRUPT=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|SKIPCORRUPT [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
− | | ''' | + | | '''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=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|ADDRAW [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''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). |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===PARSER=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|PARSER [type]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|XML}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is not found in the classpath. |
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===CSVPARSER=== |
+ | |||
+ | Introduced with {{Mark|Version 7.8:}} | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|CSVPARSER [options]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | |'' | + | |''empty'' |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies the way how CSV data is to be parsed. The available options are listed in the [[CSV Module#Options|CSV Module]]. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===JSONPARSER=== |
+ | |||
+ | Introduced with {{Mark|Version 7.8:}} | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|JSONPARSER [options]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | |'' | + | |''empty'' |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies the way how JSON data is to be parsed. The available options are listed in the [[JSON Module#Options|JSON Module]]. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===TEXTPARSER=== |
+ | |||
+ | Introduced with {{Mark|Version 7.8:}} | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|TEXTPARSER [options]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | |'' | + | |''empty'' |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies the way how TEXT data is to be parsed. Available options are listed in the article on [[Parsers]]. |
|} | |} | ||
− | == | + | ==XML Parsing== |
+ | |||
+ | ===CHOP=== | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|CHOP [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|true}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. By default, this option is set to {{Code|true}}, as it often reduces the database size by up to 50%. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>. |
− | |||
− | |||
− | | | ||
|} | |} | ||
− | = | + | ===INTPARSE=== |
+ | |||
+ | {{Mark|Updated with Version 7.8}}: default is now {{Code|false}}. | ||
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|INTPARSE [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |' | + | |Uses the internal XML parser instead of the standard Java XML parser. The internal parser is faster, more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for parsing DTDs. |
+ | |} | ||
+ | |||
+ | ===DTD=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|DTD [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
− | | ''' | + | | '''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|CATFILE]] option can be changed to locally resolve DTDs. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===CATFILE=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|CATFILE [path]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | |'' | + | |''empty'' |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies a catalog file to locally resolve DTDs; see the entry on [[Catalog Resolver]]s for more details. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ==Indexing== |
+ | |||
+ | The current index and full-text index options will be stored in a new database, and take effect if indexes are rebuilt via the [[Commands#OPTIMIZE|OPTIMIZE]]. | ||
+ | |||
+ | ===TEXTINDEX=== | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|TEXTINDEX [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|true}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |' | + | |Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see [[Indexes]] for more details. |
+ | |} | ||
+ | |||
+ | ===ATTRINDEX=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|ATTRINDEX [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|true}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | | | + | |Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values; see [[Indexes]] for more details. |
− | |||
− | |||
|} | |} | ||
− | == | + | ===FTINDEX=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|FTINDEX [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |' | + | |Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions; see [[Indexes]] for more details. |
+ | |} | ||
+ | |||
+ | ===MAXLEN=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|MAXLEN [int]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|96}} |
|- | |- | ||
− | | ''' | + | | '''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=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|MAXCATS [int]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|100}} |
− | | | ||
− | |||
− | |||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===UPDINDEX=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|UPDINDEX [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |If turned on, incremental indexing will be activated: |
− | + | * with each update, the text and attribute value indexes will be updated as well. | |
− | + | * The value of this option will be assigned once to a new database, and cannot be changed after that. | |
− | + | * The advantage of incremental indexes is that the value index structures will always be up-to-date. | |
+ | * The downside is that updates will take longer. The article on [[Index#Updates|Index Structures]] includes additional details. | ||
|} | |} | ||
− | == | + | ===INDEXSPLITSIZE=== |
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|INDEXSPLITSIZE [num]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|0}} |
|- | |- | ||
| '''Summary''' | | '''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. |
− | |||
− | |||
− | |||
|} | |} | ||
− | = | + | ===FTINDEXSPLITSIZE=== |
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|FTINDEXSPLITSIZE [num]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|0}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |This option affects the [[Indexes#Index Construction|construction]] of new full-text 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. |
|} | |} | ||
− | == | + | ==Full-Text== |
+ | |||
+ | ===STEMMING=== | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|STEMMING [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |A new full-text index will stem all tokens and speed up queries on stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this index. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===CASESENS=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|CASESENS [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |A new full-text index will preserve the case of all tokens. The same case normalization will be applied to all query tokens that are checked against tokens in this index. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===DIACRITICS=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|DIACRITICS [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |A new full-text index will preserve the diacritics of all tokens. The same diacritics normalization will be applied to all query tokens that are checked against tokens in this index. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===LANGUAGE=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|LANGUAGE [lang]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|en}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |A new full-text index will use the given language to normalize all tokens. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages. |
|} | |} | ||
− | == | + | ===STOPWORDS=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|STOPWORDS [path]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |''empty'' |
− | |||
− | |||
− | |||
|- | |- | ||
| '''Summary''' | | '''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. A standard stopword list for English texts is provided in the directory {{Code|etc/stopwords.txt}} in the official releases. |
− | |||
− | |||
− | |||
|} | |} | ||
− | = | + | =Query Options= |
− | == | + | ===QUERYINFO=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|QUERYINFO [boolean]}} |
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|false}} | ||
+ | |- | ||
+ | | '''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''' | | '''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. |
− | |||
− | |||
− | |||
|} | |} | ||
− | == | + | ===BINDINGS=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|BINDINGS [vars]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | |'' | + | |''empty'' |
|- | |- | ||
| '''Summary''' | | '''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]. | ||
+ | * This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>. | ||
|- | |- | ||
− | | ''' | + | | '''Examples''' |
− | | | + | |<code>$a=1,$b=2</code> binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b<br/> <code>a=1,,2</code> binds the value {{Code|1,2}} to the variable $a<br/> <code>{URI}a=x</code> binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}. <pre class="brush:xml"> |
+ | SET BINDINGS BIND-VAR="hello world!" | ||
+ | XQUERY declare variable $BIND-VAR external; $BIND-VAR | ||
+ | </pre> binds the value {{Code|hello world!}} to the variable $BIND-VAR and shows how it can be used in a [[Commands#Command_Scripts| Command Script]]. | ||
+ | |||
|} | |} | ||
− | == | + | ===QUERYPATH=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|QUERYPATH [path]}} |
+ | |- | ||
+ | | '''Default''' | ||
+ | |''empty'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Contains the path (''base URI'') to the executed query (default: ''empty''). This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a query. | ||
+ | |} | ||
+ | |||
+ | ===INLINELIMIT=== | ||
+ | |||
+ | {{Mark|Introduced with Version 7.8:}} | ||
+ | |||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|INLINELIMIT}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|100}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies the maximum size the body of a function may have in order to be inlined. Function inlining can be turned off by setting this value to {{Code|-1}}. |
+ | |} | ||
+ | |||
+ | ===TAILCALLS=== | ||
+ | |||
+ | {{Mark|Introduced with Version 7.8:}} | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|TAILCALLS}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|256}} | ||
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |The | + | |Specifies how many stack frames of [http://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}}. |
|} | |} | ||
− | == | + | ===DEFAULTDB=== |
+ | |||
+ | {{Mark|Introduced with Version 7.8:}} | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|DEFAULTDB}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | |' | + | |If this option is turned on, paths specified in the {{Code|fn:doc}} and {{Code|fn:collections}} 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|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]]. |
+ | |} | ||
+ | |||
+ | ===CACHEQUERY=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|CACHEQUERY [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | | | + | |Caches the query results before returning them to the client. This option may be set to {{Code|true}} if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX). |
− | |||
− | |||
|} | |} | ||
− | == | + | ===FORCECREATE=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|FORCECREATE [boolean]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |By activating this option, the XQuery {{Code|doc()}} and {{Code|collection()}} functions will create database instances for the addressed input files. |
− | |||
− | |||
− | |||
|} | |} | ||
− | = | + | ===CHECKSTRINGS=== |
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|CHECKSTRINGS [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|true}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | | | + | |If this option is turned off, strings from external sources will be adopted as is, i. e., without being checked for valid XML characters: |
+ | * This option affects [[Java Bindings]] and the string conversion and input functions [[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. | ||
+ | |} | ||
+ | |||
+ | ===LSERROR=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|LSERROR [error]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|0}} |
|- | |- | ||
− | | ''' | + | | '''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. |
− | |||
− | |||
|} | |} | ||
− | == | + | ===RUNQUERY=== |
+ | |||
+ | {{Mark|Introduced with Version 7.8:}} | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|RUNQUERY [boolean]}} |
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|true}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Specifies if a query will be executed or parsed only. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>. | ||
+ | |} | ||
+ | |||
+ | ===RUNS=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|RUNS [num]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|1}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies how often a query will be evaluated. The result is serialized only once, and the measured times are averages of all runs. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-r</code>. |
+ | |} | ||
+ | |||
+ | =Serialization Options= | ||
+ | |||
+ | ===SERIALIZE=== | ||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|SERIALIZE [boolean]}} | ||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|true}} |
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | | | + | |Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>. |
− | |||
− | |||
|} | |} | ||
− | == | + | ===SERIALIZER=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|SERIALIZER [params]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | |'' | + | |''empty'' |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Contains parameters for [[Serialization|serializing]] query results: |
+ | * Keys and values are separated by equality signs. | ||
+ | * Multiple parameters are delimited by commas. | ||
+ | * The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>. | ||
|- | |- | ||
− | | ''' | + | | '''Example''' |
− | | | + | |<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration. |
|} | |} | ||
− | == | + | ===EXPORTER=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|EXPORTER [params]}} |
+ | |- | ||
+ | | '''Default''' | ||
+ | |''empty'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Contains parameters for exporting all resources of a database; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas. | ||
+ | |} | ||
+ | |||
+ | ===XMLPLAN=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|XMLPLAN [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>. |
+ | |} | ||
+ | |||
+ | ===COMPPLAN=== | ||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signature''' | ||
+ | |{{Code|COMPPLAN [boolean]}} | ||
+ | |- | ||
+ | | '''Default''' | ||
+ | |{{Code|true}} | ||
|- | |- | ||
− | | ''' | + | | '''Summary''' |
− | | | + | |Creates the query plan before or after query compilation. Query plans might change due to optimizations. |
|} | |} | ||
− | == | + | ===DOTPLAN=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{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. | ||
+ | |} | ||
+ | |||
+ | ===DOTCOMPACT=== | ||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|DOTCOMPACT [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Chooses a compact dot representation. |
|} | |} | ||
− | == | + | =Other Options= |
+ | |||
+ | ===AUTOFLUSH=== | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{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 [[Commands#FLUSH|FLUSH]] command. | ||
+ | |} | ||
+ | |||
+ | ===WRITEBACK=== | ||
+ | |||
+ | {{Mark|Updated with Version 7.8:}} only applies to main-memory document instances. | ||
+ | |||
+ | {| width='100%' | ||
|- | |- | ||
− | | ''' | + | | width='120' | '''Signature''' |
− | | | + | |{{Code|WRITEBACK [boolean]}} |
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|false}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Propagates updates on main-memory instances of files that have been retrieved via {{Code|fn:doc}} or {{Code|fn:collection}} back to disk. No backups of your original files will be created if this option is turned on. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>. |
− | |||
− | | | ||
− | |||
|} | |} | ||
− | == | + | ===MAXSTAT=== |
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | |width=' | + | | width='120' | '''Signature''' |
− | |{{Code| | + | |{{Code|MAXSTAT [num]}} |
− | |||
− | |||
− | |||
|- | |- | ||
− | | ''' | + | | '''Default''' |
− | | | + | |{{Code|30}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO|INFO INDEX]]</code> command. |
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 7.8 | ||
+ | |||
+ | * Added: <code>[[#CSVPARSER|CSVPARSER]]</code>, <code>[[#JSONPARSER|JSONPARSER]]</code>, <code>[[#TEXTPARSER|TEXTPARSER]]</code>, <code>[[#HTMLPARSER|HTMLPARSER]]</code>, <code>[[#INLINELIMIT|INLINELIMIT]]</code>, <code>[[#TAILCALLS|TAILCALLS]]</code>, <code>[[#DEFAULTDB|DEFAULTDB]]</code>, <code>[[#RUNQUERY|RUNQUERY]]</code> | ||
+ | * Updated: <code>[[#WRITEBACK|WRITEBACK]]</code> only applies to main-memory document instances. | ||
+ | * Updated: <code>[[#DEBUG|DEBUG]]</code> option can be changed at runtime by users with admin permissions. | ||
+ | * Updated: default of <code>[[#INTPARSE|INTPARSE]]</code> is now {{Code|false}}. | ||
+ | * Removed: <code>HTMLOPT</code> (replaced with <code>[[#HTMLPARSER|HTMLPARSER]]</code>), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code> | ||
;Version 7.7 | ;Version 7.7 | ||
− | * | + | * Added: <code>[[#ADDCACHE|ADDCACHE]]</code>, <code>[[#CHECKSTRINGS|CHECKSTRINGS]]</code>, <code>[[#FTINDEXSPLITSIZE|FTINDEXSPLITSIZE]]</code>, <code>[[#INDEXSPLITSIZE|INDEXSPLITSIZE]]</code> |
+ | |||
+ | ;Version 7.6 | ||
+ | |||
+ | * Added: <code>[[#GLOBALLOCK|GLOBALLOCK]]</code> | ||
+ | * Added: store local options in configuration file after {{Code|# Local Options}} comments. | ||
;Version 7.5 | ;Version 7.5 | ||
− | * Added: <code>[[# | + | * Added: options can now be set via system properties |
− | + | * Added: a pragma expression can be used to locally change database options | |
− | + | * Added: <code>[[#USER|USER]]</code>, <code>[[#PASSWORD|PASSWORD]]</code>, <code>[[#LOG|LOG]]</code>, <code>[[#LOGMSGMAXLEN|LOGMSGMAXLEN]]</code>, <code>[[#WEBPATH|WEBPATH]]</code>, <code>[[#RESTXQPATH|RESTXQPATH]]</code><code>[[#HTTPLOCAL|HTTPLOCAL]]</code>, <code>[[#CREATEONLY|CREATEONLY]]</code>, <code>[[#STRIPNS|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 | ;Version 7.3 | ||
− | + | * Updated: <code>[[#KEEPALIVE|KEEPALIVE]]</code>, <code>[[#TIMEOUT|TIMEOUT]]</code>: default values changed | |
− | * Updated: <code>[[# | + | * 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 | ;Version 7.2 | ||
− | * | + | * Added: <code>[[#PROXYHOST|PROXYHOST]]</code>, <code>[[#PROXYPORT|PROXYPORT]]</code>, <code>[[#NONPROXYHOSTS|NONPROXYHOSTS]]</code>, <code>[[#HTMLOPT|HTMLOPT]]</code> |
− | + | * Updated: <code>[[#TIMEOUT|TIMEOUT]]</code>: ignore timeout for admin users | |
;Version 7.1 | ;Version 7.1 | ||
− | * Updated: <code>[[# | + | * Added: <code>[[#ADDRAW|ADDRAW]]</code>, <code>[[#MAXLEN|MAXLEN]]</code>, <code>[[#MAXCATS|MAXCATS]]</code>, <code>[[#UPDINDEX|UPDINDEX]]</code> |
+ | * Updated: <code>[[#BINDINGS|BINDINGS]]</code> | ||
;Version 7.0 | ;Version 7.0 | ||
− | * Added: <code>[[# | + | * Added: <code>[[#SERVERHOST|SERVERHOST]]</code>, <code>[[#KEEPALIVE|KEEPALIVE]]</code>, <code>[[#AUTOFLUSH|AUTOFLUSH]]</code>, <code>[[#QUERYPATH|QUERYPATH]]</code> |
− | |||
− | |||
− | |||
− |
Revision as of 16:07, 16 February 2014
This page is linked from the Getting Started Section.
The options listed on this page influence the way how database commands are executed and XQuery expressions are evaluated. Options are divided into global options, which are valid for all BaseX instances, and local options, which are specific to a client or session. Values of options are either strings, numbers or booleans.
The .basex
configuration file is parsed by every new local BaseX instance. It contains all global options and, optionally, local options at the end of the file.
Various ways exist to access and change options:
- The current value of an option can be requested with the GET and changed with the SET command. 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 existing value will be inverted.
- Initial values for options can also be specified via system properties, which can e.g. be passed on with the -D flag on command line, or using System.setProperty() before creating a BaseX instance. The specified keys needs to be prefixed with
org.basex.
. An example:
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop" CHOP: false
- Options can also be set in the prolog of an XQuery expression. In the option declaration, options need to be bound to the Database Module namespace. All values will be reset after the evaluation of a query:
declare option db:chop 'false'; ...
- Options can also be applied locally by using pragmas:
(# db:chop false #) { parse-xml('<xml> hi </xml>') }
If options are implicitly changed by operations in the GUI, the underlying commands will be listed in the Info View.
Contents
Global Options
Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception (since Version 7.8) is the DEBUG option, which can also be changed at runtime by users with admin permissions.
General
DEBUG
Signature | DEBUG [boolean]
|
Default | false
|
Summary | Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on command line via -d .
|
DBPATH
Signature | DBPATH [path]
|
Default | {home}/BaseXData or {home}/data
|
Summary | Points to the directory in which all databases are located. |
REPOPATH
Signature | REPOPATH [path]
|
Default | {home}/BaseXRepo
|
Summary | Points to the Repository, in which all XQuery modules are located. |
LANG
Signature | LANG [language]
|
Default | English
|
Summary | Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. |
LANGKEY
Signature | LANGKEY [boolean]
|
Default | false
|
Summary | Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed. |
GLOBALLOCK
Signature | GLOBALLOCK [boolean]
|
Default | false
|
Summary | Controls if local (database) or global (process) locking will be used for managing read and write operations. The article on Transaction Management provides more details on concurrency control. |
Client/Server Architecture
HOST
Signature | HOST [host]
|
Default | localhost
|
Summary | This host name is used by the client when connecting to a server. This option can also be changed when running the client on command line via -n .
|
PORT
Signature | PORT [port]
|
Default | 1984
|
Summary | This port is used by the client when connecting to a server. This option can also be changed when running the client on command line via -p .
|
SERVERPORT
Signature | SERVERPORT [port]
|
Default | 1984
|
Summary | This is the port the database server will be listening to. This option can also be changed when running the server on command line via -p .
|
EVENTPORT
Signature | EVENTPORT [port]
|
Default | 1985
|
Summary | This port is used by the client to listen for server events. It will only be bound if a client attaches itself to a database event. This option can also be changed when running the server on command line via -e .
|
USER
Signature | USER [name]
|
Default | empty |
Summary | Represents a user name, which is used for accessing the server or an HTTP service:
|
PASSWORD
Signature | PASSWORD [password]
|
Default | empty |
Summary | Represents a password, which is used for accessing the server or an HTTP service:
|
SERVERHOST
Signature | SERVERHOST [host|ip]
|
Default | empty |
Summary | This is the host name or ip address the server is bound to. If the option is set to an empty string (which is the default), the server will be open to all clients. |
PROXYHOST
Signature | PROXYHOST [host]
|
Default | empty |
Summary | This is the host name of a proxy server. |
PROXYPORT
Signature | PROXYPORT [port]
|
Default | 80
|
Summary | This is the port number of a proxy server. |
NONPROXYHOSTS
Signature | NONPROXYHOSTS [hosts]
|
Default | empty |
Summary | This is a list of hosts that should be directly accessed. |
TIMEOUT
Signature | TIMEOUT [seconds]
|
Default | 30
|
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 0 . It is ignored for ADMIN operations.
|
KEEPALIVE
Signature | KEEPALIVE [seconds]
|
Default | 600
|
Summary | Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to 0 .
|
PARALLEL
Signature | PARALLEL [number]
|
Default | 8
|
Summary | Denotes the maximum allowed number of parallel transactions.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. |
LOG
Signature | LOG [boolean]
|
Default | true
|
Summary | Turns Logging of server operations and HTTP requests on/off. This option can also be changed when running the server on command line via -z .
|
LOGMSGMAXLEN
Signature | LOGMSGMAXLEN [length]
|
Default | 1000
|
Summary | Specifies the maximum length of a single log message. |
HTTP Options
If BaseX is run as Web Application, the HTTP options are either determined by the web server, or specified in the webapp/WEB-INF
directory and the jetty.xml
and web.xml
configuration files.
WEBPATH
Signature | WEBPATH [path]
|
Default | {home}/BaseXWeb or {home}/webapp
|
Summary | Points to the directory in which all the Web Application contents are stored, including XQuery, Script, RESTXQ and configuration files. |
RESTXQPATH
Signature | RESTXQPATH [path]
|
Default | empty |
Summary | Points to the directory which contains the RESTXQ modules of a web application. Relative paths will be resolved against the WEBPATH directory. |
HTTPLOCAL
Signature | HTTPLOCAL [boolean]
|
Default | false
|
Summary | By default, a database server instance will be opened along with the web server. If the flag is set to true , all commands will be executed in an embedded database context.If BaseX is run as Web Application, and if the flag is false , the server will be started as soon as the first HTTP service is called.
|
STOPPORT
Signature | STOPPORT [port]
|
Default | 8985
|
Summary | This is the port on which the HTTP Server can be locally closed:
|
Create Options
General
MAINMEM
Signature | MAINMEM [boolean]
|
Default | false
|
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. |
ADDCACHE
Signature | ADDCACHE [boolean]
|
Default | false
|
Summary | If this option is activated, documents that are added via ADD will first be cached to disk before being added to the final database. This option is helpful when larger documents are to be imported, and if the existing heuristics cannot estimate the size of the input (e.g. when adding directories). |
Parsing
CREATEFILTER
Signature | CREATEFILTER [filter]
|
Default | *.xml
|
Summary | File filter in the Glob Syntax, which is applied whenever new databases are created, or resources are added to a database. |
ADDARCHIVES
Signature | ADDARCHIVES [boolean]
|
Default | true
|
Summary | If this option is set to true , files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a database.
|
SKIPCORRUPT
Signature | SKIPCORRUPT [boolean]
|
Default | false
|
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
Signature | ADDRAW [boolean]
|
Default | false
|
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 will be added as raw files (i.e., in their binary representation). |
PARSER
Signature | PARSER [type]
|
Default | XML
|
Summary | Defines a parser for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if Tagsoup is not found in the classpath. |
CSVPARSER
Introduced with Template:Mark
Signature | CSVPARSER [options]
|
Default | empty |
Summary | Specifies the way how CSV data is to be parsed. The available options are listed in the CSV Module. |
JSONPARSER
Introduced with Template:Mark
Signature | JSONPARSER [options]
|
Default | empty |
Summary | Specifies the way how JSON data is to be parsed. The available options are listed in the JSON Module. |
TEXTPARSER
Introduced with Template:Mark
Signature | TEXTPARSER [options]
|
Default | empty |
Summary | Specifies the way how TEXT data is to be parsed. Available options are listed in the article on Parsers. |
XML Parsing
CHOP
Signature | CHOP [boolean]
|
Default | true
|
Summary | Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. By default, this option is set to true , as it often reduces the database size by up to 50%. It can also be turned off on command line via -w .
|
INTPARSE
Template:Mark: default is now false
.
Signature | INTPARSE [boolean]
|
Default | false
|
Summary | Uses the internal XML parser instead of the standard Java XML parser. The internal parser is faster, more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for parsing DTDs. |
DTD
Signature | DTD [boolean]
|
Default | false
|
Summary | Parses referenced DTDs and resolves XML entities. By default, this option is switched to false , as many DTDs are located externally, which may completely block the process of creating new databases. The CATFILE option can be changed to locally resolve DTDs.
|
CATFILE
Signature | CATFILE [path]
|
Default | empty |
Summary | Specifies a catalog file to locally resolve DTDs; see the entry on Catalog Resolvers for more details. |
Indexing
The current index and full-text index options will be stored in a new database, and take effect if indexes are rebuilt via the OPTIMIZE.
TEXTINDEX
Signature | TEXTINDEX [boolean]
|
Default | true
|
Summary | Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see Indexes for more details. |
ATTRINDEX
Signature | ATTRINDEX [boolean]
|
Default | true
|
Summary | Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values; see Indexes for more details. |
FTINDEX
Signature | FTINDEX [boolean]
|
Default | false
|
Summary | Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions; see Indexes for more details. |
MAXLEN
Signature | MAXLEN [int]
|
Default | 96
|
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
Signature | MAXCATS [int]
|
Default | 100
|
Summary | Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the Name Index or Path Index. The value of this option will be assigned once to a new database, and cannot be changed after that. |
UPDINDEX
Signature | UPDINDEX [boolean]
|
Default | false
|
Summary | If turned on, incremental indexing will be activated:
|
INDEXSPLITSIZE
Signature | INDEXSPLITSIZE [num]
|
Default | 0
|
Summary | This option affects the 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. |
FTINDEXSPLITSIZE
Signature | FTINDEXSPLITSIZE [num]
|
Default | 0
|
Summary | This option affects the construction of new full-text 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. |
Full-Text
STEMMING
Signature | STEMMING [boolean]
|
Default | false
|
Summary | A new full-text index will stem all tokens and speed up queries on stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this index. |
CASESENS
Signature | CASESENS [boolean]
|
Default | false
|
Summary | A new full-text index will preserve the case of all tokens. The same case normalization will be applied to all query tokens that are checked against tokens in this index. |
DIACRITICS
Signature | DIACRITICS [boolean]
|
Default | false
|
Summary | A new full-text index will preserve the diacritics of all tokens. The same diacritics normalization will be applied to all query tokens that are checked against tokens in this index. |
LANGUAGE
Signature | LANGUAGE [lang]
|
Default | en
|
Summary | A new full-text index will use the given language to normalize all tokens. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages. |
STOPWORDS
Signature | STOPWORDS [path]
|
Default | empty |
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. A standard stopword list for English texts is provided in the directory etc/stopwords.txt in the official releases.
|
Query Options
QUERYINFO
Signature | QUERYINFO [boolean]
|
Default | false
|
Summary | Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the Info View in the GUI. It can also be activated on command line via -V .
|
XQUERY3
Signature | XQUERY3
|
Default | true
|
Summary | Enables all XQuery 3.0 features supported by BaseX. If this option is set to false , the XQuery parser will only accept expressions of the XQuery 1.0 specification.
|
BINDINGS
Signature | BINDINGS [vars]
|
Default | empty |
Summary | Contains external variables to be bound to a query:
|
Examples | $a=1,$b=2 binds the values 1 and 2 to the variables $a and $ba=1,,2 binds the value 1,2 to the variable $a{URI}a=x binds the value x to the variable $a with the namespace URI . SET BINDINGS BIND-VAR="hello world!" XQUERY declare variable $BIND-VAR external; $BIND-VARbinds the value hello world! to the variable $BIND-VAR and shows how it can be used in a Command Script.
|
QUERYPATH
Signature | QUERYPATH [path]
|
Default | empty |
Summary | Contains the path (base URI) to the executed query (default: empty). This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a query. |
INLINELIMIT
Signature | INLINELIMIT
|
Default | 100
|
Summary | Specifies the maximum size the body of a function may have in order to be inlined. Function inlining can be turned off by setting this value to -1 .
|
TAILCALLS
Signature | TAILCALLS
|
Default | 256
|
Summary | Specifies how many stack frames of 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 -1 .
|
DEFAULTDB
Signature | DEFAULTDB
|
Default | false
|
Summary | If this option is turned on, paths specified in the fn:doc and fn:collections functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the OPEN command). If the path does not match any existing resources, it will be resolved as described in the article on accessing database resources.
|
CACHEQUERY
Signature | CACHEQUERY [boolean]
|
Default | false
|
Summary | Caches the query results before returning them to the client. This option may be set to true if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX).
|
FORCECREATE
Signature | FORCECREATE [boolean]
|
Default | false
|
Summary | By activating this option, the XQuery doc() and collection() functions will create database instances for the addressed input files.
|
CHECKSTRINGS
Signature | CHECKSTRINGS [boolean]
|
Default | true
|
Summary | If this option is turned off, strings from external sources will be adopted as is, i. e., without being checked for valid XML characters:
|
LSERROR
Signature | LSERROR [error]
|
Default | 0
|
Summary | This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option. See the page on Full-Texts for more information on fuzzy querying. |
RUNQUERY
Signature | RUNQUERY [boolean]
|
Default | true
|
Summary | Specifies if a query will be executed or parsed only. This option can also be changed on command line via -R .
|
RUNS
Signature | RUNS [num]
|
Default | 1
|
Summary | Specifies how often a query will be evaluated. The result is serialized only once, and the measured times are averages of all runs. This option can also be changed on command line via -r .
|
Serialization Options
SERIALIZE
Signature | SERIALIZE [boolean]
|
Default | true
|
Summary | Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to false . It can also be turned off on command line via -z .
|
SERIALIZER
Signature | SERIALIZER [params]
|
Default | empty |
Summary | Contains parameters for serializing query results:
|
Example | encoding=US-ASCII,omit-xml-declaration=no : sets the encoding to US-ASCII and prints the XML declaration.
|
EXPORTER
Signature | EXPORTER [params]
|
Default | empty |
Summary | Contains parameters for exporting all resources of a database; see Serialization for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas. |
XMLPLAN
Signature | XMLPLAN [boolean]
|
Default | false
|
Summary | Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on command line via -x .
|
COMPPLAN
Signature | COMPPLAN [boolean]
|
Default | true
|
Summary | Creates the query plan before or after query compilation. Query plans might change due to optimizations. |
DOTPLAN
Signature | DOTPLAN [boolean]
|
Default | false
|
Summary | Visualizes the execution plan of an XQuery expression with dotty and saves its dot file in the query directory. |
DOTCOMPACT
Signature | DOTCOMPACT [boolean]
|
Default | false
|
Summary | Chooses a compact dot representation. |
Other Options
AUTOFLUSH
Signature | AUTOFLUSH [boolean]
|
Default | true
|
Summary | Flushes database buffers to disk after each update. If this option is set to 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 FLUSH command.
|
WRITEBACK
Template:Mark only applies to main-memory document instances.
Signature | WRITEBACK [boolean]
|
Default | false
|
Summary | Propagates updates on main-memory instances of files that have been retrieved via fn:doc or fn:collection back to disk. No backups of your original files will be created if this option is turned on. This option can also be activated on command line via -u .
|
MAXSTAT
Signature | MAXSTAT [num]
|
Default | 30
|
Summary | Specifies the maximum number of index occurrences printed by the INFO INDEX command.
|
Changelog
- Version 7.8
- Added:
CSVPARSER
,JSONPARSER
,TEXTPARSER
,HTMLPARSER
,INLINELIMIT
,TAILCALLS
,DEFAULTDB
,RUNQUERY
- Updated:
WRITEBACK
only applies to main-memory document instances. - Updated:
DEBUG
option can be changed at runtime by users with admin permissions. - Updated: default of
INTPARSE
is nowfalse
. - Removed:
HTMLOPT
(replaced withHTMLPARSER
),PARSEROPT
(replaced with parser-specific options),DOTDISPLAY
,DOTTY
- Version 7.7
- Added:
ADDCACHE
,CHECKSTRINGS
,FTINDEXSPLITSIZE
,INDEXSPLITSIZE
- Version 7.6
- Added:
GLOBALLOCK
- Added: store local options in configuration file after
# 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:
USER
,PASSWORD
,LOG
,LOGMSGMAXLEN
,WEBPATH
,RESTXQPATH
HTTPLOCAL
,CREATEONLY
,STRIPNS
- Removed:
HTTPPATH
;HTTPPORT
: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:
KEEPALIVE
,TIMEOUT
: default values changed - Removed:
WILDCARDS
; new index supports both fuzzy and wildcard queries - Removed:
SCORING
; new scoring model will focus on lengths of text nodes and match options
- Version 7.2
- Added:
PROXYHOST
,PROXYPORT
,NONPROXYHOSTS
,HTMLOPT
- Updated:
TIMEOUT
: ignore timeout for admin users
- Version 7.1
- Version 7.0
- Added:
SERVERHOST
,KEEPALIVE
,AUTOFLUSH
,QUERYPATH