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 {{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>

==Create a new database==<pre>Now we will create another database from the basexserver -c PASSWORDBaseX [httpServer]Server was started (port://files1984).basex.org/xmlPassword: _</xmark.xml xmark.xml] document.pre>

* Create By default, the new database, named 'xmark'server listens to the port {{Code|1984}}.<code>> [[Commands#CREATE DBPressing {{Code|CREATE DB]] xmark xmarkCtrl+c}} will close all connections and databases and gracefully shut down the server process.xml</code>

* Set the new database xmark as the context:<code>> Various [[CommandsCommand-Line_Options#OPENServer|command-line options]] are available to simplify batch processing. The [[Start_Scripts|OPENstart script]] xmark</code>can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).

* Otherwise, to set factbook as Run one of the current context, execute {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the followingcommand:<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.

==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: <code>> [[Commands#CLOSEStart_Scripts|CLOSEstart script]]</code>.

==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 Username and password can also be specified as command-line option. To evaluate commands without entering the xmarkconsole mode, you can use the <code>-c</code> option on the command line: <pre>basexclient -V -Uadmin -P.xml document to the factbook database to create a collection. The name of the original factbook database remains.-c "CREATE DB input <example/>; XQUERY /"

* First make sure factbook is opened:Database 'input' created in 13.85 ms.<codeexample/>> [[Commands#OPEN|OPEN]] factbookQuery:</code>

* Now add the xmarkParsing: 0.xml document18 msCompiling: 0.04 ms<code>Evaluating: 0.12 ms> [[Commands#ADD|ADD]] xmarkPrinting: 0.xml07 ms</code>Total Time: 0.41 ms

==Delete a document==Hit(s): 1 Item* Deleting a document from a collection is easyUpdated:0 Items<code>Printed: 10 Bytes> [Read Locking: local [Commands#DELETE|DELETEinput]] xmark.xml</code>Write Locking: none

Make sure that the collection, which contains the '''xmarkQuery "user" executed in 0.xml''' document, is opened41 ms. ==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 server. For a complete list, please visit the [[Commands]] Section. * To see all databases on the server, type:<code>> [[Commands#LIST|LIST]]</code> * To see the general information of the opened database, type:<code>> [[Commands#INFO|INFO]]</code> * To list all sessions that are managed by the server instance, 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.