Changes

Jump to navigation Jump to search
2,014 bytes added ,  17:43, 4 June 2024
no edit summary
This page is part of the [[Getting Started]] Section.BaseX offers a It introduces you to the standalone (embedded) 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.
==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]]).
==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 124All operations will be performed with admin permissions (no password needs to be supplied).95 msVarious [[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).<example/>
Query: /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.
Compiling:=Operations=
Result: root()==Create a Database==
ParsingTo create a database, you need an XML document, e.g., [https: 0//files.basex.42 msCompilingorg/xml/factbook.xml factbook.xml]. Save this document to your working directory and type in the following command to create and open the database: 9.3 msEvaluating: 0.35 ms<code>Printing: 5> {{Command|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 By default, databases are stored in 15.62 ms.the <code>basex/data</precode>directory of your project’s home directory. Depending on your [[Configuration]], the location may vary.
All available command-line options can be found [[Startup Options#BaseX Standalone|here]].==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==See  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==[[GUI]]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, [[Database 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]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.
Bureaucrats, editor, reviewer, Administrators
13,554

edits

Navigation menu