Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
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 lots of different ways, such as a
 
BaseX is very light-weight. It can be run and used in lots of different ways, such as a
Line 13: Line 13:
 
First of all, [http://basex.org/download download] BaseX from our homepage. The following distributions are available:
 
First of all, [http://basex.org/download download] BaseX from our homepage. The following distributions are available:
  
==Distributions==
+
=Distributions=
  
===Core Package===
+
==Core Package==
  
 
The '''Core Package''' is a small JAR file. It contains the BaseX database management system, the XQuery processor, the client/server architecture, and the graphical user interface. It does not require any additional libraries.
 
The '''Core Package''' is a small JAR file. It contains the BaseX database management system, the XQuery processor, the client/server architecture, and the graphical user interface. It does not require any additional libraries.
  
===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 BaseX's browser-based database administration interface ([[DBA]]).
Line 38: Line 38:
 
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.
  
===Web Archive===
+
==Web Archive==
  
 
The '''WAR Archive''' can be embedded in existing Java web servers.
 
The '''WAR Archive''' can be embedded in existing Java web servers.
  
===Other Distributions===
+
==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.
 
Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
  
==Requirements==
+
=Requirements=
  
 
BaseX is platform-independent and runs on any system that provides an implementation of the [http://www.java.com Java Runtime Environment (JRE)]:
 
BaseX is platform-independent and runs on any system that provides an implementation of the [http://www.java.com Java Runtime Environment (JRE)]:
Line 56: Line 56:
 
Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).
 
Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).
  
==Concurrent Operations==
+
=Concurrent Operations=
  
 
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.
 
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.
Line 64: Line 64:
 
More details on concurrency can be found on the [[Transaction Management]] page.
 
More details on concurrency can be found on the [[Transaction Management]] page.
  
=Standalone Application=
+
=Startup=
  
==Graphical User Interface==
+
* BaseX comes with a [[GUI|graphical user interface]] that offers you marvellous tools for managing, querying and visualizing your (XML) data and write complex applications in XQuery.
 
+
* If you prefer to work on command-line line and want to do batch processing, you can start BaseX as [[#Command-Line Client|standalone command-line client]].
The [[GUI]] is the visual interface to the features of BaseX. It is a fully fledged XML editor and can be used to create new databases, perform queries or interactively explore your XML data. It can be started as follows:
+
* The [[Database Server]] comes into play if you have multiple users or clients.
 
+
* 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.
* 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.
 
 
 
More information on the GUI's command-line options can be found [[Command-Line Options#GUI|here]].
 
 
 
==Command-Line Client==
 
 
 
The [[Command-Line Client]] can be used to execute XQuery expressions or run database commands on the command line. It can also be used for both scripting and batch processing your XML data. It can be started as follows:
 
 
 
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basex.bat]]}} scripts.
 
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseX}}
 
* On ''Windows'': Double click on the '''BaseX (Standalone)''' icon.
 
 
 
It is important to remember that the standalone mode does ''not'' interact with the client/server architecture. More information on the standalone mode's command-line options can be found [[Command-Line Options#Standalone|here]].
 
 
 
=Database 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]], [[User Management|manages user permissions]] and [[Logging|logs all user interactions]].
 
 
 
By default, the server listens to the port {{Code|1984}}.
 
There are several ways of starting and stopping the server:
 
 
 
* 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.
 
* 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 HTTP Server (Start)''' icon, which will start both the HTTP Server used for [[#Web Application|Web Applications]] and the database server. With '''BaseX HTTP Server (Stop)''', you can shut down the server process.
 
 
 
Pressing {{Code|Ctrl+c}} will close all connections and databases and shut down the server process. More information on the database server's command-line options can be found [[Command-Line Options#Server|here]].
 
 
 
==Client==
 
 
 
The BaseX [[Database Server#Command-Line Client|Command-Line Client]] interface can be used to send
 
commands and queries to the server instance on command line. It can be started as follows:
 
 
 
* 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.
 
 
 
More information on the command-line options can be found [[Command-Line Options#Client|here]].
 
 
 
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/>
 
 
 
If you want to communicate with the database server programmatically, we provide clients in various [[Clients|programming languages]].
 
 
 
=Web Application=
 
 
 
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 [https://www.eclipse.org/jetty/ Jetty Web Server] will be created,
 
which by default listens to the port {{Code|8984}}. Additionally, the BaseX database
 
server will be started, which is accessible on port {{Code|1984}}.
 
 
 
It can be started as follows:
 
 
 
* 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-9.4.14.v20181114; built: 2018-11-14T21:20:31.478Z; git: c4550056e785fb5665914545889f21dc136ad9e6; jvm 11.0.1+13
 
[main] INFO org.eclipse.jetty.webapp.StandardDescriptorProcessor - NO JSP Support for /, did not find org.eclipse.jetty.jsp.JettyJspServlet 
 
...
 
HTTP Server was started (port: 8984).
 
Server was started (port: 1984).
 
</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.
 
 
 
More information on the HTTP server's command-line options can be found [[Command-Line Options#HTTP Server|here]].
 
 
 
==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=
 
=Changelog=

Revision as of 13:28, 12 November 2019

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 lots of different ways, such as a

It can also be embedded as a library in your own application.

First of all, download BaseX from our homepage. The following distributions are available:

Distributions

Core Package

The Core Package is a small JAR file. It contains the BaseX database management system, the XQuery processor, the client/server architecture, and the graphical user interface. It does not require any 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 BaseX's browser-based database administration interface (DBA).

After BaseX has been unzipped or installed, the following directories will be available:

  • bin/: Start scripts (Windows, Linux).
  • data/: Database directory. See Configuration for more details.
  • 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.

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 classpath.

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.

Requirements

BaseX is platform-independent and runs on any system that provides an implementation of the Java Runtime Environment (JRE):

  • Since Version 9 of BaseX, Java 8 is required.
  • Since Version 8, 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), Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).

Concurrent Operations

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.

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

  • BaseX comes with a graphical user interface that offers you marvellous tools for managing, querying and visualizing your (XML) data and write complex applications in XQuery.
  • If you prefer to work on command-line line and want to do batch processing, you can start BaseX as standalone command-line client.
  • The Database Server comes into play if you have multiple users or clients.
  • 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.

Changelog

Version 8.0
  • Update: Switched to Java 7
Version 7.0
  • Updated: BaseXJAXRX has been replaced with BaseXHTTP