Database Server

This article tells you how to use the client/server architecture of BaseX, and how to run the client on 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 Start 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 (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, take a look at the Command-Line Options and the start script.

Introduction

The client provides similar features to the standalone interface. 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 transferred to the server).

Username and password can also be specified as command-line options. 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.