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:<pre>>[[Commands#CREATE DATABASE|CREATE DB]] factbook factbook.xml</pre> : '''factbook''' is the name of the database <br/>: '''factbook.xml''' is the xml file, which is used to create the database<br/>  If everything works you see the following lines:<pre>Database 'factbook' created in 950.83 ms.</pre> ; Where is the database stored?By default, databases are stored in the <code>BaseXData</code> directory, which is located in your home folder.Depending on your [[Configuration]], the location of your home folder varies. For example, on a Mac it'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 the application directory. ==Execute a query==The [[Commands#XQUERY|XQUERY]] command lets you run a query.* For example, this query returns all country nodes in the currently opened database.<pre>>[[Commands#XQUERY|XQUERY]] //country</pre> * You can also run queries in files:<pre>>[[Commands#RUN|RUN]] /Users/John/query.xq</pre> ==Create a new database==Now we will create another database from the [http://files.basex.org/xml/xmark.xml xmark.xml] document. * Create the new database, named 'xmark'.<pre>>[[Commands#CREATE DATABASE|CREATE DB]] xmark xmark.xml</pre> * Set the new database xmark as the context:<pre>>[[Commands#OPEN|OPEN]] xmark</pre> * Now you can easily execute queries on your new database:<pre>>[[Commands#XQUERY|XQUERY]] //people/person/name</pre> ==Switch the database==* You can explicitly query the factbook database with the <code>doc(...)</code> funtion, no matter what the current context is.<pre>>[[Commands#XQUERY|XQUERY]] doc("factbook")//country</pre> * Otherwise, to set factbook as the current context, execute the following:<pre>>[[Commands#OPEN|OPEN]] factbook</pre> * To list the current context, type:<pre>>[[Commands#SHOW|SHOW]] DATABASES</pre>

That yields the following linesThe 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:

<pre>* Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Add the {{Code|stop}} keyword to gracefully shut down the server.1 opened database* If you have installed BaseX on ''Windows'', click on the '''BaseX HTTP Server (sStart):- factbook ''' icon, which will start both the HTTP Server used for [[#Web Application|Web Applications]] and the database server. With '''BaseX HTTP Server (1xStop)</pre>''', you can shut down the server process.

==Close or delete a database==* To [[CommandsBy default, the server listens to the port {{Code|1984}}. Pressing {{Code|Ctrl+c}} will close]] all connections and databases and gracefully shut down the current context database, please type: <pre>>[[Commands#CLOSE|CLOSE]]</pre>server process.

* Use the Various [[CommandsCommand-Line_Options#DROPServer|DROPcommand-line options]] command are available to delete the xmark database:<pre>>simplify batch processing. The [[Commands#DROP DATABASEStart_Scripts|DROP DBstart script]] xmark</pre>can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).

==Create a collectionClient=='''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.

* First make sure factbook is openedRun one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the following command:<pre>>[[Commands#OPEN{{Code|OPEN]] factbookjava -cp BaseX.jar org.basex.BaseXClient}}</pre>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.

* Now add At startup, you need to enter your credentials. The initial passwort of the {{Code|admin}} user is {{Code|admin}}; it can be changed with the xmark.xml document: <pre>>{{Code|[[Commands#ADDPASSWORD|ADDPASSWORD]] xmark}} command.xml</pre>

==Delete For further details, have a document==* Deleting a document from a collection is easy:<pre>>look at the [[CommandsCommand-Line_Options#DELETEClient|command-line options]] and the [[Start_Scripts|DELETEstart script]] xmark.xml</pre>

==Delete a collection==Deleting a collection The BaseX command-line client provides similar features to the [[Command-Line Client|standalone client]]. The major difference is that all commands will be executed by the same as deleting BaseX server instance. As a databaseconsequence, paths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).

* Username and password can also be specified as command-line option. To delete evaluate commands without entering the collection factbookconsole mode, typeyou can use the <code>-c</code> option on the command line:

>[[Commands#DROP DATABASE|DROP basexclient -V -Uadmin -Padmin -c "CREATE DB]] factbookinput <example/pre>; XQUERY /"

==Get server information==Several commands help to explore the state of a serverDatabase 'input' created in 13. For a complete list, please visit the [[Commands]] Section85 ms.<example/>Query:/

* To see all databases on the server, typeParsing:0.18 ms<pre>>[[Commands#LIST|LIST]]</pre>Compiling: 0.04 msEvaluating: 0.12 ms* To see which database is currently openedPrinting:0.07 ms<pre>>[[Commands#SHOW DATABASES|SHOW DATABASES]]</pre> * To see the general information of the opened database, typeTotal Time:<pre>>[[Commands#INFO|INFO]]</pre>0.41 ms

* To see the users in BaseX, typeHit(s):1 Item<pre>Updated: 0 ItemsPrinted: 10 Bytes>Read Locking: local [[Commands#SHOW USERS|SHOW USERS]input]</pre>Write Locking: none

* 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.=Language Bindings=

==See also ==[[Standalone Mode]], [[GUI]], [[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]].