Database Server
This step by step tutorial is part of the Getting Started Guide. 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 section for a complete list of database commands.
Startup
The database server can be started as follows:
- Run one of the
basexserver
orbasexserver.bat
scripts. Add thestop
keyword to gracefully shut down the server. - Execute the following command:
java -cp BaseX.jar org.basex.BaseXServer
. Again, thestop
keyword will ensure a graceful shutdown. - 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.
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).
The client is started similarly:
- Run one of the
basexclient
orbasexclient.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.
The default admin
user can be used to connect to the server:
- Username:
admin
- Password:
admin
The password should be changed with the PASSWORD
command after the first login.
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.