Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
| width='90' | '''SignatureXML Syntax''' |{{Code|CLOSE }}<code><close/></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|SHOW BACKUPS}}<code><show-backups/></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|XQUERY <code><xquery>[query]}}</xquery></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|REPO LIST}}<code><repo-list/></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|ADD (TO <code><add>[input]</add></code><br/><code><add path='[path]) '>[input]}}</add></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|STORE (TO <code><store>[input]</store></code><br/><code><store path='[path]) '>[input]}}</store></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|OPTIMIZE (ALL)}}<code><optimize/></code><br/><code><optimize-all/></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|FLUSH}}<code><flush/></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|SHOW DATABASES}}<code><show-databases/></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|CREATE EVENT <code><create-event name='[NAMEname]}}'/></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|SHOW EVENTS}}<code><show-events/></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|DROP EVENT <code><drop-event name='[NAMEname]}}'/></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|PASSWORD (<code><password/></code><br/><code><password>[password])}}</password></code><br/>
| width='90' | '''SignatureXML Syntax''' |{{Code|INFO}}<code><info/></code><br/>
no edit summary
This article is linked from part of the [[Getting Started]] Section.
It lists all database commands supported by BaseX.
Commands can e.g. be run from the [[Startup_Options#BaseX_Standalone|Command Line]],
=Conventions=
Multiple commands can be separated by semicolons.
==XML Syntax==
{{Mark|Introduced with Version 7.3:}}
In addition to the string syntax, database commands can also be formulated in XML. All commands are surrounded by a {{Code|<commands/>}} root element. The following XML script creates a database, adds two documents and performs a query:
<pre class="brush:xquery">
<commands>
<create-db name='test'/>
<add>input.xml</add>
<add path='embedded.xml'><root>Embedded Document</root></add>
<xquery>count(//text())</xquery>
</commands>
</pre>
==Glob Syntax==
==Aliases==
In all commands, the {{Code|DB}} keyword can be replaced by the shortcut {{Code|DATABASE}}.
=Database Operations=
==CREATE DB==
{|width='100%'
|-
| width='90' | 'Syntax''Syntax'|width='100%'|{{Code|CREATE DB [name] ([input])}}
|-
| '''XML Syntax''' |<code><create-db name='[name]'/></code><br/><code><create-db name='[name]'>[input]</create-db></code><br/>
|-
| '''Permission'''
==OPEN==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|OPEN [path]}}|-| '''XML Syntax''' |<code><open path='[path]'/></code><br/>
|-
| '''Permission'''
==CHECK==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|CHECK [input]}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|CHECK <code><check input='[input]}}'/></code><br/>
|-
| '''Permission'''
==CLOSE==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|CLOSE }}
|-
|-
| '''Permission'''
==EXPORT==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|EXPORT [path]}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|EXPORT <code><export path='[path]}}'/></code><br/>
|-
| '''Permission'''
{{Mark|Updated in Version 7.2:}} {{Code|PATH}} removed as argument; path summary is now updated by [[#OPTIMIZE|OPTIMIZE]] command
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|CREATE INDEX [TEXT|ATTRIBUTE|FULLTEXT]}}
|-
| width='90' | 'XML Syntax''Signature'''|{{Code|CREATE INDEX [TEXT|nbsp; ATTRIBUTE|nbsp;FULLTEXT]}}|<code><create-index type='text|attribute|fulltext'/></code><br/>
|-
| '''Permission'''
{{Mark|Updated in Version 7.2:}} {{Code|PATH}} removed as argument; path summary is now always available
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|DROP INDEX [TEXT|ATTRIBUTE|FULLTEXT]}}|-| '''XML Syntax''' |<code><drop-index type='text|attribute|fulltext'/></code><br/>
|-
| '''Permission'''
==ALTER DB==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|ALTER DB [name] [newname]}}|-| '''XML Syntax''' |<code><alter-db name='[name]' newname='[newname]'/></code><br/>
|-
| '''Permission'''
==DROP DB==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|DROP DB [name]}}|-| '''XML Syntax''' |<code><drop-db name='[name]'/></code><br/>
|-
| '''Permission'''
==CREATE BACKUP==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|CREATE BACKUP [name]}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|CREATE BACKUP <code><create-backup name='[name]}}'/></code><br/>
|-
| '''Permission'''
==RESTORE==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|RESTORE [name]}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|RESTORE <code><restore name='[name]}}'/></code><br/>
|-
| '''Permission'''
==DROP BACKUP==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|DROP BACKUP [name]}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|DROP BACKUP <code><drop-backup name='[name]}}'/></code><br/>
|-
| '''Permission'''
==SHOW BACKUPS==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|SHOW BACKUPS}}
|-
|-
| '''Permission'''
==COPY==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|COPY [name] [newname]}}|-| '''XML Syntax''' |<code><copy name='[name]' newname='[newname]'/></code><br/>
|-
| '''Permission'''
==INFO DB==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|INFO DB}}|-| '''XML Syntax''' |<code><info-db/></code><br/>
|-
| '''Permission'''
==INFO INDEX==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|INFO INDEX ([TEXT|ATTRIBUTE|FULLTEXT|PATH])}}|-| '''XML Syntax''' |<code><info-index type='tag|attname|path|text|attribute|fulltext'/></code><br/>
|-
| '''Permission'''
==INFO STORAGE==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|INFO STORAGE [start end] | [query]}}
|-
| width='90' | '''SignatureXML Syntax''' | {{Code|INFO STORAGE <code><info-storage/></code><br/><code><info-storage start='[start ]' end='[end] | '/></code><br/><code><info-storage>[query]}}</info-storage></code><br/>
|-
| '''Permission'''
==LIST==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|LIST ([path])}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|LIST (<code><list/></code><br/><code><list path='[path])}}'/></code><br/>
|-
| '''Permission'''
==XQUERY==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|XQUERY [query]}}
|-
|-
| '''Permission'''
==RETRIEVE==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|RETRIEVE [path]}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|RETRIEVE <code><retrieve path='[path]}}'/></code><br/>
|-
| '''Permission'''
==RUN==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|RUN [file]}}|-| '''XML Syntax''' |<code><run file='[file]'/></code><br/>
|-
| '''Permission'''
==FIND==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|FIND [keywords]}}|-| '''XML Syntax''' |<code><find>[keywords]</find></code><br/>
|-
| '''Permission'''
==CS==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|CS [query]}}|-| '''XML Syntax''' |<code><cs>[query]</cs></code><br/>
|-
| '''Permission'''
==REPO INSTALL==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|REPO INSTALL [path]}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|REPO INSTALL <code><repo-install path='[path]}}'/></code><br/>
|-
| '''Permission'''
==REPO LIST==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|REPO LIST}}
|-
|-
| '''Permission'''
==REPO DELETE==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|REPO DELETE [name]}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|REPO DELETE <code><repo-delete name='[name]}}'/></code><br/>
|-
| '''Permission'''
==ADD==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|ADD (TO [path]) [input]}}
|-
|-
| '''Permission'''
==DELETE==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|DELETE [path]}}|-| '''XML Syntax''' |<code><delete path='[path]'/></code><br/>
|-
| '''Permission'''
==RENAME==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|RENAME [path] [newpath]}}|-| '''XML Syntax''' |<code><rename path='[path]' newpath='[newpath]'/></code><br/>
|-
| '''Permission'''
==REPLACE==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|REPLACE [path] [input]}}|-| '''XML Syntax''' |<code><replace path='[path]'>[input]</replace></code><br/>
|-
| '''Permission'''
==STORE==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|STORE (TO [path]) [input]}}
|-
|-
| '''Permission'''
==OPTIMIZE==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|OPTIMIZE (ALL)}}
|-
|-
| '''Permission'''
==FLUSH==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|FLUSH}}
|-
|-
| '''Permission'''
==SHOW DATABASES==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|SHOW DATABASES}}
|-
|-
| '''Permission'''
==SHOW SESSIONS==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|SHOW SESSIONS}}|-| '''XML Syntax''' |<code><show-sessions/></code><br/>
|-
| '''Permission'''
==SHOW USERS==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|SHOW USERS (ON [database])}}|-| '''XML Syntax''' |<code><show-users/></code><br/><code><show-users database='[database]'/></code><br/>
|-
| '''Permission'''
==KILL==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|KILL [target]}}|-| '''XML Syntax''' |<code><kill target='[target]'/></code><br/>
|-
| '''Permission'''
==CREATE EVENT==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|CREATE EVENT [NAME]}}
|-
|-
| '''Permission'''
==SHOW EVENTS==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|SHOW EVENTS}}
|-
|-
| '''Permission'''
==DROP EVENT==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|DROP EVENT [NAME]}}
|-
|-
| '''Permission'''
==CREATE USER==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|CREATE USER [name] ([password])}}
|-
| width='90' | 'XML Syntax'''Signature |<code><create-user name='[name]'/></code><br/><code><create-user name='|{{Code|CREATE USER [name] (' password='[password])}}'/></code><br/>
|-
| '''Permission'''
==ALTER USER==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|ALTER USER [name] ([password])}}|-| '''XML Syntax''' |<code><alter-user name='[name]'/></code><br/><code><alter-user name='[name]' password='[password]'/></code><br/>
|-
| '''Permission'''
==DROP USER==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|DROP USER [name] (ON [database])}}:|-| '''XML Syntax''' |<code><drop-user name='[name]'/></code><br/><code><drop-user name='[name]' database='[database]'/></code><br/>
|-
| '''Permission'''
==GRANT==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|GRANT [NONE|READ|WRITE|CREATE|ADMIN] (ON [database]) TO [user]}}|-| '''XML Syntax''' |<code><grant name='[name]' permission='none|read|write|create|admin'/></code><br/><code><grant name='[name]' database='[database]' permission='none|read|write|create|admin'/></code><br/>
|-
| '''Permission'''
==PASSWORD==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|PASSWORD ([password])}}
|-
|-
| '''Permission'''
==GET==
{{Mark|Updated in Version 7.2.1:}} permission changed from {{Code|READ}} to {{Code|NONE}}
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|GET [option]}}
|-
| width='90' | '''SignatureXML Syntax''' |{{Code|GET <code><get option='[option]}}'/></code><br/>
|-
| '''Permission'''
==SET==
{{Mark|Updated in Version 7.2.1:}} permission changed from {{Code|READ}} to {{Code|NONE}}
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|SET [option] ([value])}}
|-
| width='90' | 'XML Syntax'''Signature |<code><set option='[option]'/></code><br/><code><set option='|{{Code|SET [option] ('>[value])}}</set></code><br/>
|-
| '''Permission'''
==INFO==
{|width='100%'|-| '''Syntax'''|width='100%'|{{Code|INFO}}
|-
|-
| '''Permission'''
==HELP==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|HELP ([command])}}|-| '''XML Syntax''' |<code><help/></code><br/><code><help>[command]</help></code><br/>
|-
| '''Permission'''
==EXIT==
{|width='100%'
|-
| width='90' | 'Syntax''Signature'|width='100%'|{{Code|EXIT }}|-| '''XML Syntax''' |<code><exit/></code><br/>
|-
| '''Permission'''
=Changelog=
;Version 7.3
* Added: XML Syntax added
;Version 7.2.1
