Difference between revisions of "Database Server"

From BaseX Documentation
Jump to navigation Jump to search
 
(124 intermediate revisions by 7 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.
+
This article belongs to the [[Getting Started]] Guide. It tells you how to run BaseX in client-server mode from command-line.
−
After you finished this tutorial, you will be familiar with the basic BaseX commands.
 
  
−
==Startup==
+
=Startup=
  
−
see the [[Startup Overview]].
+
==Server==
  
−
===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>).
 
−
*You can either start the server in interaction mode if you add the -i flag. This allows you to further interact with the server during runtime (add databases or users, ...).
 
  
−
<code>
+
* Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Use {{Code|basexserverstop}} or {{Code|basexserverstop.bat}} to gracefully shut down the server.
−
:> java -cp BaseX.jar org.basex.BaseXServer -i
+
* 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.
−
</code>
+
 
−
+
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:
−
:Or the server can be started alternatively without the -i flag. Note, that you have to restart the server to execute further commands from this shell.
 
−
<code>
 
−
: > java -cp BaseX.jar org.basex.BaseXServer
 
−
</code>
 
  
−
*A default admin user is created (you can change the password with the [[Commands|PASSWORD]] command):
 
−
:Username: admin
 
−
:Password: admin
 
−
 
−
*Once the server has successfully started you see the following lines:
 
 
<pre>
 
<pre>
−
BaseXServer [Server]
+
basexserver -c PASSWORD
−
Server was started.
+
BaseX [Server]
 +
Server was started (port: 1984).
 +
Password: _
 
</pre>
 
</pre>
  
−
===Starting the Client===
+
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.
−
*Open a new terminal window, make sure you are in the right directory (/basex).
 
−
*Execute the following to start the client:
 
−
<code>
 
−
:> java -cp BaseX.jar org.basex.BaseXClient
 
−
</code>
 
−
 
 
−
*If you haven't changed the password with the server, you can login as default user (admin/admin).
 
  
−
==First Operations==
+
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).
−
To get familiar with BaseX we suggest to execute the following basic operations.
 
  
−
===Creating a database===
+
==Client==
−
* 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].
 
−
* Save this document to the /basex directory.
 
−
* On the client terminal run:
 
−
<code>
 
−
: > create db factbook factbook.xml
 
−
</code>
 
  
−
: ''factbook'' - is the name of the database <br/>
+
Database clients are started similarly:
−
: ''factbook.xml''  - is the xml file, which is used to create the database<br/>     
 
  
−
If everything works you see the following lines:
+
* Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.
−
<pre>Database 'factbook' created in 1950.83 ms.
+
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXClient}}
−
</pre>
+
* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.
−
 
−
;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.
 
  
−
===Executing a query===
+
At startup, you need to enter your credentials.
−
The [[Commands|xquery]] command lets you run a query.
 
−
* For example, this query returns all country nodes in the currently opened database.
 
−
<code>
 
−
: > xquery //country
 
−
</code>
 
  
−
* You can also run queries in files:
+
For further details, have a look at the [[Command-Line_Options#Client|command-line options]] and the [[Start_Scripts|start script]].
−
<code>
 
−
: > run /Users/John/query.xq
 
−
</code>
 
  
−
===Creating a new database===
+
=Introduction=  
−
Now we will create another database. You can find the example document here: [http://phobos101.inf.uni-konstanz.de/basex/demo].
 
  
−
* Create the new database, named 'xmark'.
+
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>
 
−
: > create db xmark xmark.xml
 
−
</code>
 
  
−
* Set the new database xmark as the context:
+
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 xmark
+
<pre>
−
</code>
+
basexclient -V -Uadmin -P... -c "CREATE DB input <example/>; XQUERY /"
−
 
 
−
* Now you can easily execute queries on your new database:
 
−
<code>
 
−
: > xquery //people/person/name
 
−
</code>
 
  
−
===Switching the database===
+
Database 'input' created in 13.85 ms.
−
* You can explicitly query the factbook database with the doc()-funtion, no matter what the current context is.
+
<example/>
−
<code>
+
Query:
−
: > xquery doc("factbook")//country
+
/
−
</code>
 
  
−
* Otherwise, to set factbook as the current context, execute the following:
+
Parsing: 0.18 ms
−
<code>
+
Compiling: 0.04 ms
−
: > open factbook
+
Evaluating: 0.12 ms
−
</code>
+
Printing: 0.07 ms
 +
Total Time: 0.41 ms
  
−
* To list the current context, type:
+
Hit(s): 1 Item
−
<code>
+
Updated: 0 Items
−
: > show databases
+
Printed: 10 Bytes
−
</code>
+
Read Locking: local [input]
 +
Write Locking: none
  
−
That yields the following lines:
+
Query "user" executed in 0.41 ms.
−
 
 
−
<pre>
 
−
1 opened database(s):
 
−
- factbook (1x)
 
 
</pre>
 
</pre>
  
 +
=Language Bindings=
  
−
===Close or delete a database===
+
If you want to communicate with the database server programmatically, we provide clients for various [[Clients|programming languages]].
−
If you want to close the opened database, simply type:
 
−
:<code>
 
−
> close
 
−
</code>
 
−
 
 
−
If you want to delete the xmark database, use:
 
−
:<code>
 
−
> 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.
 
−
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 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:
 
−
:<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.
+
=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]]
 

Latest revision as of 12:24, 26 October 2023

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

Startup[edit]

Server[edit]

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[edit]

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[edit]

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[edit]

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

Changelog[edit]

Version 10.0
  • Updated: The default admin password has been removed.
Retrieved from "http://docs.basex.org/index.php?title=Database_Server&oldid=16659"