Difference between revisions of "Commands"
(41 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
This article is part of the [[Getting Started]] Section. | This article is part of the [[Getting Started]] Section. | ||
It lists all database commands supported by BaseX. | It lists all database commands supported by BaseX. | ||
− | Commands can | + | |
− | [[#Command Scripts|Scripts]], the [[Clients]], [[REST]], the input field in the [[GUI]] | + | Commands can 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 itself will show up in the [[GUI#Visualizations|Info View]]. The [[User_Management|Permission]] fields indicate which rights are required by a user to perform a command in the client/server architecture. |
− | and other ways. If the GUI is used, all commands that are triggered by the GUI itself | ||
− | will show up in the [[GUI#Visualizations|Info View]]. | ||
− | The [[User_Management|Permission]] fields indicate which | ||
− | rights are required by a user to perform a command in the client/server architecture. | ||
=Basics= | =Basics= | ||
Line 12: | Line 8: | ||
==Command Scripts== | ==Command Scripts== | ||
− | Database commands in both | + | On command line, multiple commands can be written down in a single line (separated by semicolons). 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 be recognized and evaluated as such. |
===String Syntax=== | ===String Syntax=== | ||
− | + | Lines starting with <code>#</code> are interpreted as comments and are skipped. With the following script, a database is created, two documents are added to it, and a query is performed: | |
<pre class="brush:xml"> | <pre class="brush:xml"> | ||
CREATE DB test | CREATE DB test | ||
− | |||
ADD TO embedded.xml <root>embedded</root> | ADD TO embedded.xml <root>embedded</root> | ||
# run query | # run query | ||
− | XQUERY count(//text()) | + | XQUERY <hits>{ count(//text()) }</hits> |
+ | CLOSE | ||
</pre> | </pre> | ||
===XML Syntax=== | ===XML Syntax=== | ||
− | The string syntax is limited when XML snippets need to be embedded in a command, | + | The string syntax is limited when XML snippets need to be embedded in a command, or when complex queries are to be specified. |
− | or when complex queries are to be specified. | ||
− | + | The XML syntax 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: | |
− | Multiple commands can be enclosed by a {{Code|<commands/>}} root element: | ||
<pre class="brush:xml"> | <pre class="brush:xml"> | ||
<commands> | <commands> | ||
<create-db name='test'/> | <create-db name='test'/> | ||
− | |||
<add path='embedded.xml'><root>embedded</root></add> | <add path='embedded.xml'><root>embedded</root></add> | ||
− | <xquery>count(//text())</xquery> | + | <!-- run query --> |
+ | <xquery><![CDATA[ | ||
+ | <hits>{ count(//text()) }</hits> | ||
+ | ]]></xquery> | ||
+ | <close/> | ||
</commands> | </commands> | ||
</pre> | </pre> | ||
Line 58: | Line 55: | ||
* <code>;</code>: Separator for multiple database commands on the [[Command-Line Options|command line]] | * <code>;</code>: Separator for multiple database commands on the [[Command-Line Options|command line]] | ||
* <code>\/</code>: Directory path separators | * <code>\/</code>: Directory path separators | ||
− | |||
* <code>:*?\"<>|}</code>: invalid filename characters on Windows | * <code>:*?\"<>|}</code>: invalid filename characters on Windows | ||
+ | * Names starting or ending with <code>.</code>: hidden folders (e.g. the [[Logging|.logs directory]]) | ||
==Aliases== | ==Aliases== | ||
Line 68: | Line 65: | ||
==CREATE DB== | ==CREATE DB== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 80: | Line 78: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |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 | + | |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 can be a file or directory path to XML documents, a remote URL, or a string containing XML: |
* {{Code|name}} must be a [[#Valid Names|valid database name]] | * {{Code|name}} must be a [[#Valid Names|valid database name]] | ||
* database creation can be controlled by setting [[Options#Create Options|Create Options]] | * database creation can be controlled by setting [[Options#Create Options|Create Options]] | ||
Line 130: | Line 128: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |This convenience command combines | + | |This convenience command combines {{Command|OPEN}} and {{Command|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''' | | '''Errors''' | ||
Line 157: | Line 155: | ||
==EXPORT== | ==EXPORT== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 169: | Line 168: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Exports all documents in the database to the specified file {{Code|path}}, using the serializer options specified by the | + | |Exports all documents in the database to the specified file {{Code|path}}, using the serializer options specified by the {{Option|EXPORTER}} option. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 176: | Line 175: | ||
==CREATE INDEX== | ==CREATE INDEX== | ||
+ | |||
+ | {{Mark|Updated with Version 8.4:}} Token index added. | ||
{| width='100%' | {| width='100%' | ||
Line 189: | Line 190: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Creates the specified [[Indexes#Value Indexes|Value Index]]. | + | |Creates the specified [[Indexes#Value Indexes|Value Index]]. The current [[Options#Indexing|Index Options]] will be considered when creating the index. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 218: | Line 219: | ||
==ALTER DB== | ==ALTER DB== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 241: | Line 243: | ||
==DROP DB== | ==DROP DB== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 260: | Line 263: | ||
==CREATE BACKUP== | ==CREATE BACKUP== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 283: | Line 287: | ||
==RESTORE== | ==RESTORE== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 319: | Line 324: | ||
==DROP BACKUP== | ==DROP BACKUP== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 339: | Line 345: | ||
==SHOW BACKUPS== | ==SHOW BACKUPS== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 355: | Line 362: | ||
==COPY== | ==COPY== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 374: | Line 382: | ||
==INFO DB== | ==INFO DB== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 386: | Line 395: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Shows information on the currently opened database. | + | |Shows general information and meta data on the currently opened database. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 393: | Line 402: | ||
==INFO INDEX== | ==INFO INDEX== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
|width='130'|'''Syntax''' | |width='130'|'''Syntax''' | ||
− | |{{Code|INFO INDEX ([ | + | |{{Code|INFO INDEX ([ELEMNAME|ATTRNAME|PATH|TEXT|ATTRIBUTE|TOKEN|FULLTEXT])}} |
|- | |- | ||
| '''XML Syntax''' | | '''XML Syntax''' | ||
− | |<code><info-index type=' | + | |<code><info-index type='elemname|attrname|path|text|attribute|token|fulltext'/></code><br/> |
|- | |- | ||
| '''Permission''' | | '''Permission''' | ||
Line 412: | Line 422: | ||
==INFO STORAGE== | ==INFO STORAGE== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
|width='130'|'''Syntax''' | |width='130'|'''Syntax''' | ||
− | |{{Code|INFO STORAGE [start end | + | |{{Code|INFO STORAGE [start end]}} |
|- | |- | ||
| '''XML Syntax''' | | '''XML Syntax''' | ||
− | |<code><info-storage | + | |<code><info-storage (start='...') (end='...')/></code><br/> |
|- | |- | ||
| '''Permission''' | | '''Permission''' | ||
Line 424: | Line 435: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Shows the internal main table of the currently opened database. An integer range | + | |Shows the internal main table of the currently opened database. An integer range may be specified as argument. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 454: | Line 465: | ||
==XQUERY== | ==XQUERY== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 473: | Line 485: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * | + | * <code>XQUERY 1 to 10</code><br/>returns the sequence {{Code|(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)}}. |
− | * | + | * <code>SET RUNS 10; XQUERY 1 to 10</code><br/>returns the results after having run the query 10 times. |
− | * | + | * <code>SET XMLPLAN true; XQUERY 1 to 10</code><br/>returns the result and prints the query plan as XML. |
|} | |} | ||
==RETRIEVE== | ==RETRIEVE== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 498: | Line 511: | ||
==FIND== | ==FIND== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 542: | Line 556: | ||
==REPO INSTALL== | ==REPO INSTALL== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 567: | Line 582: | ||
==REPO LIST== | ==REPO LIST== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 583: | Line 599: | ||
==REPO DELETE== | ==REPO DELETE== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 595: | Line 612: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | | Deletes the package with | + | | Deletes the specified package with the specified {{Code|name}}. What is called "name" can also be the id (which is the name followed by the version) or the directory of the package. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | | The command fails if the package to be deleted | + | | The command fails if the package to be deleted is required by another package. |
|} | |} | ||
Line 604: | Line 621: | ||
==ADD== | ==ADD== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 618: | Line 636: | ||
|Adds a file, directory or XML string specified by {{Code|input}} to the currently opened database at the specified {{Code|path}}: | |Adds a file, directory or XML string specified by {{Code|input}} to the currently opened database at the specified {{Code|path}}: | ||
* {{Code|input}} may either be a single XML document, a directory, a remote URL or a plain XML string. | * {{Code|input}} may either be a single XML document, a directory, a remote URL or a plain XML string. | ||
− | * A document with the same path may occur than once in a database. If this is unwanted, | + | * A document with the same path may occur than once in a database. If this is unwanted, the {{Command|REPLACE}} command can be used. |
− | * If a file is too large to be added in one go, its data structures will be cached to disk first. Caching can be enforced by turning the | + | * If a file is too large to be added in one go, its data structures will be cached to disk first. Caching can be enforced by turning the {{Option|ADDCACHE}} option on. |
− | If files are to be added to an empty database, it is usually faster to use the | + | If files are to be added to an empty database, it is usually faster to use the {{Command|CREATE DB}} command and specify the initial input as argument. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 633: | Line 651: | ||
==DELETE== | ==DELETE== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 652: | Line 671: | ||
==RENAME== | ==RENAME== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 676: | Line 696: | ||
==REPLACE== | ==REPLACE== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 688: | Line 709: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Replaces | + | |Replaces resources in the currently opened database, addressed by {{Code|path}}, with the file, directory or XML string specified by {{Code|input}}, or adds new documents if no resource exists at the specified path. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |The command fails if no database is opened | + | |The command fails if no database is opened or if the specified path is invalid. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 700: | Line 721: | ||
==STORE== | ==STORE== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 712: | Line 734: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Stores a [[Binary Data|raw file]] in the opened database to the specified {{Code|path}} | + | |Stores a [[Binary Data|raw file]] specified via {{Code|input}} in the opened database to the specified {{Code|path}}: |
+ | * 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. | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 719: | Line 744: | ||
==OPTIMIZE== | ==OPTIMIZE== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 731: | Line 757: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Optimizes the index structures, meta data and statistics of the currently opened database | + | |Optimizes the index structures, meta data and statistics of the currently opened database: |
+ | * If {{Code|ALL}} is specified, all database structures are completely reconstructed. The database size will be reduced, and all orphaned data will be deleted. | ||
+ | * Without {{Code|ALL}}, only the outdated index structures and database statistics will be updated. If the database is completely up-to-date, nothing will be done. | ||
+ | * Database options will be adopted from the original database. Only {{Option|AUTOOPTIMIZE}} and (if {{Code|ALL}} is specified) {{Option|UPDINDEX}} will be adopted from the current options. | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 738: | Line 767: | ||
==FLUSH== | ==FLUSH== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 750: | Line 780: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Explicitly flushes the buffers of the currently opened database to disk. This command is applied if | + | |Explicitly flushes the buffers of the currently opened database to disk. This command is applied if {{Option|AUTOFLUSH}} has been set to {{Code|false}}. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 756: | Line 786: | ||
|} | |} | ||
− | = | + | =Monitoring= |
==SHOW SESSIONS== | ==SHOW SESSIONS== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 775: | Line 806: | ||
==SHOW USERS== | ==SHOW USERS== | ||
+ | |||
+ | {{Mark|Updated with Version 8.6}}: If called by non-admins, will only return the current user | ||
{| width='100%' | {| width='100%' | ||
Line 788: | Line 821: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Shows all users that are | + | |Shows all users that are visible to the current user. If a {{Code|database}} is specified, only those users will be shown for which a pattern was specified that matches the database name. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 795: | Line 828: | ||
==KILL== | ==KILL== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 811: | Line 845: | ||
| '''Errors''' | | '''Errors''' | ||
|The command fails if a user tried to kill his/her own session. | |The command fails if a user tried to kill his/her own session. | ||
+ | |} | ||
+ | |||
+ | ==JOBS LIST== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | |width='130'|'''Syntax''' | ||
+ | |{{Code|JOBS LIST}} | ||
+ | |- | ||
+ | | '''XML Syntax''' | ||
+ | |<code><jobs-list/></code><br/> | ||
+ | |- | ||
+ | | '''Permission''' | ||
+ | |''ADMIN'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns information on all jobs that are currently queued or executed. | ||
+ | |} | ||
+ | |||
+ | ==JOBS RESULT== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | |width='130'|'''Syntax''' | ||
+ | |{{Code|JOBS RESULT [id]}} | ||
+ | |- | ||
+ | | '''XML Syntax''' | ||
+ | |<code><jobs-result id='...'/></code><br/> | ||
+ | |- | ||
+ | | '''Permission''' | ||
+ | |''ADMIN'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns the cached result of a query with the specified job id: | ||
+ | * Results can only be retrieved once. After retrieval, the cached result will be dropped. | ||
+ | * If the original query has raised an error, the cached error will be raised instead. | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |The command fails if the addressed job is still running or if the result has already been retrieved. | ||
+ | |} | ||
+ | |||
+ | ==JOBS STOP== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | |width='130'|'''Syntax''' | ||
+ | |{{Code|JOBS STOP [id]}} | ||
+ | |- | ||
+ | | '''XML Syntax''' | ||
+ | |<code><jobs-stop id='...'/></code><br/> | ||
+ | |- | ||
+ | | '''Permission''' | ||
+ | |''ADMIN'' | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Cancels the execution of a job with the specified id, or drops the cached result of a query. Unknown ids are ignored. All jobs are gracefully stopped; it is up to the process to decide when it is safe to shut down. | ||
|} | |} | ||
Line 940: | Line 1,030: | ||
==RUN== | ==RUN== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 952: | Line 1,043: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Evaluates the contents of {{Code|file}} as XQuery expression. If the file ends with the suffix {{Code|.bxs}}, the file | + | |Evaluates the contents of {{Code|file}} as XQuery expression. If the file ends with the suffix {{Code|.bxs}}, the file contents will be evaluated as [[#Basics|command script]]. This command can be used to run several commands in a row, with no other transaction intervening the execution. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 959: | Line 1,050: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * <code>RUN query.xq</code><br/>will | + | * <code>RUN query.xq</code><br/>will evaluate the specified file as XQuery expression |
− | * <code>RUN commands.bxs</code><br/>will | + | * <code>RUN commands.bxs</code><br/>will evaluate the specified file as command script |
|} | |} | ||
Line 977: | Line 1,068: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Evaluates the specified {{Code|input}} as [[#Basics|command script]]. This command can be used to run several commands in a | + | |Evaluates the specified {{Code|input}} as [[#Basics|command script]]. This command can be used to run several commands in a row, with no other transaction intervening the execution. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 989: | Line 1,080: | ||
==GET== | ==GET== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 1,008: | Line 1,100: | ||
==SET== | ==SET== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 1,027: | Line 1,120: | ||
==INFO== | ==INFO== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 1,043: | Line 1,137: | ||
==HELP== | ==HELP== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 1,091: | Line 1,186: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Exits the console mode (alias of | + | |Exits the console mode (alias of {{Command|EXIT}}). |
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 8.6 | ||
+ | * Updated: {{Command|SHOW USERS}}: If called by non-admins, will only return the current user | ||
+ | |||
+ | ;Version 8.5 | ||
+ | * Added: {{Command|JOBS LIST}}, {{Command|JOBS RESULT}}, {{Command|JOBS STOP}} | ||
+ | * Updated: [[#Valid Names|Valid Names]]: allow dots (except as first and last character) | ||
+ | |||
+ | ;Version 8.4 | ||
+ | * Updated: {{Command|CREATE INDEX}}, {{Command|DROP INDEX}}, {{Command|INFO INDEX}}: token index added | ||
+ | * Updated: {{Command|INFO STORAGE}}: Query argument removed, start/end added to XML syntax. | ||
+ | * Updated: {{Command|INFO INDEX}}: Token index added; index {{Code|TAG}} renamed to {{Code|ELEMNAME}}; index {{Code|ATTNAME}} renamed to {{Code|ATTRNAME}} | ||
+ | * Updated: {{Command|OPTIMIZE}}: adopt original index options | ||
;Version 8.2 | ;Version 8.2 | ||
− | |||
* Removed: {{Code|CREATE EVENT}}, {{Code|DROP EVENT}} and {{Code|SHOW EVENTS}} command | * Removed: {{Code|CREATE EVENT}}, {{Code|DROP EVENT}} and {{Code|SHOW EVENTS}} command | ||
;Version 8.0 | ;Version 8.0 | ||
− | |||
* Updated: commands for [[#User Management|User Management]] | * Updated: commands for [[#User Management|User Management]] | ||
− | * Updated: | + | * Updated: {{Command|OPEN}}: path argument added |
* Removed: {{Code|CS}} command | * Removed: {{Code|CS}} command | ||
− | * Added: | + | * Added: {{Command|QUIT}} |
;Version 7.9 | ;Version 7.9 | ||
− | + | * Added: {{Command|TEST}} runs XQUnit tests. | |
− | * Added: | ||
;Version 7.7 | ;Version 7.7 | ||
− | |||
* Updated: syntax of [[#Valid Names|valid names]]. | * Updated: syntax of [[#Valid Names|valid names]]. | ||
;Version 7.5 | ;Version 7.5 | ||
− | + | * Added: {{Command|EXECUTE}} executes a command script. | |
− | * Added: | + | * Added: {{Command|INSPECT}} performs integrity checks. |
− | * Added: | ||
* Added: automatic detection of [[#Basics|Command Scripts]]. | * Added: automatic detection of [[#Basics|Command Scripts]]. | ||
− | * Removed: {{Code|SHOW DATABASES}}; information is also returned by | + | * Removed: {{Code|SHOW DATABASES}}; information is also returned by {{Command|SHOW SESSIONS}}. |
− | * Removed: | + | * Removed: {{Command|OPEN}}: path argument. |
;Version 7.3 | ;Version 7.3 | ||
− | |||
* Added: [[#XML Syntax|XML Syntax]] added. | * Added: [[#XML Syntax|XML Syntax]] added. | ||
− | * Updated: | + | * Updated: {{Command|CHECK}} can now be used to create empty databases. |
− | * Updated: Names and paths in | + | * Updated: Names and paths in {{Command|OPEN}} and {{Command|LIST}} are now specified as separate arguments. |
;Version 7.2.1 | ;Version 7.2.1 | ||
− | + | * Updated: permissions for {{Command|GET}} and {{Command|SET}} changed from {{Code|READ}} to {{Code|NONE}}. | |
− | * Updated: permissions for | ||
;Version 7.2 | ;Version 7.2 | ||
− | + | * Updated: {{Command|CREATE INDEX}}, {{Command|DROP INDEX}} ({{Code|PATH}} argument removed. Path summary is always available now and updated with {{Command|OPTIMIZE}}). | |
− | * Updated: | + | * Updated: permissions for {{Command|REPO DELETE}}, {{Command|REPO INSTALL}} and {{Command|REPO LIST}}. |
− | * Updated: permissions for | ||
;Version 7.1 | ;Version 7.1 | ||
− | + | * Updated: {{Command|KILL}} (killing sessions by specifying IP:port) | |
− | * Updated: | ||
;Version 7.0 | ;Version 7.0 | ||
− | + | * Added: {{Command|FLUSH}}, {{Command|RETRIEVE}}, {{Command|STORE}}. | |
− | * Added: | + | * Updated: {{Command|ADD}}: simplified arguments. |
− | * Updated: | ||
− | |||
− | |||
− |
Revision as of 17:45, 22 August 2017
This article is part of the Getting Started Section. It lists all database commands supported by BaseX.
Commands can be executed from the Command Line, as part of 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 itself will show up in the Info View. The Permission fields indicate which rights are required by a user to perform a command in the client/server architecture.
Contents
Basics
Command Scripts
On command line, multiple commands can be written down in a single line (separated by semicolons). 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 .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 be recognized and evaluated as such.
String Syntax
Lines starting with #
are interpreted as comments and are skipped. With the following script, a database is created, two documents are added to it, and a query is performed:
CREATE DB test ADD TO embedded.xml <root>embedded</root> # run query XQUERY <hits>{ count(//text()) }</hits> CLOSE
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.
The XML syntax provides more flexibility here. Multiple commands can be enclosed by a <commands/>
root element. Some commands, such as ADD
, allow you to directly embed XML documents. If you want to embed XML in XQuery expressions, entities should be encoded, or the CDATA
syntax should be used:
<commands> <create-db name='test'/> <add path='embedded.xml'><root>embedded</root></add> <!-- run query --> <xquery><![CDATA[ <hits>{ count(//text()) }</hits> ]]></xquery> <close/> </commands>
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:
AB?
addresses all names with the charactersAB
and one more character.*AB
addresses all names ending with the charactersAB
.X*,Y*,Z*
addresses all names starting with the charactersX
,Y
, orZ
.
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 !#$%&'()+-=@[]^_`{}~
. The following characters are reserved for other features:
,?*
: glob syntax;
: Separator for multiple database commands on the command line\/
: Directory path separators:*?\"<>|}
: invalid filename characters on Windows- Names starting or ending with
.
: hidden folders (e.g. the .logs directory)
Aliases
In all commands, the DB
keyword can be replaced by DATABASE
.
Database Operations
CREATE DB
Syntax | CREATE DB [name] ([input])
|
XML Syntax | <create-db name='...'>([input])</create-db> |
Permission | CREATE |
Summary | Creates a new database with the specified name and, optionally, an initial input , and opens it. An existing database will be overwritten.The input can be a file or directory path to XML documents, a remote URL, or a string containing XML:
|
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 |
|
OPEN
Syntax | OPEN [name] ([path])
|
XML Syntax | <open name='...' (path='...')/>
|
Permission | READ |
Summary | Opens the database specified by name . The documents to be opened can be specified by the [path] argument.
|
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
Syntax | CHECK [input]
|
XML Syntax | <check input='...'/> |
Permission | READ/CREATE |
Summary | This convenience command combines OPEN and CREATE DB : if a database with the name 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
Syntax | CLOSE
|
XML Syntax | <close/> |
Permission | READ |
Summary | Closes the currently opened database. |
Errors | The command fails if the database files could not be closed for some reason. |
EXPORT
Syntax | EXPORT [path]
|
XML Syntax | <export path='...'/> |
Permission | CREATE |
Summary | Exports all documents in the database to the specified file path , using the serializer options specified by the EXPORTER 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
Template:Mark Token index added.
Syntax | CREATE INDEX [TEXT|ATTRIBUTE|TOKEN|FULLTEXT]
|
XML Syntax | <create-index type='text|attribute|token|fulltext'/> |
Permission | WRITE |
Summary | Creates the specified Value Index. The current Index Options will be considered when creating the 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
Syntax | DROP INDEX [TEXT|ATTRIBUTE|TOKEN|FULLTEXT]
|
XML Syntax | <drop-index type='text|attribute|token|fulltext'/> |
Permission | WRITE |
Summary | Drops the specified Value 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
Syntax | ALTER DB [name] [newname]
|
XML Syntax | <alter-db name='...' newname='...'/> |
Permission | CREATE |
Summary | Renames the database specified by name to newname . newname must be a 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 |
|
DROP DB
Syntax | DROP DB [name]
|
XML Syntax | <drop-db name='...'/> |
Permission | CREATE |
Summary | Drops the database with the specified name . The 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
Syntax | CREATE BACKUP [name]
|
XML Syntax | <create-backup name='...'/> |
Permission | CREATE |
Summary | Creates a zipped backup of the database specified by name . The backup file will be suffixed with the current timestamp and stored in the database directory. The Glob Syntax can be used to address more than one database.
|
Errors | The command fails if the specified database does not exist, or if it could not be zipped for some other reason. |
Examples |
|
RESTORE
Syntax | RESTORE [name]
|
XML Syntax | <restore name='...'/> |
Permission | CREATE |
Summary | Restores a database with the specified 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
Syntax | INSPECT
|
XML Syntax | <inspect/>
|
Permission | READ |
Summary | Performs some integrity checks on the opened database and returns a brief summary. |
DROP BACKUP
Syntax | DROP BACKUP [name]
|
XML Syntax | <drop-backup name='...'/> |
Permission | CREATE |
Summary | Drops all backups of the database with the specified name . The Glob Syntax can be used to address more than one database.
|
Examples |
|
SHOW BACKUPS
Syntax | SHOW BACKUPS
|
XML Syntax | <show-backups/> |
Permission | CREATE |
Summary | Shows all database backups. |
COPY
Syntax | COPY [name] [newname]
|
XML Syntax | <copy name='...' newname='...'/> |
Permission | CREATE |
Summary | Creates a copy of the database specified by name . newname must be a valid database name.
|
Errors | The command fails if the target database already exists, or if the source database does not exist. |
INFO DB
Syntax | INFO DB
|
XML Syntax | <info-db/> |
Permission | READ |
Summary | Shows general information and meta data on the currently opened database. |
Errors | The command fails if no database is opened. |
INFO INDEX
Syntax | INFO INDEX ([ELEMNAME|ATTRNAME|PATH|TEXT|ATTRIBUTE|TOKEN|FULLTEXT])
|
XML Syntax | <info-index type='elemname|attrname|path|text|attribute|token|fulltext'/> |
Permission | READ |
Summary | Shows information on the existing 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
Syntax | INFO STORAGE [start end]
|
XML Syntax | <info-storage (start='...') (end='...')/> |
Permission | READ |
Summary | Shows the internal main table of the currently opened database. An integer range 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
Syntax | LIST ([name] ([path]))
|
XML Syntax | <list (name='...' (path='...'))/> |
Permission | NONE |
Summary | Lists all available databases. If name is specified, the resources of a database are listed. The output can be further restricted to the resources matching the specified path .If database resources are listed, the size is either the number of nodes (for XML resources) or the number of bytes (for binary resources). |
Errors | The command fails if the optional database cannot be opened, or if the existing databases cannot be listed for some other reason. |
XQUERY
Syntax | XQUERY [query]
|
XML Syntax | <xquery>[query]</xquery> |
Permission | depends on query |
Summary | Runs the specified query and prints the result.
|
Errors | The command fails if the specified query is invalid. |
Examples |
|
RETRIEVE
Syntax | RETRIEVE [path]
|
XML Syntax | <retrieve path='...'/> |
Permission | READ |
Summary | Retrieves a raw file from the opened database at the specified path .
|
Errors | The command fails if no database is opened, if the source path is invalid or if the data cannot not be retrieved for some other reason. |
FIND
Syntax | FIND [query]
|
XML Syntax | <find>[query]</find> |
Permission | READ |
Summary | Builds and runs a query for the specified query terms. Keywords can be enclosed in quotes to look for phrases. The following modifiers can be used to further limit search:
|
Errors | The command fails if no database is opened. |
TEST
Syntax | TEST [path]
|
XML Syntax | <test path='...'/> |
Permission | ADMIN |
Summary | Runs all XQUnit tests in the specified path . The path can point to a single file or a directory.Unit testing can also be triggered via -t on command line.
|
Errors | The command fails if at least one test fails. |
Examples |
|
REPO INSTALL
Syntax | REPO INSTALL [path]
|
XML Syntax | <repo-install path='...'/> |
Permission | CREATE |
Summary | Installs the package with path path .
|
Errors | The command fails in the following cases:
|
REPO LIST
Syntax | REPO LIST
|
XML Syntax | <repo-list/> |
Permission | READ |
Summary | Lists all installed packages. |
REPO DELETE
Syntax | REPO DELETE [name]
|
XML Syntax | <repo-delete name='...'/> |
Permission | CREATE |
Summary | Deletes the specified package with the specified name . What is called "name" can also be the id (which is the name followed by the version) or the directory of the package.
|
Errors | The command fails if the package to be deleted is required by another package. |
Updates
ADD
Syntax | ADD (TO [path]) [input]
|
XML Syntax | <add (path='...')>[input]</add> |
Permission | WRITE |
Summary | Adds a file, directory or XML string specified by input to the currently opened database at the specified path :
If files are to be added to an empty database, it is usually faster to use the |
Errors | The command fails if no database is opened, if one of the documents to be added is not well-formed, or if it could not be parsed for some other reason. |
Examples |
|
DELETE
Syntax | DELETE [path]
|
XML Syntax | <delete path='...'/> |
Permission | WRITE |
Summary | Deletes all documents from the currently opened database that start with the specified path .
|
Errors | The command fails if no database is opened. |
RENAME
Syntax | RENAME [path] [newpath]
|
XML Syntax | <rename path='...' newpath='...'/> |
Permission | WRITE |
Summary | Renames all document paths in the currently opened database that start with the specified 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 |
|
REPLACE
Syntax | REPLACE [path] [input]
|
XML Syntax | <replace path='...'>[input]</replace> |
Permission | WRITE |
Summary | Replaces resources in the currently opened database, addressed by path , with the file, directory or XML string specified by input , or adds new documents if no resource exists at the specified path.
|
Errors | The command fails if no database is opened or if the specified path is invalid. |
Examples |
|
STORE
Syntax | STORE (TO [path]) [input]
|
XML Syntax | <store (path='...')>[input]</store> |
Permission | WRITE |
Summary | Stores a raw file specified via input in the opened database to the specified path :
|
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
Syntax | OPTIMIZE (ALL)
|
XML Syntax | <optimize/> <optimize-all/> |
Permission | WRITE |
Summary | Optimizes the index structures, meta data and statistics of the currently opened database:
|
Errors | The command fails if no database is opened, or if the currently opened database is a main-memory instance. |
FLUSH
Syntax | FLUSH
|
XML Syntax | <flush/> |
Permission | WRITE |
Summary | Explicitly flushes the buffers of the currently opened database to disk. This command is applied if AUTOFLUSH has been set to false .
|
Errors | The command fails if no database is opened. |
Monitoring
SHOW SESSIONS
Syntax | SHOW SESSIONS
|
XML Syntax | <show-sessions/> |
Permission | ADMIN |
Summary | Shows all sessions that are connected to the current server instance. |
SHOW USERS
Template:Mark: If called by non-admins, will only return the current user
Syntax | SHOW USERS (ON [database])
|
XML Syntax | <show-users (database='...')/> |
Permission | ADMIN |
Summary | Shows all users that are visible to the current user. If a database is specified, only those users will be shown for which a pattern was specified that matches the database name.
|
Errors | The command fails if the optional database could not be opened. |
KILL
Syntax | KILL [target]
|
XML Syntax | <kill target='...'/> |
Permission | ADMIN |
Summary | Kills sessions of a user or an IP:port combination, specified by target . The 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. |
JOBS LIST
Syntax | JOBS LIST
|
XML Syntax | <jobs-list/> |
Permission | ADMIN |
Summary | Returns information on all jobs that are currently queued or executed. |
JOBS RESULT
Syntax | JOBS RESULT [id]
|
XML Syntax | <jobs-result id='...'/> |
Permission | ADMIN |
Summary | Returns the cached result of a query with the specified job id:
|
Errors | The command fails if the addressed job is still running or if the result has already been retrieved. |
JOBS STOP
Syntax | JOBS STOP [id]
|
XML Syntax | <jobs-stop id='...'/> |
Permission | ADMIN |
Summary | Cancels the execution of a job with the specified id, or drops the cached result of a query. Unknown ids are ignored. All jobs are gracefully stopped; it is up to the process to decide when it is safe to shut down. |
User Management
CREATE USER
Syntax | CREATE USER [name] ([password])
|
XML Syntax | <create-user name='...'>([password])</create-user> |
Permission | ADMIN |
Summary | Creates a user with the specified name and password . If no password is specified, it is requested via the chosen frontend (GUI or bash).
|
Errors | The command fails if the specified user already exists. |
ALTER USER
Syntax | ALTER USER [name] ([newname])
|
XML Syntax | <alter-user name='...' newname='...'/> |
Permission | ADMIN |
Summary | Renames the user with the specified name to newname .
|
Errors | The command fails if the specified user does not exist, or if the new user already exists. |
ALTER PASSWORD
Syntax | ALTER PASSWORD [name] ([password])
|
XML Syntax | <alter-password name='...'>([password])</alter-password> |
Permission | ADMIN |
Summary | Alters the password of the user with the specified name . If no password is specified, it is requested via the chosen frontend (GUI or bash).
|
Errors | The command fails if the specified user does not exist. |
DROP USER
Syntax | DROP USER [name] (ON [pattern]) :
|
XML Syntax | <drop-user name='...' (pattern='...')/> |
Permission | ADMIN |
Summary | Drops the user with the specified name . The Glob Syntax can be used to address more than one database or user. If a glob pattern is specified, only the pattern will be removed.
|
Errors | The command fails if admin is specified as user name, or if the specified user does not exist or is currently logged in.
|
GRANT
Syntax | GRANT [NONE|READ|WRITE|CREATE|ADMIN] (ON [pattern]) TO [user]
|
XML Syntax | <grant name='...' permission='none|read|write|create|admin' (pattern='...')/> |
Permission | ADMIN |
Summary | Grants the specified permission to the specified user . The Glob Syntax can be used to address more than one user. If a glob pattern is specified, the permission will be applied to all databases that match this pattern.
|
Errors | The command fails if admin is specified as user name or if the specified user does not exist.
|
Examples |
|
PASSWORD
Syntax | PASSWORD ([password])
|
XML Syntax | <password>([password])</password> |
Permission | NONE |
Summary | Changes the password of the current user. If no password is specified, it is requested via the chosen frontend (GUI or bash).
|
General Commands
RUN
Syntax | RUN [file]
|
XML Syntax | <run file='...'/>
|
Permission | depends on input |
Summary | Evaluates the contents of file as XQuery expression. If the file ends with the suffix .bxs , the file contents will be evaluated as command script. This command can be used to run several commands in a row, with no other transaction intervening the execution.
|
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 |
|
EXECUTE
Syntax | EXECUTE [input]
|
XML Syntax | <execute>[input]</execute>
|
Permission | depends on input |
Summary | Evaluates the specified input as command script. This command can be used to run several commands in a row, with no other transaction intervening the execution.
|
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 |
|
GET
Syntax | GET [option]
|
XML Syntax | <get (option='...')/> |
Permission | NONE |
Summary | Returns the current value of the Option specified via option . Global options can only be requested by users with ADMIN permissions.
|
Errors | The command fails if the specified option is unknown. |
SET
Syntax | SET [option] ([value])
|
XML Syntax | <set option='...'>([value])</set> |
Permission | NONE |
Summary | Sets the Option specified by option to a new 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
Syntax | INFO
|
XML Syntax | <info/> |
Permission | READ |
Summary | Shows global information. |
HELP
Syntax | HELP ([command])
|
XML Syntax | <help>([command])</help> |
Permission | NONE |
Summary | If 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
Syntax | EXIT
|
XML Syntax | <exit/> |
Permission | NONE |
Summary | Exits the console mode. |
QUIT
Syntax | QUIT
|
XML Syntax | <quit/> |
Permission | NONE |
Summary | Exits the console mode (alias of EXIT ).
|
Changelog
- Version 8.6
- Updated:
SHOW USERS
: If called by non-admins, will only return the current user
- Version 8.5
- Added:
JOBS LIST
,JOBS RESULT
,JOBS STOP
- Updated: Valid Names: allow dots (except as first and last character)
- Version 8.4
- Updated:
CREATE INDEX
,DROP INDEX
,INFO INDEX
: token index added - Updated:
INFO STORAGE
: Query argument removed, start/end added to XML syntax. - Updated:
INFO INDEX
: Token index added; indexTAG
renamed toELEMNAME
; indexATTNAME
renamed toATTRNAME
- Updated:
OPTIMIZE
: adopt original index options
- Version 8.2
- Removed:
CREATE EVENT
,DROP EVENT
andSHOW EVENTS
command
- Version 8.0
- Updated: commands for User Management
- Updated:
OPEN
: path argument added - Removed:
CS
command - Added:
QUIT
- Version 7.9
- Added:
TEST
runs XQUnit tests.
- Version 7.7
- Updated: syntax of valid names.
- Version 7.5
- Added:
EXECUTE
executes a command script. - Added:
INSPECT
performs integrity checks. - Added: automatic detection of Command Scripts.
- Removed:
SHOW DATABASES
; information is also returned bySHOW SESSIONS
. - Removed:
OPEN
: path argument.
- Version 7.3
- Added: XML Syntax added.
- Updated:
CHECK
can now be used to create empty databases. - Updated: Names and paths in
OPEN
andLIST
are now specified as separate arguments.
- Version 7.2.1
- Version 7.2
- Updated:
CREATE INDEX
,DROP INDEX
(PATH
argument removed. Path summary is always available now and updated withOPTIMIZE
). - Updated: permissions for
REPO DELETE
,REPO INSTALL
andREPO LIST
.
- Version 7.1
- Updated:
KILL
(killing sessions by specifying IP:port)
- Version 7.0