Jump to navigation Jump to search
Text replacement - "[" to "["
This page is part of the [[Getting Started]] Section.
BaseX offers a It introduces you to the standalone console command-line mode from which all [[Commands|database commands]] can be executed.The article on the [[Database Server]] provides numerous examples for running commands in the console mode(note that the GUI does ''not'' interact with the client/server architecture)of BaseX.
First of all, please launch a '''standalone''' version of BaseX: double click on the '''BaseX''' icon, or run the <code>basex</code> script. [[Startup#Standalone|Follow this link]] for more information (or check out the additional [[Command-Line Options#Standalone|command-line options]]).
==Working with the BaseX Console== After the BaseX Console has been started, the <code>HELP</code> The command -line client can be used toto list all [[Commands|database commands]]. Multiple commands can be separated by semicolons.started as follows:
To evaluate commands without entering * Run one of the console mode{{Code|basex}} or {{Code|basex.bat}} scripts.* If you have installed BaseX on ''Windows'', you can use the<code>-c</code> option click on the command line: <pre>basex -Vc "CREATE DB input <example/>; XQUERY /"'''BaseX Standalone''' icon.
Database 'input' created in 124Various [[Command-Line_Options#Standalone|command-line options]] are available to simplify batch processing.95 msThe [[Start_Scripts|start script]] can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).<example/>
Query: /Please note that the standalone client must not be used if you perform parallel (concurrent) read and write operations on your databases. See [[Startup#Concurrent Operations|Concurrent Operations]] for more details.
Result: root()==Create a Database==
Parsing* To create a database you need an XML document, e.g. [https: 0// factbook.xml].42 msCompiling: 9* Save this document to your working directory.3 msEvaluating* Type in the following command to create and open the database: 0.35 msPrinting: 5<code>> [[Commands#CREATE DB|CREATE DB]] factbook factbook.53 msxmlTotal Time: 15.62 ms</code>
Hit(s): 1 Item'''factbook''' is the name of the database <br/>Updated: 0 ItemsPrinted: 10 Bytes'''factbook.xml''' is the initial input of the database<br/>
Query executed in 15.62 ms.</pre>; Where is the database stored?
All available command-line options can be found By default, databases are stored in the <code>basex/data</code> directory, which is located in your home folder.Depending on your [[Command-Line Options#BaseX Standalone|hereConfiguration]], the location of your home folder varies. For example, on a Mac it's <code>/Users/John</code>, if your name is John.
==Execute a Query== The [[GUICommands#XQUERY|XQUERY]]command lets you run a query.* For example, the following query returns all country nodes in the currently opened factbook database.<code>> [[Commands#XQUERY|XQUERY]] //country</code> * You can also run queries in files:<code>> [[Commands#RUN|RUN]] /Users/John/query.xq</code> ==Database ServerCommands== * The following command lists all databases than can be opened by the currently logged in user:<code>> [[Commands#LIST|LIST]]</code> * To open an existing database, execute the following:<code>> [[Commands#OPEN|OPEN]] factbook</code> * To get information on the currently opened database, type:<code>> [[Commands#INFO|INFO]]</code> * You can also address a database within your query with the [[Database Module#db:open|db:open]] function:<code>> [[Commands#XQUERY|XQUERY]] db:open("factbook")//country</code> * To [[Commands|close]] the current database, please type: <code>> [[Commands#CLOSE|CLOSE]]</code> * Use the [[Commands#DROP DB|DROP DB]]command to delete a database:<code>> [[Commands#DROP DB|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>> [[Getting StartedCommands#CREATE DB|CREATE DB]]store</code><br/><code>> [[CategoryCommands#ADD|ADD]] factbook.xml</code><br/><code>> [[Commands#ADD|ADD]] http:Beginner//</code> * Deleting a document from a database is easy, but make sure that the database, which contains the addressed document, is currently opened:<code>> [[Commands#DELETE|DELETE]]factbook.xml</code> ==Backup and Restore== * To backup your database, type:<code>> [[Commands#CREATE BACKUP|CREATE BACKUP]] factbook</code> * To restore your database, type:<code>> [[Commands#RESTORE|RESTORE]] factbook</code> The backup file is stored in the database directory.It contains the name of the database and a timestamp: <code>[db-name]-[timestamp].zip</code>.If a database is to be restored, and if several backups exist, the backup with the newest timestamp is taken.
Bureaucrats, editor, reviewer, Administrators


Navigation menu