Changes

It shows you how to run BaseX in client-server mode from a terminal. You can copy & and paste the all commands to get it 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 commands.

==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 First, launch a database==* To create a database you need an XML document, e.g. [http'''Server''' and '''Client''' instance of BaseX:double click on the '''BaseX Server//files.basex.org/xml/factbook.xml factbook.xml].* Save this document to Client''' icons, or run the directory you are working in.* In the client terminal, type in:<code>: basexserver</code> and <code> CREATE DB factbook factbook.xmlbasexclient</code>scripts. [[Startup#BaseX Server|Follow this link]] for more information (or check out the additional [[Command-Line Options#BaseX Server|command-line options]]).

If everything works you see the following lines:<pre>Database 'factbook' created in 950.83 ms.</pre> ; Where is the database stored?By default, databases are stored in The BaseX command-line client provides similar features to the <code>BaseXData</code> directory, which is located in your home folder.Depending on your [[ConfigurationStandalone Mode]], the location of your home folder varies. For example, on a Mac it's <code>/Users/John</code>, if your name The major difference is John. If you have used the Windows Installer, the directory that all commands will be named <code>data</code>, and reside in executed by the application directoryBaseX server instance. ==Execute As a query==The [[Commands#XQUERY|XQUERY]] command lets you run a query.* For exampleconsequence, this query returns all country nodes in paths/URIs to resources need to be resolvable by the currently opened database.<code>: > XQUERY //country</code> * You can also run queries in files:<code>: > RUN /Users/John/query.xq</code> ==Create a new database==Now we server (file contents will create another database from not be transfered to the [http://files.basex.org/xml/xmark.xml xmark.xml] document. * Create the new database, named 'xmark'.<code>: > CREATE DB xmark xmark.xml</code> * Set the new database xmark as the context:<code>: > OPEN xmark</code> * Now you can easily execute queries on your new database:<code>: > XQUERY //people/person/name</code> ==Switch the database==* You can explicitly query the factbook database with the <code>doc(...server)</code> funtion, no matter what the current context is.<code>: > XQUERY doc("factbook")//country</code> * Otherwise, to set factbook as the current context, execute the following:<code>: > OPEN factbook</code> * To list the current context, type:<code>: > SHOW DATABASES</code> That yields the following lines:

1 opened database(s):basexclient - factbook (1x)</pre> ==Close or delete a database==* To [[Commands|close]] the current context database, please type: <code>: > CLOSE</code> * Use the [[Commands#DROP|DROP]] command to delete the xmark database:<code>: > DROP V -Uadmin -Padmin -c "CREATE DB xmark</code> ==Create a collection=='''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. 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:<code>: > OPEN factbook</code> * Now add the xmark.xml document: <code>: > ADD xmark.xml</code> ==Delete a document==* Deleting a document from a collection is easy:<code>: > DELETE xmark.xml</code> Make sure that the collection, which contains the '''xmark.xml''' document, is opened. ==Delete a collection==Deleting a collection is the same as deleting a database. * To delete the collection factbook, type:<code>: > DROP 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>: > LIST</code> * To see which database is currently opened:<code>: > SHOW DATABASESinput <example/code> * To see the general information of the opened database, type:<code>: > INFO<; XQUERY /code> * To see the users in BaseX, type:<code>: > SHOW USERS</code> ==Backup and restore==To backup your database, type::<code>> BACKUP factbook</code>"

To restore your database, type:Database 'input' created in 13.85 ms.:<codeexample/>> RESTORE factbookQuery:</code>

The backup-file is stored in the database directory.The file is named <code>factbook-timestamp.zip</code> Hit(<code>db_name-timestamp.zip</code>s).: 1 ItemUpdated: 0 ItemsPrinted: 10 BytesRead Locking: local [input]To restore the database the file with the newest timestamp is taken.Write Locking: none