Changes

=Basics= ==Command Scripts== Multiple commands can be written down in a single line – separated by semicolons – or stored as command script. Database commands in both string and XML syntax can be placed in a text file and stored as file with the BaseX command script suffix {{Code|.bxs}}. If the path to a script file is passed on to BaseX on command-line, or if it is opened in the GUI editor, it will automatically be recognized and evaluated as such. ===String Syntax=== Lines starting with <code>#</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> ===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== Database and user names follow the same naming constraints: Names are restricted to ASCII characters. They must at least have one character, and they may contain letters, numbers and any of the special characters <code>!#$%&'()+-=@[]^_`{}~</code>. The following characters are reserved for other features: * <code>,?*</code>: [[#Glob Syntax|glob syntax]]* <code>;</code>: Separator for multiple database commands on the This article is part of the [[Getting Started]] Section.It lists all database commands supported by BaseX.Commands can e.g. be executed from the [[Command-Line Options#BaseX_Standalone|Command Line]],as part of [[#Command Scripts|Scripts]], via the [[Clients]], [[REST]], the input field in the [[GUI]], and other ways. If 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 the client/server architecture.

Multiple On command line, multiple commands can be written down in a single line – (separated by semicolons – or stored as ). You can also put them into a command script. : Database commands in both string and XML syntax can be placed in a text file and stored as file with the BaseX command script suffix {{Code|.bxs}}. If the path to a script file is passed on to BaseX on command-line, or if it is opened in the GUI editor, it will automatically be recognized and evaluated as such.

Lines starting with <code>#</code> are interpreted as comments and are skipped. The With the following script creates , a databaseis created, adds two documents are added to it , and performs a queryis performed:

XQUERY <hits>{ count(//text())}</hits>CLOSE

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 The XMLsyntax provides more flexibility here.Multiple commands can be enclosed by a {{Code|<commands/>}} root element. Some commands, such as {{Command|ADD}}, allow you to directly embed XML documents. If you want to embed XML in XQuery expressions, entities should be encoded, or the {{Code|CDATA}} syntax should be used:

<!-- run query --> <xquery><![CDATA[ <hits>{ count(//text())}</hits> ]]></xquery> <close/>

|Creates a new database with the specified {{Code|name}} and, optionally, an initial {{Code|input}}, and opens it. An existing database will be overwritten.<br />The input may either can be a reference file or directory path to a single XML document, a directorydocuments, a remote URL, or a string containing XML:

|Shows general information and meta data on the currently opened database.

| Deletes the specified package with name the specified {{Code|name}}, optionally . What is called "name" can also be the id (which is the name followed by a the version) or the directory of the package.

| The command fails if the package to be deleted participates in a dependencyis required by another package.

* A document with the same path may occur than once in a database. If this is unwanted, the {{Command|REPLACE}} command can be used.

|Stores a [[Binary Data|raw file]] specified via {{Code|input}} in the opened database to the specified {{Code|path}}. {{Code|:* The input}} 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|/}}).* An existing resource will be replaced.

=Server AdministrationMonitoring=

|Shows all users that are registered in visible to the databasecurrent user. If a {{Code|database}} is specified, all user only those users will be shown for which a pattern was specified that matches the database name.

|Evaluates the contents of {{Code|file}} as XQuery expression. If the file ends with the suffix {{Code|.bxs}}, the file content contents will be evaluated as [[#Basics|command script]]. This command can be used to run several commands in a single row, with no other transactionintervening the execution.

* <code>RUN query.xq</code><br/>will evaluated evaluate the specified file as XQuery expression* <code>RUN commands.bxs</code><br/>will evaluated evaluate the specified file as command script

|Evaluates the specified {{Code|input}} as [[#Basics|command script]]. This command can be used to run several commands in a single row, with no other transactionintervening the execution.