Changes

Jump to navigation Jump to search
30,947 bytes removed ,  11:46, 20 May 2013
Undo revision 9231 by CG (talk)
=Global Options=
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 [[Startup_Options#BaseX_Standalone|Command Line]],[[#Command Scripts|Scripts]], 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.==General==
=Basics= =DBPATH=Command Scripts== Database commands in both the string and XML syntax can be placed in a text file and stored on disk. 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 such. ==String Syntax== Multiple commands can be written in a single line and separated by semicolons, or stored as command script. 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== Both database and user names must follow the same naming constraints. Valid names may contain letters, numbers, underscores and dashes. Names must have at least one character; they also should not be longer than 128 characters, although this is not enforced. A regular expression matching valid names is <code>[-_a-zA-Z0-9]{1,128}</code>. ==Aliases== In all commands, the {{Code|DB}} keyword can be replaced by {{Code|DATABASE}}. =Database Operations= ==CREATE DB=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|CREATE DB [name] ([input])}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><create-db name='...'>([input])</create-db></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Creates the database {{Code|[name]}} with an optional {{Code|[input]}} and opens it.<br />The input may either be a reference 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 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 for some other reason.|-| '''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 be parsed with Java's [[Parsers#XML Parsers|default XML parser]].* <code><create-db name='simple'><hello>Universe</hello></create-db></code><br/>creates a database named {{Code|simple}} with an initial document {{Code|<hello>Universe</hello>}}.|} ==OPEN== {| width='100%'|-|width='100'|'''Syntax'''|{{Code|OPEN [name]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><open name='...'/></code>|-| '''Permission'''|''READ''|-| '''Summary'''|Opens 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 reason.|} ==CHECK== {| width='100%'|-|width='100'|'''Syntax'''|{{Code|CHECK [input]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><check input='...'/></code><br/>|-| '''Permission'''|''READ/CREATE''|-| '''Summary'''|This convenience command combines [[#OPEN|OPEN]] and [[#CREATE DB|CREATE DB]]: if a database with the name {{Code|[input]}} 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 created.|} ==CLOSE=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|CLOSE }}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<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.|} ==EXPORT=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|EXPORT [path]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><export path='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Exports all documents in the database to the specified {{Code|[path]}}, using the serializer options specified by the <code>[[Options#EXPORTER|EXPORTER]]</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 are invalid, or if the documents cannot be serialized for some other reason.|} ==CREATE INDEX== {| width='100%'|-|width='100'|'''Syntax'''|{{Code|CREATE INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXT]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code>&lt;create-index type='text&#x7c;attribute&#x7c;fulltext'/&gt;</code><br/>|-| '''Permission'''|''WRITE''|-| '''Summary'''|Creates the specified database [[Indexes|index]].|-| '''Errors'''|The command fails if no database is opened, if the specified index is unknown, or if indexing fails for some other reason.|} ==DROP INDEX== {| width='100%'|-|width='100'|'''Syntax'''|{{Code|DROP INDEX [TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXT]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><drop-index type='text&#x7c;attribute&#x7c;fulltext'/></code><br/>|-| '''Permission'''|''WRITE''|-| '''Summary'''|Drops the specified database [[Indexes|index]].|-| '''Errors'''|The command fails if no database is opened, if the specified index is unknown, or if it could not be deleted for some other reason.|} =Administration= ==ALTER DB=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|ALTER DB [name] [newname]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><alter-db name='...' newname='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Renames the database specified by {{Code|[name]}} to {{Code|[newname]}}. {{Code|[newname]}} must be a [[#Valid Names|valid database name]].|-| '''Errors'''|The command fails if the target database already exists, if the source database does not exist or is currently locked, or if it could not be renamed for some other reason.|-| '''Examples'''|* {{Code|ALTER DB db tempdb}}<br/>renames the database {{Code|db}} into {{Code|tempdb}}.|} ==DROP DB=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|DROP DB [name]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<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.|} ==CREATE BACKUP=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|CREATE BACKUP [name]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><create-backup name='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Creates a zipped backup of the database specified by {{Code|[name]}}. The backup file will be suffixed with the current timestamp and stored in the database directory. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.<br/>Please note that Java 7 is required to handle ''ZIP files larger than 4 GB''.|-| '''Errors'''|The command fails if the specified database does not exist, or if it could not be zipped for some other reason.|-| '''Examples'''|* {{Code|BACKUP db}}<br/>creates a zip archive of the database {{Code|db}} (e.g. {{Code|db-2011-04-01-12-27-28.zip}}) in the [[Configuration#Database_Directory|database directory]].|} ==RESTORE=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|RESTORE [name]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<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== {| width='100%'|-|width='100'|'''Syntax'''|{{Code|INSPECT}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><inspect/></code>|-| '''Permission'''|''READ''|-| '''Summary'''|Performs some integrity checks on the opened database and returns a brief summary.|} ==DROP BACKUP=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|DROP BACKUP [name]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><drop-backup name='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Drops all backups of the database with the specified {{Code|[name]}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database.|-| '''Examples'''|* {{Code|DROP BACKUP abc*}}<br/>deletes the backups of all databases starting with the characters {{Code|abc}}.|} ==SHOW BACKUPS=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|SHOW BACKUPS}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><show-backups/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Shows all database backups.|} ==COPY=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|COPY [name] [newname]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><copy name='...' newname='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''|Creates a copy of the database specified by {{Code|[name]}}. {{Code|[newname]}} must be a [[#Valid Names|valid database name]].|-| '''Errors'''|The command fails if the target database already exists, or if the source database does not exist.|} ==INFO DB=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|INFO DB}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><info-db/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Shows information on the currently opened database.|-| '''Errors'''|The command fails if no database is opened.|} ==INFO INDEX=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|INFO INDEX ([TAG&#x7c;ATTNAME&#x7c;PATH&#x7c;TEXT&#x7c;ATTRIBUTE&#x7c;FULLTEXT])}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><info-index type='tag&#x7c;attname&#x7c;path&#x7c;text&#x7c;attribute&#x7c;fulltext'/></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Shows information on the existing [[Indexes|index]] structures. The output can be optionally limited to the specified index.|-| '''Errors'''|The command fails if no database is opened, or if the specified index is unknown.|} ==INFO STORAGE=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|INFO STORAGE [start end] &#x7c; [query]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><info-storage>([query])</info-storage></code><br/>|-| '''Permission'''|''READ''|-| '''Summary'''|Shows the internal main table of the currently opened database. An integer range or a query may be specified as argument.|-| '''Errors'''|The command fails if no database is opened, or if one of the specified arguments is invalid.|} = Querying = ==LIST== {| width='100%'|-|width='100'|'''Syntax'''|{{Code|LIST ([name] ([path]))}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><list (name='...' (path='...'))/></code><br/>|-| '''Permission'''|''NONE''|-| '''Summary'''|Lists all available databases. If {{Code|[name]}} is specified, the resources of a database are listed. The output can be further restricted to the resources matching the specified {{Code|[path]}}.|-| '''Errors'''|The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason.|} ==XQUERY=={| width='100%'|-|width='100'|'''Syntax'''|{{Code|XQUERY [query]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><xquery>[query]</xquery></code><br/>|-| '''Permission'''|''depends on query''|-| '''Summary'''|Runs the specified {{Code|[query]}} and prints the result.|-| '''Errors'''|The command fails if the specified query is invalid.|-| '''Examples'''|* {{Code|XQUERY 1 to 10}}<br/>returns the sequence {{Code|(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)}}.* {{Code|SET RUNS 10; XQUERY 1 to 10}}<br/>runs the query 10 times, returns the result and prints the average execution time.* {{Code|SET XMLPLAN true; XQUERY 1 to 10}}<br/>returns the result and prints the query plan as XML.|} ==RETRIEVE==
{| width='100%'
|-
|width='10090'|'''SyntaxSignature'''|{{Code|RETRIEVE DBPATH [path]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><retrieve path='...'/></code><br/>
|-
| '''PermissionDefault'''|''READ''<code>[[Configuration#Database Directory|{home}/BaseXData]]</code> or <code>[[Configuration#Database Directory|{home}/data]]</code>
|-
| '''Summary'''
|Retrieves a raw file from Points to the opened database at the specified {{Code|[path]}}directory in which all databases are located.|-| <br/> '''ErrorsNote:'''|The command fails this option can only be changed if no database is currently opened, if the source path is invalid or if the data cannot not be retrieved for some other reason.
|}
==FIND=REPOPATH===
{| width='100%'
|-
|width='10090'|'''SyntaxSignature'''|{{Code|FIND REPOPATH [querypath]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><find>[query[Configuration#Database Directory|{home}/BaseXRepo]]</find></code><br/>|-| '''Permission'''|''READ''
|-
| '''Summary'''
|Builds and runs a query for Points to the specified {{Code|[query[Repository]}} terms. Keywords can be enclosed ], in quotes to look for phrases. The following modifiers can be used to further limit search:<code>=</code> looks for exact text nodes<br/><code>~</code> looks for approximate hits<br/><code>@=</code> looks for exact attribute values<br/><code>@</code> looks for attributes|-| '''Errors'''|The command fails if no database is openedwhich all XQuery modules are located.
|}
==CS=DEBUG===
{| width='100%'
|-
|width='10090'|'''SyntaxSignature'''|{{Code|CS DEBUG [queryboolean]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><cs>[query]</cs></code><br/>
|-
| '''PermissionDefault'''|''depends on query''{{Code|false}}
|-
| '''Summary'''
|Evaluates the specified {{Code|[query]}} Sends internal debug info to STDERR. This option can be turned on to get additional information for development and declares the resulting nodes as new ''context set''debugging purposes. In subsequent queries, the context set will It can also be available triggered on [[Startup Options#BaseX Standalone|command line]] via the context item expression of XQuery ({{Code|.}}).|<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 databased</code>.
|}
==REPO INSTALL=LANG===
{| width='100%'
|-
|width='10090'|'''SyntaxSignature'''|{{Code|REPO INSTALL LANG [pathlanguage]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><repo-install path='...'/></code><br/>{{Code|-| '''Permission'''|''CREATE''English}}
|-
| '''Summary'''
| Installs Specifies the package with path {{Code|[path]}}interface language.|-| Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'ErrorsJapanese', and 'Vietnamese'| 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 is not supported by the current version of BaseX.* A component of the package is already installed as part of another package.
|}
==REPO LIST=LANGKEY===
{| width='100%'
|-
|width='10090'|'''SyntaxSignature'''|{{Code|REPO LISTLANGKEY [boolean]}}
|-
| '''XML&nbsp;SyntaxDefault'''&nbsp;&nbsp;&nbsp;|<code><repo-list/></code><br/>|-{{Code| '''Permission'''|''READ''false}}
|-
| '''Summary'''
| Lists Prefixes all installed packagestexts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed.
|}
==REPO DELETE=GLOBALLOCK={| width='100%'|-|width='100'|'''Syntax'''|{{Code|REPO DELETE [name]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><repo-delete name='...'/></code><br/>|-| '''Permission'''|''CREATE''|-| '''Summary'''| Deletes the package with name {{Code|[name]}}, optionally followed by a version.|-| '''Errors'''| The command fails if the package to be deleted participates in a dependency.|}
=Updates={{Mark|Introduced with Version 7.6:}}
==ADD==
{| width='100%'
|-
|width='10090'|'''SyntaxSignature'''|{{Code|ADD (TO GLOBALLOCK [path]) [inputboolean]}}|-| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;|<code><add (path='...')>[input]</add></code><br/>
|-
| '''PermissionDefault'''|''WRITE''{{Code|false}}
|-
| '''Summary'''
|Adds a file, directory or XML string specified by {{Code|[input]}} to the currently opened Controls if local (database at the specified {{Code|[path]}}.<br/>{{Code|[input]}} may either be a single XML document, a directory, a remote URL ) or a plain XML string. If the path denotes a directory, it needs to be suffixed with a slash global ({{Code|/}}process).|-| '''Errors'''|The command fails if no database is opened, if one of the documents to locking will be added is not well-formed, or if it could not be parsed used 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 managing read and moves it to {{Code|temp/onewrite operations.xml}}.* {{Code|ADD TO target/ xmldir}}<br/>adds all files from the {{Code|xmldir}} directory to the database in the {{Code|target}} pathThe article on [[Transaction Management]] provides more details on concurrency control.
|}
 
==DELETE==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|DELETE [path]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><delete path='...'/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Deletes all documents from the currently opened database that start with the specified {{Code|[path]}}.
|-
| '''Errors'''
|The command fails if no database is opened.
|}
 
==RENAME==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|RENAME [path] [newpath]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><rename path='...' newpath='...'/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''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 is opened, or if the target path is empty.
|-
| '''Examples'''
|
* {{Code|RENAME one.xml two.xml}}<br/>renames the document {{Code|one.xml}} to {{Code|two.xml}}.
* {{Code|RENAME / TOP}}<br/>moves all documents to a {{Code|TOP}} root directory.
|}
 
==REPLACE==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|REPLACE [path] [input]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><replace path='...'>[input]</replace></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Replaces a document in the currently opened database, addressed by {{Code|[path]}}, with the file or XML string specified by {{Code|[input]}}, or adds it as a new document.
|-
| '''Errors'''
|The command fails if no database is opened, if the specified path points to a database directory, or if the input is not found.
|-
| '''Examples'''
|
* {{Code|REPLACE one.xml input.xml}}<br/>replaces the document {{Code|one.xml}} with the contents of the file {{Code|input.xml}}.
* {{Code|REPLACE top.xml &lt;xml/&gt;}}<br/>replaces the document {{Code|top.xml}} with the document {{Code|&lt;xml/&gt;}}.
|}
 
==STORE==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|STORE (TO [path]) [input]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><store (path='...')>[input]</store></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Stores a raw file in the opened database to the specified {{Code|[path]}}. {{Code|[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|/}}).
|-
| '''Errors'''
|The command fails if no database is opened, if the specified resource is not found, if the target path is invalid or if the data cannot not be written for some other reason.
|}
 
==OPTIMIZE==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|OPTIMIZE (ALL)}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><optimize/></code><br/><code><optimize-all/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Optimizes the index structures, meta data and statistics of the currently opened database. If the {{Code|ALL}} flag is specified, the internal database structures are completely rebuilt; this often leads to a reduction of the total database size.
|-
| '''Errors'''
|The command fails if no database is opened, or if the currently opened database is a main-memory instance.
|}
 
==FLUSH==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|FLUSH}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><flush/></code><br/>
|-
| '''Permission'''
|''WRITE''
|-
| '''Summary'''
|Explicitly flushes the buffers of the currently opened database to disk. This command is applied if [[Options#AUTOFLUSH|AUTOFLUSH]] has been set to {{Code|false}}.
|-
| '''Errors'''
|The command fails if no database is opened.
|}
 
=Server Administration=
 
==SHOW SESSIONS==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|SHOW SESSIONS}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><show-sessions/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Shows all sessions that are connected to the current server instance.
|}
 
==SHOW USERS==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|SHOW USERS (ON [database])}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<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.
|}
 
==KILL==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|KILL [target]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><kill target='...'/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Kills sessions of a user or an IP:port combination, specified by {{Code|[target]}}. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one user.
|-
| '''Errors'''
|The command fails if a user tried to kill his/her own session.
|}
 
==CREATE EVENT==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|CREATE EVENT [NAME]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><create-event name='...'/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Creates the specified [[Events|event]].
|-
| '''Errors'''
|The command fails if event already exists.
|}
 
==SHOW EVENTS==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|SHOW EVENTS}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><show-events/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Shows all [[Events|events]] that have been registered in the database.
|}
 
==DROP EVENT==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|DROP EVENT [NAME]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><drop-event name='...'/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Drops the specified [[Events|event]].
|-
| '''Errors'''
|The command fails if the event doesn't exist.
|}
 
=User Management=
 
==CREATE USER==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|CREATE USER [name] ([password])}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><create-user name='...'>([password])</create-user></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Creates a user with the specified {{Code|[name]}} and {{Code|[password]}}. {{Code|[name]}} must be a [[#Valid Names|valid user 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 already exists, or if the password is no valid MD5 hash value.
|}
 
==ALTER USER==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|ALTER USER [name] ([password])}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><alter-user name='...'>([password])</alter-user></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Alters the {{Code|[password]}} of the user specified by {{Code|[name]}}. The password must be a valid MD5 hash value. If no password is specified in the console mode, it is requested via standard input.
|-
| '''Errors'''
|The command fails if the specified user does not exist, or if the password is no valid MD5 hash value.
|}
 
==DROP USER==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|DROP USER [name] (ON [database])}}:
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><drop-user name='...' (database='...')/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Drops the user with the specified {{Code|[name]}}. If a {{Code|[database]}} 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==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|GRANT [NONE&#x7c;READ&#x7c;WRITE&#x7c;CREATE&#x7c;ADMIN] (ON [database]) TO [user]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><grant name='...' permission='none&#x7c;read&#x7c;write&#x7c;create&#x7c;admin' (database='...')/></code><br/>
|-
| '''Permission'''
|''ADMIN''
|-
| '''Summary'''
|Grants the specified [[User_Management|permission]] to the specified {{Code|[user]}}. If a {{Code|[database]}} is specified, the permissions are only granted locally. The [[#Glob Syntax|Glob Syntax]] can be used to address more than one database or user.
|-
| '''Errors'''
|The command fails if {{Code|admin}} is specified as user name, if the specified user does not exist, or if the optional database could not be opened for modification.
|-
| '''Examples'''
|
* {{Code|GRANT READ TO JoeWinson}}<br/>grants {{Code|READ}} permission to the user {{Code|JoeWinson}}.
* {{Code|GRANT WRITE ON Wiki TO editor*}}<br/>grants {{Code|WRITE}} permissions on the {{Code|Wiki}} database to all users starting with the characters {{Code|editor*}}.
|}
 
==PASSWORD==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|PASSWORD ([password])}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<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.
|}
 
=General Commands=
 
==RUN==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|RUN [file]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<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='100'|'''Syntax'''
|{{Code|EXECUTE [input]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><execute>[input]</execute></code>
|-
| '''Permission'''
|''depends on input''
|-
| '''Summary'''
|Evaluates the specified {{Code|[input]}} as [[#Basics|command script]]. 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 be canceled as soon as one of 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|db1}} and {{Code|db2}} in a single transaction.
|}
 
==GET==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|GET [option]}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<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.
|}
 
==SET==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|SET [option] ([value])}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><set option='...'>([value])</set></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Sets the [[Options|Option]] specified by {{Code|[option]}} to a new {{Code|[value]}}. Only local options can be modified. If no value is specified, and if the value is boolean, it will be inverted.
|-
| '''Errors'''
|The command fails if the specified option is unknown or if the specified value is invalid.
|}
 
==INFO==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|INFO}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><info/></code><br/>
|-
| '''Permission'''
|''READ''
|-
| '''Summary'''
|Shows global information.
|}
 
==HELP==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|HELP ([command])}}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><help>([command])</help></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|If {{Code|[command]}} is specified, information on the specific command is printed; otherwise, all commands are listed.
|-
| '''Errors'''
|The command fails if the specified command is unknown.
|}
 
==EXIT==
{| width='100%'
|-
|width='100'|'''Syntax'''
|{{Code|EXIT }}
|-
| '''XML&nbsp;Syntax'''&nbsp;&nbsp;&nbsp;
|<code><exit/></code><br/>
|-
| '''Permission'''
|''NONE''
|-
| '''Summary'''
|Exits the console mode.
|}
 
=Changelog=
 
;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==
Bureaucrats, editor, reviewer, Administrators
12,226

edits

Navigation menu