Changes

Jump to navigation Jump to search
1,232 bytes added ,  12:50, 30 July 2018
=Getting Started=
 
BaseX is very light-weight. It can be run and used in various ways:
 
* as standalone application, using the [[#Standalone|Standalone]] mode or the [[#Graphical User Interface|Graphical User Interface]],
* as [[#Client/Server|Client/Server]] application, or
* as [[#HTTP Server|Web Application]], called from a web server.
 
It can also be embedded as a library in your own application.
First of all, [http://basex.org/download download] BaseX from our homepage.
The following distributions are available:
* the '''Core Package''' is a JAR file, which contains the database system, the query processor and the GUI frontend. It is runs completely without additional libraries.* the '''ZIP Archive''' and the '''Windows Installer''' contain libraries for web applications and advanced features, [[Start Scripts]], and some additional optional files.* the '''WAR Archive''' can be embedded in existing Java web servers.==Distributions==
Some additional distributions are available from the download page,most of which contain only the core package and, optionally, scripts for starting BaseX.===Core Package===
BaseX The '''Core Package''' is very light-weighta small JAR file. It contains the database system, the XQuery processor and the graphical user interface. It does not require any additional libraries. ===Full Distributions=== 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. After BaseX has been unzipped or installed, the following directories will be available: * {{Code|bin/}}: Start scripts (Windows, Linux).* {{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, …).* {{Code|lib/custom/}}: Directory, in which additional JAR files can be run placed (such as the Saxon library).* {{Code|repo/}}: [[Repository]] (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 BaseX is started via the start scripts or the Windows icons, all JAR files in the {{Code|lib}} directory and used 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 {{Code|bin}} directory to your PATH environment variable. ===Web Archive=== The '''WAR Archive''' can be embedded in various ways:existing Java web servers.
* as standalone application, using the [[#Standalone|Standalone]] mode or the [[#Graphical User Interface|Graphical User Interface]],* as [[#Client/Server|Client/Server]] application, or* as [[#HTTP Server|Web Application]], called from a web server.===Other Distributions===
It can also be embedded as a library in your own applicationVarious 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 [http://www.java.com Java Runtime Environment (JRE)]:
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.
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu