Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
==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/Client''' icons, or run the <code>basexserver</files.basex.orgcode> and <code>basexclient</xml/factbookcode> scripts.xml factbook.xml[[Startup#BaseX Server|Follow this link]].* Save this document to the directory you are working in.* In for more information (or check out the client terminal, type in:<code>> additional [[CommandsCommand-Line Options#CREATE DATABASEBaseX Server|CREATE DBcommand-line options]] factbook factbook).xml</code>
: '''factbook''' is the name of the database <br/>: '''factbook.xml''' is the xml file, which is used to create the database<br/> ==Working on Command-Line==
If everything works you see The BaseX command-line client provides similar features to the following lines:<pre>Database 'factbook' created in 950.83 ms.</pre> ; Where is the database stored?By default, databases are stored in the <code>BaseXData</code> directory, which is located in your home folder.Depending on your [[ConfigurationStandalone Mode]], . The major difference is that all commands will be executed by the location of your home folder variesBaseX server instance. For exampleAs a consequence, on a Mac it's <code>paths/Users/John</code>, if your name is John. If you have used URIs to resources need to be resolvable by the Windows Installer, the directory server (file contents will not be named <code>data</code>, and reside in transfered to the application directoryserver).
==Execute a query==The [[Commands#XQUERY|XQUERY]] command lets you run a query.* For example, this query returns all country nodes in the currently opened database.<code>> [[Commands#XQUERY|XQUERY]] //country</code> * You Username and password 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 [http://files.basex.org/xml/xmarkbe specified as command-line option.xml xmark.xml] document. * Create To evaluate commands without entering the new databaseconsole mode, named 'xmark'.<code>> [[Commands#CREATE DATABASE|CREATE DB]] xmark xmark.xml</code> * Set the new database xmark as you can use the context:<code>> [[Commands#OPEN|OPEN]] xmark-c</code> * Now you can easily execute queries option on your new databasethe command line:<code>> [[Commands#XQUERY|XQUERY]] //people/person/name</code> ==Switch the database==* You can explicitly query the factbook database with the <code>doc(...)</code> funtion, no matter what the current context is.
>[[Commands#XQUERY|XQUERY]] doc(basexclient -V -Uadmin -Padmin -c "factbook")//countryCREATE DB input <example/pre>; XQUERY /"
* Otherwise, to set factbook as the current context, execute the following:<pre>>[[Commands#OPEN|OPEN]] factbook</pre> * To list the current context, type:<pre>>[[Commands#SHOW|SHOW]] DATABASES</pre> 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==Database 'input''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:<pre>>[[Commands#OPEN|OPEN]] factbook</pre> * Now add the xmark.xml document: <pre>>[[Commands#ADD|ADD]] xmark.xml</pre> ==Delete a document==* Deleting a document from a collection is easy:<pre>>[[Commands#DELETE|DELETE]] xmarkcreated in 13.xml</pre> Make sure that the collection, which contains the '''xmark85 ms.xml''' document, is opened. ==Delete a collection==Deleting a collection is the same as deleting a database. * To delete the collection factbook, type:<pre>>[[Commands#DROP DATABASE|DROP DB]] factbook<example/pre> ==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, typeQuery:<pre>>[[Commands#LIST|LIST]]</pre> * To see which database is currently opened:<pre>>[[Commands#SHOW DATABASES|SHOW DATABASES]]</pre> * To see the general information of the opened database, type:<pre>>[[Commands#INFO|INFO]]</pre> * To see the users in BaseX, type:<pre>>[[Commands#SHOW USERS|SHOW USERS]]</pre> ==Backup and restore==* To backup your database, type:<pre>> [[Commands#CREATE BACKUP|CREATE BACKUP]] factbook</pre> * To restore your database, type:<pre>> [[Commands#RESTORE|RESTORE]] factbook</pre>
'''Where is the backup-file stored?'''Parsing: 0.18 msCompiling: 0.04 msEvaluating: 0.12 msPrinting: 0.07 msTotal Time: 0.41 ms
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
==See also ==[[Standalone Mode]], [[GUI]], [[Getting Started]], [[Advanced Usage]][[Category:Beginner]][[Category:Server]]Query "user" executed in 0.41 ms.</pre>
no edit summary
It shows 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 commands.
<pre>
