Difference between revisions of "Startup"

From BaseX Documentation
Jump to navigation Jump to search
m (Fix apparent typo in link to Start Scripts page)
 
(61 intermediate revisions by 3 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=
  
First of all, [http://basex.org/download download] BaseX from our homepage.
+
BaseX is very light-weight. It can be run and used in lots of different ways:
The following distributions are available:
 
  
* the '''Core Package''' is a JAR file, which contains the database code, the query processor and the GUI frontend. It runs completely without additional libraries.
+
# 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.
* the '''ZIP Archive''' and the '''Windows Installer''' contain libraries for web applications and advanced features, [[Start Scripts]], and some additional optional files.
+
# You can start BaseX as [[Command-Line Client]] if you prefer to work on command-line line and want to do batch processing.
* the '''WAR Application''' can be embedded in existing Java web servers.
+
# 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 [[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.
  
Some additional distributions are available from the download page,
+
BaseX can also be embedded as library in your own applications.
most of which contain only the core package and, optionally, scripts for starting BaseX.
 
  
BaseX is very light-weight. It can be run and used in various ways:
+
==Concurrent Operations==
  
* as standalone application, using the [[#Standalone|Standalone]] mode or the [[#Graphical User Interface|Graphical User Interface]],
+
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.
* as [[#Client/Server|Client/Server]] application, or
 
* as [[#Web Application|Web Application]], called from a web server.
 
  
It can also be embedded as a library in your own application.
+
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.
  
====Requirements====
+
More details on concurrency can be found on the [[Transaction Management]] page.
  
BaseX is platform-independent and runs on any system that provides an implementation of [http://www.java.com Java] (JRE).
+
=Startup=
Since <b>Version 8.0</b> of BaseX, Java 7 is required, because it provides better file handling support,
 
and because Oracle stopped public support for older versions.
 
  
BaseX has been tested on several platforms, including Windows (2000, XP, Vista, 7), Max OS X (10.x),
+
First, [https://basex.org/download get a fresh copy of BaseX] from our homepage.
Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).
 
  
====Concurrent Operations====
+
BaseX is platform-independent and runs on any system that provides an implementation of the [https://www.java.com Java Runtime Environment (JRE)]:
 +
* 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.
  
If you plan to perform concurrent read and write operations on a single database, you
+
BaseX has been tested on several platforms, including Windows (2000, XP, Vista, 7), Mac OS X (10.x),
should use the client/server architecutre or deploy it as web application.
+
Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).
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.
 
  
==Standalone==
+
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. It can be started as follows (get more information on all [[Command-Line 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.
 
* 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.
 
 
 
The GUI can be started as follows (get more information on all [[Command-Line Options#BaseX GUI|Startup Options]]):
 
  
* Double click on the {{Code|BaseX.jar}} file.
+
==Core Package==
* 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.
+
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.
  
==Client/Server==
+
==Full Distributions==
  
===Server===
+
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]]).
  
The [[Database Server]] comes into play if BaseX is to be used by
+
After BaseX has been unzipped or installed, the following directories will be available:
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}}.
+
* {{Code|bin/}}: Start scripts (Windows, Linux).
There are several ways of starting and stopping the server
+
* {{Code|data/}}: Database directory. See [[Configuration]] for more details.
(get more information on all [[Command-Line Options#BaseX Server|Startup Options]]):
+
* {{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.
+
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.
* 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 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.
  
===Client===
+
==Web Archive==
  
The [[Database Server|BaseX Client]] interface can be used to send
+
The '''WAR Archive''' can be embedded in existing Java web servers.
commands and queries to the server instance on command line.
 
  
It can be started as follows
+
==Other Distributions==
(get more information on all [[Command-Line 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.
+
Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
* 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 various [[Clients]] (language bindings), which allow you to communicate with BaseX from other programming lanaguges.
 
 
 
==HTTP Server==
 
 
 
With the HTTP Server, BaseX can be used as [[Web Application]].
 
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}}.
 
 
 
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
 
(get more information on all [[Command-Line 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.
 
* 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]].
 
 
 
After that, you can open your browser and navigate to the start page http://localhost:8984.
 
  
 
=Changelog=
 
=Changelog=
Line 128: Line 74:
  
 
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
 
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
 
[[Category:Beginner]]
 

Latest revision as of 12:42, 2 July 2020

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 lots of different ways:

  1. BaseX comes with a Graphical User Interface that offers you marvellous tools for managing, querying and visualizing your data and write complex applications in XQuery.
  2. You can start BaseX as Command-Line Client if you prefer to work on command-line line and want to do batch processing.
  3. 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.
  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.

BaseX can also be embedded as library in your own applications.

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

Startup[edit]

First, get a fresh copy of BaseX from our homepage.

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

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

Changelog[edit]

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