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.

First, 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]]).==

* To create a The database you need an XML documentserver handles concurrent [[Transaction_Management|read and write transactions]], e.g. [http://files.basex.org/xml/factbook.xml factbook.xml[User Management|manages user permissions]].* Save this document to the directory you are working in.* In the client terminal, type in:<code>> and [[Commands#CREATE DBLogging|CREATE DBlogs user interactions]] factbook factbook.xml</code>It can be started as follows:

: * Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Use {{Code|basexserverstop}} or {{Code|basexserverstop.bat}} to gracefully shut down the server.* If you have installed BaseX on ''Windows'', click on the '''factbookBaseX HTTP Server (Start)''' is icon, which will start both the name of HTTP Server used for [[#Web Application|Web Applications]] and the database <br/>: server. With '''factbook.xmlBaseX HTTP Server (Stop)''' is the xml file, which is used to create you can shut down the database<br/> server process.

If everything works Unless you see have already chosen an admin password yet (e.g., via the Windows installer or a previous installation), you can do so by invoking the following lines{{Command|PASSWORD}} command on your terminal: <pre>Database 'factbook' created in 950.83 msbasexserver -c PASSWORDBaseX [Server]Server was started (port: 1984).Password: _

=Execute a query=The [[Commands#XQUERYBy default, the server listens to the port {{Code|XQUERY]] command lets you run a query1984}}.* For example, this query returns Pressing {{Code|Ctrl+c}} will close all country nodes in connections and databases and gracefully shut down the currently opened databaseserver process.<code>> [[Commands#XQUERY|XQUERY]] //country</code>

* You can also run queries in files:<code>> Various [[CommandsCommand-Line_Options#RUNServer|command-line options]] are available to simplify batch processing. The [[Start_Scripts|RUNstart script]] /Users/John/querycan be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).xq</code>

=Create a new database=Now we will create another database from the [http://files.basex.org/xml/xmark.xml xmark.xml] document.Client==

* Set Run one of the new database xmark as {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the contextfollowing command:<code>> [[Commands#OPEN{{Code|OPEN]] xmarkjava -cp BaseX.jar org.basex.BaseXClient}}</code>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.

* Now At startup, you can easily execute queries on need to enter your new database:<code>> [[Commands#XQUERY|XQUERY]] //people/person/name</code>credentials.

=Switch the database=* You can explicitly query the factbook database with the <code>doc(...)</code> funtionFor further details, no matter what have a look at the current context is.<code>> [[CommandsCommand-Line_Options#XQUERYClient|XQUERYcommand-line options]] doc("factbook")//country</code>and the [[Start_Scripts|start script]].

* The following BaseX command lists all databases than can be opened by -line client provides similar features to the currently logged in users:<code>> [[Commands#LISTCommand-Line Client|LISTstandalone client]]<. 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).

=Close or delete a database=* Username and password can also be specified as command-line option. To [[Commands|close]] evaluate commands without entering the current context databaseconsole mode, please type: you can use the <code>-c</code>option on the command line: <pre> [[Commands#CLOSE|CLOSE]]basexclient -V -Uadmin -P... -c "CREATE DB input <example/code>; XQUERY /"

* Use the [[Commands#DROP DB|DROP DB]] command to delete the xmark database:Database 'input' created in 13.85 ms.<codeexample/>> [[Commands#DROP DB|DROP DB]] xmarkQuery:</code>

=Create a collection=Parsing: 0.18 ms'''What is a collection?'''Compiling: 0.04 msWith BaseX you can group documents into one logical collectionEvaluating: 0. A collection is a database that contains two or more documents12 msPrinting: 0. Collections accept any type of XML documents, regardless of their structure07 msTotal Time: 0.41 ms

Let'Hit(s add the xmark.xml document to the factbook database to create a collection. The name of the original factbook database remains.): 1 ItemUpdated: 0 ItemsPrinted: 10 BytesRead Locking: local [input]Write Locking: none

* First make sure factbook is opened:<code>> [[Commands#OPEN|OPEN]] factbook</code> * Now add the xmark.xml document: <code>> [[Commands#ADD|ADD]] xmark.xml</code> =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 '''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.