Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
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.
* 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:
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:
==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 can also be specified in XML.Multiple commands can be enclosed by a {{Code|<commands/>}} root element: <pre class="brush:xml"><commands> <create-db name='test'/> <add>input.xml</add> <add path='embedded.xml'><root>embedded</root></add> <xquery>count(//text())</xquery></commands></pre> ==Glob Syntax== 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==Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception is the [[#debug|DEBUG]] option, which can also be changed at runtime by users with [[User Management|admin permissions]].
In all commands, the {{Code|DB}} keyword can be replaced by {{Code|DATABASE}}.==General Options==
==CREATE DB==
==EXPORT==
==ALTER DB==
==CREATE BACKUP==
==SHOW BACKUPS==
==INFO DB==
==INFO STORAGE==
==FIND==
==REPO INSTALL=={| width='100%' width='100%'
==REPO DELETE==
==ADD==
==RENAME==
==STORE==
==FLUSH==
==SHOW SESSIONS==
==KILL==
==SHOW EVENTS==
=User Management=
==CREATE USER==
==DROP USER=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|DROP USER [name] (ON [database])}}:|-| '''XML Syntax''' |<code><drop-user name='...' (database='...')/></code><br/>|-| '''Permission'''|''ADMIN''Mark|-| '''Summary'''|Drops the user Introduced with the specified {{Code|[name]}}Version 9. If a {{Code|[database]}4:} is specified, the user is only dropped 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 is logged in, or if the optional database could not be opened for modification.|}
==GRANT==
=General Commands=Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that will be set before the web server is started:
==SET=={| width='100%'|-|width='100'|'''Syntax'''|{{CodeMark|SET [option] ([value])}}|-| '''XML Syntax''' |<code><set option='Introduced with Version 9...'>([value])</set></code><br/>|-| '''Permission'''|''NONE''|-| '''Summary'''|Sets the [[Options|Option]] specified by {{Code|[option]}} to a new {{Code|[value]}3:}. 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==
==EXIT==
;Version 7.5
* 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==
===HOST===
===SERVERPORT===
===USER===
===PROXYPORT===
===WEBPATH===
===MAINMEM===
{{Mark|Introduced with Version 7.7:}}===CHOP===
===CREATEFILTER===
===SKIPCORRUPT===
===CHOP===
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='90120' | '''Signature'''
* Commas that occur in the value itself are encoded by duplication.* If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [httphttps://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].* This option can also be used on [[Startup Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>.
{{Mark|Introduced with Version 7.7:}}
===SERIALIZE===
no edit summary
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 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:
...
<syntaxhighlight lang=Global Options"perl">java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"CHOP: false</syntaxhighlight>
<syntaxhighlight lang=Basics"xml"><key>JVMOptions</key><array> <string>-Dorg.basex.CHOP=false</string></array></syntaxhighlight>
=Database Operations==DEBUG===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CREATE DB DEBUG [nameboolean] ([input])}}
|-
| '''XML SyntaxDefault''' |<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 SyntaxDefault''' |<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 SyntaxDefault''' |<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='100'|'''Syntax'''|{{Code|CLOSE }}|-| '''XML Syntax''' |<code><close/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Closes the currently opened database.|-| '''Errors'''|The command fails if the database files could not be closed for some reason.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|EXPORT REPOPATH [path]}}
|-
| '''XML SyntaxDefault''' |<code><export path='...'[[Configuration#Database Directory|{home}/>repo]]</code><br/>|-| '''Permission'''|''CREATE''
|-
| '''Summary'''
|Exports all documents in the database Points to the specified {{Code|[path]}}, using the serializer options specified by the <code>[[Options#EXPORTER|EXPORTERRepository]]</code> option.|-| '''Errors'''|The command fails if no database is opened, if the target path points to a file or is invalid, if the serialization parameters in which all XQuery modules are invalid, or if the documents cannot be serialized for some other reasonlocated.
|}
==CREATE INDEX=LANG===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CREATE INDEX LANG [TEXT|ATTRIBUTE|FULLTEXTlanguage]}}
|-
| '''XML SyntaxDefault''' |<code><create-index type='text|attribute|fulltext'/></code><br/>{{Code|-| '''Permission'''|''WRITE''English}}
|-
| '''Summary'''
|Creates Specifies the specified database [[Indexes|index]]interface language.|-| Currently, seven languages are available: 'English', 'German', 'French', 'ErrorsDutch', 'Italian'|The command fails if no database is opened, if the specified index is unknown'Japanese', or if indexing fails for some other reasonand 'Vietnamese'.
|}
==DROP INDEX=LANGKEY===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|DROP INDEX LANGKEY [TEXT|ATTRIBUTE|FULLTEXTboolean]}}
|-
| '''XML SyntaxDefault''' |<code><drop-index type='text|attribute|fulltext'/></code><br/>{{Code|-| '''Permission'''|''WRITE''false}}
|-
| '''Summary'''
|Drops 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 it could not be deleted for some other reasonyou want to see where particular texts are displayed.
|}
=Administration==FAIRLOCK===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|ALTER DB FAIRLOCK [name] [newnameboolean]}}
|-
| '''XML SyntaxDefault''' |<code><alter-db name='...' newname='...'/></code><br/>|-{{Code| '''Permission'''|''CREATE''false}}
|-
| '''Summary'''
|Renames Defines the database locking strategy:* By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the limit of parallel transactions (specified by via {{CodeOption|[name]}} to {{Code|[newname]PARALLEL}}) has been reached. {{Code|[newname]}} must be a [[#Valid Names|valid database name]]This prevents update operations from blocking all other requests.|-| '''Errors'''|The command fails if For example, the target database already existsDBA can further be used to see which jobs are running, even if the source database does not exist or queue is currently lockedfull.* If fair locking is enabled, or if read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it could not should be renamed for some other reason.|-| '''Examples'''|* {{Code|ALTER DB db tempdb}}<br/>renames used if the database {{Code|db}} into {{Code|tempdb}}prompt evaluation of update operations is critical.
|}
==DROP DB=CACHETIMEOUT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|DROP DB [name]}}|-| '''XML Syntax''' |<code><drop-db name='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Drops the database with the specified {{Code|[name]}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.|-| '''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 reason.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CREATE BACKUP CACHETIMEOUT [nameseconds]}}
|-
| '''XML SyntaxDefault''' |<code><create-backup name='...'/></code><br/>{{Code|-| '''Permission'''|''CREATE''3600}}
|-
| '''Summary'''
|Creates a zipped backup Specifies how many seconds the results of the database specified queries, which have been queued by {{Code|[name]}}. The backup file will be suffixed with the current timestamp and stored in the database directory. The [[#Glob SyntaxJobs Module|Glob Syntaxasynchronously executed]] 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 will 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}}) cached in the [[Configuration#Database_Directory|database directory]]main memory.
|}
==RESTORE=={| widthClient/Server Architecture='100%'|-|width='100'|'''Syntax'''|{{Code|RESTORE [name]}}|-| '''XML Syntax''' |<code><restore name='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Restores a database with the specified {{Code|[name]}}. The name may include the timestamp of the backup file.|-| '''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 reason.|}
==INSPECT=HOST===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|INSPECTHOST [host]}}
|-
| '''XML SyntaxDefault''' |<code><inspect/></code>|-{{Code| '''Permission'''|''READ''localhost}}
|-
| '''Summary'''
|Performs some integrity checks on This host name is used by the opened database and returns client when connecting to a brief summaryserver. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
|}
==DROP BACKUP=PORT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|DROP BACKUP [name]}}|-| '''XML Syntax''' |<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}}.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|SHOW BACKUPSPORT [port]}}
|-
| '''XML SyntaxDefault''' |<code><show-backups/></code><br/>|-{{Code| '''Permission'''|''CREATE''1984}}
|-
| '''Summary'''
|Shows all database backupsThis port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
|}
==COPY=SERVERPORT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|COPY [name] [newname]}}|-| '''XML Syntax''' |<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.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|INFO DBSERVERPORT [port]}}
|-
| '''XML SyntaxDefault''' |<code><info-db/></code><br/>|-{{Code| '''Permission'''|''READ''1984}}
|-
| '''Summary'''
|Shows information on This is the port the currently opened databaseserver will be listening to.|This option can also be changed when running the server on [[Command-Line Options#BaseX Server| '''Errors'''|The command fails if no database is openedline]] via <code>-p</code>.
|}
==INFO INDEX=USER={| width='100%'|-|width='100'|'''Syntax'''|{{Code|INFO INDEX ([TAG|ATTNAME|PATH|TEXT|ATTRIBUTE|FULLTEXT])}}|-| '''XML Syntax''' |<code><info-index type='tag|attname|path|text|attribute|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.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|INFO STORAGE USER [start end] | [queryname]}}
|-
| '''XML Syntax''' |<code><info-storage>([query])</info-storage></code><br/>|-| '''PermissionDefault'''|''READempty''
|-
| '''Summary'''
|Shows the internal main table of Represents a user name, which is used for accessing the currently opened database. An integer range server or an HTTP service:* The default value will be overwritten if a query may client specifies its own credentials.* If the default value is empty, login will only be specified as argumentpossible if the client specifies credentials.|* The option can also be changed on [[Command-| '''Errors'''Line Options#BaseX Client|The command fails if no database is opened, or if one of the specified arguments is invalidline]] via <code>-U</code>.
|}
= Querying = =PASSWORD=LIST==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|LIST (PASSWORD [namepassword] ([path]))}}
|-
| '''XML SyntaxDefault''' |<code><list (name='...' (path='...'))/></code><br/>|-| '''Permission'''|''NONEempty''
|-
| '''Summary'''
|Lists all available databasesRepresents a password, which is used for accessing the server:* The default value will be overwritten if a client specifies its own credentials. * If {{Code|[name]}} the default value is specifiedempty, login will only be possible if the resources of a database are listedclient specifies credentials. * The output option can also be further restricted to the resources matching the specified {{Codechanged on [[Command-Line Options#BaseX Client|[pathcommand line]]}}via <code>-P</code>.|-| '''Errors'''|The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason* Please note that it is a security risk to specify your password in plain text.
|}
==XQUERY=AUTHMETHOD===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|XQUERY AUTHMETHOD [querymethod]}}
|-
| '''XML Syntax''' |<code><xquery>[query]</xquery></code><br/>|-| '''PermissionDefault'''|''depends on queryBasic''
|-
| '''Summary'''
|Runs Specifies the specified {{Codedefault authentication method, which will be used by the [[Web Application|[queryHTTP server]]}} and prints the resultfor negotiating credentials.|-| '''Errors'''|The command fails if the specified query is invalid.|-| '''Examples'''|* Allowed values are {{Code|XQUERY 1 to 10Basic}}<br/>returns the sequence , {{Code|(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)Digest}}.* , and {{Code|SET RUNS 10; XQUERY 1 to 10Custom}}:<br/>runs * If basic access is chosen, the query 10 timesclient can still request digest authentication.* This is different for digest access, returns the result and prints the average execution timewhich cannot be overwritten.* {{Code|SET XMLPLAN true; XQUERY 1 to 10}}<br/>returns the result and prints With custom authentication, the query plan as XMLserver will not do any authentication.
|}
==RETRIEVE=SERVERHOST={| width='100%'|-|width='100'|'''Syntax'''|{{Code|RETRIEVE [path]}}|-| '''XML Syntax''' |<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.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|FIND SERVERHOST [queryhost|ip]}}
|-
| '''XML Syntax''' |<code><find>[query]</find></code><br/>|-| '''PermissionDefault'''|''READempty''
|-
| '''Summary'''
|Builds and runs a query for This is the specified {{Code|[query]}} termshost name or ip address the server is bound to. Keywords can be enclosed in quotes If the option is set to look for phrases. The following modifiers can an empty string (which is the default), the server will be used open 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 openedall clients.
|}
==CS=PROXYHOST={| width='100%'|-|width='100'|'''Syntax'''|{{Code|CS [query]}}|-| '''XML Syntax''' |<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.|}
|-
|width='100120'|'''SyntaxSignature'''|{{Code|REPO INSTALL PROXYHOST [pathhost]}}
|-
| '''XML SyntaxDefault''' |<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 is not a xar file.* The package to be installed does not exist or is already installed.* The package descriptor is with invalid syntax.* The package to be installed depends on a package which is not installed.* The package This is not supported by the current version host name of BaseXa proxy server.* A component of If the package value is already installed as part of another packagean empty string, it will be ignored.
|}
==REPO LIST=PROXYPORT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|REPO LIST}}|-| '''XML Syntax''' |<code><repo-list/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''| Lists all installed packages.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|REPO DELETE PROXYPORT [nameport]}}
|-
| '''XML SyntaxDefault''' |<code><repo-delete name='...'/></code><br/>{{Code|-| '''Permission'''|''CREATE''0}}
|-
| '''Summary'''
| Deletes This is the package with name port number of a proxy server. If the value is set to {{Code|[name]0}}, optionally followed by a version.|-| '''Errors'''| The command fails if the package to it will be deleted participates in a dependencyignored.
|}
=Updates==NONPROXYHOSTS===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|ADD (TO NONPROXYHOSTS [path]) [inputhosts]}}
|-
| '''XML SyntaxDefault''' |<code><add (path='...')>[input]</add></code><br/>|-| '''Permission'''|''WRITEempty''
|-
| '''Summary'''
|Adds This is 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 list of hosts that should be a single XML document, a directory, a remote URL or a plain XML stringdirectly accessed. If the path denotes a directory, it needs to be suffixed with a slash ({{Code|/}}).|-| '''Errors'''|The command fails if no database value is opened, if one of the documents to be added is not well-formedan empty string, or if it could not will 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}} to the database and moves it to {{Code|temp/one.xml}}.* {{Code|ADD TO target/ xmldir}}<br/>adds all files from the {{Code|xmldir}} directory to the database in the {{Code|target}} pathignored.
|}
==DELETE=IGNOREHOSTNAME={| width='100%'|-|width='100'|'''Syntax'''|{{Code|DELETE [path]}}|-| '''XML Syntax''' |<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.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|RENAME IGNOREHOSTNAME [path] [newpathboolean]}}
|-
| '''XML SyntaxDefault''' |<code><rename path='...' newpath='...'/></code><br/>|-{{Code| '''Permission'''|''WRITE''false}}
|-
| '''Summary'''
|Renames all document paths in the currently opened database that start with the specified {{Code|[path]}}. The command may be used to either rename single documents or directories.|-| '''Errors'''|The command fails if no database If this option is openedenabled, or if the target path is emptyhostnames of certificates will not be verified.|-| '''Examples'''|* Use {{CodeOption|RENAME one.xml two.xml}}<br/>renames the document {{Code|one.xmlIGNORECERT}} to {{Code|two.xml}}.* {{Code|RENAME / TOP}}<br/>moves all documents to a {{Code|TOP}} root directorycompletely disable certificate verification.
|}
==REPLACE=IGNORECERT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|REPLACE [path] [input]}}|-| '''XML Syntax''' |<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 <xml/>}}<br/>replaces the document {{Code|top.xml}} with the document {{Code|<xml/>}}.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|STORE (TO IGNORECERT [path]) [inputboolean]}}
|-
| '''XML SyntaxDefault''' |<code><store (path='...')>[input]</store></code><br/>{{Code|-| '''Permission'''|''WRITE''false}}
|-
| '''Summary'''
|Stores a raw file in the opened database This option can be turned on to ignore untrusted certificates when connecting to the specified {{Code|[path]}}servers. Use {{CodeOption|[input]IGNOREHOSTNAME}} may either be a file reference, a remote URL, or a plain 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 the specified resource is not found, if suppress only the target path is invalid or if the data cannot not be written for some other reasonhostname verification.
|}
==OPTIMIZE=TIMEOUT={| width='100%'|-|width='100'|'''Syntax'''|{{Code|OPTIMIZE (ALL)}}|-| '''XML Syntax''' |<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.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|FLUSHTIMEOUT [seconds]}}
|-
| '''XML SyntaxDefault''' |<code><flush/></code><br/>|-{{Code| '''Permission'''|''WRITE''30}}
|-
| '''Summary'''
|Explicitly flushes Specifies the buffers maximum time a transaction triggered by a client may take. If an operation takes longer than the specified number of seconds, it will be aborted. Active update operations will not be affected by this timeout, as this would corrupt the integrity of the currently opened database to disk. This command The timeout is applied deactivated if [[Options#AUTOFLUSH|AUTOFLUSH]] has been the timeout is set to {{Code|false0}}.It is ignored for operations with [[User Management|-| '''Errors'''|The command fails if no database is openedadmin permissions]].
|}
=Server Administration==KEEPALIVE===
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|SHOW SESSIONSKEEPALIVE [seconds]}}
|-
| '''XML SyntaxDefault''' |<code><show-sessions/></code><br/>|-{{Code| '''Permission'''|''ADMIN''600}}
|-
| '''Summary'''
|Shows all sessions that are connected to Specifies the maximum time a client will be remembered by the current server instance. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0}}.
|}
==SHOW USERS=PARALLEL={| width='100%'|-|width='100'|'''Syntax'''|{{Code|SHOW USERS (ON [database])}}|-| '''XML Syntax''' |<code><show-users (database='...')/></code><br/>|-| '''Permission'''|''ADMIN''|-| '''Summary'''|Shows all users that are registered in the database. If a {{Code|[database]}} is specified, local users are shown.|-| '''Errors'''|The command fails if the optional database could not be opened.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|KILL PARALLEL [targetnumber]}}
|-
| '''XML SyntaxDefault''' |<code><kill target='...'/></code><br/>{{Code|-| '''Permission'''|''ADMIN''8}}
|-
| '''Summary'''
|Kills sessions Denotes the maximum allowed number of a user or an IPparallel [[Transaction Management|transactions]]:port combination, specified by * If {{CodeOption|[target]FAIRLOCK}}is enabled, the number of parallel transactions will never exceed the specified value. The [[#Glob Syntax|Glob Syntax]] can be used * If the option is disabled (which is the default), the limit only applies to address more than one usertransactions that access databases.|-| '''Errors'''|* The command fails if main reason for allowing parallel operations is to 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 user tried to kill his/her own sessionsingle transaction may even give you better results than any parallel activity.
|}
==CREATE EVENT=LOG={| width='100%'|-|width='100'|'''Syntax'''|{{Code|CREATE EVENT [NAME]}}|-| '''XML Syntax''' |<code><create-event name='...'/></code><br/>|-| '''Permission'''|''ADMIN''|-| '''Summary'''|Creates the specified [[Events|event]].|-| '''Errors'''|The command fails if event already exists.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|SHOW EVENTSLOG [boolean]}}
|-
| '''XML SyntaxDefault''' |<code><show-events/></code><br/>|-{{Code| '''Permission'''|''ADMIN''true}}
|-
| '''Summary'''
|Shows all Turns [[EventsLogging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|eventscommand line]] that have been registered in the databasevia <code>-z</code>.
|}
==DROP EVENT=LOGMSGMAXLEN={| width='100%'|-|width='100'|'''Syntax'''|{{Code|DROP EVENT [NAME]}}|-| '''XML Syntax''' |<code><drop-event name='...'/></code><br/>|-| '''Permission'''|''ADMIN''|-| '''Summary'''|Drops the specified [[Events|event]].|-| '''Errors'''|The command fails if the event doesn't exist.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|CREATE USER LOGMSGMAXLEN [namelength] ([password])}}
|-
| '''XML SyntaxDefault''' |<code><create-user name='...'>([password])</create-user></code><br/>{{Code|-| '''Permission'''|''ADMIN''1000}}
|-
| '''Summary'''
|Creates a user with Specifies the specified {{Code|[name]}} and {{Code|[password]}}. {{Code|[name]}} must be maximum length of a single [[#Valid NamesLogging|valid user namelog message]]. 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 already exists, or if the password is no valid MD5 hash value.
|}
==ALTER USER=LOGTRACE={| width='100%'|-|width='100'|'''Syntax'''|{{Code|ALTER USER [name] ([password])}}|-| '''XML Syntax''' |<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.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|GRANT LOGTRACE [NONE|READ|WRITE|CREATE|ADMIN] (ON [database]) TO [userboolean]}}
|-
| '''XML SyntaxDefault''' |<code><grant name='...' permission='none|read|write|create|admin' (database='...')/></code><br/>{{Code|-| '''Permission'''|''ADMIN''true}}
|-
| '''Summary'''
|Grants the specified If BaseX is running as [[User_Management|permissionWeb Application]] to the specified , trace output (generated via {{Code|[user]fn:trace}}. If a , {{CodeFunction|Profiling|[database]prof:dump}} is specified, and similar functions) if written to the permissions are only granted locally. The [[#Glob SyntaxLogging|Glob Syntaxdatabase logs]] can be used to address more than one database or user.|-| '''Errors'''|The command fails if {{Code|admin}} If this option is specified as user name, if the specified user does not existdisabled, or if the optional database could not trace output will be opened for modification.|-| '''Examples'''|* {{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission redirected to standard error, as it is known from 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*}}standalone version of BaseX.
|}
==PASSWORDHTTP Services=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|PASSWORD ([password])}}|-| '''XML Syntax''' |<code><password>([password])</password></code><br/>|-| '''Permission'''|''NONE''|-| '''Summary'''|Changes the {{Code|[password]}} of the current user. 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 password is no valid MD5 hash value.|}
==RUN=WEBPATH={| width='100%'|-|width='100'|'''Syntax'''|{{Code|RUN [file]}}|-| '''XML Syntax''' |<code><run file='...'/></code>|-| '''Permission'''|''depends on input''|-| '''Summary'''|Evaluates the contents of {{Code|[file]}} as XQuery expression. If the file ends with the suffix {{Code|.bxs}}, the file content will be evaluated as [[#Basics|command script]]. This command can be used to run several commands in a single transaction.|-| '''Errors'''|The command fails if the 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.|-| '''Examples'''|* <code>RUN query.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==
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|EXECUTE WEBPATH [inputpath]}}
|-
| '''XML SyntaxDefault''' |<code><execute>[input[Configuration#Database Directory|{home}/webapp]]</execute></code>|-| '''Permission'''|''depends on input''
|-
| '''Summary'''
|Evaluates Points to the specified {{Code|directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[inputRESTXQ]]}} and configuration files:* The option is ignored if BaseX is deployed as [[Web Application#BasicsServlet_Container|command scriptweb servlet]]. This command can be used to run several commands in a single transaction.|-| '''Errors'''|The command fails if the syntax of the specified input is invalid. * It will cannot be canceled as soon as one of assigned via the executed commands fails.|-| '''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|db1web.xml}} and {{Code|db2}} in a single transactionfile, as it will be evaluated before the configuration files are parsed.
|}
==GET=GZIP={| width='100%'|-|width='100'|'''Syntax'''|{{Code|GET [option]}}|-| '''XML Syntax''' |<code><get option='...'/></code><br/>|-| '''Permission'''|''NONE''|-| '''Summary'''|Returns the current value of the [[Options|Option]] specified via {{Code|[option]}}. Global options can only be requested by users with ADMIN permissions.|-| '''Errors'''|The command fails if the specified option is unknown.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|INFOGZIP [boolean]}}
|-
| '''XML SyntaxDefault''' |<code><info/>false</code><br/>|-| '''Permission'''|''READ''
|-
| '''Summary'''
|Shows global informationJetty provides a [https://www.eclipse.org/jetty/documentation/current/gzip-filter.html Gzip handler] for dynamically uncompressing requests and compressing responses. This feature can be enabled if Jetty is started via the [[Web Application|BaseX HTTP Server]]:* The option can also be enabled on [[Command-Line Options#HTTP Server|command line]] via <code>-g</code>.* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the 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 web server will be applied (support for GET requests, exclusion of binaries, MSIE 6.0, etc.).
|}
==HELP=RESTXQPATH={| width='100%'|-|width='100'|'''Syntax'''|{{Code|HELP ([command])}}|-| '''XML Syntax''' |<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.|}
{| width='100%'
|-
|width='100120'|'''SyntaxSignature'''|{{Code|EXIT RESTXQPATH [path]}}
|-
| '''XML Syntax''' |<code><exit/></code><br/>|-| '''PermissionDefault'''|''NONEempty''
|-
| '''Summary'''
|Exits Points to the console modedirectory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
|}
=Changelog==PARSERESTXQ===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HOST [host]PARSERESTXQ}}
|-
| '''Default'''
|{{Code|localhost3}}
|-
| '''Summary'''
|This host name Timeout after which the RESTXQ directory will be parsed for changes:* If {{Code|0}} is used by specified, the client when connecting to directory will be parsed every time a serverRESTXQ function is called. This option can also * A positive value defines the idle time in seconds after which parsing will be changed when running enforced. The default value is {{Code|3}}: Changes in the client on RESTXQ directory will be detected after 3 seconds without RESTXQ function calls.* Monitoring is completely disabled if a negative value is specified. See [[Startup OptionsRESTXQ#BaseX ClientPreliminaries|command lineRESTXQ Preliminaries]] via <code>-n</code>for more details.
|}
===PORTRESTXQERRORS==={| width='100%'|-| width='90' | '''Signature'''|{{Code|PORT [port]}}|-| '''Default'''|{{Code|1984}}|-| '''Summary'''|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Startup Options#BaseX Client|command line]] via <code>-p</code>.|}
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERVERPORT [port]RESTXQERRORS}}
|-
| '''Default'''
|{{Code|1984true}}
|-
| '''Summary'''
|This is Reports parsing errors in XQuery modules in the port RESTXQ directory back to the database server will be listening toclient. This By default, this option is enabled. On productive systems, it can also be changed when running disabled in order to suppress errors that should not be seen by the server on [[Startup Options#BaseX Server|command line]] via <code>-p</code>client.
|}
===EVENTPORTRESTPATH==={| width='100%'|-| width='90' | '''Signature'''|{{Code|EVENTPORT [port]}}|-| '''Default'''|{{Code|1985}}|-| '''Summary'''|This port is used by the client to listen for [[Events|server events]]. It will only be bound if a client attaches itself to a database event. This option can also be changed when running the server on [[Startup Options#BaseX Server|command line]] via <code>-e</code>.|}
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|USER RESTPATH [namepath]}}
|-
| '''Default'''
|-
| '''Summary'''
|Represents a user namePoints to the directory which contains XQuery files and command scripts, which is used for accessing the server or an HTTP service:* The default value will can be overwritten if a client specifies its own credentials.* If the default value is empty, login will only be possible if evaluated via the client specifies credentials.* The option can also be changed on [[Startup OptionsREST#BaseX ClientGET Requests|command lineREST run operation]] via <code>-U</code>. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
|}
===PASSWORDHTTPLOCAL===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PASSWORD HTTPLOCAL [passwordboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Represents a passwordBy default, which if BaseX is used for accessing run as [[Web Application]], the database server or an HTTP service:* The default value instance will be overwritten if a client specifies its own credentials.* If the default value is emptystarted in addition, login will only be possible if the client specifies credentials.* The option which can also then be changed on addressed by [[Startup Options#BaseX Client|command lineClients]] via the database port (see {{Option|PORT}}).<code>-P<br/code>.* Please note that it If the option is a security risk set to specify your password in plain text{{Code|true}}, no database server will be launched.
|}
===SERVERHOSTSTOPPORT===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERVERHOST STOPPORT [host|ipport]}}
|-
| '''Default'''
|''empty''{{Code|8985}}
|-
| '''Summary'''
|This is the host name or ip address port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:* The listener for stopping the web server will only be started if the specified value is bound togreater than {{Code|0}}. If the * The option is set to an empty string (which 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 default), the HTTP server will be open to all clientson [[Command-Line Options#BaseX Server|command line]] via <code>-s</code>.
|}
=Create Options= =PROXYHOST=General=={| width===MAINMEM='100%' width='100%'|-| width='90' | '''Signature'''|{{Code|PROXYHOST [host]}}|-| '''Default'''|''empty'' |-| '''Summary'''|This is the host name of a proxy server.|}
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PROXYPORT MAINMEM [portboolean]}}
|-
| '''Default'''
|{{Code|80false}}
|-
| '''Summary'''
|This 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 lost if the BaseX instance in which the database was created is shut down.* It is not possible to store binary resources in a main-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 port number of exported file in a proxy serversecond step.* This option will not be available for [[Database Module#db:create|db:create]], because the database would not be accessible anymore after database creation, i. e., outside the query scope.
|}
===NONPROXYHOSTSADDCACHE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|NONPROXYHOSTS ADDCACHE [hostsboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|If this option is activated, data structures of documents will first be cached to disk before being added to the final database. This option is a list of hosts that should helpful when larger documents need to be directly accessedadded, and if the existing heuristics cannot estimate the input size (e.g. when adding directories or sending input streams).
|}
==Parsing=TIMEOUT= ===CREATEFILTER===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|TIMEOUT CREATEFILTER [secondsfilter]}}
|-
| '''Default'''
|{{Code|30*.xml}}
|-
| '''Summary'''
|Specifies File filter in the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout[[Commands#Glob Syntax|Glob Syntax]], it will be aborted. Write operations will not be affected by this timeoutwhich is applied whenever new databases are created, as this would corrupt the integrity of the or resources are added to a database. The timeout is deactivated if the timeout is set to {{Code|0}}. It is ignored for {{Code|ADMIN}} operations.
|}
===KEEPALIVEADDARCHIVES===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|KEEPALIVE ADDARCHIVES [secondsboolean]}}
|-
| '''Default'''
|{{Code|600true}}
|-
| '''Summary'''
|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{Code|0true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc.) are parsed whenever new databases are created or resources are added to a database.
|}
===PARALLELARCHIVENAME===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARALLEL ARCHIVENAME [numberboolean]}}
|-
| '''Default'''
|{{Code|8false}}
|-
| '''Summary'''
|Denotes the maximum allowed If this option is set to {{Code|numbertrue}} , the file name of parallel read [[Transaction Management|transactions]]parsed archives will be included in the document paths.
|}
===LOGSKIPCORRUPT===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|LOG SKIPCORRUPT [boolean]}}
|-
| '''Default'''
|{{Code|truefalse}}
|-
| '''Summary'''
|Turns [[Logging]] of server operations and HTTP requests on/offSkips corrupt (i. This e., not well-formed) files while creating a database or adding new documents. If this option can also is activated, document updates are slowed down, as all files will be changed when running the server on [[Startup Options#BaseX Server|command line]] via <code>-z</code>parsed twice. Next, main memory consumption will be higher as parsed files will be cached in main memory.
|}
===LOGMSGMAXLENADDRAW===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|LOGMSGMAXLEN ADDRAW [lengthboolean]}}
|-
| '''Default'''
|{{Code|1000false}}
|-
| '''Summary'''
|Specifies If this option is enabled, all resources that are filtered out by the maximum length of {{Option|CREATEFILTER}} option while being added to a single database will be stored as [[LoggingBinary Data|log messageraw files]]instead (i.e., in their binary representation).
|}
==HTTP Options=PARSER=== 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.
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|WEBPATH PARSER [pathtype]}}
|-
| '''Default'''
|<code>[[Configuration#Database Directory{{Code|{homeXML}/BaseXWeb]]</code> or <code>[[Configuration#Database Directory|{home}/webapp]]</code>
|-
| '''Summary'''
|Points to the directory in which all the Defines a [[Web ApplicationParsers|parser]] contents for importing new files to the database. Available parsers are stored{{Code|XML}}, {{Code|JSON}}, {{Code|CSV}}, including XQuery{{Code|TEXT}}, Script{{Code|HTML}}, and {{Code|RAW}}. HTML input will be parsed as XML documents if [[RESTXQParsers#HTML_Parser|Tagsoup]] and configuration filesis not found in the classpath.
|}
===RESTXQPATHCSVPARSER===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|RESTXQPATH CSVPARSER [pathoptions]}}
|-
| '''Default'''
|-
| '''Summary'''
|Points to Specifies the directory which contains the [[RESTXQ]] modules of a web application. Relative paths way how CSV data will be resolved against parsed. 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#WEBPATHOptions|WEBPATHCSV Module]] directory.|-| '''Examples'''|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.
|}
===HTTPLOCALJSONPARSER===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTTPLOCAL JSONPARSER [booleanoptions]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|By default, a database server instance Specifies the way how JSON data will be opened along parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with the web server<code>,</code>. If The available options (except for the flag is set to {{Code|true}}, all commands will be executed in an embedded database context.additional <code>encoding<br/code>If BaseX is run as option) are described in the [[Web ApplicationJSON Module#Options|JSON Module]], and if the flag is {{Code.|-| '''Examples'''|false}}<code>format=jsonml, lax=yes</code> interprets the server will be started input as soon as the first HTTP service is calledJSONML and uses lax parsing.
|}
===STOPPORTHTMLPARSER===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|STOPPORT HTMLPARSER [portoptions]}}
|-
| '''Default'''
|{{Code|8985}}''empty''
|-
| '''Summary'''
|This is Specifies the port on which way how HTML data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are described in the [[StartupParsers#BaseX HTTP ServerOptions|HTTP ServerParsers]] can be locally closed:article.|-| '''Examples'''* 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 <code>encoding=Shift-JIS,nons=true</code> parses the input as a [[Web Application]] or started via [[Web Application#Maven|Maven]]Sihft-JIS and suppresses namespaces.* This option can also be changed when running the HTTP server on [[Startup Options#BaseX Server|command line]] via <code>-slexical=true</code>preserves comments.
|}
=Create Options= =TEXTPARSER=General==
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|MAINMEM TEXTPARSER [booleanoptions]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|If this option is turned on, new databases Specifies the way how TEXT data will be exclusively created in main memoryparsed. Most queries will be evaluated faster in main memory modeKeys and values are delimited with <code>=</code>, and multiple options are delimited with <code>, but all data is lost if BaseX is shut down</code>. The value available options are listed in the [[Parsers]] article.|-| '''Examples'''|<code>lines=true</code> creates a single element for each line of this option will be assigned once to a new database, and cannot be changed after thattext.
|}
===ADDCACHE=XML Parsing==
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|ADDCACHE CHOP [boolean]}}
|-
| '''Default'''
|{{Code|falsetrue}}
|-
| '''Summary'''
|If this option is activated, Many XML documents include whitespaces that are have been added via to improve readability. This option controls the [https://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:* With the default value {{Code|true}}, leading and trailing whitespaces from text nodes will be chopped and all empty text nodes will be discarded.* The flag should be turned off if a document contains [[CommandsFull-Text#ADDMixed Content|ADDmixed content]] will first .* The flag can also be cached to disk before being added to turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>.* If the final database. This option <code>xml:space="preserve"</code> attribute is helpful when larger documents are attached to an element, chopping will be importedturned off for all descendant text nodes. In the following example document, and if the existing heuristics cannot estimate whitespaces in the size text nodes of the input (e{{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.g. when adding directories)</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.
|}
==Parsing=STRIPNS===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CREATEFILTER STRIPNS [filterboolean]}}
|-
| '''Default'''
|{{Code|*.xmlfalse}}
|-
| '''Summary'''
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a databaseStrips all namespaces from an XML document and all elements while parsing.
|}
===ADDARCHIVESINTPARSE==={| width='100%'|-| width='90' | '''Signature'''|{{Code|ADDARCHIVES [boolean]}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a database.|}
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SKIPCORRUPT INTPARSE [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Skips corrupt Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the internal parser:* Performance: Documents (i.e., not well-formedin particular small ones) will be parsed faster* Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (�) files while creating a database or adding new * Entities: around 250 HTML entities will be detected and decodedYou will be able to correctly parse most XML documentswith the internal parser. If this option Java’s Xerces parser is activatedstill used as default, document updates are slowed downhowever, as because it supports all files will be parsed twice. Nextfeatures of the XML standard and advanced DTD features, main memory consumption will be higher such as parsed files will be cached in main memoryrecursive entity expansion.
|}
===ADDRAWDTD===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|ADDRAW DTD [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|If Parses referenced DTDs and resolves XML entities. By default, this option is activatedswitched to {{Code|false}}, and if new resources as many DTDs are added to a databaselocated externally, all files that are not filtered by which may completely block the [[#CREATEFILTERprocess of creating new databases. The {{Option|CREATEFILTER]] CATFILE}} option will can be added as ''raw'' files (i.e., in their binary representation)changed to locally resolve DTDs.
|}
===PARSERXINCLUDE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARSER XINCLUDE [typeboolean]}}
|-
| '''Default'''
|{{Code|XMLtrue}}
|-
| '''Summary'''
|Defines a [[ParsersResolves XInclude inclusion tags and merges referenced XML documents. By default, this option is switched to {{Code|parser]] for importing new files to the databasetrue}}. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are This option is only available as parsers. HTML will be parsed as normal XML files if [http://home.ccil.org/~cowan/the standard Java XML/tagsoup/ Tagsoup] Parser is not found in the classpathused (see {{Option|INTPARSE}}).
|}
===PARSEROPTCATFILE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|PARSEROPT CATFILE [optionspath]}}
|-
| '''Default'''
|-
| '''Summary'''
|Defines parserSemicolon-specific options; see separated list of XML catalog files to resolve URIs. See [[ParsersCatalog Resolver]] s for more informationdetails.
|}
==Indexing=HTMLOPT= 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. ===TEXTINDEX===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|HTMLOPT TEXTINDEX [optionsboolean]}}
|-
| '''Default'''
|''empty''{{Code|true}}
|-
| '''Summary'''
|Allows to specify TagSoup options for HTML parsing; see Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes. See [[ParsersIndex#HTML ParserText Index|HTML ParserText Index]] for more informationdetails.
|}
==XML Parsing=ATTRINDEX===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CHOP ATTRINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Chops all leading and trailing whitespaces from text nodes while building Creates an attribute index whenever a new database, and discards empty text nodesis created. By default, this option is set to {{Code|true}}, as it often reduces the database size by An attribute index speeds up to 50%queries with equality comparisons on attribute values. It can also be turned off on See [[Startup OptionsIndex#BaseX StandaloneAttribute Index|command lineAttribute Index]] via <code>-w</code>for more details.
|}
===INTPARSETOKENINDEX===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|INTPARSE TOKENINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Uses the internal XML parser instead of the standard Java XML parserCreates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. The internal parser is faster, See [[Index#Token Index|Token Index]] for more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for parsing DTDsdetails.
|}
===DTDFTINDEX===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DTD FTINDEX [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Parses referenced DTDs and resolves XML entitiesCreates a full-text index whenever a new database is created. By default, this option is switched to {{Code|false}}, as many DTDs are located externally, which may completely block the process of creating new databasesA full-text index speeds up queries with full-text expressions. The See [[Index#CATFILEFull-Text Index|CATFILEFull-Text Index]] option can be changed to locally resolve DTDsfor more details.
|}
===CATFILETEXTINCLUDE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|CATFILE TEXTINCLUDE [pathnames]}}
|-
| '''Default'''
|-
| '''Summary'''
|Specifies a catalog file to locally resolve DTDs; see Defines name patterns for the entry on parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Catalog ResolverIndexes#Selective Indexing|Selective Indexing]]s for more details.
|}
==Indexing=ATTRINCLUDE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|TEXTINDEX ATTRINCLUDE [booleannames]}}
|-
| '''Default'''
|{{Code|true}}''empty''
|-
| '''Summary'''
|Creates a text index whenever a new database is createdDefines name patterns for the attributes to be indexed. A text index speeds up queries with equality comparisons on text By default, all attribute nodes; see will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===ATTRINDEXTOKENINCLUDE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|ATTRINDEX TOKENINCLUDE [booleannames]}}
|-
| '''Default'''
|{{Code|true}}''empty''
|-
| '''Summary'''
|Creates an Defines name patterns for the attributes to be indexed. By default, tokens in all attribute index whenever a new database is creatednodes will be indexed.<br/>Name patterns are separated by commas. An attribute index speeds up queries with equality comparisons on attribute values; see See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===FTINDEXFTINCLUDE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|FTINDEX FTINCLUDE [booleannames]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|Creates a full-Defines name patterns for the parent elements of texts that are indexed. By default, all text index whenever a new database is creatednodes will be indexed.<br/>Name patterns are separated by commas. A full-text index speeds up queries with full-text expressions; see See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
|}
===MAXLEN===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|MAXLEN [int]}}
|-
===MAXCATS===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|MAXCATS [int]}}
|-
===UPDINDEX===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|UPDINDEX [boolean]}}
|-
|-
| '''Summary'''
|If turned on, incremental indexing will be activatedenabled: all update operations will also update the value index structures (texts and attribute values). * The current value of this option will be assigned once to a new database, and cannot databases. It can be changed after thatfor existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or [[Database_Module#db:optimize|db:optimize($db, true())]]. The advantage of incremental indexes is that * After each update, the value index structures indexes will always be up-to-daterefreshed as well. The downside is that Incremental updates will take a little bit longerare currently not available for the full-text index and database statistics. The * Find more details in the article on [[Index#Updates|Index Structures]] includes additional details.
|}
===INDEXSPLITSIZEAUTOOPTIMIZE=== {{Mark|Introduced with Version 7.7:}}
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|INDEXSPLITSIZE AUTOOPTIMIZE [numboolean]}}
|-
| '''Default'''
|{{Code|0false}}
|-
| '''Summary'''
|This option affects the [[Indexes#Index Construction|construction]] of If turned on, auto optimization will be applied to new text databases:* With each update, outdated indexes and attribute indexesdatabase statistics will be recreated. It specifies * As a result, the number of index build operations that are performed before writing partial index data structures will always be up-to disk-date. By default* However, if the updates can take much longer, so this option should only be activated for medium-sized databases.* The value is set of this option will be assigned once to 0, some dynamic split heuristics are applieda new database. It can be reassigned by running {{Command|OPTIMIZE}} or [[Database_Module#db:optimize|db:optimize]].
|}
===FTINDEXSPLITSIZESPLITSIZE=== {{Mark|Introduced with Version 7.7:}}
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|FTINDEXSPLITSIZE SPLITSIZE [num]}}
|-
| '''Default'''
|-
| '''Summary'''
|This option affects the [[Indexes#Index ConstructionPerformance|construction]] of new full-text value indexes. It specifies 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 dynamic split 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 main memory will be required.
|}
==Full-TextIndexing==
===STEMMING===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|STEMMING [boolean]}}
|-
|-
| '''Summary'''
|A new If {{Code|true}}, all tokens will be stemmed during full-text index indexing, using a language-specific stemmer implementation. By default, tokens will stem all tokens and speed up queries on not be stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this indexSee [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===CASESENS===
{| width='100%'
|{{Code|CASESENS [boolean]}}
|-
|-
| '''Summary'''
|A new full-text index will preserve If {{Code|true}}, the case of all tokenswill be preserved during full-text indexing. The same By default, case normalization will be applied to ignored (all query tokens that are checked against tokens will be indexed in this indexlower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===DIACRITICS===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|DIACRITICS [boolean]}}
|-
|-
| '''Summary'''
|A new If set to {{Code|true}}, diacritics will be preserved during full-text index will preserve the diacritics of all tokensindexing. The same By default, diacritics normalization will be applied to all query tokens that are checked against tokens in this indexremoved. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===LANGUAGE===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|LANGUAGE [lang]}}
|-
|-
| '''Summary'''
|A new full-text index The specified language will use influence the given language to normalize all tokensway how texts will be tokenized and stemmed. This option is mainly important if tokens are to It can be stemmed, or if the tokenization name of a language differs from Western languagesor a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
|}
===STOPWORDS===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|STOPWORDS [path]}}
|-
|-
| '''Summary'''
|A new If a text file with stop words is specified, frequently used terms contained in that file will be ignored when a full-text index will drop tokens that are listed in the specified stopword listis created. A stopword list may decrease the size of the full text indexand speed up your queries. A standard stopword list See [[Indexes#Full-Text Index|Full-Text Index]] for English texts is provided in the directory {{Code|etc/stopwords.txt}} in the official releasesmore details.
|}
===QUERYINFO===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|QUERYINFO [boolean]}}
|-
|-
| '''Summary'''
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.
|}
===XQUERY3MIXUPDATES===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|XQUERY3MIXUPDATES}}
|-
| '''Default'''
|{{Code|truefalse}}
|-
| '''Summary'''
|Enables all [[XQuery 3Allows queries to both contain updating and non-updating expressions.0]] features supported All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by BaseXan updating expression. If By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}, the . See [[XQuery parser will only accept expressions of the XQuery 1.0 specificationUpdate#Returning Results|Returning Results]] for more details.
|}
===BINDINGS===
{| width='100%'
|-
| width='90120' | '''Signature'''
|{{Code|BINDINGS [vars]}}
|-
|-
| '''Summary'''
|Contains external variables to be bound to a query. The string must comply with the following rules:* Variable names and values are must be separated by equality signs, and multiple .* Multiple variables are must be delimited by commas.* Commas in values must be duplicated.
* Variables may optionally be introduced with a leading dollar sign.
|-
| '''Examples'''
|* <code>$a=1,$b=2</code> binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b<br/>* <code>a=1,,2</code> binds the value {{Code|1,2}} to the variable $a<br/>* <code>{URI}a=x</code> binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.* 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>
|}
===QUERYPATHINLINELIMIT===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|QUERYPATH [path]INLINELIMIT}}
|-
| '''Default'''
|{{Code|100}}|-|''empty'Summary'''|This option controls inlining of XQuery functions:* The XQuery compiler inlines functions to speed up query evaluation.* Inlining will only take place if a function body is not too large (i.e., if 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 locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (follow the link to get more information on function inlining).|} ===TAILCALLS=== {| width='100%'|-| width='120' | '''Signature'''|{{Code|TAILCALLS}}|-| '''Default'''|{{Code|256}}|-| '''Summary'''|Specifies how many stack frames of [https://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1}}.|} ===WITHDB=== {{Mark|Introduced with Version 9.3.}} {| width='100%'|-| width='120' | '''Signature'''|{{Code|WITHDB}}|-| '''Default'''|{{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===
{| 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> (�)., 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 the BaseX-specific fuzzy match option. See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information on fuzzy querying.
|}
===RUNSRUNQUERY===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|RUNS RUNQUERY [numboolean]}}
|-
| '''Default'''
|{{Code|1true}}
|-
| '''Summary'''
|Specify number of runs Specifies if a query is will be executed by the or parsed only. This option can also be changed on [[CommandsCommand-Line Options#XQUERYBaseX Standalone|XQUERYcommand line]] command. The result is only serialized once, and the measured times are averages of all runsvia <code>-R</code>.
|}
=Serialization Options==RUNS===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERIALIZE RUNS [booleannum]}}
|-
| '''Default'''
|{{Code|true1}}
|-
| '''Summary'''
|Results of XQuery expressions Specifies how often a query will be evaluated. The result is serialized if this option is turned ononly once, and the measured times are averages of all runs. For debugging purposes and performance measurements, this This option can be set to {{Code|false}}. It can also be turned off changed on [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-zr</code>.
|}
===SERIALIZERENFORCEINDEX===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|SERIALIZER ENFORCEINDEX [paramsboolean]}}
|-
| '''Default'''
|''empty''{{Code|false}}
|-
| '''Summary'''
|Contains parameters for [[Serialization|serializing]] query results:* Keys and values are separated by equality signs.* Multiple parameters are delimited by commas.* The option can also be used on Enforces index rewritings in path expressions (see [[Startup OptionsIndexes#BaseX StandaloneEnforce Rewritings|command lineEnforce Rewritings]] with the flag <code>-s</code>.|-| '''Example'''|<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declarationfor details).
|}
===EXPORTERCOPYNODE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|EXPORTER COPYNODE [paramsboolean]}}
|-
| '''Default'''
|''empty''{{Code|true}}
|-
| '''Summary'''
|Contains parameters for exporting When creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], all resources enclosed nodes will be copied, and all resulting nodes will get new node identities. This step can be very expensive, and it can be disabled with this option. The option should be used carefully, as it changes the standard behavior of a database; see XQuery. It should preferrably be used in [[SerializationXQuery Extensions#Database Pragmas|Pragmas]] for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas.
|}
=Serialization Options= =XMLPLAN==SERIALIZE===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|XMLPLAN SERIALIZE [boolean]}}
|-
| '''Default'''
|{{Code|falsetrue}}
|-
| '''Summary'''
|Prints the execution plan Results of an XQuery expression in its XML representationexpressions will be serialized if this option is turned on. This For debugging purposes and performance measurements, this option can be set to {{Code|false}}. It can also be activated turned off on [[Startup Command-Line Options#BaseX Standalone|command line]] via <code>-xz</code>.
|}
===COMPPLANSERIALIZER===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|COMPPLAN SERIALIZER [booleanparams]}}
|-
| '''Default'''
|{{Code|true}}''empty''
|-
| '''Summary'''
|Creates Parameters for [[Serialization|serializing]] query results. The string must comply with the query plan before or after 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.The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the compilation stepflag <code>-s</code>. Query plans might change due |-| '''Examples'''|* <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 optimizations{{Code|US-ASCII}} and prints the XML declaration.* <code>item-separator=,,</code> : separates serialized items by a single comma.
|}
===DOTPLANEXPORTER===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTPLAN EXPORTER [booleanparams]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|Visualizes Contains parameters for exporting resources of a database and writing files after updates via the execution plan of an XQuery expression with [http://www{{Option|WRITEBACK}} option.graphvizKeys and values are separated by equality signs, multiple parameters are delimited by commas.org dottySee [[Serialization]] and saves its dot file in for more details.|-| '''Examples'''|* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the query directoryXML declaration.
|}
===DOTCOMPACTXMLPLAN===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTCOMPACT XMLPLAN [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Chooses a compact dot Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.
|}
===DOTDISPLAYCOMPPLAN===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTDISPLAY COMPPLAN [boolean]}}
|-
| '''Default'''
|-
| '''Summary'''
|Visualizes Generates the dot representation query plan, which can be activated via {{Option|XMLPLAN}}, before or after the query executioncompilation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>.
|}
===DOTTYFULLPLAN===
{| width='100%'
|-
| width='90120' | '''Signature'''|{{Code|DOTTY FULLPLAN [pathboolean]}}
|-
| '''Default'''
|{{Code|dottyfalse}}
|-
| '''Summary'''
|Location Attaches the file path, line and column of the {{Code|dotty}} executableexpressions in the original query string to the query plan. Values (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.3
* 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.
* 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>}}
