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 administration of BaseX. Visit the [[Commands|commands section]] for a complete list of database commandscommand-line.

=Startup=Start BaseX Server and Client==Please have a look at the [[Startup Overview]], and start a server and a client instance of BaseX.

==Create a databaseServer==* To create a database you need an XML document, e.g. [http://www.w3.org/XML/Binary/2005/03/test-data/Over100/factbook.xml factbook.xml].* Save this document to the directory your working in.* On the client terminal, run: <code>: > 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 1950{{Code|basexserver}} or {{Code|basexserver.83 msbat}} scripts.</pre> ; Where is Add the {{Code|stop}} keyword to gracefully shut down the database stored?server.Databases are stored in * If you have installed BaseX on ''Windows'', click on the BaseXData directory '''BaseX HTTP Server (Start)''' icon, which is located in your home folder. Depending on your operating system will start both the HTTP Server used for [[#Web Application|Web Applications]] and the location of your home folder variesdatabase server. For example, on a mac itWith '''BaseX HTTP Server (Stop)'''s /Users/John, if your name is Johnyou can shut down the server process.

==Execute a Query==The [[CommandsBy 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>: > XQUERY //country</code>

* You Various [[Command-Line_Options#Server|command-line options]] are available to simplify batch processing. The [[Start_Scripts|start script]] can also run queries in files:<code>: > RUN /Users/John/querybe 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. You can find the example document here: [http://phobos101.inf.uni-konstanz.de/basex/demo].

* Create the new database, named 'xmark'.<code>Database clients are started similarly: > CREATE DB xmark xmark.xml</code>

* Set Run one of the new database xmark as {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the contextfollowing command:{{Code|java -cp BaseX.jar org.basex.BaseXClient}}<code>: > OPEN xmark</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>: > XQUERY //people/person/name</code>be changed with the {{Code|[[Commands#PASSWORD|PASSWORD]]}} command.

==Switch For further details, have a look at the Database==* You can explicitly query the factbook database with the doc()[[Command-Line_Options#Client|command-funtion, no matter what line options]] and the current context is[[Start_Scripts|start script]].<code>: > XQUERY doc("factbook")//country</code>

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

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

==Close or delete a Database==* To [[Commands|close]] the current context database type: 'input' created in 13.85 ms.<codeexample/>Query: > CLOSE</code>

* Use the [[Commands|drop]] command to delete the xmark databaseParsing:0.18 ms<code>Compiling: 0.04 msEvaluating: 0.12 msPrinting: > DROP DBxmark0.07 ms</code>Total Time: 0.41 ms

Let's add the xmarkQuery "user" executed in 0.xml document to the factbook database to create a collection. The name of the original factbook database remains41 ms. * First make sure factbook is opened:<code>: > OPEN factbook</codepre> * Now add the xmark.xml document: <code>: > ADD xmark.xml</code> ==Delete a Document==* 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. ==Delete a Collection==Deleting a collection is the same as deleting a database. * To delete the collection factbook, type:<code>: > DROP factbook</code> ==Get Server Information==Several commands help to explore the state of a server. For a complete list visit the [[Commands|commands section]]. * To see all databases on the server, type:<code>: > LIST</code> * To see which database is currently opened:<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</code> To restore your database, type::<code>> RESTORE factbook</code> '''Where is the backup-file stored?'''

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