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:<code>> [[Commands#CREATE DATABASE|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.bat}} scripts.83 msUse {{Code|basexserverstop}} or {{Code|basexserverstop.</pre> ; Where is bat}} to gracefully shut down the database stored?By default, databases are stored in the <code>BaseXData</code> directory, which is located in your home folderserver.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 installed BaseX on ''Windows Installer'', click on the directory '''BaseX HTTP Server (Start)''' icon, which will be named <code>data</code>, and reside in start both the application directory. ==Execute a query==The HTTP Server used for [[Commands#XQUERYWeb Application|XQUERYWeb Applications]] command lets you run a query.* For example, this query returns all country nodes in and the currently opened databaseserver.<code>> [[Commands#XQUERY|XQUERY]] //country</code> * You can also run queries in files:<code>> [[Commands#RUN|RUN]] /Users/John/query.xq</code> ==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 With '''BaseX HTTP Server (Stop)''xmark'.<code>> [[Commands#CREATE DATABASE|CREATE DB]] xmark xmark.xml</code> * Set the new database xmark as the context:<code>> [[Commands#OPEN|OPEN]] xmark</code> * Now , you can easily execute queries on your new database:<code>> [[Commands#XQUERY|XQUERY]] //people/person/name</code>shut down the server process.

==Switch the database==* You can explicitly query the factbook database with the <code>docUnless you have already chosen an admin password yet (e.g..)</code> funtion, no matter what via the current context is.<code>> [[Commands#XQUERY|XQUERY]] doc("factbook"Windows installer or a previous installation)//country</code> * Otherwise, to set factbook as the current context, execute the following:<code>> [[Commands#OPEN|OPEN]] factbook</code> * To list you can do so by invoking the current context, type:<code>> [[Commands#SHOW{{Command|SHOW]] DATABASES</code> That yields the following linesPASSWORD}} command on your terminal:

1 opened databasebasexserver -c PASSWORDBaseX [Server]Server was started (sport: 1984).Password:- factbook (1x)_

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

==Create a collection=='''What is a collection?'''With BaseX you Various [[Command-Line_Options#Server|command-line options]] are available to simplify batch processing. The [[Start_Scripts|start script]] can group documents into one logical collectionbe adjusted for individual purposes (e.g. A collection if the default memory limit is a database that contains two or more documents. Collections accept any type of XML documents, regardless of their structuretoo restrictive).

* First make sure factbook is openedDatabase clients are started similarly:<pre>>[[Commands#OPEN|OPEN]] factbook</pre> * Now add the xmark.xml document: <pre>>[[Commands#ADD|ADD]] xmark.xml</pre>

==Delete a document==* Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Deleting a document from a collection is easyExecute the following command:<pre>>[[Commands#DELETE{{Code|DELETE]] xmarkjava -cp BaseX.xmljar org.basex.BaseXClient}}</pre>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.

Make sure that the collectionAt startup, which contains the '''xmark.xml''' document, is openedyou need to enter your credentials.

==Delete For further details, have a collection==Deleting a collection is look at the [[Command-Line_Options#Client|command-line options]] and the same as deleting a database[[Start_Scripts|start script]].

==Get server information==Several The BaseX command-line client provides similar features to the [[Command-Line Client|standalone client]]. The major difference is that all commands help to explore will be executed by the state of a BaseX serverinstance. For As a complete listconsequence, please visit paths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the [[Commands]] Sectionserver).

* Username and password can also be specified as command-line option. To see all databases evaluate commands without entering the console mode, you can use the <code>-c</code> option on the server, typecommand line:

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

* To see which database is currently opened:Database 'input' created in 13.85 ms.<preexample/>>[[Commands#SHOW DATABASES|SHOW DATABASES]]Query:</pre>

* To see the general information of the opened database, typeParsing:0.18 ms<pre>Compiling: 0.04 ms>[[Commands#INFO|INFO]]Evaluating: 0.12 ms</pre>Printing: 0.07 msTotal Time: 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

'''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.