Changes

Jump to navigation Jump to search
308 bytes added ,  13:33, 27 July 2022
no edit summary
=Introduction=
BaseX is very light-weight. It can be run and used in lots of many different ways, such as a:
* [[#Standalone Application|Standalone Application]], using the BaseX comes with a [[#Graphical User InterfaceGUI|Graphical User Interface]] or the that offers you tools for managing, querying and visualizing your data and writing sophisticated applications in XQuery.# You can start BaseX as a standalone [[#Command-Line Client|Command-Line Client]];if you prefer to work in the terminal, or want to do batch processing.* # The [[#Database Server|Database Server]] in a client/server architecture; is the right choice if you have multiple users or clients, orif you use other programming languages and if you don’t require HTTP services.* HTTP server for # The [[#Web Application|Web ApplicationsHTTP 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.
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 can also be embedded as a library in your own applicationis platform-independent and runs on any system supporting Java.
=Startup= First , ensure that an up-to-date version of all, [httpthe Java Runtime Environment (JRE) is available://basex.org/download download]  {| class="wikitable"|-! BaseX from our homepage. The following distributions are available:Version! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-| ''older''| 6|}
=Distributions=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. 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). Next, [https://basex.org/download get a fresh copy of BaseX] from our homepage. The following distributions are available:
==Core Package==
The '''Core Package''' is a small very compact 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 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 BaseX's the [[DBA]], a browser-based database administration interface ([[DBA]]).If you unzip or install BaseX, the target directory will contain the following directories:
After BaseX has been unzipped or installed{| 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 following directories will be availableSaxon 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]].|}
* {{Code|bin/}}: Start scripts (Windows, Linux).* {{Code|data/}}: Database directory. See [[Configuration]] for more details.* {{Code|etc/}}: Example data: XML sample, Global [[Catalog Resolver|catalog and DTD filesOptions]].* {{Code|lib/}}: Extra libraries (Jetty, Tagsoup, …).* {{Code|lib/custom/}}: Directory, are stored 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).* {{CodeConfiguration|src/}}: Directory for your XQuery scripts and other source data.* {{Code|webapp/}}: [[Web Application]] directory: home of the RESTXQ web application, REST scripts, and [[DBAbasex configuration file]].
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 classpathclass path.
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.
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 [http://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.
 
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 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, but update . 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 timein 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.
=StartupChangelog=
* 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;Version 10.0* If you prefer Update: Switched 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 [[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.Java 11
=Changelog=;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
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu