Changes

This step by step tutorial shows article belongs to the [[Getting Started]] Guide. It tells you how to run BaseX in client-server mode from a terminal. You can copy & paste the commands to get it running on your machine.After you finished this tutorial, you will be familiar with the basic BaseX commandscommand-line.

==Startup==

==First Operations==To get familiar with BaseX we suggest to execute the following basic operationsThe database 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:

===Creating a database===* Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Add the {{Code|stop}} keyword to gracefully shut down the server.* To create a database If you need an XML documenthave installed BaseX on ''Windows'', click on the '''BaseX HTTP Server (Start)''' icon, e.g. which will start both the HTTP Server used for [[http://www.w3.org/XML/Binary/2005/03/test-data/Over100/factbook.xml factbook.xml#Web Application|Web Applications]].* Save this document to and the /basex directorydatabase server.* On With '''BaseX HTTP Server (Stop)''', you can shut down the client terminal run: <code>: > create db factbook factbookserver process.xml</code>

: ''factbook'' - is By default, the name of server listens to the database <br/>: ''factbookport {{Code|1984}}.xml'' - is Pressing {{Code|Ctrl+c}} will close all connections and databases and gracefully shut down the xml file, which is used to create the database<br/> server process.

If everything works you see the following lines:<pre>Database 'factbook' created in 1950.83 ms.</pre> ;Where is the database stored?Databases Various [[Command-Line_Options#Server|command-line options]] are stored in the BaseXData directory which is located in your home folder. Depending on your operating system the location of your home folder variesavailable to simplify batch processing. For example, on a mac it's /Users/John, if your name is John. ===Executing a query===The [[CommandsStart_Scripts|xquerystart script]] command lets you run a query.* For example, this query returns all country nodes in the currently opened database.<code>: > xquery //country</code> * You can also run queries in files:<code>: > run /Users/John/querybe adjusted for individual purposes (e.xq</code> ===Creating a new database===Now we will create another databaseg. You can find if the example document here: [http://phobos101.inf.uni-konstanz.de/basex/demo]default memory limit is too restrictive).

* Set the new database xmark as the contextDatabase clients are started similarly:<code>: > open xmark</code>

* Now you can easily execute queries on your new database:<code>Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the following command: > xquery //people/person/name{{Code|java -cp BaseX.jar org.basex.BaseXClient}}</code>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.

===Switching At startup, you need to enter your credentials. The initial passwort of the database===* You {{Code|admin}} user is {{Code|admin}}; it can explicitly query the factbook database be changed with the doc()-funtion, no matter what the current context is{{Code|[[Commands#PASSWORD|PASSWORD]]}} command.<code>: > xquery doc("factbook")//country</code>

* OtherwiseFor further details, to set factbook as have a look at the current context, execute [[Command-Line_Options#Client|command-line options]] and the following:<code>: > open factbook</code>[[Start_Scripts|start script]].

That yields The BaseX command-line client provides similar features to the following lines:[[Command-Line Client|standalone client]]. The major difference is that all commands will be executed by the BaseX server instance. As a consequence, paths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).

1 opened database(s):basexclient - factbook (1x)V -Uadmin -Padmin -c "CREATE DB input <example/pre>; XQUERY /"

===Closing or deleting a database===Parsing: 0.18 ms* To [[Commands|close]] the current context database typeCompiling: 0.04 ms<code>Evaluating: 0.12 msPrinting: > close0.07 ms</code>Total Time: 0.41 ms

* Use the [[Commands|drop]] command to delete the xmark databaseHit(s): 1 ItemUpdated:0 Items<code>Printed: 10 BytesRead Locking: > drop db xmarklocal [input]</code>Write Locking: none

===Creating a collection==='''What is a collection?'''With BaseX you can group documents into one logical collection. A collection is a database that contains two or more documents. Collections accept any type of XML documents, regardless of their structure. Let's add the xmark.xml document to the factbook database to create a collection. The name of the original factbook database remains. * First make sure factbook is opened:<code>: > open factbook</code> * Now add the xmark.xml document: <code>: > add xmark.xml</code> ===Deleting a document from a collection===* Deleting a document from a collection is very easy:<code>: > delete xmark.xml</code> Make sure the collection which contains the xmark.xml document is opened. ===Deleting a collection===Deleting a collection is the same as deleting a database. * To delete the collection factbook, type:<code>: > drop factbook</code> ===Getting information about the server===Several commands exist to show the state of a serverQuery "user" executed in 0. For a complete list see the [[Commands|commands section]]41 ms. * To see all databases on the server, type:<code>: > list</code> * To see which database is currently opened, type:<code>: > show databases</code> To see the general information of the opened database, type:<code>: > info</code> To see the users in BaseX, type:<code>: > show users</code> ===Backup and Restore===To backup your database, type::<code>> backup factbook</codepre> To restore your database, type::<code>> restore factbook</code> '''Where is the backup-file stored?'''

==See also ==[[BaseX Standalone]], [[BaseX GUI]], [[Getting Started Guide]]If you want to communicate with the database server programmatically, we provide clients for various [[Advanced User Portal]][[Category:Beginner]][[Category:ServerClients|programming languages]].