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==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>: > 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 database directory will 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>: > 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 from the [http://files.basex.org/xml/xmark.xml xmark.xml] document.

* 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 the database==* You can explicitly query the factbook database with For further details, have a look at the <code>doc(...)</code> funtion, no matter what [[Command-Line_Options#Client|command-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>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 msPrinting: > CLOSE0.07 ms</code>Total Time: 0.41 ms

* Use the [[Commands#DROP|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

==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:<code>: > OPEN factbook</code> * 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 If you want to communicate with 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 listprogrammatically, please visit the we provide clients for various [[CommandsClients|programming languages]] 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?''' 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 Tutorial]], [[GUI Tutorial]], [[Getting Started]], [[Advanced Usage]][[Category:Beginner]][[Category:Server]]