Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
(237 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Requirements==
+
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
  
===Java===
+
=Introduction=
  
A Runtime Environment of [http://www.java.com Java 1.6] (JRE) is needed to run BaseX.
+
BaseX is very light-weight. It can be run and used in many different ways:
BaseX is platform-independent 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).
 
  
===BaseX===
+
# BaseX comes with a [[GUI|Graphical User Interface]] that offers you tools for managing, querying and visualizing your data and writing sophisticated applications in XQuery.
Download the latest BaseX version for your operating system [http://basex.org/download here].
+
# You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the terminal, or want to do batch processing.
Run the Windows installer, or download the <code>BaseX.zip</code> archive to get all project components, including the [[Starting Script Files| start scripts]]. If you do not use the Windows installer, we recommend to add the <code>bin</code> directory, which contains all the start scripts, to your path environment; this way, you can run BaseX from every folder in the shell/terminal.
+
# The [[Database Server]] is the right choice if you have multiple users or clients, or if you use other programming languages and if you don’t require HTTP services.
 +
# The [[Web Application|HTTP Server]] provides [[REST]] and [[WebDAV]] services. With [[RESTXQ]], complex web applications can be built, and the embedded [[DBA]] application allows you to work with BaseX in the browser.
 +
# It can also be embedded as a Java library in your applications.
  
==BaseX GUI==
+
BaseX has been tested on numerous platforms, including Windows (2000, XP, Vista, 7, 10, 11), Mac OS X (10.x , 11.x), Linux (SuSE xxx, Debian, Redhat, CentOS, Ubuntu) and OpenBSD (up to 7.x). It is platform-independent and runs on any system supporting Java.
  
There are several methods for starting the GUI:
+
=Startup=
  
*Double click on <code>BaseX.jar</code>
+
First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:
*Execute the command: <code>java -cp BaseX.jar org.basex.BaseXGUI</code>
 
*Start the script <code>basexgui</code>/<code>basexgui.bat</code>
 
  
<b>Note</b>: The BaseX GUI is just working on local databases. While you can always access
+
{| class="wikitable"
local database from a BaseX server instance, you should avoid accessing databases
+
|-
concurrently with the GUI and the server, esp. if updates are performed.
+
! BaseX Version
 +
! Minimum Java Version
 +
|-
 +
| 10
 +
| 11
 +
|-
 +
| 9
 +
| 8
 +
|-
 +
| 8
 +
| 7
 +
|-
 +
| ''older''
 +
| 6
 +
|}
  
==BaseX Server==
+
If you have several versions or distributions installed, you can type {{Code|java -version}} on command-line to check which Java version is currently used.
  
There are several methods for starting the server (get more information [[Startup Advanced|here]]):
+
If you have Windows, we recommend the {{Code|.msi}} distributions from [https://adoptium.net/ Adoptium]. The JRE packages are sufficient, but you can also install the JDK (Java Development Kit).
  
*Execute the command: <code>java -cp BaseX.jar org.basex.BaseXServer</code>
+
Next, [https://basex.org/download get a fresh copy of BaseX] from our homepage. The following distributions are available:
*Start the script <code>basexserver</code>/<code>basexserver.bat</code>
 
  
<b>Note</b>: For concurrently accessing the databases (especially for write transactions),
+
==Core Package==
you have to use the BaseX Server. Please don't use any other BaseX mode with the databases
 
from the BaseX Server while the server is working.
 
  
==BaseX Client==
+
The '''Core Package''' is a very compact JAR file. It contains the BaseX database management system, the XQuery processor, the client/server architecture, and the graphical user interface. It runs without additional libraries.
  
There are several methods for starting the client communicating with the server (get more information [[Startup Advanced|here]]):
+
==Full Distributions==
  
*Execute the command: <code>java -cp BaseX.jar org.basex.BaseXClient</code>
+
In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the [[DBA]], a browser-based database administration interface. If you unzip or install BaseX, the target directory will contain the following directories:
*Start the script <code>basexclient</code>/<code>basexclient.bat</code>
 
  
A default admin user can be used to connect: <br/>
+
{| class="wikitable"
* <b>Username:</b> <code>admin</code>
+
|- valign="top"
* <b>Password:</b> <code>admin</code>
+
! Directory
The password can be changed using the <code>[[Commands#PASSWORD|PASSWORD]]</code> command.<br/>
+
! Description
 +
|-
 +
| {{Code|bin}}
 +
| Start scripts (Windows, Linux).
 +
|-
 +
| {{Code|data}}
 +
| The database directory.
 +
|-
 +
| {{Code|etc}}
 +
| Example data: XML sample, [[Catalog Resolver|catalog and DTD files]].
 +
|-
 +
| {{Code|lib}}
 +
| Extra libraries (Jetty, Tagsoup, …).
 +
|-
 +
| {{Code|lib/custom}}
 +
| Directory in which additional JAR files can be placed (such as the Saxon library).
 +
|-
 +
| {{Code|repo}}
 +
| [[Repository]] for external XQuery modules (the [http://www.xqueryfunctions.com FunctX] library is included as example).
 +
|-
 +
| {{Code|src}}
 +
| Directory for your XQuery scripts and other source data.
 +
|-
 +
| {{Code|webapp}}
 +
| [[Web Application]] directory: home of the RESTXQ web application, REST scripts, and [[DBA]].
 +
|}
  
See also the [[Server Tutorial]] section for more details.
+
Global [[Options]] are stored in the [[Configuration|.basex configuration file]].
  
==BaseX Standalone Client==
+
If BaseX is started via the start scripts or the Windows icons, all JAR files in the {{Code|lib}} directory and its descendant directories will be added to the class path.
  
There are several methods for starting the standalone client (get more information [[Startup Advanced|here]]):
+
If you work with the ZIP distribution, and if you want to make BaseX globally available, you can add the {{Code|bin}} directory to your PATH environment variable.
  
*Execute the command: <code>java -cp BaseX.jar org.basex.BaseX</code>
+
==Web Archive==
*Start the script <code>basex</code>/<code>basex.bat</code>
 
  
==See also ==
+
The '''WAR Archive''' can be embedded in existing Java web servers.
[[Server Tutorial]], [[GUI Tutorial]], [[Standalone Tutorial]], [[Getting Started]]
+
 
[[Category:Beginner]]
+
==Other Distributions==
__NOTOC__
+
 
 +
Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
 +
 
 +
=Concurrent Operations=
 +
 
 +
If you want to perform parallel (concurrent) read and write operations on your databases, you must use the client/server architecture or run BaseX as a web application. You can safely open a database in different JVMs (Java virtual machines) for read-only access, and you will not encounter any problems when reading from and writing to different databases. Update operations from different JVMs to the same database will be rejected or may even lead to corrupt databases.
 +
 
 +
For example, if you only read data, you can easily run several clients (standalone, GUI, database clients) in parallel. If you update your data, however, you shouldn’t use the GUI or a standalone instance at the same time.
 +
 
 +
More details on concurrency can be found on the [[Transaction Management]] page.
 +
 
 +
=Changelog=
 +
 
 +
;Version 10.0
 +
* Update: Switched to Java 11
 +
 
 +
;Version 9.0
 +
* Update: Switched to Java 8
 +
 
 +
;Version 8.0
 +
* Update: Switched to Java 7
 +
 
 +
;Version 7.0
 +
* Updated: BaseXJAXRX has been replaced with BaseXHTTP

Revision as of 12:33, 27 July 2022

This article is part of the Getting Started Guide. It tells you how to get BaseX running.

Introduction

BaseX is very light-weight. It can be run and used in many different ways:

  1. BaseX comes with a Graphical User Interface that offers you tools for managing, querying and visualizing your data and writing sophisticated applications in XQuery.
  2. You can start BaseX as a standalone Command-Line Client if you prefer to work in the terminal, or want to do batch processing.
  3. The Database Server is the right choice if you have multiple users or clients, or if you use other programming languages and if you don’t require HTTP services.
  4. The HTTP Server provides REST and WebDAV services. With RESTXQ, complex web applications can be built, and the embedded DBA application allows you to work with BaseX in the browser.
  5. It can also be embedded as a Java library in your applications.

BaseX has been tested on numerous platforms, including Windows (2000, XP, Vista, 7, 10, 11), Mac OS X (10.x , 11.x), Linux (SuSE xxx, Debian, Redhat, CentOS, Ubuntu) and OpenBSD (up to 7.x). It is platform-independent and runs on any system supporting Java.

Startup

First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:

BaseX Version Minimum Java Version
10 11
9 8
8 7
older 6

If you have several versions or distributions installed, you can type java -version on command-line to check which Java version is currently used.

If you have Windows, we recommend the .msi distributions from Adoptium. The JRE packages are sufficient, but you can also install the JDK (Java Development Kit).

Next, get a fresh copy of BaseX from our homepage. The following distributions are available:

Core Package

The Core Package is a very compact JAR file. It contains the BaseX database management system, the XQuery processor, the client/server architecture, and the graphical user interface. It runs without additional libraries.

Full Distributions

In addition, the ZIP Package and the Windows Installer contain extra libraries for RESTXQ web applications and other advanced features, Start Scripts, and the DBA, a browser-based database administration interface. If you unzip or install BaseX, the target directory will contain the following directories:

Directory Description
bin Start scripts (Windows, Linux).
data The database directory.
etc Example data: XML sample, catalog and DTD files.
lib Extra libraries (Jetty, Tagsoup, …).
lib/custom Directory in which additional JAR files can be placed (such as the Saxon library).
repo Repository for external XQuery modules (the FunctX library is included as example).
src Directory for your XQuery scripts and other source data.
webapp Web Application directory: home of the RESTXQ web application, REST scripts, and DBA.

Global Options are stored in the .basex configuration file.

If BaseX is started via the start scripts or the Windows icons, all JAR files in the lib directory and its descendant directories will be added to the class path.

If you work with the ZIP distribution, and if you want to make BaseX globally available, you can add the bin directory to your PATH environment variable.

Web Archive

The WAR Archive can be embedded in existing Java web servers.

Other Distributions

Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.

Concurrent Operations

If you want to perform parallel (concurrent) read and write operations on your databases, you must use the client/server architecture or run BaseX as a web application. You can safely open a database in different JVMs (Java virtual machines) for read-only access, and you will not encounter any problems when reading from and writing to different databases. Update operations from different JVMs to the same database will be rejected or may even lead to corrupt databases.

For example, if you only read data, you can easily run several clients (standalone, GUI, database clients) in parallel. If you update your data, however, you shouldn’t use the GUI or a standalone instance at the same time.

More details on concurrency can be found on the Transaction Management page.

Changelog

Version 10.0
  • Update: Switched to Java 11
Version 9.0
  • Update: Switched to Java 8
Version 8.0
  • Update: Switched to Java 7
Version 7.0
  • Updated: BaseXJAXRX has been replaced with BaseXHTTP