Difference between revisions of "Startup"
Line 30: | Line 30: | ||
====Concurrent Operations==== | ====Concurrent Operations==== | ||
− | If you plan to perform concurrent read and write operations on a single database, | + | If you plan to perform concurrent read and write operations on a single database, you |
− | the client/server | + | should use the client/server architecutre or deploy it as web application. |
− | in different JVMs (Java virtual machines) for read-only access, and you won’t encounter any | + | You may safely open the same database in different JVMs (Java virtual machines) for |
− | problems when reading from or writing to different databases, but your update operations will | + | read-only access, and you won’t encounter any problems when reading from or writing |
− | be rejected if the database to be written to is currently opened by another virtual machine. | + | to different databases, but your update operations will be rejected if the database |
+ | to be written to is currently opened by another virtual machine. | ||
==BaseX GUI== | ==BaseX GUI== |
Revision as of 10:57, 9 February 2015
This article is part of the Getting Started Guide. It tells you how to get BaseX running.
Contents
Getting Started
First of all, download BaseX from our homepage. The following distributions are available:
- the Core Package is a JAR file, which contains the database code, the query processor and the GUI frontend. It runs completely without additional libraries.
- the ZIP Archive and the Windows Installer contain libraries for web applications and advanced features, Starts Scripts, and some additional optional files.
- the WAR Application can be embedded in existing Java web servers.
Some additional distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
BaseX can be run and used in various ways:
- as standalone application, using the Graphical User Interface or the Command-Line Interface,
- as client/server application, or
- as Web Application, called from a web server.
It can also be embedded as library in your own application.
Requirements
BaseX is platform-independent and runs on any system that provides an implementation of Java (JRE). With Version 8.0 of BaseX, we switched to Java 7, because it provides better file handling support, and because Oracle stopped public support for older versions.
BaseX has been tested on several platforms, including Windows (2000, XP, Vista, 7), Max OS X (10.x), Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).
Concurrent Operations
If you plan to perform concurrent read and write operations on a single database, you should use the client/server architecutre or deploy it as web application. 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.
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
orbasexgui.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 thebasex
project.
Note that the GUI does not interact with the client/server architecture.
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
orbasex.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.
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
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. - 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.
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
orbasexclient.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.
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
orbasexhttp.bat
scripts. Call the script with thestop
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 thebasex-api
directory, and pressCtrl+c
to shut down the process (see Web Application: Maven for more details).
After that, you can open your browser and navigate to the start page http://localhost:8984.
Changelog
- Version 8.0
- Update: Switched to Java 7
- Version 7.0
- Updated: BaseXJAXRX has been replaced with BaseXHTTP