Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
<p>BaseX offers a standalone console mode in which all This page is part of the [[CommandsGetting Started]] and XQuery queries can be executedSection. As first operations It introduces you can do to the sameas described in the [[BaseX_Server#First_Operations|first operations]] sections for clientstandalone command-server mode.</p> ==Start of BaseX in console line mode== <p> Just enter: <code>java -cp BaseX.jar org.base.BaseX</code> on the command line.<br/> The Java option <code>-Xmx...</code> reserves more memory, and the <code>-h</code> flag of BaseX lists all available flags:</p> <pre>java -Xmx512m -cp BaseX.jar org.basex.BaseX -h
Usage: BaseX [-diosuvVwz] [-cq] [file] [file] Execute XQuery file -c<cmd> Execute database command(s) -d Activate debugging mode -i<input> Open initial file or database -o<file> Write output to file -q<expr> Execute XQuery expression -s<pars> Set serialization parameter(s) -u Write updates back to original files -v/V Show (all) process info -w Keep whitespaces from source files -z Skip output of results</pre>=Startup=
==Working with the BaseX Console== <p>After starting the BaseX Console you can type in <code>help</code> to get a list of all[[Commands|BaseX commands]]. Several commands The command-line client 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 linestarted as follows:</p> <pre>java -cp BaseX.jar org.basex.BaseX -Vc "create db input input.xml; xquery /"
Database * Run one of the {{Code|basex}} or {{Code|basex.bat}} scripts.* If you have installed BaseX on ''Windows'', click on the 'input' created in 53'BaseX Standalone''' icon.64 ms.<html> <!-- 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>
Query: /All operations will be performed with admin permissions (no password needs to be supplied). 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).
Compiling: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()=Operations=
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==Create a Database==
Query executed 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 and type in 13.25 msthe following command to create and open the database:<code>> {{Command|CREATE DB}} factbook factbook.xml</precode>
no edit summary
: '''factbook''' is the name of the database <br/>: '''factbook.xml''' is the initial input of the database<br/> By default, databases are stored in the <code>basex/data</code> directory of your project’s home directory. Depending on your [[Configuration]], 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==[[BaseX GUI]]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|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, [[BaseX Server]]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 Guidedb-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.
