Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
 
(50 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
 
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
  
=Getting Started=
+
=Introduction=
  
BaseX is very light-weight. It can be run and used in various ways:
+
BaseX is very light-weight. It can be run and used in many different ways:
  
* as standalone application, using the [[#Standalone|Standalone]] mode or the [[#Graphical User Interface|Graphical User Interface]],
+
# 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.
* as [[#Client/Server|Client/Server]] application, or
+
# You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the terminal, or want to do batch processing.
* as [[#HTTP Server|Web Application]], called from a web server.
+
# 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.
  
It can also be embedded as a library in your own application.
+
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.
  
First of all, [http://basex.org/download download] BaseX from our homepage.
+
=Startup=
The following distributions are available:
 
  
==Distributions==
+
First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:
  
===Core Package===
+
{| class="wikitable"
 +
|-
 +
! BaseX Version
 +
! Minimum Java Version
 +
|-
 +
| 10
 +
| 11
 +
|-
 +
| 9
 +
| 8
 +
|-
 +
| 8
 +
| 7
 +
|-
 +
| ''older''
 +
| 6
 +
|}
  
The '''Core Package''' is a small JAR file. It contains the database system, the XQuery processor and the graphical user interface. It does not require any additional libraries.
+
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.
  
===Full Distributions===
+
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 '''ZIP Package''' and the '''Windows Installer''' contain the BaseX core library and extra libraries for web applications and advanced features, [[Start Scripts]], and some additional optional files.
+
Next, [https://basex.org/download get a fresh copy of BaseX] from our homepage. The following distributions are available:
  
After BaseX has been unzipped or installed, the following directories will be available:
+
==Core Package==
  
* {{Code|bin}}: Start scripts (Windows, Linux)
+
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.
* {{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, …), which will be added to the class path by the start scripts.
 
* {{Code|lib/custom}}: Directory for additional JAR files (such as the Saxon library).
 
* {{Code|repo}}: Repository directory for 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: RESTXQ web application, REST scripts, [[DBA]]
 
  
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.
+
==Full Distributions==
  
===Web Archive===
+
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 '''WAR Archive''' can be embedded in existing Java web servers.
+
{| 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]].
 +
|}
  
===Other Distributions===
+
Global [[Options]] are stored in the [[Configuration|.basex configuration file]].
  
Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
+
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.
  
==Requirements==
+
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.
  
BaseX is platform-independent and runs on any system that provides an implementation of the [http://www.java.com Java Runtime Environment (JRE)]:
+
==Web Archive==
* 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), Max OS X (10.x),
+
The '''WAR Archive''' can be embedded in existing Java web servers.
Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).
 
  
==Concurrent Operations==
+
==Other Distributions==
  
If you want to perform parallel (concurrent) read and write operations on your databases, you must use the client/server architecture or deploy 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.
+
Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
  
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.
+
=Concurrent Operations=
  
More details on concurrency are found in the [[Transaction Management]] article.
+
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.
  
=Standalone=
+
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.
  
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. It can be started as follows (get more information on all [[Command-Line Options#Standalone|Startup Options]]):
+
More details on concurrency can be found on the [[Transaction Management]] page.
  
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basex.bat]]}} scripts.
+
=Changelog=
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseX}}
 
* On ''Windows'': Double click on the '''BaseX''' icon.
 
 
 
It is important to remember that the standalone mode does ''not'' interact with the [[#Client/Server|Client/Server]] architecture.
 
 
 
=Graphical User Interface=
 
 
 
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.
 
 
 
It can be started as follows (get more information on all [[Command-Line Options#GUI|Startup Options]]):
 
 
 
* Double click on the {{Code|BaseX.jar}} file.
 
* 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.
 
 
 
=Client/Server=
 
 
 
==Server==
 
 
 
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}}.
+
;Version 10.0
There are several ways of starting and stopping the server
+
* Update: Switched to Java 11
(get more information on all [[Command-Line Options#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.
+
;Version 9.0
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXServer}}. Again, the {{Code|stop}} keyword will ensure a graceful shutdown.
+
* Update: Switched to Java 8
* On ''Windows'': Double click on the '''BaseX Server''' icon, which will also start the [[#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.
 
 
 
==Client==
 
 
 
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
 
(get more information on all [[Command-Line Options#Client|Startup Options]]):
 
 
 
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexclient]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexclient.bat]]}} scripts.
 
* 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/>
 
* <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/>
 
 
 
We provide additional clients in various [[Clients|programming languages]].
 
 
 
=HTTP Server=
 
 
 
With the HTTP Server, BaseX can be used to build [[Web Application]]s.
 
It provides access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services.
 
An instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server] will be created,
 
which by default listens to the port {{Code|8984}}. Additionally, the BaseX Server will
 
be started, which is accessible on port {{Code|1984}}.
 
 
 
It can be started as follows (get more information on all [[Command-Line Options#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.
 
* On ''Windows'': Double click on the '''BaseX Server''' or '''BaseX Server (stop)''' icon.
 
* BaseX can also be deployed as [[Web Application#Servlet Container|web servlet]].
 
 
 
In the first two cases, the command-line output will look similar to the following lines (the JSP warning message [http://stackoverflow.com/questions/3521654/missing-jsp-support-in-jetty-or-confusing-log-message can be ignored]):
 
 
 
<pre class="brush:xml">
 
[main] INFO org.eclipse.jetty.server.Server - jetty-8.1.18.v20150929
 
[main] INFO org.eclipse.jetty.webapp.StandardDescriptorProcessor - NO JSP Support for /, did not find org.apache.jasper.servlet.JspServlet
 
[main] INFO org.eclipse.jetty.server.AbstractConnector - Started SelectChannelConnector@0.0.0.0:8984
 
HTTP Server was started (port: 8984).
 
</pre>
 
 
 
You can adjust the Jetty logging level by adding the following properties to the start script:
 
 
 
<pre class="brush:xml">
 
-Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -D{classref}.LEVEL=DEBUG
 
</pre>
 
 
 
After that, you can e. g. open your browser and navigate to the RESTXQ start page http://localhost:8984.
 
 
 
==Database Administration==
 
 
 
The [[DBA]] is a web-based database administration interface. It allows you to create and administrate databases, evaluate queries in realtime, view log files, manage users, etc.
 
 
 
It can be accessed via http://localhost:8984/dba/.
 
 
 
=Changelog=
 
  
 
;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 12:33, 27 July 2022

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.

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