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 [[Command-Line 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 DB|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?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 directory will be named <code>data</code>, and reside in can shut down the application directoryserver process.

==Execute a query==The [[Commands#XQUERY|XQUERY]] command lets Unless you run have already chosen an admin password yet (e.g., via the Windows installer or a query.* For exampleprevious installation), this query returns all country nodes in you can do so by invoking the currently opened database.<code>> [[Commands#XQUERY{{Command|XQUERY]] //country</code>PASSWORD}} command on your terminal:

* You can also run queries in files:<codepre>> basexserver -c PASSWORDBaseX [[Commands#RUN|RUNServer]] /Users/John/queryServer was started (port: 1984).xqPassword: _</codepre>

==Create a new database==Now we By default, the server listens to the port {{Code|1984}}. Pressing {{Code|Ctrl+c}} will create another database from close all connections and databases and gracefully shut down the [http://files.basex.org/xml/xmark.xml xmark.xml] documentserver process.

* Create the new database, named 'xmark'Various [[Command-Line_Options#Server|command-line options]] are available to simplify batch processing.<code>> The [[Commands#CREATE DBStart_Scripts|CREATE DBstart script]] xmark xmarkcan be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).xml</code>

* Now you can easily execute queries on your new databaseDatabase clients are started similarly:<code>> [[Commands#XQUERY|XQUERY]] //people/person/name</code>

==Switch * Run one of the database=={{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* You can explicitly query Execute the factbook database with the <code>doc(following command: {{Code|java -cp BaseX.jar org.basex.)</code> funtionBaseXClient}}* If you have installed BaseX on ''Windows'', no matter what click on the current context is'''BaseX Client''' icon.<code>> [[Commands#XQUERY|XQUERY]] doc("factbook")//country</code>

* OtherwiseAt startup, you need to set factbook as the current context, execute the following:<code>> [[Commands#OPEN|OPEN]] factbook</code>enter your credentials.

* The following For further details, have a look at the [[Command-Line_Options#Client|command lists all databases than can be opened by -line options]] and the currently logged in users:<code>> [[Commands#LISTStart_Scripts|LISTstart script]]</code>.

=Introduction=Close or delete a database==* To [[Commands|close]] the current context database, please type: <code>> [[Commands#CLOSE|CLOSE]]</code>

* Use the [[Commands#DROP DB|DROP DB]] The BaseX command -line client provides similar features to delete the xmark database:<code>> [[Commands#DROP DBCommand-Line Client|DROP DBstandalone client]] xmark<. The major difference is that all commands will be executed by the BaseX server instance. As a consequence, paths/code>URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).

==Create a collection==Username 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:'''What is a collection?''' With BaseX you can group documents into one logical collection<pre>basexclient -V -Uadmin -P. A collection is a database that contains two or more documents. Collections accept any type of XML documents, regardless of their structure.-c "CREATE DB input <example/>; XQUERY /"

LetDatabase 's add the xmark.xml document to the factbook database to create a collectioninput' created in 13. The name of the original factbook database remains85 ms.<example/>Query:/

* First make sure factbook is openedParsing:0.18 ms<code>Compiling: 0.04 ms> [[Commands#OPEN|OPEN]] factbookEvaluating: 0.12 ms</code>Printing: 0.07 msTotal Time: 0.41 ms

* Now add the xmark.xml documentHit(s): 1 Item<code>Updated: 0 ItemsPrinted: 10 Bytes> Read Locking: local [[Commands#ADD|ADDinput]] xmark.xml</code>Write Locking: none

==Delete a document==* Deleting a document from a collection is easy:<code>> [[Commands#DELETE|DELETE]] xmark.xml</code> Make sure that the collection, which contains the '''xmark.xml''' document, is opened. ==Delete a collection==Deleting a collection is the same as deleting a database. * To delete the collection factbook, type:<code>> [[Commands#DROP DB|DROP DB]] factbook</code> ==Get server information==Several commands help to explore the state of a serverQuery "user" executed in 0. For a complete list, please visit the [[Commands]] Section41 ms. * To see all databases on the server, type:<code>> [[Commands#LIST|LIST]]</code> * To see which database is currently opened:<code>> [[Commands#SHOW DATABASES|SHOW DATABASES]]</code> * To see the general information of the opened database, type:<code>> [[Commands#INFO|INFO]]</code> * To see the users in BaseX, type:<code>> [[Commands#SHOW USERS|SHOW USERS]]</code> ==Backup and restore==* To backup your database, type:<code>> [[Commands#CREATE BACKUP|CREATE BACKUP]] factbook</codepre>

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