Difference between revisions of "Database Server"

From BaseX Documentation
Jump to navigation Jump to search
m (Reverted edits by AW (talk) to last revision by CG)
Line 1: Line 1:
 
This step by step tutorial shows you how to run BaseX in client-server mode from a terminal.  You can copy & paste the commands to get it 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.
 
This step by step tutorial shows you how to run BaseX in client-server mode from a terminal.  You can copy & paste the commands to get it 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.
−
 
−
The server/client environment of BaseX offers the following features:
 
−
* ACID safe transactions, with multiple readers and single writers
 
−
* User management with global and local permissions
 
−
* Password authentication via cram-md5
 
−
* Logging of server activity
 
−
 
−
If you run BaseX for the first time, a default admin user is created:
 
−
* <b>Username:</b> <code>admin</code>
 
−
* <b>Password:</b> <code>admin</code>
 
−
 
−
The password can be changed using the <code>[[Commands#PASSWORD|PASSWORD]]</code> command
 
−
or the GUI server dialog.
 
−
 
−
The BaseX server can be started via the GUI server dialog or, as shown in the [[Startup Overview]].
 
  
 
==Startup==
 
==Startup==
Line 20: Line 5:
  
 
==First Operations==
 
==First Operations==
−
To get to know BaseX, we advise to run some of the following operations to see how it works and
+
To get familiar with BaseX we suggest to execute the following basic operations.
−
get your first indentations.
 
  
 
===Create a database===
 
===Create a database===
−
In order to create a database you need a xml-document, e.g.  
+
* To create a database you need an XML document, e.g. [http://www.w3.org/XML/Binary/2005/03/test-data/Over100/factbook.xml factbook.xml].
−
[http://www.w3.org/XML/Binary/2005/03/test-data/Over100K/factbook.xml factbook.xml].<br/>
+
* Save this document to the /basex directory.
−
Save this document to the /basex directory.
+
* On the client terminal run:
−
On the client terminal run:
+
<code>
−
:<code>
+
: > create db factbook factbook.xml
−
> create db factbook factbook.xml
 
 
</code>
 
</code>
−
<br/>
 
−
''factbook'' - is the name of the database <br/>
 
−
''factbook.xml''  - is the xml file, which is used to create the database<br/>     
 
  
−
If everything works, this message will appear, the time might differ.
+
: ''factbook'' - is the name of the database <br/>
 +
: ''factbook.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 1950.83 ms.
 
<pre>Database 'factbook' created in 1950.83 ms.
 
</pre>
 
</pre>
 
 
−
;Where is the database stored?
+
; Where is the database stored?
−
It is stored in the BaseXData directory in your home directory.
+
Databases are stored in the BaseXData directory which is located in your home folder. Depending on your operating system the location of your home folder varies. For example, on a mac it's /Users/John, if your name is John.
−
In my case it's in /Users/JohnDoe/BaseXData/factbook.
 
  
 
===Execute a query===
 
===Execute a query===
−
To run a query the xquery command is used. After '''xquery'''  you can insert
+
The [[Commands|xquery]] command lets you run a query.
−
any valid xquery you like. <br/>
+
* For example, this query returns all country nodes in the currently opened database.
−
This query returns all the countries in the database.
+
<code>
−
:<code>
+
: > xquery //country
−
> xquery //country
 
 
</code>
 
</code>
−
<br/>
 
  
−
If you wish, you can also save your query in a file, and run it on basex.
+
* You can also run queries in files:
−
:<code>
+
<code>
−
> run /pathToQuery/query.txt
+
: > run /Users/John/query.xq
 
</code>
 
</code>
  
−
===Create another database, switch between databases===
+
===Create a new database===
−
Now we will create an another database. You can get the xml document from here [http://phobos101.inf.uni-konstanz.de/basex/demo].
+
Now we will create another database. You can find the example document here: [http://phobos101.inf.uni-konstanz.de/basex/demo].
−
:<code>
+
 
−
> create db xmark xmark.xml
+
* Create the new database, named 'xmark'.
 +
<code>
 +
: > create db xmark xmark.xml
 
</code>
 
</code>
  
−
To set the new database xmark as the context (the active, opened database), use:
+
* Set the new database xmark as the context:
−
:<code>
+
<code>
−
> open xmark
+
: > open xmark
 
</code>
 
</code>
  
−
Now you can simply type your xquery:
+
* Now you can easily execute queries on your new database:
−
:<code>
+
<code>
−
> xquery //people/person/name
+
: > xquery //people/person/name
 
</code>
 
</code>
  
−
If you want to query the factbook database you can access it by explicitly naming it with the doc()-function.
+
===Switch the database===
−
:<code>
+
* You can explicitly query the factbook database with the doc()-funtion, no matter what the current context is.
−
> xquery doc("factbook")//country
+
<code>
 +
: > xquery doc("factbook")//country
 
</code>
 
</code>
  
−
If you want to set the factbook database as the context, you can use:
+
* Otherwise, to set factbook as the current context, execute the following:
−
:<code>
+
<code>
−
> open factbook
+
: > open factbook
 
</code>
 
</code>
  
−
To see which database is opened, use:
+
* To list the current context, type:
−
:<code>
+
<code>
−
> show databases
+
: > show databases
 
</code>
 
</code>
 +
 +
That yields the following lines:
 +
 +
<pre>
 +
1 opened database(s):
 +
- factbook (1x)
 +
</pre>
  
 
===Close or delete a database===
 
===Close or delete a database===
−
If you want to close the opened database, simple type:
+
* To [[Commands|close]] the current context database type:  
−
:<code>
+
<code>
−
> close
+
: > close
 
</code>
 
</code>
  
−
If you want to delete the xmark database, use:
+
* Use the [[Commands|drop]] command to delete the xmark database:
−
:<code>
+
<code>
−
> drop db xmark
+
: > drop db xmark
 
</code>
 
</code>
  
 
===Create a collection===
 
===Create a collection===
 
'''What is a collection?'''
 
'''What is a collection?'''
−
With BaseX you can group documents into one logical 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.
−
A collection is a database that contains two or more documents.
 
−
You can put any type of XML documents into the collection, regardless
 
−
of their structure.
 
  
−
Now we will add the xmark.xml document to the factbook database,
+
Let's add the xmark.xml document to the factbook database to create a collection. The name of the original factbook database remains.
−
and thus create a collection. The collection will keep the name factbook.
 
  
−
First make sure factbook is opened:
+
* First make sure factbook is opened:
−
:<code>
+
<code>
−
> open factbook
+
: > open factbook
 
</code>
 
</code>
  
−
Now add the xmark.xml document:  
+
* Now add the xmark.xml document:  
−
:<code>
+
<code>
−
> add xmark.xml
+
: > add xmark.xml
 
</code>
 
</code>
  
 
===Delete a document from a collection===
 
===Delete a document from a collection===
−
Deleting a document from a collection is very easy, just type:
+
* Deleting a document from a collection is very easy:
−
:<code>
+
<code>
−
> delete xmark.xml
+
: > delete xmark.xml
 
</code>
 
</code>
  
−
N.B. The collection has to be the context i.e. the database which
+
Make sure the collection which contains the xmark.xml document is opened.
−
contains the document has to be opened.
 
  
 
===Delete a collection===
 
===Delete a collection===
 
Deleting a collection is the same as deleting a database.
 
Deleting a collection is the same as deleting a database.
−
If you want to delete the collection factbook, type:
+
 
−
:<code>
+
* To delete the collection factbook, type:
−
> drop factbook
+
<code>
 +
: > drop factbook
 
</code>
 
</code>
  
−
===Getting information about the server===
+
===Get information about the server===
−
To see all databases in BaseX, type:
+
Several commands help to explore the state of a server. For a complete list visit the [[Commands|commands section]].
−
:<code>
+
 
−
> list
+
* To see all databases on the server, type:
 +
<code>
 +
: > list
 
</code>
 
</code>
  
−
To see which database is currently opened, type:
+
* To see which database is currently opened:
−
:<code>
+
<code>
−
> show databases
+
: > show databases
 
</code>
 
</code>
  
−
To see the general information of the opened database, type:
+
* To see the general information of the opened database, type:
−
:<code>
+
<code>
−
> info
+
: > info
 
</code>
 
</code>
  
−
To see the users in BaseX, type:
+
* To see the users in BaseX, type:
−
:<code>
+
<code>
−
> show users
+
: > show users
 
</code>
 
</code>
  
−
===Backup and Restrore===
+
===Backup and Restore===
 
To backup your database, type:
 
To backup your database, type:
 
:<code>
 
:<code>
Line 167: Line 155:
 
</code>
 
</code>
  
−
'''Where is the backup file stored?'''
+
'''Where is the backup-file stored?'''
  
−
The backup-file is stored in the BaseXData directory, which is in your home directory.
+
The backup-file is stored in the database directory.
−
The file is named factbook-timestamp.zip (db_name-timestamp.zip).
+
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.
 
To restore the database the file with the newest timestamp is taken.
  

Revision as of 11:51, 12 January 2011

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

See the Startup Overview.

First Operations

To get familiar with BaseX we suggest to execute the following basic operations.

Create a database

  • To create a database you need an XML document, e.g. factbook.xml.
  • Save this document to the /basex directory.
  • On the client terminal run:

> create db factbook factbook.xml

factbook - is the name of the database
factbook.xml - is the xml file, which is used to create the database

If everything works you see the following lines: 

Database 'factbook' created in 1950.83 ms.
Where is the database stored?

Databases are stored in the BaseXData directory which is located in your home folder. Depending on your operating system the location of your home folder varies. For example, on a mac it's /Users/John, if your name is John.

Execute a query

The xquery command lets you run a query.

  • For example, this query returns all country nodes in the currently opened database.

> xquery //country

  • You can also run queries in files:

> run /Users/John/query.xq

Create a new database

Now we will create another database. You can find the example document here: [1].

  • Create the new database, named 'xmark'.

> create db xmark xmark.xml

  • Set the new database xmark as the context:

> open xmark

  • Now you can easily execute queries on your new database:

> xquery //people/person/name

Switch the database

  • You can explicitly query the factbook database with the doc()-funtion, no matter what the current context is.

> xquery doc("factbook")//country

  • Otherwise, to set factbook as the current context, execute the following:

> open factbook

  • To list the current context, type:

> show databases

That yields the following lines: 

1 opened database(s):
- factbook (1x)

Close or delete a database

  • To close the current context database type:

> close

  • Use the drop command to delete the xmark database:

> drop db xmark

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:

> open factbook

  • Now add the xmark.xml document:

> add xmark.xml

Delete a document from a collection

  • Deleting a document from a collection is very easy:

> delete xmark.xml

Make sure 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:

> drop factbook

Get information about the server

Several commands help to explore the state of a server. For a complete list visit the commands section.

  • To see all databases on the server, type:

> list

  • To see which database is currently opened:

> show databases

  • To see the general information of the opened database, type:

> info

  • To see the users in BaseX, type:

> show users

Backup and Restore

To backup your database, type:

> backup factbook

To restore your database, type:

> restore factbook

Where is the backup-file stored?

The backup-file is stored in the database directory. The file is named factbook-timestamp.zip (db_name-timestamp.zip). To restore the database the file with the newest timestamp is taken.

See also

Standalone Tutorial, GUI Tutorial, Getting Started, Advanced User Portal

Retrieved from "http://docs.basex.org/index.php?title=Database_Server&oldid=1585"