Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replacement - "[http://basex.org/" to "[https://basex.org/")
 
(17 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
=Introduction=
 
=Introduction=
  
BaseX is very light-weight. It can be run and used in lots of different ways:
+
BaseX is very light-weight. It can be run and used in many different ways:
  
# BaseX comes with a [[GUI|Graphical User Interface]] that offers you marvellous tools for managing, querying and visualizing your data and write complex applications in XQuery.
+
# 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.
# You can start BaseX as [[Command-Line Client]] if you prefer to work on command-line line and want to do batch processing.
+
# You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the terminal, or want to do batch processing.
# The [[Database Server]] is the right choice if you have multiple users or clients, if you don’t require HTTP services, and if you tend to communicate with BaseX on a technical level.
+
# 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.
 
# 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 can also be embedded as library in your own 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.
  
==Concurrent Operations==
+
=Startup=
 
 
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 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, but 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) at the same time. 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.
 
  
=Startup=
+
First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:
  
First of all, [https://basex.org/download get a fresh copy of BaseX] from our homepage.
+
{| class="wikitable"
 +
|-
 +
! BaseX Version
 +
! Minimum Java Version
 +
|-
 +
| 10
 +
| 11
 +
|-
 +
| 9
 +
| 8
 +
|-
 +
| 8
 +
| 7
 +
|-
 +
| ''older''
 +
| 6
 +
|}
  
BaseX is platform-independent and runs on any system that provides an implementation of the [http://www.java.com Java Runtime Environment (JRE)]:
+
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.
* Since <b>Version 9</b> of BaseX, Java 8 is required.
 
* Since <b>Version 8</b>, Java 7 is required.
 
* Older versions are based on Java 6.
 
  
BaseX has been tested on several platforms, including Windows (2000, XP, Vista, 7), Mac OS X (10.x),
+
The downloads on https://www.java.com/ are limited to Java 8. If you are looking for a suitable distribution, we recommend the [https://adoptium.net/ JRE packages from Adoptium].
Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).
 
  
The following distributions are available:
+
Next, [https://basex.org/download get a fresh copy of BaseX] from our homepage. The following distributions are available:
  
 
==Core Package==
 
==Core Package==
Line 40: Line 47:
 
==Full Distributions==
 
==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 BaseX's browser-based database administration interface ([[DBA]]).
+
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:
  
After BaseX has been unzipped or installed, the following directories will be available:
+
{| 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]].
 +
|}
  
* {{Code|bin/}}: Start scripts (Windows, Linux).
+
Global [[Options]] are stored in the [[Configuration|.basex configuration file]].
* {{Code|data/}}: Database directory. See [[Configuration]] for more details.
 
* {{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]].
 
  
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 classpath.
+
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.
  
 
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.
 
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.
Line 64: Line 92:
  
 
Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
 
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=
 
=Changelog=
 +
 +
;Version 10.0
 +
* Update: Switched to Java 11
 +
 +
;Version 9.0
 +
* Update: Switched to Java 8
  
 
;Version 8.0
 
;Version 8.0
 
 
* Update: Switched to Java 7
 
* Update: Switched to Java 7
  
 
;Version 7.0
 
;Version 7.0
 
 
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
 
* Updated: BaseXJAXRX has been replaced with BaseXHTTP

Latest revision as of 17:12, 15 March 2023

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

Introduction[edit]

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[edit]

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.

The downloads on https://www.java.com/ are limited to Java 8. If you are looking for a suitable distribution, we recommend the JRE packages from Adoptium.

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

Core Package[edit]

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[edit]

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[edit]

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

Other Distributions[edit]

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[edit]

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[edit]

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