Changes

<p>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 BaseX commandscommand-line.</p>

==RequirementsServer==Java 1.6 is required to run newer versions of BaseX. If you need help installing Java please visit[http://www.java.com/en/download/help/download_options.xml java.com]. <br/>We assume that you are familiar with a shell at a basic level.

===Download===Download the The database server handles concurrent [http://www.inf.uni-konstanz.de/dbis/basex/download basex.jar[Transaction_Management|read and write transactions]], [[User Management|manages user permissions]] and [[Logging|logs user interactions]]. <br/>We assume that the basex.jar file is located in ''/basex''.It can be started as follows:

===Starting * Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Add the Server===#Navigate {{Code|stop}} keyword to gracefully shut down the location of basexserver.jar * If you have installed BaseX on ''Windows'', click on the '''BaseX HTTP Server (<code>> cd /basex</code>Start)''' icon, which will start both the HTTP Server used for [[#Web Application|Web Applications]] and the database server.#Execute: :<code>> java -cp With '''BaseXHTTP Server (Stop)''', you can shut down the server process.jar org.basex.BaseXServer</code>

A By default admin user is created: <br/>Username: admin<br/>Password: admin<br/>The password can be changed using the password command.<br/> Adding the <code>-i</code> flag lets you interact (execute commands, add databases or users) with the server during runtimelistens to the port {{Code|1984}}.:<pre>> java -cp BaseX.jar org.basex.BaseXServer -i</pre> Once Pressing {{Code|Ctrl+c}} will close all connections and databases and gracefully shut down the server is successfully started you see the following lines::<pre>BaseXServer [Server]&#10;Server was startedprocess.</pre>

===Starting the Client===Various [[Command-Line_Options#Open a new terminal window, make sure you Server|command-line options]] are in the right directoryavailable to simplify batch processing.#Execute::<code>> java -cp BaseXThe [[Start_Scripts|start script]] can be adjusted for individual purposes (e.jar orgg.basex.BaseXClient</code><br/>#If you haven't changed the password with if the server, you can login as default user (admin/adminmemory limit is too restrictive).

==First OperationsClient==To get familiar with BaseX we suggest to execute the following basic operations.

===Create a database===To create a database you need an XML document, e.g. [httpDatabase clients are started similarly://www.w3.org/XML/Binary/2005/03/test-data/Over100K/factbook.xml factbook.xml].<br/>Save this document to the /basex directory.On the client terminal run: :<code>> create db factbook factbook.xml</code><br/>''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 * Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the following linescommand:{{Code|java -cp BaseX.jar org.basex.BaseXClient}}<pre>Database * If you have installed BaseX on 'factbook' created in 1950.83 ms.</pre> ;Where is Windows'', click on the database stored?It is stored in the BaseXData directory in your home directory.In my case it's in /Users/JohnDoe/BaseXData/factbook''BaseX Client''' icon.

===Execute a query===To run a query At startup, you need to enter your credentials. The initial passwort of the xquery command {{Code|admin}} user is used. After '''xquery''' you {{Code|admin}}; it can insertany valid xquery you like. <br/>This query returns all be changed with the countries in the database{{Code|[[Commands#PASSWORD|PASSWORD]]}} command.:<code> > xquery //country</code><br/>

If you wishFor further details, you can also save your query in have a file, look at the [[Command-Line_Options#Client|command-line options]] and run it on basex.:<code>> run /pathToQuery/querythe [[Start_Scripts|start script]].txt</code>

=Introduction==Create an another database / switch between databases===Now we will create an another database. You can get the xml document from here [http://phobos101.inf.uni-konstanz.de/basex/demo].:<code>> create db xmark xmark.xml</code>

To set The BaseX command-line client provides similar features to the new database xmark as [[Command-Line Client|standalone client]]. The major difference is that all commands will be executed by the context BaseX server instance. As a consequence, paths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the active, opened databaseserver), use::<code>> open xmark</code>.

Now Username and password can also be specified as command-line option. To evaluate commands without entering the console mode, you can simply type your xquery::use the <code>-c</code>option on the command line: <pre> xquery //people/person/namebasexclient -V -Uadmin -Padmin -c "CREATE DB input <example/code>; XQUERY /"

If you want to query the factbook database you can access it by explicitly naming it with the doc()-functionDatabase 'input' created in 13.85 ms.:<codeexample/> > xquery doc("factbook")//countryQuery:</code>

If you want to set the factbook database as the context, you can useParsing:0.18 msCompiling:<code>0.04 ms> open factbookEvaluating: 0.12 msPrinting: 0.07 ms</code>Total Time: 0.41 ms

To see which database is opened, useHit(s):1 ItemUpdated:<code>0 Items> show databasesPrinted: 10 BytesRead Locking: local [input]</code>Write Locking: none

===Close or delete a database===If you want to close the opened database, simply type::<code>> close</code> If you want to delete the xmark database, use::<code>> drop db xmark</code> ===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.You can put any type of XML documents into the collection, regardlessof their structure. Now we will add the xmark.xml document to the factbook database,and thus create a collection. The collection will keep the name factbook. First make sure factbook is opened::<code>> open factbook</code> Now add the xmark.xml document: :<code>> add xmark.xml</code> ===Delete a document from a collection===Deleting a document from a collection is very easy, just type::<code>> delete xmark.xml</code> N.B. The collection has to be the context i.e. the database whichcontains the document has to be openedQuery "user" executed in 0. ===Delete a collection===Deleting a collection is the same as deleting a database41 ms.If you want to delete the collection factbook, type::<code>> drop factbook</codepre> ===Getting information about the server===To see all databases on the server, type::<code>> list</code> To see which database is currently opened, type::<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 ==[[BaseX Standalone]], [[BaseX GUI]], [[Getting Started Guide]]If you want to communicate with the database server programmatically, we provide clients for various [[Advanced User Portal]][[Category:Beginner]][[Category:ServerClients|programming languages]].