Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
(97 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running. The application can be run and used in various ways:
+
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
  
* as a standalone application, using the [[Graphical User Interface]] or the [[Standalone Mode|Command-Line Interface]]
+
=Introduction=
* as a [[Database Server|client/server]] application
 
* as a [[Web Application]], both embedded or client/server-based
 
  
'''Important:''' If you plan to perform concurrent read and write operations on a
+
BaseX is very light-weight. It can be run and used in many different ways:
single database, the client/server architecture is the right choice. 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.
 
  
==Requirements==
+
# 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 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, 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====
+
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.
Please [http://basex.org/download download] the latest BaseX version from our homepage.
 
The official releases include the BaseX JAR file, libraries and optional [[Start Scripts]].
 
If you do not use an installer, we recommend to manually add the project’s
 
{{Code|bin}} directory to your path environment; this way, you will be able to run
 
BaseX from everywhere in your shell/terminal.
 
  
====Java====
+
=Startup=
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 GUI==
+
First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:
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#BaseX GUI|Startup Options]]):
+
{| class="wikitable"
 +
|-
 +
! BaseX Version
 +
! Minimum Java Version
 +
|-
 +
| 10
 +
| 11
 +
|-
 +
| 9
 +
| 8
 +
|-
 +
| 8
 +
| 7
 +
|-
 +
| ''older''
 +
| 6
 +
|}
  
* Double click on the {{Code|BaseX.jar}} file.
+
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|basexgui]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexgui.bat]]}} scripts.
 
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXGUI}}
 
* On ''Windows'': Double click on the '''BaseX GUI''' icon.
 
* For [[Maven]] users: type in {{Code|mvn exec:java}} in the main directory of the {{Code|basex}} project.
 
  
Note that the GUI does ''not'' interact with the client/server architecture.
+
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).
  
==BaseX Standalone==
+
Next, [https://basex.org/download get a fresh copy of BaseX] from our homepage. The following distributions are available:
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
+
==Core Package==
(get more information on all [[Startup Options#BaseX Standalone|Startup Options]]):
 
  
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basex.bat]]}} scripts.
+
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.
* Execute the following command: {{Code|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.
+
==Full Distributions==
  
==BaseX Server==
+
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:
The [[Database Server]] comes into play if BaseX is to be used by
 
more than one user (client). It handles concurrent [[Transaction_Management|read and write transactions]],
 
provides [[User Management|user management]] and [[Logging|logs all user interactions]].
 
  
By default, the server listens to the port {{Code|1984}}.
+
{| class="wikitable"
There are several ways of starting and stopping the server
+
|- valign="top"
(get more information on all [[Startup Options#BaseX Server|Startup Options]]):
+
! 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]].
 +
|}
  
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexserver]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexserver.bat]]}} scripts. Add the {{Code|stop}} keyword to gracefully shut down the server.
+
Global [[Options]] are stored in the [[Configuration|.basex configuration file]].
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXServer}}. Again, the {{Code|stop}} keyword will ensure a graceful shutdown.
 
* On ''Windows'': Double click on the '''BaseX Server''' icon, which will also start the [[#BaseX HTTP Server|HTTP Server]], or the '''BaseX Server (stop)''' icon.
 
  
Pressing {{Code|Ctrl+c}} will close all connections and databases and shut down the server process.
+
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.
  
==BaseX Client==
+
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.
The [[Database Server|BaseX Client]] interface can be used to send
 
commands and queries to the server instance on command line.
 
  
It can be started as follows
+
==Web Archive==
(get more information on all [[Startup Options#BaseX Client|Startup Options]]):
 
  
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexclient]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexclient.bat]]}} scripts.
+
The '''WAR Archive''' can be embedded in existing Java web servers.
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXClient}}
 
* On ''Windows'': Double click on the '''BaseX Client''' icon.
 
  
The default {{Code|admin}} user can be used to connect to the server: <br/>
+
==Other Distributions==
* <b>Username:</b> {{Code|admin}}
 
* <b>Password:</b> {{Code|admin}}
 
The password should be changed with the {{Code|[[Commands#PASSWORD|PASSWORD]]}} command after the first login.<br/>
 
  
Please check out the article on the [[Database Server]] for more details.
+
Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
  
==BaseX HTTP Server==
+
=Concurrent Operations=
  
The HTTP Server gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] Services of BaseX.
+
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.
By default, it starts an instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server],
 
which by default listens to the port {{Code|8984}}, and the BaseX Server, which listens to {{Code|1984}}.
 
  
To run the HTTP Server, you need to [http://basex.org/products/download/ 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
+
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.
(get more information on all [[Startup Options#BaseX HTTP Server|Startup Options]]):
 
  
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]}} or {{Code|[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]}} scripts. Call the script with the {{Code|stop}} keyword to gracefully shut down the server.
+
More details on concurrency can be found on the [[Transaction Management]] page.
* 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 {{Code|mvn jetty:run}} in the main directory of the {{Code|basex-api}} project, and press {{Code|Ctrl+c}} to shut down the process (see [[Web Application#Maven|Web Application: Maven]] for more details).
 
  
 
=Changelog=
 
=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
 
;Version 7.0
 
 
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
 
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
 
[[Category:Beginner]]
 

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