Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
m
BaseX offers a standalone (embedded) console mode from which all This page is part of the [[Commands|database commandsGetting Started]] can be executedSection.The [[Server Tutorial]] contains a good introduction on how It introduces you to run 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.
Database 'input' created in 53.64 ms.<html> <!The command-- Header --> <head id="0"> <title>XML</title> </head> <!-- Body --> <body id="1" bgcolor="#FFFFFF" text="#000000" link="#0000CC"> <h1>Databases & XML</h1> <div align="right"> <b>Assignments</b> <ul> <li>Exercise 1</li> <li>Exercise 2</li> </ul> </div> </body> <?pi bogus?></html>line client can be started as follows:
Query: /* Run one of the {{Code|basex}} or {{Code|basex.bat}} scripts.* If you have installed BaseX on ''Windows'', click on the '''BaseX Standalone''' icon.
Compiling:Various [[Command-Line_Options#Standalone|command-line options]] are available to simplify batch processing. The [[Start_Scripts|start script]] can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).
Result: rootPlease 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.
Parsing: 0.19 msCompiling: 9.27 msEvaluating: 0.33 msPrinting: 3.08 msTotal Time: 12.88 msResults: 1 ItemUpdated: 0 ItemsPrinted: 375 BytesMemory: 5834 KB=Operations=
Query executed in 13.25 ms.</pre>==Create a Database==
All available * To create a database you need an XML document, e.g. [https://files.basex.org/xml/factbook.xml factbook.xml].* Save this document to your working directory.* Type in the following command-line options can be found to create and open the database:<code>> [[Startup OptionsCommands#BaseX StandaloneCREATE DB|hereCREATE DB]]factbook factbook.xml</code>
Text replacement - "[http://files.basex.org/" to "[https://files.basex.org/"
=Startup=Working with the BaseX Console== <p>After the BaseX Console has been started, the <code>HELP</code> command can be used toto list all [[Commands|database commands]]. Several commands can be separated by semicolons.</p> <p> To evaluate commands without entering the console mode, you can use the<code>-c</code> option on the command line:</p> <pre>basex -Vc "CREATE DB input input.xml; XQUERY /"
: '''factbook''' is the name of the database <br/>: '''factbook.xml''' is the initial input of the database<br/> ; Where is the database stored? By default, databases are stored in the <code>basex/data</code> directory, which is located in your home folder.Depending on your [[Configuration]], 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=See = The [[Commands#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 Commands== * The following command lists all databases than can be opened by the currently logged in user:<code>> [[GUI TutorialCommands#LIST|LIST]]</code> * To open an existing database, execute the following:<code>> [[Server TutorialCommands#OPEN|OPEN]]factbook</code> * To get information on the currently opened database, type:<code>> [[Getting StartedCommands#INFO|INFO]]</code> * You can also address a database within your query with the [[CategoryDatabase Module#db:open|db:Beginneropen]]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>> [[Commands#CREATE DB|CREATE DB]] store</code><br/><code>> [[Commands#ADD|ADD]] factbook.xml</code><br/><code>> [[Commands#ADD|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>> [[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.
