Difference between revisions of "Database Server"

From BaseX Documentation
Jump to navigation Jump to search
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This step by step tutorial is part of the [[Getting Started]] Guide.
+
This article belongs to the [[Getting Started]] Guide. It tells you how to run BaseX in client-server mode from command-line.
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, 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]]).
+
==Server==
  
==Working with the BaseX Console==
+
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:
  
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).
+
* Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Add the {{Code|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 Application|Web Applications]] and the database server. With '''BaseX HTTP Server (Stop)''', you can shut down the server process.
  
The username and password can also be specified as options. To evaluate commands without entering the console mode, you can use the <code>-c</code> option on the command line:
+
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.
 +
 
 +
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).
 +
 
 +
==Client==
 +
 
 +
Database clients are started similarly:
 +
 
 +
* Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.
 +
* Execute the following command: {{Code|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 {{Code|admin}} user is {{Code|admin}}; it can be changed with the {{Code|[[Commands#PASSWORD|PASSWORD]]}} command.
 +
 
 +
For further details, have a look at the [[Command-Line_Options#Client|command-line options]] and the [[Start_Scripts|start script]].
 +
 
 +
=Introduction=
 +
 
 +
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).
 +
 
 +
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:
 
   
 
   
 
<pre>
 
<pre>
Line 32: Line 52:
 
Write Locking: none
 
Write Locking: none
  
Query "user" executed in 0.41 ms.</pre>
+
Query "user" executed in 0.41 ms.
[[Category:Beginner]]
+
</pre>
[[Category:Server]]
+
 
 +
=Language Bindings=
 +
 
 +
If you want to communicate with the database server programmatically, we provide clients for various [[Clients|programming languages]].

Latest revision as of 12: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[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. 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[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. 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[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 -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[edit]

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