Changes

This step by step tutorial is part of article belongs to the [[Getting Started]] Guide.It shows tells you how to run BaseX in client-server mode from a terminal. You can copy and paste all commands to get them running on your machine. After you finished this tutorial, you will be familiar with the basic administration of BaseX. Visit the [[Commands|commands section]] for a complete list of database commandscommand-line.

==Startup==First of all, please launch a '''Server''' and '''Client''' instance of BaseX: double click on the '''BaseX Server/Client''' icons, or run the <code>basexserver</code> and <code>basexclient</code> scripts. [[Startup#BaseX Server|Follow this link]] for more information (or check out the additional [[Startup Options#BaseX Server|command-line options]]).

==Create a databaseServer==* To create a database you need an XML document, e.g. [http://files.basex.org/xml/factbook.xml factbook.xml].* Save this document to the directory you are working in.* In the client terminal, type in:<code>> [[Commands#CREATE DATABASE|CREATE DB]] factbook factbook.xml</code>

: '''factbook''' is the name of the The database <br/>server handles concurrent [[Transaction_Management|read and write transactions]], [[User Management|manages user permissions]] and [[Logging|logs user interactions]]. It can be started as follows: '''factbook.xml''' is the xml file, which is used to create the database<br/>

If everything works you see * Run one of the following lines:<pre>Database 'factbook' created in 950{{Code|basexserver}} or {{Code|basexserver.83 msbat}} scripts.</pre> ; Where is Add the {{Code|stop}} keyword to gracefully shut down the database stored?server.By default* If you have installed BaseX on ''Windows'', databases are stored in click on the <code>BaseXData</code> directory'''BaseX HTTP Server (Start)''' icon, which is located in your home folder.Depending on your will start both the HTTP Server used for [[Configuration#Web Application|Web Applications]], and the location of your home folder variesdatabase server. For example, on a Mac itWith '''BaseX HTTP Server (Stop)'''s <code>/Users/John</code>, if your name is John. If you have used the Windows Installer, the directory will be named <code>data</code>, and reside in can shut down the application directoryserver process.

==Execute a query==The [[Commands#XQUERYBy default, the server listens to the port {{Code|XQUERY]] command lets you run a query1984}}.* For example, this query returns Pressing {{Code|Ctrl+c}} will close all country nodes in connections and databases and gracefully shut down the currently opened databaseserver process.<code>> [[Commands#XQUERY|XQUERY]] //country</code>

* You can also run queries in files:<code>> Various [[CommandsCommand-Line_Options#RUNServer|command-line options]] are available to simplify batch processing. The [[Start_Scripts|RUNstart script]] /Users/John/querycan be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).xq</code>

==Create a new databaseClient==Now we will create another database from the [http://files.basex.org/xml/xmark.xml xmark.xml] document.

* Set Run one of the new database xmark as {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the contextfollowing command:<code>> [[Commands#OPEN{{Code|OPEN]] xmarkjava -cp BaseX.jar org.basex.BaseXClient}}</code>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.

* Now At startup, you need to enter your credentials. The initial passwort of the {{Code|admin}} user is {{Code|admin}}; it can easily execute queries on your new database:<code>> be changed with the {{Code|[[Commands#XQUERYPASSWORD|XQUERYPASSWORD]] //people/person/name</code>}} command.

==Switch the database==* You can explicitly query the factbook database with the <code>doc(...)</code> funtionFor further details, no matter what have a look at the current context is.<code>> [[CommandsCommand-Line_Options#XQUERYClient|XQUERYcommand-line options]] doc("factbook")//country</code>and the [[Start_Scripts|start script]].

* To list The BaseX command-line client provides similar features to the current context, type:<code>> [[Commands#SHOWCommand-Line Client|SHOWstandalone client]] DATABASES<. The major difference is that all commands will be executed by the BaseX server instance. As a consequence, paths/code>URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).

That yields Username and password can also be specified as command-line option. To evaluate commands without entering the following linesconsole mode, you can use the <code>-c</code> option on the command line: <syntaxhighlight>basexclient -V -Uadmin -Padmin -c "CREATE DB input <example/>; XQUERY /"

Database 'input' created in 13.85 ms.<preexample/>1 opened database(s)Query:- factbook (1x)</pre>

==Close or delete a database==Parsing: 0.18 ms* To [[Commands|close]] the current context database, please typeCompiling: 0.04 ms<code>Evaluating: 0.12 ms> [[Commands#CLOSE|CLOSE]]Printing: 0.07 ms</code>Total Time: 0.41 ms

* Use the [[Commands#DROP|DROP]] command to delete the xmark databaseHit(s):1 Item<code>Updated: 0 Items> Printed: 10 BytesRead Locking: local [[Commands#DROP DATABASE|DROP DBinput]] xmark</code>Write Locking: none

==Create a collection=='''What is a collection?'''With BaseX you can group documents into one logical collectionQuery "user" executed in 0. A collection is a database that contains two or more documents. Collections accept any type of XML documents, regardless of their structure41 ms.</syntaxhighlight>

* First make sure factbook is opened:<pre>>[[Commands#OPEN|OPEN]] factbook</pre> * Now add If you want to communicate with the xmark.xml document: <pre>>[[Commands#ADD|ADD]] xmark.xml</pre> ==Delete a document==* Deleting a document from a collection is easy:<pre>>[[Commands#DELETE|DELETE]] xmark.xml</pre> Make sure that the collection, which contains the '''xmark.xml''' document, is opened. ==Delete a collection==Deleting a collection is the same as deleting a database. * To delete the collection factbook, type:<pre>>[[Commands#DROP DATABASE|DROP DB]] factbook</pre> ==Get server information==Several commands help to explore the state of a server. For a complete listprogrammatically, please visit the [we provide clients for various [Commands]] Section. * To see all databases on the server, type:<pre>>[[Commands#LIST|LIST]]</pre> * To see which database is currently opened:<pre>>[[Commands#SHOW DATABASESClients|SHOW DATABASESprogramming languages]]</pre> * To see the general information of the opened database, type:<pre>>[[Commands#INFO|INFO]]</pre> * To see the users in BaseX, type:<pre>>[[Commands#SHOW USERS|SHOW USERS]]</pre> ==Backup and restore==* To backup your database, type:<pre>> [[Commands#CREATE BACKUP|CREATE BACKUP]] factbook</pre> * To restore your database, type:<pre>> [[Commands#RESTORE|RESTORE]] factbook</pre> '''Where is the backup-file stored?''' The backup-file is stored in the database directory.The file is named <code>factbook-timestamp.zip</code> (<code>db_name-timestamp.zip</code>).To restore the database the file with the newest timestamp is taken. ==See also ==[[Standalone Mode]], [[GUI]], [[Getting Started]], [[Advanced Usage]][[Category:Beginner]][[Category:Server]]