Changes

Jump to navigation Jump to search
11,359 bytes removed ,  27 May
m
Fixed typo if should be is
This page is linked from the [[Getting Started]] Section.
The options listed on this page influence the way how database [[Commands|commands]] are executed and XQuery expressions are evaluated. Options are divided into [[#Global Options|global options]], which are valid for all BaseX instances, and local options, which are specific to a client or session. Values Two kinds of options are either ''strings'', ''numbers'' or ''booleans''.exist:
The {{Code|.basex}} * '''[[Configuration#Configuration FilesGlobal Options|configuration fileGlobal Options]] is parsed by every new local ''' are valid for all BaseX instanceinstances in the same JVM. It This is used to store particularly relevant if you are working with the client/server architecture.* '''Local options ''' (all remaining ones) are specific to disk:a client or session.
* Global Values of options can only be set via the configuration file are either ''strings'', ''numbers'' or system properties ''booleans''. Options are ''static'' and not bound to a single operation (see belowfor example, the next command).* With {{Version|7.6}} Various ways exist to access and later, local change options can also be specified in the configuration file after the {{Code|# Local Options}} comment.:
Various ways exist to access * The current value of an option can be requested with the {{Command|GET}} command. Local options can be changed via {{Command|SET}} (all global options, except for {{Option|DEBUG}}, can only be changed at startup time). If an option is of type ''boolean'', and change options:if no value is specified, its current value will be inverted.
* The current value of an option can be requested with the [[Commands#GET{{Code|GET]] and changed with the .basex}} [[CommandsConfiguration#SETConfiguration Files|SETconfiguration file]] commandis parsed by every new local BaseX instance. All values are ''static'': they stay valid until they are changed once again by another operationIt contains all global options. If an option is Local options can be specified at the end of type ''boolean'', and if no value is specified, its existing value will be inverted.the file after the {{Code|Local Options}} comment:
* 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.<syntaxhighlight 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:bashperl">java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"CHOP: false</pre> * # General 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 classDEBUG ="brush:xquery">declare option db:chop 'false';
...
</pre>
<pre class# Local OptionsCHOP ="brush:xquery">(# db:chop false #) { parse-xml('<xml> hi </xml>') }</presyntaxhighlight>
If * Initial values for global options are implicitly changed by operations in can also be specified via system properties, which can e.g. be passed on with the [[GUI]https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag]on command line, the underlying commands will be listed in the or using [[GUIhttps://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#VisualizationssetProperty(java.lang.String,java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|Info View]]org.basex.}}.<br/><br/>An example:
<syntaxhighlight lang=Global Options"perl">java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"CHOP: false</syntaxhighlight>
This article is part of * If using the [[Getting Started]] Section.It lists all database commands supported by BaseX.Commands Mac OS X packaged application then global options can e.g. be executed from set within the [[Startup_Options#BaseX_Standalone|Command Line]],[[#Command Scripts|Scripts]], the [[Clients]], [[REST]], the input field in the [[GUI]]and other waysInfo. If plist file within the GUI is used, all commands that are triggered by the GUI itselfwill show up in the [[GUI#Visualizations|Info View]].The [[User_Management|Permission]] fields indicate whichrights are required by a user to perform a command in Contents folder of the client/server architectureapplication package.For example:
<syntaxhighlight lang=Basics"xml"><key>JVMOptions</key><array> <string>-Dorg.basex.CHOP=false</string></array></syntaxhighlight>
==Command Scripts==* In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:
Database commands in both the string and XML syntax can be placed in a text file and stored on disk<syntaxhighlight lang="xml"><context-param> <param-name>org. The default extension for BaseX command scripts is {{Code|.bxs}}. If the path to a command script is passed on to BaseX, it will automatically be recognized and evaluated as suchbasex.chop</param-name> <param-value>false</param-value></context-param></syntaxhighlight>
==String Syntax==* In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]].
Multiple If options are changed by operations in the [[GUI]], the underlying commands can will be written listed in a single line and separated by semicolons, or stored as command scriptthe [[GUI#Visualizations|Info View]]. Lines starting with <codebr/>#<br/code> are interpreted as comments and are skipped. The following script creates a database, adds two documents to it and performs a query:
<pre class="brush:xml">CREATE DB testADD input.xmlADD TO embedded.xml <root>embedded</root># run queryXQUERY count(//text())</pre> Global Options==XML Syntax== The string syntax is limited when XML snippets need to be embedded in a command,or when complex queries are to be specified.
This is why database commands Global options are constants. They can also only be specified set in XMLthe configuration file or via system properties (see above).Multiple commands One exception is the [[#debug|DEBUG]] option, which can also be enclosed changed at runtime by a {{Codeusers with [[User Management|<commands/>}} root element:admin permissions]].
<pre class="brush:xml"><commands> <create-db name='test'/> <add>input.xml</add> <add pathGeneral Options=='embedded.xml'><root>embedded</root></add> <xquery>count(//text())</xquery></commands></pre>
==Glob Syntax=DEBUG===
Some commands support the glob syntax to address more than one database or user. Question marks and asterisks can be used to match one or more characters, and commas can be used to separate multiple patterns. Some examples:
 
* {{Code|AB?}} addresses all names with the characters {{Code|AB}} and one more character.
* {{Code|*AB}} addresses all names ending with the characters {{Code|AB}}.
* {{Code|X*,Y*,Z*}} addresses all names starting with the characters {{Code|X}}, {{Code|Y}}, or {{Code|Z}}.
 
==Valid Names==
 
Both database and user names must follow the same naming constraints. Valid names may contain letters, numbers, underscores and dashes. Names must have at least one character; they also should not be longer than 128 characters, although this is not enforced. A regular expression matching valid names is <code>[-_a-zA-Z0-9]{1,128}</code>.
 
==Aliases==
 
In all commands, the {{Code|DB}} keyword can be replaced by {{Code|DATABASE}}.
 
=Database Operations=
 
==CREATE DB==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CREATE DB DEBUG [nameboolean] ([input])}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><create-db name='...'>([input])</create-db></code><br/>{{Code|-| '''Permission'''|''CREATE''false}}
|-
| '''Summary'''
|Creates the database {{Code|[name]}} with an optional {{Code|[input]}} and opens itSends internal debug info to STDERR.<br />The input may either This option can be a reference turned on to a single XML document, a directory, a remote URL, or a string containing XML:* {{Code|[name]}} must be a [[#Valid Names|valid database name]]* several get additional [[Options#Create Options|Create Options]] can be set to influence the creation process.|-| '''Errors'''|The command fails if a database with the specified name is currently used by another process, if one of the documents to be added is not well-formed or if it cannot be parsed information for some other reasondevelopment and debugging purposes.|-| '''Examples'''|* {{Code|CREATE DB input}}<br/>creates an empty database {{Code|input}}.* {{Code|CREATE DB xmark http://files.basex.org/xml/xmark.xml}}<br/>creates the database {{Code|xmark}}, containing a single initial document called {{Code|xmark.xml}}.* {{Code|CREATE DATABASE coll /path/to/input}}<br/>creates the database {{Code|coll}} with all documents found in the {{Code|input}} directory.* {{Code|SET INTPARSE false; CREATE DB input input.xml}}<br/>creates a database {{Code|input}} with {{Code|input.xml}} as initial document, which will It can also be parsed with Java's triggered on [[ParsersCommand-Line Options#XML ParsersBaseX Standalone|default XML parsercommand line]].* via <code><create-db name='simple'><hello>Universe</hello></create-db>d</code><br/>creates a database named {{Code|simple}} with an initial document {{Code|<hello>Universe</hello>}}.
|}
==OPEN=DBPATH===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|OPEN DBPATH [namepath]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><open name='...'code>[[Configuration#Database Directory|{home}/>data]]</code>|-| '''Permission'''|''READ''
|-
| '''Summary'''
|Opens Points to the database specified by {{Code|[name]}}.|-| '''Errors'''|The command fails if the specified database does not exist, is currently being updated by another process or cannot be opened for some other reasondirectory in which all databases are located.
|}
==CHECK=LOGPATH===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CHECK LOGPATH [inputpath]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><check input='...'/>logs</code><br/>|-| '''Permission'''|''READ/CREATE''
|-
| '''Summary'''
|This convenience command combines Points to the directory in which all [[#OPENLogging|OPENlog files]] and [[#CREATE DB|CREATE DB]]: if a database with are stored. Relative paths will be resolved against the name {{CodeOption|[input]DBPATH}} exists, it is opened. Otherwise, a new database is created; if the specified input points to an existing resource, it is stored as initial content.|-| '''Errors'''|The command fails if the addressed database could neither be opened nor createddirectory.
|}
==CLOSE=REPOPATH=== 
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CLOSE REPOPATH [path]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><close[[Configuration#Database Directory|{home}/>repo]]</code><br/>|-| '''Permission'''|''READ''
|-
| '''Summary'''
|Closes Points to the currently opened database.|-| '''Errors'''|The command fails if the database files could not be closed for some reason[[Repository]], in which all XQuery modules are located.
|}
==EXPORT=LANG=== 
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|EXPORT LANG [pathlanguage]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><export path='...'/></code><br/>{{Code|-| '''Permission'''|''CREATE''English}}
|-
| '''Summary'''
|Exports all documents in Specifies the database to the specified {{Code|[path]}}interface language. Currently, seven languages are available: 'English', using the serializer options specified by the <code>[[Options#EXPORTER|EXPORTER]]</code> option.|-| 'German', 'ErrorsFrench', 'Dutch'|The command fails if no database is opened, if the target path points to a file or is invalid'Italian', if the serialization parameters are invalid'Japanese', or if the documents cannot be serialized for some other reasonand 'Vietnamese'.
|}
==CREATE INDEX=LANGKEY===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CREATE INDEX LANGKEY [TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXTboolean]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code>&lt;create-index type='text&#x7c;attribute&#x7c;fulltext'/&gt;</code><br/>{{Code|-| '''Permission'''|''WRITE''false}}
|-
| '''Summary'''
|Creates Prefixes all texts with the specified database [[Indexes|index]]internal language keys.|-| '''Errors'''|The command fails if no database This option is opened, helpful if the specified index BaseX is unknowntranslated into another language, or and if indexing fails for some other reasonyou want to see where particular texts are displayed.
|}
==DROP INDEX=FAIRLOCK===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|DROP INDEX FAIRLOCK [TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXTboolean]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><drop-index type='text&#x7c;attribute&#x7c;fulltext'/></code><br/>{{Code|-| '''Permission'''|''WRITE''false}}
|-
| '''Summary'''
|Drops Defines the specified database [[Indexes|index]].locking strategy:|* By default, non-| '''Errors'''|The command fails if no database fair is openedused. Read transactions will be favored, and transactions that access no databases can be evaluated even if the limit of parallel transactions (specified index via {{Option|PARALLEL}}) has been reached. This prevents update operations from blocking all other requests. For example, the DBA can further be used to see which jobs are running, even if the queue is full.* If fair locking is unknownenabled, read and write transactions will be treated equally (first in, or if first out). This avoids starvation of update operations, and it could not should be deleted for some other reasonused if the prompt evaluation of update operations is critical.
|}
=Administration==CACHETIMEOUT===
==ALTER DB==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|ALTER DB CACHETIMEOUT [name] [newnameseconds]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><alter-db name='...' newname='...'/></code><br/>|-{{Code| '''Permission'''|''CREATE''3600}}
|-
| '''Summary'''
|Renames Specifies how many seconds the database specified results of queries, which have been queued by {{Code|the [name]}} to {{Code|[newname]}}. {{CodeJobs Module|[newnameasynchronously executed]}} must be a [[#Valid Names|valid database name]].|-| '''Errors'''|The command fails if the target database already exists, if the source database does not exist or is currently locked, or if it could not will be renamed for some other reason.|-| '''Examples'''|* {{Code|ALTER DB db tempdb}}<br/>renames the database {{Code|db}} into {{Code|tempdb}}cached in main memory.
|}
==DROP DBClient/Server Architecture== ===HOST=== 
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|DROP DB HOST [namehost]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><drop-db name='...'/></code><br/>{{Code|-| '''Permission'''|''CREATE''localhost}}
|-
| '''Summary'''
|Drops This host name is used by the database with client when connecting to a server. This option can also be changed when running the specified {{Code|[name]}}. The client on [[Command-Line Options#Glob SyntaxBaseX Client|Glob Syntaxcommand line]] can be used to address more than one database.|via <code>-| '''Errors'''|The command fails if the specified database does not exist or is currently locked, or if the database could not be deleted for some other reasonn</code>.
|}
==CREATE BACKUP=PORT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|CREATE BACKUP [name]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><create-backup name='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Creates a zipped backup of the database specified by {{Code|[name]}}. The backup file will be suffixed with the current timestamp and stored in the database directory. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.<br/>Please note that Java 7 is required to handle ''ZIP files larger than 4 GB''.|-| '''Errors'''|The command fails if the specified database does not exist, or if it could not be zipped for some other reason.|-| '''Examples'''|* {{Code|BACKUP db}}<br/>creates a zip archive of the database {{Code|db}} (e.g. {{Code|db-2011-04-01-12-27-28.zip}}) in the [[Configuration#Database_Directory|database directory]].|}
==RESTORE==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|RESTORE PORT [nameport]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><restore name='...'/></code><br/>{{Code|-| '''Permission'''|''CREATE''1984}}
|-
| '''Summary'''
|Restores This port is used by the client when connecting to a database with server. This option can also be changed when running the specified {{Code|client on [[name]}}. The name may include the timestamp of the backup file.|Command-Line Options#BaseX Client| '''Errors'''|The command fails if the specified backup does not exist, if the database to be restored is currently locked, or if it could not be restored for some other reasonline]] via <code>-p</code>.
|}
==INSPECT=SERVERPORT===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|INSPECTSERVERPORT [port]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><inspect/></code>|-{{Code| '''Permission'''|''READ''1984}}
|-
| '''Summary'''
|Performs some integrity checks on This is the port the opened database and returns a brief summaryserver 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>.
|}
==DROP BACKUP=USER={| width='100%'|-|width='100'|'''Syntax'''|{{Code|DROP BACKUP [name]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><drop-backup name='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Drops all backups of the database with the specified {{Code|[name]}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.|-| '''Examples'''|* {{Code|DROP BACKUP abc*}}<br/>deletes the backups of all databases starting with the characters {{Code|abc}}.|}
==SHOW BACKUPS==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|SHOW BACKUPSUSER [name]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><show-backups/></code><br/>|-| '''PermissionDefault'''|''CREATEempty''
|-
| '''Summary'''
|Shows all database backupsRepresents 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>.
|}
==COPY=PASSWORD={| width='100%'|-|width='100'|'''Syntax'''|{{Code|COPY [name] [newname]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><copy name='...' newname='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Creates a copy of the database specified by {{Code|[name]}}. {{Code|[newname]}} must be a [[#Valid Names|valid database name]].|-| '''Errors'''|The command fails if the target database already exists, or if the source database does not exist.|}
==INFO DB==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|INFO DBPASSWORD [password]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><info-db/></code><br/>|-| '''PermissionDefault'''|''READempty''
|-
| '''Summary'''
|Shows information on Represents a password, which is used for accessing the server:* 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 currently opened databaseclient specifies credentials.* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>.| '''Errors'''|The command fails if no database * Please note that it is openeda security risk to specify your password in plain text.
|}
==INFO INDEX=AUTHMETHOD={| width='100%'|-|width='100'|'''Syntax'''|{{Code|INFO INDEX ([TAG&#x7c;ATTNAME&#x7c;PATH&#x7c;TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXT])}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><info-index type='tag&#x7c;attname&#x7c;path&#x7c;text&#x7c;attribute&#x7c;fulltext'/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Shows information on the existing [[Indexes|index]] structures. The output can be optionally limited to the specified index.|-| '''Errors'''|The command fails if no database is opened, or if the specified index is unknown.|}
==INFO STORAGE==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|INFO STORAGE AUTHMETHOD [start end] &#x7c; [querymethod]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><info-storage>([query])</info-storage></code><br/>|-| '''PermissionDefault'''|''READBasic''
|-
| '''Summary'''
|Shows Specifies the internal main table of default authentication method, which will be used by the currently opened database[[Web Application|HTTP server]] for negotiating credentials. An integer range or a query may be specified as argument.Allowed values are {{Code|Basic}}, {{Code|-Digest}}, and {{Code| '''Errors'''Custom}}:<br/>|The command fails if no database * If basic access is openedchosen, or if one of the specified arguments client can still request digest authentication.* This is invaliddifferent for digest access, which cannot be overwritten.* With custom authentication, the server will not do any authentication.
|}
= Querying = =SERVERHOST=LIST==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|LIST (SERVERHOST [namehost&#x7c;ip] ([path]))}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><list (name='...' (path='...'))/></code><br/>|-| '''Permission'''|''NONEempty''
|-
| '''Summary'''
|Lists all available databasesThis is the host name or ip address the server is bound to. If {{Code|[name]}} the option is specified, the resources of a database are listed. The output can be further restricted set to an empty string (which is the resources matching the specified {{Code|[path]}}.|-| '''Errors'''|The command fails if the optional database cannot be openeddefault), or if the existing databases cannot server will be listed for some other reasonopen to all clients.
|}
==XQUERY=PROXYHOST=== {| width='100%' width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|XQUERY PROXYHOST [queryhost]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><xquery>[query]</xquery></code><br/>|-| '''PermissionDefault'''|''depends on queryempty''
|-
| '''Summary'''
|Runs This is the specified {{Code|[query]}} and prints the resulthost name of a proxy server.|-| '''Errors'''|The command fails if If the specified query value is invalid.|-| '''Examples'''|* {{Code|XQUERY 1 to 10}}<br/>returns the sequence {{Code|(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)}}.* {{Code|SET RUNS 10; XQUERY 1 to 10}}<br/>runs the query 10 timesan empty string, returns the result and prints the average execution time.* {{Code|SET XMLPLAN true; XQUERY 1 to 10}}<br/>returns the result and prints the query plan as XMLit will be ignored.
|}
==RETRIEVE=PROXYPORT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|RETRIEVE [path]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><retrieve path='...'/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Retrieves a raw file from the opened database at the specified {{Code|[path]}}.|-| '''Errors'''|The command fails if no database is opened, if the source path is invalid or if the data cannot not be retrieved for some other reason.|}
==FIND==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|FIND PROXYPORT [queryport]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><find>[query]</find></code><br/>|-{{Code| '''Permission'''|''READ''0}}
|-
| '''Summary'''
|Builds and runs This is the port number of a query for proxy server. If the specified value is set to {{Code|[query]0}} terms. Keywords can be enclosed in quotes to look for phrases. The following modifiers can , it will be used to further limit search:<code>=</code> looks for exact text nodes<br/><code>~</code> looks for approximate hits<br/><code>@=</code> looks for exact attribute values<br/><code>@</code> looks for attributes|-| '''Errors'''|The command fails if no database is openedignored.
|}
==CS=NONPROXYHOSTS={| width='100%'|-|width='100'|'''Syntax'''|{{Code|CS [query]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><cs>[query]</cs></code><br/>|-| '''Permission'''|''depends on query''|-| '''Summary'''|Evaluates the specified {{Code|[query]}} and declares the resulting nodes as new ''context set''. In subsequent queries, the context set will be available via the context item expression of XQuery ({{Code|.}}).|-| '''Errors'''|The command fails if no database is opened, if the specified query is invalid or if it does not return nodes of the currently opened database.|}
==REPO INSTALL==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|REPO INSTALL NONPROXYHOSTS [pathhosts]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><repo-install path='...'/></code><br/>|-| '''Permission'''|''CREATEempty''
|-
| '''Summary'''
| Installs the package with path {{Code|[path]}}.|-| '''Errors'''| The command fails in the following cases:* The package to be installed This is not a xar file.* The package to list of hosts that should be installed does not exist or is already installeddirectly accessed.* The package descriptor If the value is with invalid syntax.* The package to an empty string, it will be installed depends on a package which is not installed.* The package is not supported by the current version of BaseX.* A component of the package is already installed as part of another packageignored.
|}
==REPO LIST=IGNOREHOSTNAME={| width='100%'|-|width='100'|'''Syntax'''|{{Code|REPO LIST}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><repo-list/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''| Lists all installed packages.|}
==REPO DELETE==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|REPO DELETE IGNOREHOSTNAME [nameboolean]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><repo-delete name='...'/></code><br/>{{Code|-| '''Permission'''|''CREATE''false}}
|-
| '''Summary'''
| Deletes the package with name If this option is enabled, hostnames of certificates will not be verified. Use {{CodeOption|[name]IGNORECERT}}, optionally followed by a version.|-| '''Errors'''| The command fails if the package to be deleted participates in a dependencycompletely disable certificate verification.
|}
=Updates==IGNORECERT===
==ADD==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|ADD (TO IGNORECERT [path]) [inputboolean]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><add (path='...')>[input]</add></code><br/>{{Code|-| '''Permission'''|''WRITE''false}}
|-
| '''Summary'''
|Adds a file, directory or XML string specified by {{Code|[input]}} to the currently opened database at the specified {{Code|[path]}}.<br/>{{Code|[input]}} may either be a single XML document, a directory, a remote URL or a plain XML string. If the path denotes a directory, it needs to be suffixed with a slash ({{Code|/}}).|-| '''Errors'''|The command fails if no database is opened, if one of the documents to be added is not well-formed, or if it could not This option can be parsed for some other reason.|-| '''Examples'''|* {{Code|ADD input.xml}}<br/>adds the file {{Code|input.xml}} to the database.* {{Code|ADD TO temp/one.xml input.xml}}<br/>adds {{Code|input.xml}} turned on to the database and moves it ignore untrusted certificates when connecting to {{Code|temp/oneservers.xml}}.* {{Code|ADD TO target/ xmldir}}<br/>adds all files from the Use {{CodeOption|xmldirIGNOREHOSTNAME}} directory to suppress only the database in the {{Code|target}} pathhostname verification.
|}
==DELETE=TIMEOUT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|DELETE [path]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><delete path='...'/></code><br/>|-| '''Permission'''|''WRITE''|-| '''Summary'''|Deletes all documents from the currently opened database that start with the specified {{Code|[path]}}.|-| '''Errors'''|The command fails if no database is opened.|}
==RENAME==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|RENAME TIMEOUT [path] [newpathseconds]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><rename path='...' newpath='...'/></code><br/>|-{{Code| '''Permission'''|''WRITE''30}}
|-
| '''Summary'''
|Renames all document paths in Specifies the currently opened database that start with maximum time a transaction triggered by a client may take. If an operation takes longer than the specified {{Code|[path]}}number of seconds, it will be aborted. The command may Active update operations will not be used to either rename single documents or directoriesaffected by this timeout, as this would corrupt the integrity of the database.|-| '''Errors'''|The command fails if no database timeout is opened, or deactivated if the target path timeout is empty.|-| '''Examples'''|* {{Code|RENAME one.xml two.xml}}<br/>renames the document {{Code|one.xml}} set to {{Code|two.xml0}}.* {{CodeIt is ignored for operations with [[User Management|RENAME / TOP}}<br/>moves all documents to a {{Code|TOP}} root directoryadmin permissions]].
|}
==REPLACE=KEEPALIVE={| width='100%'|-|width='100'|'''Syntax'''|{{Code|REPLACE [path] [input]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><replace path='...'>[input]</replace></code><br/>|-| '''Permission'''|''WRITE''|-| '''Summary'''|Replaces a document in the currently opened database, addressed by {{Code|[path]}}, with the file or XML string specified by {{Code|[input]}}, or adds it as a new document.|-| '''Errors'''|The command fails if no database is opened, if the specified path points to a database directory, or if the input is not found.|-| '''Examples'''|* {{Code|REPLACE one.xml input.xml}}<br/>replaces the document {{Code|one.xml}} with the contents of the file {{Code|input.xml}}.* {{Code|REPLACE top.xml &lt;xml/&gt;}}<br/>replaces the document {{Code|top.xml}} with the document {{Code|&lt;xml/&gt;}}.|}
==STORE==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|STORE (TO KEEPALIVE [path]) [inputseconds]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><store (path='...')>[input]</store></code><br/>{{Code|-| '''Permission'''|''WRITE''600}}
|-
| '''Summary'''
|Stores Specifies the maximum time a raw file in the opened database to client will be remembered by the specified {{Code|[path]}}server. {{Code|[input]}} may either be If there has been no interaction with a file reference, client for a remote URLlonger time than specified by this timeout, or a plain stringit will be disconnected. Running operations will not be affected by this option. If The keepalive check is deactivated if the path denotes a directory, it needs value is set to be suffixed with a slash ({{Code|/0}}).|-| '''Errors'''|The command fails if no database is opened, if the specified resource is not found, if the target path is invalid or if the data cannot not be written for some other reason.
|}
==OPTIMIZE=PARALLEL={| width='100%'|-|width='100'|'''Syntax'''|{{Code|OPTIMIZE (ALL)}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><optimize/></code><br/><code><optimize-all/></code><br/>|-| '''Permission'''|''WRITE''|-| '''Summary'''|Optimizes the index structures, meta data and statistics of the currently opened database. If the {{Code|ALL}} flag is specified, the internal database structures are completely rebuilt; this often leads to a reduction of the total database size.|-| '''Errors'''|The command fails if no database is opened, or if the currently opened database is a main-memory instance.|}
==FLUSH==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|FLUSHPARALLEL [number]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><flush/></code><br/>|-{{Code| '''Permission'''|''WRITE''8}}
|-
| '''Summary'''
|Explicitly flushes Denotes the buffers maximum allowed number of the currently opened database to disk. This command is applied if parallel [[Options#AUTOFLUSHTransaction Management|AUTOFLUSHtransactions]] has been set to :* If {{CodeOption|falseFAIRLOCK}}is enabled, the number of parallel transactions will never exceed the specified value.|-* If the option is disabled (which is the default), the limit only applies to transactions that access databases.| '''Errors'''|* The command fails if no database main reason for allowing parallel operations is openedto prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.
|}
=Server Administration==LOG===
==SHOW SESSIONS==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|SHOW SESSIONSLOG [boolean]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><show-sessions/></code><br/>|-{{Code| '''Permission'''|''ADMIN''true}}
|-
| '''Summary'''
|Shows all sessions that are connected to Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the current server instanceon [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.
|}
==SHOW USERS=LOGMSGMAXLEN=== 
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|SHOW USERS (ON LOGMSGMAXLEN [databaselength])}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><show-users (database='...')/></code><br/>{{Code|-| '''Permission'''|''ADMIN''1000}}
|-
| '''Summary'''
|Shows all users that are registered in Specifies the database. If maximum length of a {{Codesingle [[Logging|[databaselog message]]}} is specified, local users are shown.|-| '''Errors'''|The command fails if the optional database could not be opened.
|}
==KILL=LOGTRACE={| width='100%'|-|width='100'|'''Syntax'''|{{Code|KILL [target]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><kill target='...'/></code><br/>|-| '''Permission'''|''ADMIN''|-| '''Summary'''|Kills sessions of a user or an IP:port combination, specified by {{Code|[target]}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one user.|-| '''Errors'''|The command fails if a user tried to kill his/her own session.|}
==CREATE EVENT==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CREATE EVENT LOGTRACE [NAMEboolean]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><create-event name='...'/></code><br/>{{Code|-| '''Permission'''|''ADMIN''true}}
|-
| '''Summary'''
|Creates If BaseX is running as [[Web Application]], trace output (generated via {{Code|fn:trace}}, {{Function|Profiling|prof:dump}} and similar functions) is written to the specified [[EventsLogging|eventdatabase logs]].|-| '''Errors'''|The command fails if event already existsIf this option is disabled, trace output will be redirected to standard error, as it is known from the standalone version of BaseX.
|}
==SHOW EVENTSHTTP Services=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|SHOW EVENTS}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><show-events/></code><br/>|-| '''Permission'''|''ADMIN''|-| '''Summary'''|Shows all [[Events|events]] that have been registered in the database.|}
==DROP EVENT==Most HTTP options are defined in the {{Code| width='100%'|-|width='100'|'''Syntax'''|jetty.xml}} and {{Code|DROP EVENT [NAME]web.xml}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|configuration files in the <code><drop[https://github.com/BaseXdb/basex/tree/master/basex-event name='...'api/src/><main/code><brwebapp/>|WEB-| '''Permission'''|''ADMIN''|INF webapp/WEB-| '''Summary'''|Drops the specified [[Events|event]INF]</code> directory.|Some additional BaseX-| '''Errors'''|The command fails if specific options exist that will be set before the event doesn't exist.|}web server is started:
=User Management==WEBPATH===
==CREATE USER==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CREATE USER WEBPATH [namepath] ([password])}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><create-user name='...'>([password[Configuration#Database Directory|{home}/webapp]])</create-user></code><br/>|-| '''Permission'''|''ADMIN''
|-
| '''Summary'''
|Creates a user with Points to the specified {{Code|directory in which all the [[nameWeb Application]]}} and {{Code|contents are stored, including XQuery, Script, [[passwordRESTXQ]}}. {{Code|[name]}} must be a and configuration files:* The option is ignored if BaseX is deployed as [[Web Application#Valid NamesServlet_Container|valid user nameweb servlet]]. The password must * It cannot be a valid MD5 hash valueassigned via the {{Code|web. If no password is specified in the console modexml}} file, as it is requested via standard input.|-| '''Errors'''|The command fails if the specified user already exists, or if will be evaluated before the password is no valid MD5 hash valueconfiguration files are parsed.
|}
==ALTER USER=GZIP={| width='100%'|-|width='100'|'''Syntax'''|{{Code|ALTER USER [name] ([password])}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><alter-user name='...'>([password])</alter-user></code><br/>|-| '''Permission'''|''ADMIN''|-| '''Summary'''|Alters the {{Code|[password]}} of the user specified by {{Code|[name]}}. The password must be a valid MD5 hash value. If no password is specified in the console mode, it is requested via standard input.|-| '''Errors'''|The command fails if the specified user does not exist, or if the password is no valid MD5 hash value.|}
==DROP USER==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|DROP USER GZIP [nameboolean] (ON [database])}}:
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><drop-user name='...' (database='...')/>false</code><br/>|-| '''Permission'''|''ADMIN''
|-
| '''Summary'''
|Drops the user with the specified {{Code|Jetty provides a [namehttps://www.eclipse.org/jetty/documentation/current/gzip-filter.html Gzip handler]}}for dynamically uncompressing requests and compressing responses. If a {{Code|[database]}} This feature can be enabled if Jetty is specified, started via the user is only dropped locally. The [[#Glob SyntaxWeb Application|Glob SyntaxBaseX HTTP Server]] :* The option can also be used to address more than one database or user.enabled on [[Command-Line Options#HTTP Server|command line]] via <code>-g</code>.| '''Errors'''|The command fails if * It cannot be assigned via the {{Code|adminweb.xml}} is specified file, as user name, if it will be evaluated before the specified user does not exist or is logged in, or if configuration files are parsed.* The [https://github.com/eclipse/jetty.project/blob/7cc552013eb4d05cb603ba0bc85d176c97957cd4/jetty-server/src/main/java/org/eclipse/jetty/server/handler/gzip/GzipHandler.java#L187-L211 same defaults] of the optional database could not web server will be opened applied (support for modificationGET requests, exclusion of binaries, MSIE 6.0, etc.).
|}
==GRANT=RESTXQPATH={| width='100%'|-|width='100'|'''Syntax'''|{{Code|GRANT [NONE&#x7c;READ&#x7c;WRITE&#x7c;CREATE&#x7c;ADMIN] (ON [database]) TO [user]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><grant name='...' permission='none&#x7c;read&#x7c;write&#x7c;create&#x7c;admin' (database='...')/></code><br/>|-| '''Permission'''|''ADMIN''|-| '''Summary'''|Grants the specified [[User_Management|permission]] to the specified {{Code|[user]}}. If a {{Code|[database]}} is specified, the permissions are only granted locally. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database or user.|-| '''Errors'''|The command fails if {{Code|admin}} is specified as user name, if the specified user does not exist, or if the optional database could not be opened for modification.|-| '''Examples'''|* {{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission to the user {{Code|JoeWinson}}.* {{Code|GRANT WRITE ON Wiki TO editor*}}<br/>grants {{Code|WRITE}} permissions on the {{Code|Wiki}} database to all users starting with the characters {{Code|editor*}}.|}
==PASSWORD==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|PASSWORD (RESTXQPATH [passwordpath])}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><password>([password])</password></code><br/>|-| '''PermissionDefault'''|''NONEempty''
|-
| '''Summary'''
|Changes Points to the {{Code|directory which contains the [[passwordRESTXQ]]}} modules of the current usera web application. The password must Relative paths will be a valid MD5 hash value. If no password is specified in resolved against the console mode, it is requested via standard input.{{Option|-| '''Errors'''|The command fails if the password is no valid MD5 hash valueWEBPATH}} directory.
|}
=General Commands==PARSERESTXQ===
==RUN==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|RUN [file]PARSERESTXQ}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><run file='...'/></code>{{Code|-| '''Permission'''|''depends on input''3}}
|-
| '''Summary'''
|Evaluates Timeout after which the contents of RESTXQ directory will be parsed for changes:* If {{Code|[file]0}} as XQuery expressionis specified, the directory will be parsed every time a RESTXQ function is called. If * A positive value defines the file ends with the suffix idle time in seconds after which parsing will be enforced. The default value is {{Code|.bxs3}}, : Changes in the file content RESTXQ directory will be evaluated as [[#Basics|command script]]. This command can be used to run several commands in a single transactiondetected after 3 seconds without RESTXQ function calls.|-| '''Errors'''|The command fails * Monitoring is completely disabled if the a negative value is specified file does not exist, or if the retrieved input is invalid. It will be canceled as soon as one of the executed commands fails.|-See [[RESTXQ#Preliminaries| '''Examples'''|* <code>RUN queryRESTXQ Preliminaries]] for more details.xq</code><br/>will evaluated the specified file as XQuery expression* <code>RUN commands.bxs</code><br/>will evaluated the specified file as command script
|}
==EXECUTE=RESTXQERRORS=== {{Mark|Updated with BaseX 9.5:}} Additionally suppress stack trace in HTTP response.
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|EXECUTE [input]RESTXQERRORS}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><execute>[input]</execute></code>|-{{Code| '''Permission'''|''depends on input''true}}
|-
| '''Summary'''
|Evaluates Reports parsing errors in XQuery modules in the RESTXQ directory and returns the specified {{Code|[input]}} as [[#Basics|command script]]full error message and stack trace to the client. By default, this option is enabled. This command In a production environment, it can be used disabled to run several commands in a single transaction.|-| '''Errors'''|The command fails if suppress errors that should not be seen by the syntax user of an API (the specified input is invalid. It will full error information can still be canceled as soon as one of looked up in the executed commands failsdatabase logs).See [[RESTXQ#Error Handling|-| '''Examples'''|* <code>EXECUTE "create db db1; create db db2"</code><br/>* <code>EXECUTE "<commands><create-db name='db1'/><create-db name='db2'/></commands>"</code><br/>both commands will create two databases {{Code|db1}} and {{Code|db2}} in a single transactionRESTXQ Error Handling]] for more details.
|}
==GET=RESTPATH=== 
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|GET RESTPATH [optionpath]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><get option='...'/></code><br/>|-| '''Permission'''|''NONEempty''
|-
| '''Summary'''
|Returns Points to the current value of directory which contains XQuery files and command scripts, which can be evaluated via the [[OptionsREST#GET Requests|OptionREST run operation]] specified via . Relative paths will be resolved against the {{CodeOption|[option]WEBPATH}}. Global options can only be requested by users with ADMIN permissions.|-| '''Errors'''|The command fails if the specified option is unknowndirectory.
|}
==SET=HTTPLOCAL={| width='100%'|-|width='100'|'''Syntax'''|{{Code|SET [option] ([value])}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><set option='...'>([value])</set></code><br/>|-| '''Permission'''|''NONE''|-| '''Summary'''|Sets the [[Options|Option]] specified by {{Code|[option]}} to a new {{Code|[value]}}. Only local options can be modified. If no value is specified, and if the value is boolean, it will be inverted.|-| '''Errors'''|The command fails if the specified option is unknown or if the specified value is invalid.|}
==INFO==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|INFOHTTPLOCAL [boolean]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><info/></code><br/>|-{{Code| '''Permission'''|''READ''false}}
|-
| '''Summary'''
|Shows global informationBy default, if BaseX is run as [[Web Application]], the database server instance will be started in addition, which can then be addressed by [[Clients]] via the database port (see {{Option|PORT}}).<br/>If the option is set to {{Code|true}}, no database server will be launched.
|}
==HELP=STOPPORT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|HELP ([command])}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><help>([command])</help></code><br/>|-| '''Permission'''|''NONE''|-| '''Summary'''|If {{Code|[command]}} is specified, information on the specific command is printed; otherwise, all commands are listed.|-| '''Errors'''|The command fails if the specified command is unknown.|}
==EXIT==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|EXIT STOPPORT [port]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><exit/></code><br/>|-{{Code| '''Permission'''|''NONE''8985}}
|-
| '''Summary'''
|Exits This is the console modeport 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>.
|}
=ChangelogCreate Options=
;Version 7.5==General==
* Added: <code>[[#EXECUTE|EXECUTE]]</code> executes a command script.* Added: <code>[[#INSPECT|INSPECT]]</code> performs integrity checks.* Added: automatic detection of [[#Basics|Command Scripts]].* Removed: {{Code|SHOW DATABASES}}; information is also returned by <code>[[#SHOW SESSIONS|SHOW SESSIONS]]</code>.* Removed: <code>[[#OPEN|OPEN]]</code>: path argument. ;Version 7.3 * Added: [[#XML Syntax|XML Syntax]] added* Updated: <code>[[#CHECK|CHECK]]</code> can now be used to create empty databases.* Updated: Names and paths in <code>[[#OPEN|OPEN]]</code> and <code>[[#LIST|LIST]]</code> are now specified as separate arguments. ;Version 7.2.1 * Updated: permissions for <code>[[#GET|GET]]</code> and <code>[[#SET|SET]]</code> changed from {{Code|READ}} to {{Code|NONE}} ;Version 7.2 * Updated: <code>[[#CREATE INDEX|CREATE INDEX]]</code>, <code>[[#DROP INDEX|DROP INDEX]]</code> ({{Code|PATH}} argument removed. Path summary is always available now and updated with [[#OPTIMIZE|OPTIMIZE]])* Updated: permissions for <code>[[#REPO DELETE|REPO DELETE]]</code>, <code>[[#REPO INSTALL|REPO INSTALL]]</code> and <code>[[#REPO LIST|REPO LIST]]</code> ;Version 7.1 * Updated: <code>[[#KILL|KILL]]</code> (killing sessions by specifying IP:port) ;Version 7.0 * Added: <code>[[#FLUSH|FLUSH]]</code>, <code>[[#RETRIEVE|RETRIEVE]]</code>, <code>[[#STORE|STORE]]</code>* Updated: <code>[[#ADD|ADD]]</code>: simplified arguments [[Category:Beginner]][[Category:Server]] ==Client/Server Architecture=MAINMEM===
===HOST===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HOST MAINMEM [hostboolean]}}
|-
| '''Default'''
|{{Code|localhostfalse}}
|-
| '''Summary'''
|This host name If this option is turned on, new databases will be created in main memory:* Most queries will be evaluated faster in main-memory mode, but all data is used by lost if the client when connecting BaseX instance in which the database was created is shut down.* It is not possible to store binary resources in a servermain-memory database. * A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new database from the exported file in a second step.* This option can also will not be changed when running the client on available for [[Startup OptionsDatabase Module#BaseX Clientdb:create|command linedb:create]] via <code>-n</code>, because the database would not be accessible anymore after database creation, i. e., outside the query scope.
|}
===PORTADDCACHE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PORT ADDCACHE [portboolean]}}
|-
| '''Default'''
|{{Code|1984false}}
|-
| '''Summary'''
|This port If this option is used by activated, data structures of documents will first be cached to disk before being added to the client when connecting to a serverfinal database. This option can also is helpful when larger documents need to be changed added, and if the existing heuristics cannot estimate the input size (e.g. when running the client on [[Startup Options#BaseX Client|command line]] via <code>-p</code>adding directories or sending input streams).
|}
==Parsing=SERVERPORT= ===CREATEFILTER=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERVERPORT CREATEFILTER [portfilter]}}
|-
| '''Default'''
|{{Code|1984*.xml}}
|-
| '''Summary'''
|This is the port the database server will be listening to. This option can also be changed when running File filter in the server on [[Startup OptionsCommands#BaseX ServerGlob Syntax|command lineGlob Syntax]] via <code>-p</code>, which is applied whenever new databases are created, or resources are added to a database.
|}
===EVENTPORTADDARCHIVES=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|EVENTPORT ADDARCHIVES [portboolean]}}
|-
| '''Default'''
|{{Code|1985true}}
|-
| '''Summary'''
|This port If this option is used by the client set to listen for [[Events{{Code|server events]]true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc. It will only be bound if a client attaches itself ) are parsed whenever new databases are created or resources are added to a database event. This option can also be changed when running the server on [[Startup Options#BaseX Server|command line]] via <code>-e</code>.
|}
===USERARCHIVENAME=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|USER ARCHIVENAME [nameboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''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 this option is emptyset to {{Code|true}}, login the file name of parsed archives will only be possible if included in the client specifies credentials.* The option can also be changed on [[Startup Options#BaseX Client|command line]] via <code>-U</code>document paths.
|}
===PASSWORDSKIPCORRUPT=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PASSWORD SKIPCORRUPT [passwordboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Represents Skips corrupt (i.e., not well-formed) files while creating a password, which is used for accessing the server database or an HTTP service:* The default value will be overwritten if a client specifies its own credentialsadding new documents.* If the default value this option is emptyactivated, document updates are slowed down, login as all files will only be possible if the client specifies credentialsparsed twice.* The option can also Next, main memory consumption will be higher as parsed files will be changed on [[Startup Options#BaseX Client|command line]] via <code>-P</code>.* Please note that it is a security risk to specify your password cached in plain textmain memory.
|}
===SERVERHOSTADDRAW=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERVERHOST ADDRAW [host&#x7c;ipboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|This is the host name or ip address the server is bound to. If the this option is set to an empty string (which is the default)enabled, all resources that are filtered out by the server {{Option|CREATEFILTER}} option while being added to a database will be open to all clientsstored as [[Binary Data|raw files]] instead (i.e., in their binary representation).
|}
===PROXYHOSTPARSER==={| width='100%' width='100%'|-| width='90' | '''Signature'''|{{Code|PROXYHOST [host]}}|-| '''Default'''|''empty'' |-| '''Summary'''|This is the host name of a proxy server.|}
===PROXYPORT===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PROXYPORT PARSER [porttype]}}
|-
| '''Default'''
|{{Code|80XML}}
|-
| '''Summary'''
|This Defines a [[Parsers|parser]] for importing new files to the database. Available parsers are {{Code|XML}}, {{Code|JSON}}, {{Code|CSV}}, {{Code|TEXT}}, {{Code|HTML}}, and {{Code|RAW}}. HTML input will be parsed as XML documents if [[Parsers#HTML_Parser|Tagsoup]] is not found in the port number of a proxy serverclasspath.
|}
===NONPROXYHOSTSCSVPARSER=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|NONPROXYHOSTS CSVPARSER [hostsoptions]}}
|-
| '''Default'''
|-
| '''Summary'''
|This is a list of hosts that should Specifies the way how CSV data will be directly accessedparsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]].|-| '''Examples'''|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.
|}
===TIMEOUTJSONPARSER=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|TIMEOUT JSONPARSER [secondsoptions]}}
|-
| '''Default'''
|{{Code|30}}''empty''
|-
| '''Summary'''
|Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it way how JSON data will be abortedparsed. Write operations will not be affected by this timeoutKeys and values are delimited with <code>=</code>, and multiple options are delimited with <code>, as this would corrupt the integrity of the database</code>. The timeout is deactivated if available options (except for the timeout is set to {{Codeadditional <code>encoding</code> option) are described in the [[JSON Module#Options|0}}JSON Module]]. It is ignored for {{Code|-| '''Examples'''|ADMIN}} operations<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.
|}
===KEEPALIVEHTMLPARSER=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|KEEPALIVE HTMLPARSER [secondsoptions]}}
|-
| '''Default'''
|{{Code|600}}''empty''
|-
| '''Summary'''
|Specifies the maximum time a client way how HTML data will be remembered by the serverparsed. If there has been no interaction Keys and values are delimited with <code>=</code>, and multiple options are delimited with a client for a longer time than specified by this timeout<code>, it will be disconnected. Running operations will not be affected by this option</code>. The keepalive check is deactivated if available options are described in the value is set to {{Code[[Parsers#Options|0}}Parsers]] article.|-| '''Examples'''|* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.* <code>lexical=true</code> preserves comments.
|}
===PARALLELTEXTPARSER=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARALLEL TEXTPARSER [numberoptions]}}
|-
| '''Default'''
|{{Code|8}}''empty''
|-
| '''Summary'''
|Denotes Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are listed in the maximum allowed {{Code|number}} of parallel read [[Transaction Management|transactionsParsers]]article.|-| '''Examples'''|<code>lines=true</code> creates a single element for each line of text.
|}
==XML Parsing=LOG= ===CHOP=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|LOG CHOP [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Turns Many XML documents include whitespaces that have been added to improve readability. This option controls the [[Logging]https://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of server operations the XML parser:* With the default value {{Code|true}}, leading and HTTP requests on/trailing whitespaces from text nodes will be chopped and all empty text nodes will be discarded.* The flag should be turned offif a document contains [[Full-Text#Mixed Content|mixed content]]. This option * The flag can also be changed when running the server turned off on [[Startup Command-Line Options#BaseX ServerStandalone|command line]] via <code>-zw</code>.* If the <code>xml:space="preserve"</code> attribute is attached to an element, chopping will be turned off for all descendant text nodes.  In the following example document, the whitespaces in the text nodes of the {{Code|text}} element will not be chopped:<syntaxhighlight lang="xml"><xml> <title> Demonstrating the CHOP flag </title> <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text></xml></syntaxhighlight>It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option; otherwise the serialized documents will automatically be indented.
|}
===LOGMSGMAXLENSTRIPNS=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|LOGMSGMAXLEN STRIPNS [lengthboolean]}}
|-
| '''Default'''
|{{Code|1000false}}
|-
| '''Summary'''
|Specifies the maximum length of a single [[Logging|log message]]Strips all namespaces from an XML document and all elements while parsing.
|}
==HTTP Options=INTPARSE=== 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='90120' | '''Signature'''|{{Code|WEBPATH INTPARSE [pathboolean]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory{{Code|{homefalse}/BaseXWeb]]</code> or <code>[[Configuration#Database Directory|{home}/webapp]]</code>
|-
| '''Summary'''
|Points to Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the directory internal parser:* Performance: Documents (in which all particular small ones) will be parsed faster* Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;)* Entities: around 250 HTML entities will be detected and decodedYou will be able to correctly parse most XML documents with the [[Web Application]] contents are storedinternal parser. Java’s Xerces parser is still used as default, including XQueryhowever, Scriptbecause it supports all features of the XML standard and advanced DTD features, [[RESTXQ]] and configuration filessuch as recursive entity expansion.
|}
===RESTXQPATHDTD==={| width='100%'|-| width='90' | '''Signature'''|{{Code|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|WEBPATH]] directory.|}
===HTTPLOCAL===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTTPLOCAL DTD [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Parses referenced DTDs and resolves XML entities. By default, a database server instance will be opened along with the web server. If the flag this option is set switched to {{Code|truefalse}}, all commands will be executed in an embedded database context.<br/>If BaseX is run as [[Web Application]]many DTDs are located externally, and if which may completely block the flag is process of creating new databases. The {{CodeOption|falseCATFILE}}, the server will option can be started as soon as the first HTTP service is calledchanged to locally resolve DTDs.
|}
===STOPPORTXINCLUDE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|STOPPORT XINCLUDE [portboolean]}}
|-
| '''Default'''
|{{Code|8985true}}
|-
| '''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 Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is greater than switched to {{Code|0true}}.* The This option is ignored only available if BaseX the standard Java XML Parser is used as a [[Web Application]] or started via [[Web Application#Maven(see {{Option|Maven]].* This option can also be changed when running the HTTP server on [[Startup Options#BaseX Server|command line]] via <code>-s</code>INTPARSE}}).
|}
=Create Options= =CATFILE=General==
===MAINMEM===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|MAINMEM CATFILE [booleanpath]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''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 Semicolon-separated list of this option will be assigned once XML catalog files to a new database, and cannot be changed after thatresolve URIs. See [[Catalog Resolver]]s for more details.
|}
===ADDCACHE=Indexing== The following options control the creation of index structures. The current values will be considered if a new database is created. See [[Indexes]] for more details.
{{Mark|Introduced with Version 7.7:}}===TEXTINDEX===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|ADDCACHE TEXTINDEX [boolean]}}
|-
| '''Default'''
|{{Code|falsetrue}}
|-
| '''Summary'''
|If this option Creates a text index whenever a new database is activated, documents that are added via created. A text index speeds up queries with equality comparisons on text nodes. See [[CommandsIndex#ADDText Index|ADDText Index]] 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)for more details.
|}
==Parsing=ATTRINDEX===
===CREATEFILTER===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CREATEFILTER ATTRINDEX [filterboolean]}}
|-
| '''Default'''
|{{Code|*.xmltrue}}
|-
| '''Summary'''
|File filter in the Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[CommandsIndex#Glob SyntaxAttribute Index|Glob SyntaxAttribute Index]], which is applied whenever new databases are created, or resources are added to a databasefor more details.
|}
===ADDARCHIVESTOKENINDEX=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|ADDARCHIVES TOKENINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, DOCX, etc.) are parsed Creates a token index whenever a new database are is created or resources are added to a database. A token index speeds up searches for single tokens in attribute values. See [[Index#Token Index|Token Index]] for more details.
|}
===SKIPCORRUPTFTINDEX=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SKIPCORRUPT FTINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Skips corrupt (i.e., not wellCreates a full-formed) files while creating text index whenever a new database or adding new documentsis created. If this option is activated, document updates are slowed down, as all files will be parsed twiceA full-text index speeds up queries with full-text expressions. Next, main memory consumption will be higher as parsed files will be cached in main memorySee [[Index#Full-Text Index|Full-Text Index]] for more details.
|}
===ADDRAWTEXTINCLUDE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|ADDRAW TEXTINCLUDE [booleannames]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|If this option is activated, and if new resources Defines name patterns for the parent elements of texts that are added to a databaseindexed. By default, all files that text nodes will be indexed.<br/>Name patterns are not filtered separated by the commas. See [[Indexes#CREATEFILTERSelective Indexing|CREATEFILTERSelective Indexing]] option will be added as ''raw'' files (i.e., in their binary representation)for more details.
|}
===PARSERATTRINCLUDE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARSER ATTRINCLUDE [typenames]}}
|-
| '''Default'''
|{{Code|XML}}''empty''
|-
| '''Summary'''
|Defines a [[Parsers|parser]] name patterns for importing new files the attributes to the databasebe indexed. CurrentlyBy default, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML all attribute nodes will be parsed as normal XML files if [http:indexed.<br//home>Name patterns are separated by commas.ccil.org/~cowan/XML/tagsoup/ TagsoupSee [[Indexes#Selective Indexing|Selective Indexing]] is not found in the classpathfor more details.
|}
===PARSEROPTTOKENINCLUDE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARSEROPT TOKENINCLUDE [optionsnames]}}
|-
| '''Default'''
|-
| '''Summary'''
|Defines parser-specific options; see name patterns for the attributes to be indexed. By default, tokens in all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[ParsersIndexes#Selective Indexing|Selective Indexing]] for more informationdetails.
|}
===HTMLOPTFTINCLUDE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTMLOPT FTINCLUDE [optionsnames]}}
|-
| '''Default'''
|-
| '''Summary'''
|Allows to specify TagSoup options Defines name patterns for HTML parsing; see the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[ParsersIndexes#HTML ParserSelective Indexing|HTML ParserSelective Indexing]] for more informationdetails.
|}
==XML Parsing=MAXLEN===
===CHOP===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CHOP MAXLEN [booleanint]}}
|-
| '''Default'''
|{{Code|true96}}
|-
| '''Summary'''
|Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodesSpecifies the maximum length for strings to be stored in [[Indexes|index structures]]. By default, The value of this option is set will be assigned once to {{Code|true}}a new database, as it often reduces the database size by up to 50%. It and can also only be turned off on changed by creating a new database or doing a [[Startup OptionsCommands#BaseX StandaloneOPTIMIZE|command linefull optimization]] via <code>-w</code>.
|}
===INTPARSEMAXCATS=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|INTPARSE MAXCATS [booleanint]}}
|-
| '''Default'''
|{{Code|true100}}
|-
| '''Summary'''
|Uses Specifies the internal XML parser instead maximum number of distinct values (categories) that will be stored together with the standard Java XML parserelement/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The internal parser is fastervalue of this option will be assigned once to a new database, more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for parsing DTDscannot be changed after that.
|}
===DTDUPDINDEX=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DTD UPDINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Parses referenced DTDs and resolves XML entities. By defaultIf turned on, incremental indexing will be enabled:* The current value of this option is switched will be assigned to new databases. It can be changed for existing databases by running {{Command|OPTIMIZE}} with the {{Code|falseALL}}keyword or [[Database_Module#db:optimize|db:optimize($db, true())]].* After each update, the value indexes will be refreshed as many DTDs well. Incremental updates are located externally, which may completely block currently not available for the process of creating new databasesfull-text index and database statistics. The * Find more details in the article on [[Index#CATFILEUpdates|CATFILEIndex Structures]] option can be changed to locally resolve DTDs.
|}
===CATFILEAUTOOPTIMIZE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CATFILE AUTOOPTIMIZE [pathboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Specifies If turned on, auto optimization will be applied to new databases:* With each update, outdated indexes and database statistics will be recreated.* As a catalog file result, the index structures will always be up-to locally resolve DTDs; see the entry on -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 {{Command|OPTIMIZE}} or [[Catalog ResolverDatabase_Module#db:optimize|db:optimize]]s for more details.
|}
==Indexing=SPLITSIZE=== 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='90120' | '''Signature'''|{{Code|TEXTINDEX SPLITSIZE [booleannum]}}
|-
| '''Default'''
|{{Code|true0}}
|-
| '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see This option affects the [[Indexes#Performance|construction]] for of new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk:* By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption. Usually, this works fine.* If explicit garbage collection is disabled when running Java (e.g. via the JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to choose a custom split size.* You can e. g. start with {{Code|1000000}} (one million) index operations and adjust this value in the next steps.* The larger the assigned value is, the less splits will take place, and the more detailsmain memory will be required.
|}
==Full-Text Indexing== =ATTRINDEX==STEMMING={| width='100%'|-| width='90' | '''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='90120' | '''Signature'''|{{Code|FTINDEX STEMMING [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Creates a If {{Code|true}}, all tokens will be stemmed during full-text index whenever indexing, using a new database is createdlanguage-specific stemmer implementation. By default, tokens will not be stemmed. A full-text index speeds up queries with full-text expressions; see See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===MAXLENCASESENS=== 
{| width='100%'
|-| width='90120' | '''Signature'''|{{Code|MAXLEN CASESENS [intboolean]}}
|-
| '''Default'''
|{{Code|96false}}
|-
| '''Summary'''
|Specifies If {{Code|true}}, the maximum length case of strings that are to tokens will be indexed by the name, path, value, and preserved during full-text index structuresindexing. The value of this option By default, case will be assigned once to a new database, and cannot ignored (all tokens will be changed after thatindexed in lower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===MAXCATSDIACRITICS==={| width='100%'|-| width='90' | '''Signature'''|{{Code|MAXCATS [int]}}|-| '''Default'''|{{Code|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 [[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='90120' | '''Signature'''|{{Code|UPDINDEX DIACRITICS [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|If turned onset to {{Code|true}}, incremental indexing diacritics will be activated: all update operations will also update the value index structures (texts and attribute values)preserved during full-text indexing. The value of this option will be assigned once to a new databaseBy default, and cannot be changed after that. The advantage of incremental indexes is that the value index structures diacritics will always be up-to-date. The downside is that updates will take a little bit longerremoved. The article on See [[Indexes#Full-Text Index#Updates|Full-Text Index Structures]] includes additional for more details.
|}
===INDEXSPLITSIZELANGUAGE=== {{Mark|Introduced with Version 7.7:}}
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|INDEXSPLITSIZE LANGUAGE [numlang]}}
|-
| '''Default'''
|{{Code|0en}}
|-
| '''Summary'''
|This option affects The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See [[Indexes#Full-Text Index Construction|constructionFull-Text Index]] 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 appliedfor more details.
|}
===FTINDEXSPLITSIZESTOPWORDS=== {{Mark|Introduced with Version 7.7:}}
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|FTINDEXSPLITSIZE STOPWORDS [numpath]}}
|-
| '''Default'''
|{{Code|0}}''empty''
|-
| '''Summary'''
|This option affects If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index is created. A stopword list may decrease the size of the full text index and speed up your queries. See [[Indexes#Full-Text Index Construction|constructionFull-Text Index]] 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 appliedfor more details.
|}
=Query Options= ===QUERYINFO=Full-Text==
===STEMMING===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|STEMMING QUERYINFO [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|A new full-text index will stem all tokens Prints more information on internal query rewritings, optimizations, and speed up queries on stemmed tokensperformance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. The same stemming normalization will It can also be applied to all query tokens that are checked against tokens in this indexactivated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.
|}
===CASESENSMIXUPDATES=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CASESENS [boolean]MIXUPDATES}}
|-
| '''Default'''
|-
| '''Summary'''
|A new fullAllows queries to both contain updating and non-text index will preserve the case of all tokensupdating expressions. The same case normalization All updating constraints will be applied turned off, and nodes to all query tokens that be returned will be copied before they are checked against tokens modified by an updating expression. By default, in compliance with the XQuery Update Facility, this indexoption is set to {{Code|false}}. See [[XQuery Update#Returning Results|Returning Results]] for more details.
|}
===DIACRITICSBINDINGS=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DIACRITICS BINDINGS [booleanvars]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|A new fullContains external variables to be bound to a query. The string must comply with the following rules:* Variable names and values must be separated by equality signs.* Multiple variables must be delimited by commas.* Commas in values must be duplicated.* Variables may optionally be introduced with a leading dollar sign.* If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [https://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].This option can also be used on [[Command-text index will preserve Line Options#BaseX Standalone|command line]] with the diacritics of all tokensflag <code>-b</code>. The same diacritics normalization will be applied |-| '''Examples'''|* <code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a* <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to all query tokens that are checked against tokens in this indexthe variable $a with the namespace {{Code|URI}}.* In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable {{Code|$GREETING}}:<syntaxhighlight lang="xquery">SET BINDINGS GREETING="hello world!"XQUERY declare variable $GREETING external; $GREETING</syntaxhighlight>
|}
===LANGUAGEINLINELIMIT=== {{Mark|Updated with Version 9.5:}} default reduced to 50. 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|LANGUAGE [lang]INLINELIMIT}}
|-
| '''Default'''
|{{Code|en50}}
|-
| '''Summary'''
|A new full-text index will use the given language This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to normalize all tokensspeed up query evaluation. This option * Inlining will only take place if a function body is mainly important not too large (i.e., if tokens are it does not contain too many expressions).* With this option, this maximum number of expressions can be specified.* Function inlining can be turned off by setting the value to {{Code|0}}.* The limit can be stemmed, or if locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (follow the tokenization of a language differs from Western languageslink to get more information on function inlining).
|}
===STOPWORDSUNROLLLIMIT=== {{Mark|Introduced with Version 9.6:}} 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|STOPWORDS [path]UNROLLLIMIT}}
|-
| '''Default'''
|''empty''{{Code|5}}
|-
| '''Summary'''
|A new full-text index will drop tokens that This option controls the unroll limit:* Loops with few iterations are listed in ''unrolled'' by the specified stopword listXQuery compiler to enable further optimizations. A stopword list may decrease * If the size of limit is increased, more optimizations will take place, but the full text indexmemory consumption and compile time will increase. A standard stopword list * See [[XQuery Optimizations#Loop Unrolling|Loop Unrolling]] for English texts is provided in the directory {{Code|etc/stopwords.txt}} in the official releasesmore details.
|}
=Query Options==ENFORCEINDEX===
===QUERYINFO===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|QUERYINFO ENFORCEINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Prints more information on internal query Enforces index rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUIpath expressions. It can also be activated on See [[Startup OptionsIndexes#BaseX StandaloneEnforce Rewritings|command lineEnforce Rewritings]] via <code>-V</code>for details.
|}
===XQUERY3COPYNODE=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|XQUERY3COPYNODE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Enables all When creating new nodes in XQuery via [[XQuery 3https://www.w3.0org/TR/xquery-31/#id-constructors Node Constructors]] features supported by BaseX, all enclosed nodes will be copied, and all resulting nodes will get new node identities. If This step can be very expensive, and it can be disabled with this option is set to {{Code|false}}. The option should be used carefully, as it changes the XQuery parser will only accept expressions standard behavior of the XQuery 1.0 specificationIt should preferrably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].
|}
===BINDINGSTAILCALLS=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|BINDINGS [vars]TAILCALLS}}
|-
| '''Default'''
|''empty''{{Code|256}}
|-
| '''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 Specifies how many stack frames of [httphttps://www.jclarken.com/xml/xmlns.htm Clark Notation] or [http://www.w3wikipedia.org/TR/xquery-30wiki/#idTail_call tail-basics Expanded QName Notationcalls].* This option can also be used are allowed on [[Startup Options#BaseX Standalone|command line]] with the flag <code>-b</code>stack at any time.|When this limit is reached, tail-| '''Examples'''|<code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} call optimization takes place and {{Code|2}} to the variables $a and $b<br/><code>a=1,,2</code> &nbsp; binds some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1,2}} to the variable $a<br/><code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.
|}
===QUERYPATHWITHDB=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|QUERYPATH [path]WITHDB}}
|-
| '''Default'''
|''empty''{{Code|true}}
|-
| '''Summary'''
|Contains By default, resources specified via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] are looked up both in the path (''base URI'') database and in the file system. If you always use {{Function|Database|db:open}} to access databases, it is recommendable to disable this option:* No locks will be created for the executed query two functions (default: ''empty''see [[Transaction Management#Limitations|limitations of database locking]] for more details). This directory * Access to local and external resources will be used to resolve relative paths to documentsfaster, query modules, and other resources addressed in a queryas the database lookup will be skipped.
|}
===CACHEQUERYDEFAULTDB=== 
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CACHEQUERY [boolean]DEFAULTDB}}
|-
| '''Default'''
|-
| '''Summary'''
|Caches If this option is turned on, paths specified in the [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] functions will first be resolved against a database that has been opened in the global context outside the query results before returning them to (e.g. by the client. This option may be set to {{CodeCommand|trueOPEN}} if command). If the whole result is needed for further operations (such path does not match any existing resources, it will be resolved as is e.g. the case described in the GUI of BaseX)article on [[Databases#Access Resources|accessing database resources]].
|}
===FORCECREATE===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|FORCECREATE [boolean]}}
|-
|-
| '''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]].
|}
===CHECKSTRINGS===
{{Mark|Introduced with Version 7.7:}}
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|CHECKSTRINGS [boolean]}}
|-
|-
| '''Summary'''
|If this option is turned offBy default, strings characters from external sources that are invalid in XML will be adopted as trigger an error. If the option isset to <code>false</code>, i. ethese characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;)., without being checked for valid XML characters:* This The option affects [[Java Bindings]] and the string conversion and input functions such as [[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='90120' | '''Signature'''
|{{Code|LSERROR [error]}}
|-
|-
| '''Summary'''
|This option specifies the maximum Levenshtein error for fuzzy full-text matching. By default, if {{Code|0}} is assigned, the BaseX-specific fuzzy match optionerror value is calculated dynamically. See the page on [[Full-Text#Fuzzy_Querying|Full-TextsFuzzy Querying]] for more information details.|} ===RUNQUERY=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|RUNQUERY [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Specifies if a query will be executed or parsed only. This option can also be changed on fuzzy querying[[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>.
|}
===RUNS===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|RUNS [num]}}
|-
|-
| '''Summary'''
|Specify number of runs Specifies how often a query is executed by the [[Commands#XQUERY|XQUERY]] commandwill be evaluated. The result is serialized only serialized 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>.
|}
===SERIALIZE===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|SERIALIZE [boolean]}}
|-
|-
| '''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 [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.
|}
===SERIALIZER===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|SERIALIZER [params]}}
|-
|-
| '''Summary'''
|Contains parameters Parameters for [[Serialization|serializing]] query results. The string must comply with the following rules:* Keys Variable names and values are must be separated by equality signs.* Multiple parameters are variables must be delimited by commas.* Commas in values must be duplicated.The option can also be used on [[Startup Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
|-
| '''ExampleExamples'''|* <code>indent=no</code> : disables automatic indentation of XML nodes. This is usually a good choice when working with [[Full-Text#Mixed Content|Mixed-Content Data]].* <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.* <code>item-separator=,,</code> : separates serialized items by a single comma.
|}
===EXPORTER===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|EXPORTER [params]}}
|-
|-
| '''Summary'''
|Contains parameters for exporting all resources of a database; see [[Serialization]] for more detailsand writing files after updates via the {{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[Serialization]] for more details.|-| '''Examples'''|* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
|}
===XMLPLAN===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|XMLPLAN [boolean]}}
|-
|-
| '''Summary'''
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.
|}
===COMPPLAN===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|COMPPLAN [boolean]}}
|-
|-
| '''Summary'''
|Creates Generates the query plan , which can be activated via {{Option|XMLPLAN}}, before or after the query compilation step. Query plans might change due to optimizationsThis option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>.
|}
===DOTPLANFULLPLAN==={| width='100%'|-| width='90' | '''Signature'''|{{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='90120' | '''Signature'''|{{Code|DOTCOMPACT FULLPLAN [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Chooses a compact dot representation.|} ===DOTDISPLAY==={| width='100%'|-| width='90' | '''Signature'''|{{Code|DOTDISPLAY [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Visualizes Attaches the file path, line and column of the dot representation after expressions in the original query executionstring to the query plan.|} ===DOTTY==={| width='100%'|-| width='90' | '''Signature'''|{{Code|DOTTY [path]}}|-| '''Default'''|{{Code|dotty}}|-| '''Summary'''|Location of the {{Code|dotty}} executableValues (items and sequences) have no input information attached.
|}
===AUTOFLUSH===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|AUTOFLUSH [boolean]}}
|-
|-
| '''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.
|}
===WRITEBACK===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|WRITEBACK [boolean]}}
|-
|-
| '''Summary'''
|Updates Propagates updates on main-memory instances of files that have been retrieved via [[Databases#XML nodes are written Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] back to the input files. No backups of your original files will be created if this option is turned on. disk:* This option can also be activated on [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>.* Please take in mind that no backup will be created from your original files.* The serialization options can be controlled via the {{Option|EXPORTER}} option.
|}
===MAXSTAT===
 
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|MAXSTAT [num]}}
|-
|-
| '''Summary'''
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO{{Command|INFO INDEX]]</code> }} command.
|}
=Changelog=
 
;Version 9.6
* Added: {{Option|UNROLLLIMIT}}
 
;Version 9.5
* Updated: {{Option|INLINELIMIT}}: default reduced to 50.
* Updated: {{Option|RESTXQERRORS}}: additionally suppress stack trace in HTTP response
 
;Version 9.4
* Added: {{Option|LOGTRACE}}
 
;Version 9.3
* Added: {{Option|WITHDB}}, {{Option|GZIP}}
 
;Version 9.2
* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}
* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
 
;Version 9.0
* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
 
;Version 8.6
* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}
* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)
* Removed: {{Code|QUERYPATH}} (will now be internally assigned)
* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ)
 
;Version 8.5
* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added.
 
;Version 8.4
* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}
* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)
* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code>
 
;Version 8.3
* Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}}
 
;Version 8.2
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
 
;Version 8.1
* Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}}
 
;Version 8.0
* Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}}
* Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored.
 
;Version 7.8.1
* Updated: {{Option|ADDARCHIVES}}: parsing of TAR and TGZ files.
 
;Version 7.8
 
* Added: {{Option|CSVPARSER}}, {{Option|JSONPARSER}}, {{Option|TEXTPARSER}}, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}}
* Updated: {{Option|WRITEBACK}} only applies to main-memory document instances.
* Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions.
* Updated: default of {{Option|INTPARSE}} is now {{Code|false}}.
* Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
;Version 7.7
 * Added: <code>[[#{{Option|ADDCACHE}}, {{Option|ADDCACHE]]</code>CHECKSTRINGS}}, <code>[[#FTINDEXSPLITSIZE{{Option|FTINDEXSPLITSIZE]]</code>}}, <code>[[#INDEXSPLITSIZE{{Option|INDEXSPLITSIZE]]</code>, <code>[[#CHECKSTRINGS|CHECKSTRINGS]]</code>}}
;Version 7.6
 * Added: <code>[[#GLOBALLOCK{{Option|GLOBALLOCK]]</code>}}
* Added: store local options in configuration file after {{Code|# Local Options}} comments.
;Version 7.5
 
* Added: options can now be set via system properties
* Added: a pragma expression can be used to locally change database options
* 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>}}
administrator, editor
4

edits

Navigation menu