Difference between revisions of "Database Server"

From BaseX Documentation
Jump to navigation Jump to search
(135 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<p>This step by step tutorial shows you how to run BaseX in client-server mode from a terminal.
+
This article belongs to the [[Getting Started]] Guide. It tells you how to run BaseX in client-server mode from command-line.
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 BaseX commands.</p>
 
  
 +
=Startup=
  
==Requirements==
+
==Server==
Java 1.6 is required to run newer versions of BaseX. If you need help installing Java please visit
 
[http://www.java.com/en/download/help/download_options.xml java.com]. <br/>
 
We assume that you are familiar with a shell at a basic level.
 
  
===Download===
+
{{Announce|With Version 10, the default admin password has been removed.}}
Download the [http://www.inf.uni-konstanz.de/dbis/basex/download basex.jar]. <br/>
 
We assume that the basex.jar file is located in ''/basex''.
 
  
===Starting the Server===
+
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:
#Navigate to the location of basex.jar (<code>> cd /basex</code>).
 
#Execute:  
 
:<code>
 
> java -cp BaseX.jar org.basex.BaseXServer
 
</code>
 
  
A default admin user is created: <br/>
+
* Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Use {{Code|basexserverstop}} or {{Code|basexserverstop.bat}} to gracefully shut down the server.
Username: admin<br/>
+
* 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.
Password: admin<br/>
 
The password can be changed using the password command.<br/>
 
 
Adding the <code>-i</code> flag lets you interact (execute commands, add databases or users) with the server during runtime.
 
:<pre>
 
> java -cp BaseX.jar org.basex.BaseXServer -i
 
</pre>
 
 
Once the server is successfully started you see the following lines:
 
:<pre>BaseXServer [Server]&#10;Server was started.</pre>
 
 
 
===Starting the Client===
 
#Open a new terminal window, make sure you are in the right directory.
 
#Execute:
 
:<code>
 
> java -cp BaseX.jar org.basex.BaseXClient
 
</code>
 
<br/>
 
 
 
#If you haven't changed the password with the server, you can login as default user (admin/admin).
 
  
==First Operations==
+
Unless you have already chosen an admin password yet (e.g., via the Windows installer or a previous installation), you can do so by invoking the {{Command|PASSWORD}} command on your terminal:
To get more familiar with BaseX we suggest to execute the following basic operations.
 
  
===Create a database===
+
<pre>
To create a database you need an xml-document, e.g.
+
basexserver -c PASSWORD
[http://www.w3.org/XML/Binary/2005/03/test-data/Over100K/factbook.xml factbook.xml].<br/>
+
BaseX [Server]
Save this document to the /basex directory.
+
Server was started (port: 1984).
On the client terminal run:
+
Password: _
:<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.
 
<pre>Database 'factbook' created in 1950.83 ms.
 
 
</pre>
 
</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===
+
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 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.
+
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).
:<code>
 
> run /pathToQuery/query.txt
 
</code>
 
  
===Create an another database / switch between databases===
+
==Client==
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:
+
Database clients are started similarly:
:<code>
 
> open xmark
 
</code>
 
  
Now you can simply type your xquery:
+
* Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.
:<code>
+
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXClient}}
> xquery //people/person/name
+
* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.
</code>
 
  
If you want to query the factbook database you can access it by explicitly naming it with the doc()-function.
+
At startup, you need to enter your credentials.
:<code>
 
> xquery doc("factbook")//country
 
</code>
 
  
If you want to set the factbook database as the context, you can use:
+
For further details, have a look at the [[Command-Line_Options#Client|command-line options]] and the [[Start_Scripts|start script]].
:<code>
 
> open factbook
 
</code>
 
  
To see which database is opened, use:
+
=Introduction=
:<code>
 
> show databases
 
</code>
 
  
===Close or delete a database===
+
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).
If you want to close the opened database, simply type:
 
:<code>
 
> close
 
</code>
 
  
If you want to delete the xmark database, 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>
+
> drop db xmark
+
<pre>
</code>
+
basexclient -V -Uadmin -P... -c "CREATE DB input <example/>; XQUERY /"
  
===Create a collection===
+
Database 'input' created in 13.85 ms.
'''What is a collection?'''
+
<example/>
With BaseX you can group documents into one logical collection.
+
Query:
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,
+
Parsing: 0.18 ms
and thus create a collection. The collection will keep the name factbook.
+
Compiling: 0.04 ms
 +
Evaluating: 0.12 ms
 +
Printing: 0.07 ms
 +
Total Time: 0.41 ms
  
First make sure factbook is opened:
+
Hit(s): 1 Item
:<code>
+
Updated: 0 Items
> open factbook
+
Printed: 10 Bytes
</code>
+
Read Locking: local [input]
 +
Write Locking: none
  
Now add the xmark.xml document:
+
Query "user" executed in 0.41 ms.
:<code>
+
</pre>
> 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 on the server, 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 Restore===
 
To backup your database, type:
 
:<code>
 
> backup factbook
 
</code>
 
  
To restore your database, type:
+
=Language Bindings=
:<code>
 
> restore factbook
 
</code>
 
  
'''Where is the backup-file stored?'''
+
If you want to communicate with the database server programmatically, we provide clients for various [[Clients|programming languages]].
  
The backup-file is stored in the BaseXData directory, which is in your home directory.
+
=Changelog=
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 ==
+
;Version 10.0
[[BaseX Standalone]], [[BaseX GUI]], [[Getting Started Guide]], [[Advanced User Portal]]
+
* Updated: The default admin password has been removed.
[[Category:Beginner]]
 
[[Category:Server]]
 

Revision as of 14:00, 25 July 2022

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

Startup

Server

With Version 10, the default admin password has been removed.

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. Use basexserverstop or basexserverstop.bat 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.

Unless you have already chosen an admin password yet (e.g., via the Windows installer or a previous installation), you can do so by invoking the PASSWORD command on your terminal:

basexserver -c PASSWORD
BaseX [Server]
Server was started (port: 1984).
Password: _

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.

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 -P... -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.

Changelog

Version 10.0
  • Updated: The default admin password has been removed.