Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
(107 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
This article is part of the [[Getting Started]] Guide.
+
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
−
It tells you how to get BaseX running.
 
  
−
==Requirements==
+
=Introduction=
  
−
====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.
 
−
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====
+
# 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.
−
A Runtime Environment of [http://www.java.com Java 1.6] (JRE) is needed to run BaseX.
+
# You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the terminal, or want to do batch processing.
−
BaseX is platform independent and runs on any system that provides a Java Virtual Machine.
+
# 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.
−
BaseX has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x),
+
# 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.
−
Linux(SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).
+
# It can also be embedded as a Java library in your applications.
  
−
====Synchronization====
+
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.
−
If you plan to concurrently read and write your data, you should resort to the
 
−
client/server architecture. This is because the GUI, the standalone client
 
−
and the client/server architecture of BaseX all work in different JVMs (Java
 
−
virtual machines) and are not synchronized among each other. You should be aware
 
−
that, in the worst case, databases might get corrupt if you use BaseX instances
 
−
in different JVMs and try to enforce updates.
 
  
−
==BaseX GUI==
+
=Startup=
−
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]]):
+
First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:
  
−
* Double click on the {{Code|BaseX.jar}} file.
+
{| class="wikitable"
−
* 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}}
+
! BaseX Version
−
* On ''Windows'': Double click on the '''BaseX GUI''' icon.
+
! Minimum Java Version
−
* For [[Maven]] users: type in {{Code|mvn exec:java}} in the main directory of the {{Code|basex}} project.
+
|-
 +
| 10
 +
| 11
 +
|-
 +
| 9
 +
| 8
 +
|-
 +
| 8
 +
| 7
 +
|-
 +
| ''older''
 +
| 6
 +
|}
  
−
Note that the GUI does ''not'' interact with the client/server architecture.
+
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.
  
−
==BaseX Standalone==
+
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 [[Standalone Mode]] can be used to enter database commands, or execute automated database operations and queries, on command line.
 
  
−
The standalone version can be started as follows
+
Next, [https://basex.org/download get a fresh copy of BaseX] from our homepage. The following distributions are available:
−
(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.
+
==Core Package==
−
* 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.
+
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.
  
−
==BaseX Server==
+
==Full Distributions==
−
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}}.
+
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 and stopping the server
 
−
(get more information on all [[Startup Options#BaseX Server|Startup Options]]):
 
  
−
* 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.
+
{| class="wikitable"
−
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXServer}}. Again, the {{Code|stop}} keyword will ensure a graceful shutdown.
+
|- valign="top"
−
* 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.
+
! 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]].
 +
|}
  
−
Pressing {{Code|Ctrl+c}} will close all connections and databases and shut down the server process.
+
Global [[Options]] are stored in the [[Configuration|.basex configuration file]].
  
−
==BaseX 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.
−
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
+
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.
−
(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.
+
==Web Archive==
−
* 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/>
+
The '''WAR Archive''' can be embedded in existing Java web servers.
−
* <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.
+
==Other Distributions==
  
−
==BaseX HTTP Server==
+
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 gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] Services of BaseX.
+
=Concurrent Operations=
−
By default, it starts an instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server],
 
−
which 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
+
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.
−
(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.
+
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.
−
* On ''Windows'': Double click on the '''BaseX Server''' or '''BaseX Server (stop)''' icon.
+
 
−
* 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.
+
More details on concurrency can be found on the [[Transaction Management]] page.
−
* You may also want to deploy BaseX as a [[Web Application]].
 
  
 
=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 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"