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 default, databases are stored in the <code>BaseXData</code> directory, which is located in your home folder.Depending on your server handles concurrent [[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 Windows Installer, the directory will be named <code>data</code>, Transaction_Management|read and reside in the application directory. ==Execute a query==The [[Commands#XQUERY|XQUERYwrite transactions]] command lets you run a query.* For example, this query returns all country nodes in the currently opened database.<code>> [[Commands#XQUERYUser Management|XQUERYmanages user permissions]] //country</code> * You can also run queries in files:<code>> and [[Commands#RUNLogging|RUNlogs user interactions]] /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 'xmark'.<code>> [[Commands#CREATE DB|CREATE DB]] xmark xmark.xml</code> * Set the new database xmark It can be started as the context:<code>> [[Commands#OPEN|OPEN]] xmark</code> * Now you can easily execute queries on your new databasefollows:<code>> [[Commands#XQUERY|XQUERY]] //people/person/name</code>

==Switch * Run one of the database=={{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Use {{Code|basexserverstop}} or {{Code|basexserverstop.bat}} to gracefully shut down the server.* You can explicitly query If you have installed BaseX on ''Windows'', click on the factbook database with the <code>doc'''BaseX HTTP Server (...Start)</code> funtion''' icon, no matter what which will start both the current context is.<code>> HTTP Server used for [[Commands#XQUERYWeb Application|XQUERYWeb Applications]] docand the database server. With '''BaseX HTTP Server ("factbook"Stop)//country</code>''', you can shut down the server process.

* OtherwiseUnless you have already chosen an admin password yet (e.g., to set factbook as via the current contextWindows installer or a previous installation), execute you can do so by invoking the following{{Command|PASSWORD}} command on your terminal:<code>> [[Commands#OPEN|OPEN]] factbook</code>

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#DROP DBServer|DROP DBcommand-line options]] command are available to delete the xmark database:<code>> simplify batch processing. The [[Commands#DROP DBStart_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, typeyou can use the <code>-c</code> option on the command line: <codepre>> [[Commands#DROP DB|DROP basexclient -V -Uadmin -P... -c "CREATE DB]] factbookinput <example/code>; XQUERY /"

==Get server information==Several commands help to explore the state of a serverDatabase 'input' created in 13. For a complete list, please visit the [[Commands]] Section85 ms.<example/>Query:/

* To see all databases on the server, typeParsing:0.18 ms<code>Compiling: 0.04 ms> [[Commands#LIST|LIST]]Evaluating: 0.12 ms</code>Printing: 0.07 msTotal Time: 0.41 ms

* To see which database is currently openedHit(s):1 Item<code>Updated: 0 ItemsPrinted: 10 Bytes> Read Locking: local [[Commands#SHOW DATABASES|SHOW DATABASES]input]</code>Write Locking: none

* To see the general information of the opened database, type:<code>> [[Commands#INFO|INFO]]</code> * To see the users Query "user" executed in BaseX, type:<code>> [[Commands#SHOW USERS|SHOW USERS]]</code> ==Backup and restore==* To backup your database, type:<code>> [[Commands#CREATE BACKUP|CREATE BACKUP]] factbook0.41 ms.</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.