Difference between revisions of "Database Server"

From BaseX Documentation
Jump to navigation Jump to search
(6 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
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.
 
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.
  
==Startup==
+
=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 database==
+
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 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 the name of the database <br/>
+
==Working on Command-Line==
: '''factbook.xml''' is the xml file, which is used to create the database<br/>     
 
  
If everything works you see the following lines:
+
The BaseX command-line client provides similar features to the [[Standalone Mode]]. The major difference is that all commands will be executed by the BaseX server instance. As a consequence, paths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).
<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 [[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>, and reside in the application directory.
 
  
==Execute a query==
+
Username and password can also be specified as command-line option. To evaluate commands without entering the console mode, you can use the <code>-c</code> option on the command line:
The [[Commands#XQUERY|XQUERY]] command lets you run a query.
+
* For example, this query returns all country nodes in the currently opened database.
+
<pre>
<code>
+
basexclient -V -Uadmin -Padmin -c "CREATE DB input <example/>; XQUERY /"
> [[Commands#XQUERY|XQUERY]] //country
 
</code>
 
  
* You can also run queries in files:
+
Database 'input' created in 13.85 ms.
<code>
+
<example/>
> [[Commands#RUN|RUN]] /Users/John/query.xq
+
Query:
</code>
+
/
  
==Create a new database==
+
Parsing: 0.18 ms
Now we will create another database from the [http://files.basex.org/xml/xmark.xml xmark.xml] document.
+
Compiling: 0.04 ms
 +
Evaluating: 0.12 ms
 +
Printing: 0.07 ms
 +
Total Time: 0.41 ms
  
* Create the new database, named 'xmark'.
+
Hit(s): 1 Item
<code>
+
Updated: 0 Items
> [[Commands#CREATE DB|CREATE DB]] xmark xmark.xml
+
Printed: 10 Bytes
</code>
+
Read Locking: local [input]
 +
Write Locking: none
  
* Set the new database xmark as the context:
+
Query "user" executed in 0.41 ms.</pre>
<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>doc(...)</code> funtion, no matter what the current context is.
 
<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>
 
 
 
* The following command lists all databases than can be opened by the currently logged in users:
 
<code>
 
> [[Commands#LIST|LIST]]
 
</code>
 
 
 
==Close or delete a database==
 
* To [[Commands|close]] the current context database, please type:
 
<code>
 
> [[Commands#CLOSE|CLOSE]]
 
</code>
 
 
 
* Use the [[Commands#DROP DB|DROP DB]] command to delete the xmark database:
 
<code>
 
> [[Commands#DROP DB|DROP 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>
 
> [[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 '''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>
 
> [[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
 
</code>
 
 
 
* To restore your database, type:
 
<code>
 
> [[Commands#RESTORE|RESTORE]] factbook
 
</code>
 
 
 
'''Where is the backup-file stored?'''
 
 
 
The backup-file is stored in the database directory.
 
The file is named <code>factbook-timestamp.zip</code> (<code>db_name-timestamp.zip</code>).
 
To restore the database the file with the newest timestamp is taken.
 
 
 
==See also ==
 
[[Standalone Mode]], [[GUI]], [[Getting Started]], [[Advanced Usage]]
 
[[Category:Beginner]]
 
[[Category:Server]]
 

Revision as of 14:53, 17 January 2016

This step by step tutorial is part of the Getting Started Guide. 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 section for a complete list of database commands.

Startup

First, launch a Server and Client instance of BaseX: double click on the BaseX Server/Client icons, or run the basexserver and basexclient scripts. Follow this link for more information (or check out the additional command-line options).

Working on Command-Line

The BaseX command-line client provides similar features to the Standalone Mode. The major difference is that all commands will be executed by the BaseX server instance. As a consequence, 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 evaluate commands without entering the console mode, you can use the -c option on the command line:

basexclient -V -Uadmin -Padmin -c "CREATE DB input <example/>; XQUERY /"

Database 'input' created in 13.85 ms.
<example/>
Query:
/

Parsing: 0.18 ms
Compiling: 0.04 ms
Evaluating: 0.12 ms
Printing: 0.07 ms
Total Time: 0.41 ms

Hit(s): 1 Item
Updated: 0 Items
Printed: 10 Bytes
Read Locking: local [input]
Write Locking: none

Query "user" executed in 0.41 ms.