Changes

This page is part of the [[Getting Started]] Section.BaseX offers a standalone (embedded) console mode from which all [[Commands|database commands]] can be executed.The article on It introduces you to the [[Database Server]] provides numerous examples for running commands in the console mode. ==Startup==First of all, please launch a '''standalone''' version of BaseX: double click on the '''BaseX''' icon, or run the <code>basex</code> script. [[Startup#BaseX Standalone|Follow this link]] for more information (or check out the additional [[Startup Options#BaseX Standalone|command-line options]])mode of BaseX.

=Startup=Working with the BaseX Console== After the BaseX Console has been started, the <code>HELP</code> command can be used toto list all [[Commands|database commands]]. Multiple commands can be separated by semicolons.

To evaluate commands without entering the console mode, you can use the<code>The command-c</code> option on the command lineclient can be started as follows: <pre>basex -Vc "CREATE DB input <example/>; XQUERY /"

Database * Run one of the {{Code|basex}} or {{Code|basex.bat}} scripts.* If you have installed BaseX on 'input' created in 124Windows'', click on the '''BaseX Standalone''' icon.95 ms.<example/>

Hit(s)To create a database, you need an XML document, e.g., [https: 1 Item//files.basex.org/xml/factbook.xml factbook.xml]. Save this document to your working directory and type in the following command to create and open the database:<code>Updated: 0 Items> {{Command|CREATE DB}} factbook factbook.xmlPrinted: 10 Bytes</code>

Query executed in 15: '''factbook''' is the name of the database <br/>: '''factbook.62 ms.xml''' is the initial input of the database<br/pre>

All available command-line options can be found By default, databases are stored in the <code>basex/data</code> directory of your project’s home directory. Depending on your [[Startup Options#BaseX Standalone|hereConfiguration]], the location may vary.

==See Execute a Query== The {{Command|XQUERY}} command lets you run a query. The following query returns all country elements of the currently opened database: <code>> {{Command|XQUERY}} //country</code> You can also run queries in files: <code>> {{Command|RUN}} /path/to/query.xq</code> ==Database Commands==[[GUI Tutorial]]The following command lists all databases that can be opened by the currently logged-in user: <code>> {{Command|LIST}}</code> To open an existing database, execute the following: <code>> {{Command|OPEN}} factbook</code> To get information on the currently opened database, [[type: <code>> {{Command|INFO}}</code> You can also address a database within your query with the {{Function|Database Server]]|db:get}} function: <code>> {{Command|XQUERY}} db:get("factbook")//country</code> To close the current database, please type:  <code>> {{Command|CLOSE}}</code> A database can eventually be dropped again: <code>> {{Command|DROP DB}} factbook</code> ==Multiple Resources== One database can contain not only a single, but millions of documents. All documents can have a different structure. With the following commands, you can create an empty database and add two documents. It is also possible to address resources via URLs: <code>> {{Command|CREATE DB}} store</code><br/><code>> {{Command|ADD}} factbook.xml</code><br/><code>> {{Command|ADD}} http://files.basex.org/xml/xmark.xml</code> Deleting a document from a database is easy, but make sure that the database, which contains the addressed document, is currently opened: <code>> {{Command|DELETE}} factbook.xml</code> ==Backup and Restore== To back up and restore your database, type: <code>> {{Command|CREATE BACKUP}} factbook</code><br/><code>> {{Command|RESTORE}} factbook</code> The backup file is stored in the database directory. It contains the name of the database and a timestamp: <code>[[Getting Started]db-name][-[Category:Beginner]timestamp].zip</code>. If a database is to be restored, and if several backups exist, the backup with the newest timestamp is taken.