Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
(185 intermediate revisions by 6 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 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).
 
  
−
===BaseX===
+
BaseX is very light-weight. It can be run and used in many different ways:
  
−
Please [http://basex.org/download download] the latest BaseX version from our homepage.
+
# 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.
−
The official releases include the BaseX runnable, [[Start Scripts]], and API files.
+
# You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the terminal, or want to do batch processing.
−
If you do not use the Windows installer, or use another operating system, we recommend
+
# 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.
−
to add the project’s <code>bin</code> directory to your path environment; this way,
+
# 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.
−
you will be able to run BaseX from everywhere in your shell/terminal.
+
# 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 ways of starting the GUI (get more information [[Startup Options#BaseX GUI|here]]):
 
  
−
*Double click on the '''BaseX GUI''' icon or the <code>BaseX.jar</code> file
+
=Startup=
−
*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexgui]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexgui.bat]]</code> scripts
 
−
*Execute the command: <code>java -cp BaseX.jar org.basex.BaseXGUI</code>
 
  
−
'''Important''': The BaseX GUI is not synchronized with other BaseX instances. You should avoid accessing the same database
+
First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:
−
from the GUI and the server, esp. if updates are performed.
 
  
−
==BaseX Server==
+
{| class="wikitable"
−
There are several ways of starting the server (get more information [[Startup Options#BaseX Server|here]]):
+
|-
 +
! BaseX Version
 +
! Minimum Java Version
 +
|-
 +
| 10
 +
| 11
 +
|-
 +
| 9
 +
| 8
 +
|-
 +
| 8
 +
| 7
 +
|-
 +
| ''older''
 +
| 6
 +
|}
  
−
*Double click on the '''BaseX Server (Start)''' icon. This will also start the JAX-RX 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.
−
*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexserver]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexserver.bat]]</code> scripts
 
−
*Execute the command <code>java -cp BaseX.jar org.basex.BaseXServer</code>
 
  
−
'''Important''': If you concurrently access the databases (especially for write transactions),
+
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).
−
the BaseX Server is the way to go. Don't use any other standalone/GUI BaseX instances
 
−
to access databases which are also opened by the server.
 
  
−
==BaseX Client==
+
Next, [https://basex.org/download get a fresh copy of BaseX] from our homepage. The following distributions are available:
−
There are several ways of starting the client version (get more information [[Startup Options#BaseX Client|here]]):
 
  
−
*Double click on the '''BaseX Client''' icon
+
==Core Package==
−
*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexclient]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexclient.bat]]</code> scripts
 
−
*Execute the command <code>java -cp BaseX.jar org.basex.BaseXClient</code>
 
  
−
The default <code>admin</code> user can be used to connect to the server: <br/>
+
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.
−
* <b>Username:</b> <code>admin</code>
 
−
* <b>Password:</b> <code>admin</code>
 
−
The password should be changed with the <code>[[Commands#PASSWORD|PASSWORD]]</code> command after the first login.<br/>
 
  
−
Please check out our little [[Server Tutorial]] for more details.
+
==Full Distributions==
  
−
==BaseX Standalone==
+
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:
  
−
There are several ways of starting the standalone version (get more information [[Startup Options#BaseX Standalone|here]]):
+
{| class="wikitable"
 +
|- valign="top"
 +
! Directory
 +
! 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]].
 +
|}
  
−
*Double click on the '''BaseX''' icon
+
Global [[Options]] are stored in the [[Configuration|.basex configuration file]].
−
*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basex]]</code>/<code>[[Start Scripts#Windows: basex.bat|basex.bat]]</code> scripts
 
−
*Execute the command <code>java -cp BaseX.jar org.basex.BaseX</code>
 
  
−
<b>Important</b>: The Standalone client is not synchronized with other BaseX instances. You should avoid accessing the same database
+
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.
−
from the standalone client and the server, esp. if updates are performed.
 
  
−
==BaseX JAX-RX Server==
+
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.
  
−
<font color='orangered'>Deprecated from Version 6.8</font>:
+
==Web Archive==
−
The JAX-RX (REST) server can be started as follows (get more information [[Startup Options#BaseX JAX-RX Server|here]]):
 
  
−
*Double click on the '''BaseX Server (Start)''' icon
+
The '''WAR Archive''' can be embedded in existing Java web servers.
−
*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basexjaxrx|basexjaxrx]]</code>/<code>[[Start Scripts#Windows: basexjaxrx.bat|basexjaxrx.bat]]</code> scripts
 
  
−
==BaseX HTTP Server==
+
==Other Distributions==
  
−
<font color='orangered'>Introduced with Version 6.8</font>:
+
Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
−
The HTTP server can be started as follows (get more information [[Startup Options#BaseX HTTP Server|here]]):
 
  
−
*Double click on the '''BaseX Server (Start)''' icon
+
=Concurrent Operations=
−
*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]</code>/<code>[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]</code> scripts
 
  
−
==See also ==
+
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.
−
[[Server Tutorial]], [[GUI Tutorial]], [[Standalone Tutorial]], [[Getting Started]]
+
 
−
[[Category:Beginner]]
+
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 13: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
Retrieved from "http://docs.basex.org/index.php?title=Startup&oldid=16199"