Difference between revisions of "Database Server"

From BaseX Documentation
Jump to navigation Jump to search
(86 intermediate revisions by 5 users not shown)
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 article belongs to the [[Getting Started]] Guide. It tells you how to run BaseX in client-server mode from command-line.
  
The server/client environment of BaseX offers the following features:
+
=Startup=
* 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
+
==Server==
or the GUI server dialog.
 
  
The BaseX server can be started via the GUI server dialog or, as shown in the [[Startup Overview]].
+
The database 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:
  
==Startup==
+
* Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Add the {{Code|stop}} keyword to gracefully shut down the server.
See the [[Startup Overview]].
+
* If you have installed BaseX on ''Windows'', click on the '''BaseX HTTP Server (Start)''' icon, which will start both the HTTP Server used for [[#Web Application|Web Applications]] and the database server. With '''BaseX HTTP Server (Stop)''', you can shut down the server process.
  
==First Operations==
+
By default, the server listens to the port {{Code|1984}}. Pressing {{Code|Ctrl+c}} will close all connections and databases and gracefully shut down the server process.
To get to know BaseX, we advise to run some of the following operations to see how it works and
 
get your first indentations.
 
  
===Create a database===
+
Various [[Command-Line_Options#Server|command-line options]] are available to simplify batch processing. The [[Start_Scripts|start script]] can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).
In order to create a database you need a xml-document, e.g.
 
[http://www.w3.org/XML/Binary/2005/03/test-data/Over100K/factbook.xml factbook.xml].<br/>
 
Save this document to the /basex directory.
 
On the client terminal run:
 
:<code>
 
> create db factbook factbook.xml
 
</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.
+
==Client==
<pre>Database 'factbook' created in 1950.83 ms.
 
</pre>
 
 
;Where is the database stored?
 
It is stored in the BaseXData directory in your home directory.
 
In my case it's in /Users/JohnDoe/BaseXData/factbook.
 
  
===Execute a query===
+
Database clients are started similarly:
To run a query the xquery command is used. After '''xquery'''  you can insert
 
any valid xquery you like. <br/>
 
This query returns all the countries in the database.
 
:<code>
 
> xquery //country
 
</code>
 
<br/>
 
  
If you wish, you can also save your query in a file, and run it on basex.
+
* Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.
:<code>
+
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXClient}}
> run /pathToQuery/query.txt
+
* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.
</code>
 
  
===Create another database, switch between databases===
+
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 {{Code|[[Commands#PASSWORD|PASSWORD]]}} command.
Now we will create an another database. You can get the xml document from here [http://phobos101.inf.uni-konstanz.de/basex/demo].
 
:<code>
 
> create db xmark xmark.xml
 
</code>
 
  
To set the new database xmark as the context (the active, opened database), use:
+
For further details, have a look at the [[Command-Line_Options#Client|command-line options]] and the [[Start_Scripts|start script]].
:<code>
 
> open xmark
 
</code>
 
  
Now you can simply type your xquery:
+
=Introduction=
:<code>
 
> xquery //people/person/name
 
</code>
 
  
If you want to query the factbook database you can access it by explicitly naming it with the doc()-function.
+
The BaseX command-line client provides similar features to the [[Command-Line Client|standalone client]]. 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).
:<code>
 
> xquery doc("factbook")//country
 
</code>
 
  
If you want to set the factbook database as the context, you can use:
+
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:
:<code>
+
> open factbook
+
<pre>
</code>
+
basexclient -V -Uadmin -Padmin -c "CREATE DB input <example/>; XQUERY /"
  
To see which database is opened, use:
+
Database 'input' created in 13.85 ms.
:<code>
+
<example/>
> show databases
+
Query:
</code>
+
/
  
===Close or delete a database===
+
Parsing: 0.18 ms
If you want to close the opened database, simple type:
+
Compiling: 0.04 ms
:<code>
+
Evaluating: 0.12 ms
> close
+
Printing: 0.07 ms
</code>
+
Total Time: 0.41 ms
  
If you want to delete the xmark database, use:
+
Hit(s): 1 Item
:<code>
+
Updated: 0 Items
> drop db xmark
+
Printed: 10 Bytes
</code>
+
Read Locking: local [input]
 +
Write Locking: none
  
===Create a collection===
+
Query "user" executed in 0.41 ms.
'''What is a collection?'''
+
</pre>
With BaseX you can group documents into one logical collection.
 
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,
 
and thus create a collection. The collection will keep the name factbook.
 
 
 
First make sure factbook is opened:
 
:<code>
 
> open factbook
 
</code>
 
 
 
Now add the xmark.xml document:
 
:<code>
 
> add xmark.xml
 
</code>
 
 
 
===Delete a document from a collection===
 
Deleting a document from a collection is very easy, just type:
 
:<code>
 
> delete xmark.xml
 
</code>
 
 
 
N.B. The collection has to be the context i.e. the database which
 
contains the document has to be opened.
 
 
 
===Delete a collection===
 
Deleting a collection is the same as deleting a database.
 
If you want to delete the collection factbook, type:
 
:<code>
 
> drop factbook
 
</code>
 
 
 
===Getting information about the server===
 
To see all databases in BaseX, type:
 
:<code>
 
> list
 
</code>
 
 
 
To see which database is currently opened, type:
 
:<code>
 
> show databases
 
</code>
 
 
 
To see the general information of the opened database, type:
 
:<code>
 
> info
 
</code>
 
 
 
To see the users in BaseX, type:
 
:<code>
 
> show users
 
</code>
 
 
 
===Backup and Restrore===
 
To backup your database, type:
 
:<code>
 
> backup factbook
 
</code>
 
 
 
To restore your database, type:
 
:<code>
 
> restore factbook
 
</code>
 
 
 
'''Where is the backup file stored?'''
 
  
The backup-file is stored in the BaseXData directory, which is in your home directory.
+
=Language Bindings=
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 ==
+
If you want to communicate with the database server programmatically, we provide clients for various [[Clients|programming languages]].
[[Standalone Tutorial]], [[GUI Tutorial]], [[Getting Started]], [[Advanced User Portal]]
 
[[Category:Beginner]]
 
[[Category:Server]]
 

Revision as of 11:15, 15 February 2021

This article belongs to the Getting Started Guide. It tells you how to run BaseX in client-server mode from command-line.

Startup

Server

The database server handles concurrent read and write transactions, manages user permissions and logs user interactions. It can be started as follows:

  • Run one of the basexserver or basexserver.bat scripts. Add the stop keyword to gracefully shut down the server.
  • If you have installed BaseX on Windows, click on the BaseX HTTP Server (Start) icon, which will start both the HTTP Server used for Web Applications and the database server. With BaseX HTTP Server (Stop), you can shut down the server process.

By default, the server listens to the port 1984. Pressing Ctrl+c will close all connections and databases and gracefully shut down the server process.

Various command-line options are available to simplify batch processing. The start script can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).

Client

Database clients are started similarly:

  • Run one of the basexclient or basexclient.bat scripts.
  • Execute the following command: java -cp BaseX.jar org.basex.BaseXClient
  • If you have installed BaseX on Windows, click on the BaseX Client icon.

At startup, you need to enter your credentials. The initial passwort of the admin user is admin; it can be changed with the PASSWORD command.

For further details, have a look at the command-line options and the start script.

Introduction

The BaseX command-line client provides similar features to the standalone client. 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.

Language Bindings

If you want to communicate with the database server programmatically, we provide clients for various programming languages.