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 {{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.<code>> HTTP Server used for [[Commands#XQUERYWeb Application|XQUERYWeb Applications]] //country</code>and the database server. With '''BaseX HTTP Server (Stop)''', you can shut down the server process.

* You Unless you have already chosen an admin password yet (e.g., via the Windows installer or a previous installation), you can also run queries in filesdo so by invoking the {{Command|PASSWORD}} command on your terminal:<code>> [[Commands#RUN|RUN]] /Users/John/query.xq</code>

>basexserver -c PASSWORDBaseX [[Commands#CREATE DATABASE|CREATE DB]Server] xmark xmarkServer was started (port: 1984).xmlPassword: _

* Set By default, the new database xmark as server listens to the context:<pre>>[[Commands#OPENport {{Code|OPEN]] xmark</pre>1984}}. Pressing {{Code|Ctrl+c}} will close all connections and databases and gracefully shut down the server process.

* Now you can easily execute queries on your new database:<pre>>Various [[CommandsCommand-Line_Options#XQUERYServer|XQUERYcommand-line options]] //people/person/name</pre>are available to simplify batch processing. The [[Start_Scripts|start script]] can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).

==Switch the databaseClient==* 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 followingDatabase clients are started similarly:<pre>>[[Commands#OPEN|OPEN]] factbook</pre>

* To list Run one of the current context, type{{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the following command:<pre>>[[Commands#SHOW{{Code|SHOW]] DATABASESjava -cp BaseX.jar org.basex.BaseXClient}}</pre>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.

<pre>1 opened database(s):For further details, have a look at the [[Command- factbook (1x)</pre>Line_Options#Client|command-line options]] and the [[Start_Scripts|start script]].

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

* Use the [[Commands#DROP|DROP]] The BaseX command -line client provides similar features to delete the xmark database:<pre>>[[Commands#DROP DATABASECommand-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/pre>URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).

==Create a collection=='''What is a collection?'''With BaseX you Username and password can group documents into one logical collectionalso be specified as command-line option. A collection is a database that contains two or more documents. Collections accept any type of XML documentsTo evaluate commands without entering the console mode, regardless of their structure. Let's add you can use the xmark.xml document to <code>-c</code> option on the factbook database to create a collection. The name of the original factbook database remains.command line:* First make sure factbook is opened:

>[[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==* Deleting a document from a collection is easyParsing:<pre>>[[Commands#DELETE|DELETE]] xmark0.xml18 ms</pre> Make sure that the collection, which contains the '''xmark.xml''' document, is openedCompiling: 0.04 ms ==Delete a collection==Deleting a collection is the same as deleting a databaseEvaluating: 0.12 ms * To delete the collection factbook, typePrinting:<pre>>[[Commands#DROP DATABASE|DROP DB]] factbook</pre> ==Get server information==Several commands help to explore the state of a server. For a complete list, please visit the [[Commands]] Section0.07 ms * To see all databases on the server, typeTotal Time:<pre>>[[Commands#LIST|LIST]]</pre> * To see which database is currently opened:<pre>>[[Commands#SHOW DATABASES|SHOW DATABASES]]</pre>0.41 ms

* To see the general information of the opened database, typeHit(s):1 Item<pre>Updated: 0 ItemsPrinted: 10 Bytes>Read Locking: local [[Commands#INFO|INFO]input]</pre>Write Locking: none

* To see the users Query "user" executed in BaseX, type:<pre>>[[Commands#SHOW USERS|SHOW USERS]]0.41 ms.

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