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 ''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> ==Switch the database==* You can explicitly query the factbook database with the <code>docBaseX HTTP Server (...Stop)</code> funtion''', no matter what you can shut down the current context isserver process.<code>> [[Commands#XQUERY|XQUERY]] doc("factbook")//country</code> * Otherwise, to set factbook as the current context, execute the following:<code>> [[Commands#OPEN|OPEN]] factbook</code> * To list the current context, type:<code>> [[Commands#SHOW|SHOW]] DATABASES</code>

That yields Unless you have already chosen an admin password yet (e.g., via the following linesWindows installer or a previous installation), you can do so by invoking the {{Command|PASSWORD}} command on your terminal:

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

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

* Use the Various [[CommandsCommand-Line_Options#DROPServer|DROPcommand-line options]] command are available to delete the xmark database:<code>> simplify batch processing. The [[Commands#DROP DATABASEStart_Scripts|DROP DBstart script]] xmark</code>can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).

==Create a collectionClient=='''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. Collections accept any type of XML documents, regardless of their structure.

* First make sure factbook is openedRun one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the following command:<code>> [[Commands#OPEN{{Code|OPEN]] factbookjava -cp BaseX.jar org.basex.BaseXClient}}</code>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.

* Now add the xmarkAt startup, you need to enter your credentials.xml document: <code>> [[Commands#ADD|ADD]] xmark.xml</code>

==Delete For further details, have a document==* Deleting a document from a collection is easy:<code>> look at the [[CommandsCommand-Line_Options#DELETEClient|command-line options]] and the [[Start_Scripts|DELETEstart script]] xmark.xml</code>

==Delete a collection==Deleting a collection The BaseX command-line client provides similar features to the [[Command-Line Client|standalone client]]. The major difference is that all commands will be executed by the same as deleting BaseX server instance. As a databaseconsequence, paths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).

* Username and password can also be specified as command-line option. To delete evaluate commands without entering the collection factbookconsole mode, type:you can use the <code>> [[Commands#DROP DATABASE|DROP DB]] factbook-c</code> ==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: <codepre>> [[Commands#LIST|LIST]]basexclient -V -Uadmin -P... -c "CREATE DB input <example/code>; XQUERY /"

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

* To see the general information of the opened database, typeParsing:0.18 ms<code>Compiling: 0.04 ms> [[Commands#INFO|INFO]]Evaluating: 0.12 ms</code>Printing: 0.07 msTotal Time: 0.41 ms

* To see the users in BaseX, typeHit(s):1 Item<code>Updated: 0 ItemsPrinted: 10 Bytes> Read Locking: local [[Commands#SHOW USERS|SHOW USERS]input]</code>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.