From BaseX Documentation

This article is part of the Getting Started Guide. It tells you how to get BaseX running. The application can be run and used in various ways:

• as a standalone application, using the Graphical User Interface or the Command-Line Interface
• as a client/server application
• as a Web Application, both embedded or client/server-based

Important: If you plan to perform concurrent read and write operations on a single database, the client/server architecture is the right choice. You may safely open the same database in different JVMs (Java virtual machines) for read-only access, and you won’t encounter any problems when reading from or writing to different databases, but your update operations will be rejected if the database to be written to is currently opened by another virtual machine.

Contents 1 Requirements 1.1 BaseX 1.2 Java 2 BaseX GUI 3 BaseX Standalone 4 BaseX Server 5 BaseX Client 6 BaseX HTTP Server 7 Changelog

[edit] Requirements

[edit] BaseX

Please download the latest BaseX version from our homepage. The official releases include the BaseX JAR file, libraries and optional Start Scripts. If you do not use an installer, we recommend to manually add the project’s bin directory to your path environment; this way, you will be able to run BaseX from everywhere in your shell/terminal.

[edit] Java

A Runtime Environment of Java 1.6 (JRE) is needed to run BaseX. BaseX is platform independent and runs on any system that provides a Java Virtual Machine. BaseX has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x), Linux(SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).

[edit] BaseX GUI

The GUI is the visual interface to the features of BaseX. It can be used to create new databases, perform queries or interactively explore your XML data.

The GUI can be started as follows (get more information on all Startup Options):

• Double click on the BaseX.jar file.
• Run one of the basexgui or basexgui.bat scripts.
• Execute the following command: java -cp BaseX.jar org.basex.BaseXGUI
• On Windows: Double click on the BaseX GUI icon.
• For Maven users: type in mvn exec:java in the main directory of the basex project.

Note that the GUI does not interact with the client/server architecture.

[edit] BaseX Standalone

The Standalone Mode can be used to execute XQuery expressions or run database commands on command line. It can also be used both for scripting and batch processing your XML data.

The standalone version can be started as follows (get more information on all Startup Options):

• Run one of the basex or basex.bat scripts.
• Execute the following command: java -cp BaseX.jar org.basex.BaseX
• On Windows: Double click on the BaseX icon.

Note that the standalone mode does not interact with the client/server architecture.

[edit] BaseX Server

The Database Server comes into play if BaseX is to be used by more than one user (client). It handles concurrent read and write transactions, provides user management and logs all user interactions.

By default, the server listens to the port 1984. There are several ways of starting and stopping the server (get more information on all Startup Options):

• Run one of the basexserver or basexserver.bat scripts. Add the stop keyword to gracefully shut down the server.
• Execute the following command: java -cp BaseX.jar org.basex.BaseXServer. Again, the stop keyword will ensure a graceful shutdown.
• On Windows: Double click on the BaseX Server icon, which will also start the HTTP Server, or the BaseX Server (stop) icon.

Pressing Ctrl+c will close all connections and databases and shut down the server process.

[edit] BaseX Client

The BaseX Client interface can be used to send commands and queries to the server instance on command line.

It can be started as follows (get more information on all Startup Options):

• Run one of the basexclient or basexclient.bat scripts.
• Execute the following command: java -cp BaseX.jar org.basex.BaseXClient
• On Windows: Double 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.

Please check out the article on the Database Server for more details.

[edit] BaseX HTTP Server

The HTTP Server gives access to the REST, RESTXQ and WebDAV Services of BaseX. By default, it starts an instance of the Jetty Web Server, which by default listens to the port 8984, and the BaseX Server, which listens to 1984.

To run the HTTP Server, you need to download one of the full distributions of BaseX (exe, zip, war), as the JAR version does not include any additionally required libraries. It can then be started as follows (get more information on all Startup Options):

• Run one of the basexhttp or basexhttp.bat scripts. Call the script with the stop keyword to gracefully shut down the server.
• On Windows: Double click on the BaseX Server or BaseX Server (stop) icon.
• You can also deploy BaseX as a Web Application
• For Maven users: type in mvn jetty:run in the main directory of the basex-api project, and press Ctrl+c to shut down the process (see Web Application: Maven for more details).

[edit] Changelog

Version 7.0

• Updated: BaseXJAXRX has been replaced with BaseXHTTP