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 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 files:<pre>do so by invoking the {{Command|PASSWORD}} command on your terminal: > [[Commands#RUN|RUN]] /Users/John/query.xq</pre>

: > basexserver -c PASSWORDBaseX [[Commands#CREATE DATABASE|CREATE DBServer]] 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 following:<pre>: > [[Commands#OPEN|OPEN]] factbook</pre>

* To list the current context, typeDatabase clients are started similarly:<pre>: > [[Commands#SHOW|SHOW]] DATABASES</pre>

That yields * Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the following linescommand:{{Code|java -cp BaseX.jar org.basex.BaseXClient}}* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.

==Close or delete For further details, have a database==* To look at the [[CommandsCommand-Line_Options#Client|closecommand-line options]] and the current context database, please type: <pre>: > [[Commands#CLOSEStart_Scripts|CLOSEstart script]]</pre>.

==Create a collection=='''What is a collection?'''With The BaseX you can group documents into one logical collectioncommand-line client provides similar features to the [[Command-Line Client|standalone client]]. A collection The major difference is a database that contains two or more documentsall commands will be executed by the BaseX server instance. Collections accept any type of XML documentsAs a consequence, regardless of their structurepaths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).

Let's add the xmark.xml document to the factbook database to create a collection. The name of the original factbook database remains. * First make sure factbook is opened:<pre>: > [[Commands#OPEN|OPEN]] factbook</pre> * Now add the xmark.xml document: <pre>: > [[Commands#ADD|ADD]] xmark.xml</pre> ==Delete a document==* Deleting a document from a collection is easy:<pre>: > [[Commands#DELETE|DELETE]] xmark.xml</pre> Make sure that the collection, which contains the '''xmark.xml''' document, is opened. ==Delete a collection==Deleting a collection is the same Username and password can also be specified as deleting a databasecommand-line option. * To delete evaluate commands without entering the collection factbookconsole mode, type:you can use the <precode>: > [[Commands#DROP DATABASE|DROP DB]] factbook-c</precode> ==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 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/>Query: > [[Commands#SHOW DATABASES|SHOW DATABASES]]</pre>

* To see the general information of the opened database, typeParsing:0.18 ms<pre>Compiling: 0.04 msEvaluating: 0.12 msPrinting: > [[Commands#INFO|INFO]]0.07 ms</pre>Total Time: 0.41 ms

* To see the users in BaseX, typeHit(s):1 Item<pre>Updated: 0 ItemsPrinted: 10 BytesRead 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.