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 {{Announce|With Version 10, the name of the database <br/>: '''factbookdefault admin password has been removed.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 The database stored?By defaultserver handles concurrent [[Transaction_Management|read and write transactions]], databases are stored in the <code>BaseXData</code> directory, which is located in your home folder.Depending on your [[ConfigurationUser Management|manages user permissions]] and [[Logging|logs user interactions]], 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 It can be named <code>data</code>, and reside in the application directory.started as follows:

==Execute a query==The [[Commands#XQUERY* Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Use {{Code|basexserverstop}} or {{Code|XQUERY]] command lets you run a querybasexserverstop.bat}} to gracefully shut down the server.* For exampleIf you have installed BaseX on ''Windows'', click on the '''BaseX HTTP Server (Start)''' icon, this query returns all country nodes in which will start both the currently opened database.<pre>>HTTP Server used for [[Commands#XQUERYWeb Application|XQUERYWeb Applications]] //country</pre>and the database server. With '''BaseX HTTP Server (Stop)''', you can shut down the server process.

* 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://filesUnless you have already chosen an admin password yet (e.basexg.org/xml/xmark.xml xmark.xml] document. * Create , via the new databaseWindows installer or a previous installation), named 'xmark'.<pre>>[[Commands#CREATE DATABASEyou can do so by invoking the {{Command|CREATE DB]] xmark xmark.xml</pre> * Set the new database xmark as the contextPASSWORD}} command on your terminal:<pre>>[[Commands#OPEN|OPEN]] xmark</pre>

>basexserver -c PASSWORDBaseX [[Commands#XQUERY|XQUERY]Server] //people/person/nameServer was started (port: 1984).Password: _

==Switch By default, the database==* You can explicitly query server listens to the factbook database with the <code>doc(port {{Code|1984}}...)</code> funtion, no matter what Pressing {{Code|Ctrl+c}} will close all connections and databases and gracefully shut down the current context isserver process.<pre>>[[Commands#XQUERY|XQUERY]] doc("factbook")//country</pre>

* Otherwise, Various [[Command-Line_Options#Server|command-line options]] are available to set factbook as the current context, execute the following:<pre>>simplify batch processing. The [[Commands#OPENStart_Scripts|OPENstart script]] factbook</pre>can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).

That yields the following linesDatabase clients are started similarly:

<pre>* Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.1 opened database(s)* Execute the following command:{{Code|java - factbook (1x)cp BaseX.jar org.basex.BaseXClient}}</pre>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.

==Close or delete a database==* To [[Commands|close]] the current context databaseAt startup, please type: <pre>>[[Commands#CLOSE|CLOSE]]</pre>you need to enter your credentials.

* Use For further details, have a look at the [[CommandsCommand-Line_Options#DROPClient|DROPcommand-line options]] command to delete and the xmark database:<pre>>[[Commands#DROP DATABASEStart_Scripts|DROP DBstart script]] xmark</pre>.

=Introduction=Create 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 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 xmarkBaseX server instance.xml document As a consequence, paths/URIs to resources need to be resolvable by the factbook database server (file contents will not be transfered to create a collection. The name of the original factbook database remainsserver).

* First make sure factbook is openedUsername and password can also be specified as command-line option. To evaluate commands without entering the console mode, you can use the <code>-c</code> option on the command line:

>[[Commands#OPEN|OPEN]] factbookbasexclient -V -Uadmin -P... -c "CREATE DB input <example/pre>; XQUERY /"

* Now add the xmarkDatabase 'input' created in 13.85 ms.xml document: <preexample/>>[[Commands#ADD|ADD]] xmark.xmlQuery:</pre>

==Delete a document==Parsing: 0.18 ms* Deleting a document from a collection is easyCompiling:0.04 ms<pre>Evaluating: 0.12 ms>[[Commands#DELETE|DELETE]] xmarkPrinting: 0.xml07 ms</pre>Total Time: 0.41 ms

==Delete a collection==Deleting a collection is the same as deleting a databaseQuery "user" executed in 0.41 ms. * To delete the collection factbook, type:<pre>>[[Commands#DROP DATABASE|DROP DB]] factbook

=Language Bindings=Get server information==Several commands help to explore the state of a server. For a complete list, please visit the [[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 DATABASES|SHOW DATABASES]]</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 If you want to communicate with the backup-file stored?'''database server programmatically, we provide clients for various [[Clients|programming languages]].

==See also ==;Version 10.0[[Standalone Mode]], [[GUI]], [[Getting Started]], [[Advanced Usage]][[Category:Beginner]][[Category* Updated:Server]]The default admin password has been removed.