Startup

From BaseX Documentation
Jump to navigation Jump to search

Here you find all instructions you need for starting the three modes of BaseX. After you successfully started BaseX just follow the instructions in the Getting Started guide.

Requirements

For running BaseX, all you need is an installed Java 1.6 and the BaseX application. As such it is platform-independant and should run on any platform that has a Java Virtual Machine available. BaseX has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x), Linux(SuSE xxx, Debian) and OpenBSD (4.x).

Java 1.6

You need to have Java 1.6 installed. If you haven't installed it yet, please visit java.com.

BaseX

Download the latest BaseX version for your operating system here. Get the BaseX.zip archive or the windows installer for all project components inclusive the starting script files. We also recommend to add the starting script files to your path environment, so you can access them from every folder in the shell/terminal.

Starting the BaseX GUI

There are several methods for starting the GUI:

  • Double click on BaseX.jar
  • Execute command: java -cp BaseX.jar org.basex.BaseXGUI
  • Starting the script basexgui / basexgui.bat

Note: The BaseX GUI is just working on local databases. Anyway you can set your local database path to the BaseX Server database path accessing it over the network. In this case we suggest you to avoid accessing databases concurrently with the GUI and the Server.

Starting the BaseX Server

There are several methods for starting the Server:

  • Execute command: java -cp BaseX.jar org.basex.BaseXServer
  • Starting the script basexserver / basexserver

Note: For using the databases concurrently (especially for write transactions) you have to use the BaseX Server. Please don't use any other BaseX modes with the BaseX Server databases while the Server is on.

Starting the BaseX Client

There are several methods for starting the Client:

  • Execute command: java -cp BaseX.jar org.basex.BaseXClient
  • Starting the script basexclient / basexclient

see also the advanced client/server information section.

Starting the BaseX Standalone

There are several methods for starting the Standalone mode:

  • Execute command: java -cp BaseX.jar org.basex.BaseX
  • Starting the script basex / basex