Jump to navigation Jump to search
2,484 bytes removed ,  15 February
no edit summary
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. [ 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.83 msbat}} scripts.</pre> ; Where is Add the database stored?By default, databases are stored in {{Code|stop}} keyword to gracefully shut down 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 [ 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 the following lines: <pre>1 opened database(s):- factbook (1x)</pre> ==Close or delete a database==* To [[Commands|close]] the current context database, please type: <pre>>[[Commands#CLOSE|CLOSE]]</pre> * Use the [[Commands#DROP|DROP]] command to delete the xmark database:<pre>>[[Commands#DROP DATABASE|DROP DB]] xmark</pre>
==Create a collection=='''What is a collection?'''With BaseX you can group documents into one logical collectionBy default, the server listens to the port {{Code|1984}}. A collection is a database that contains two or more documents. Collections accept any type of XML documents, regardless of their structurePressing {{Code|Ctrl+c}} will close all connections and databases and gracefully shut down the server process.
Let's add the xmark.xml document to the factbook database Various [[Command-Line_Options#Server|command-line options]] are available to create a collectionsimplify batch processing. The name of [[Start_Scripts|start script]] can be adjusted for individual purposes (e.g. if the original factbook database remainsdefault memory limit is too restrictive).
* First make sure factbook is opened:<pre>>[[Commands#OPEN|OPEN]] factbook</pre> * Now add the xmark.xml document: <pre>>[[Commands#ADD|ADD]] xmark.xml</pre>==Client==
==Delete a document==* Deleting a document from a collection is easyDatabase clients are started similarly:<pre>>[[Commands#DELETE|DELETE]] xmark.xml</pre>
Make sure that * Run one of the collection{{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXClient}}* If you have installed BaseX on ''Windows'', which contains click on the '''xmark.xmlBaseX Client''' document, is openedicon.
==Delete a collection==Deleting a collection At startup, you need to enter your credentials. The initial passwort of the {{Code|admin}} user is {{Code|admin}}; it can be changed with the same as deleting a database{{Code|[[Commands#PASSWORD|PASSWORD]]}} command.
* To delete For further details, have a look at the collection factbook, type:<pre>>[[CommandsCommand-Line_Options#DROP DATABASEClient|command-line options]] and the [[Start_Scripts|DROP DBstart script]] factbook</pre>.
=Introduction=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 BaseX command-line client provides similar features to the server, type:<pre>>[[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/pre>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 see which database is currently openedevaluate commands without entering the console mode, you can use the <code>-c</code> option on the command line:
>[[Commands#SHOW DATABASES|SHOW DATABASES]]basexclient -V -Uadmin -Padmin -c "CREATE DB input <example/pre>; XQUERY /"
* To see the general information of the opened database, type:Database 'input' created in 13.85 ms.<preexample/>>[[Commands#INFO|INFO]]Query:</pre>
* To see the users in BaseX, typeParsing:0.18 ms<pre>Compiling: 0.04 ms>[[Commands#SHOW USERS|SHOW USERS]]Evaluating: 0.12 ms</pre>Printing: 0.07 msTotal Time: 0.41 ms
==Backup and restore==Hit(s): 1 Item* To backup your database, typeUpdated:0 Items<pre>Printed: 10 Bytes> [Read Locking: local [Commands#CREATE BACKUP|CREATE BACKUPinput]] factbook</pre>Write Locking: none
* To restore your database, type:<pre>> [[Commands#RESTORE|RESTORE]] factbookQuery "user" executed in 0.41 ms.
'''Where is the backup-file stored?''' The backup-file is stored in the database directory.The file is named <code></code> (<code></code>).To restore the database the file with the newest timestamp is taken.=Language Bindings=
==See also ==[[Standalone Mode]], [[GUI]], [[Getting Started]]If you want to communicate with the database server programmatically, we provide clients for various [[Advanced Usage]][[Category:Beginner]][[Category:ServerClients|programming languages]].
Bureaucrats, editor, reviewer, Administrators


Navigation menu