Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
==Requirements==This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
===Java===A Runtime Environment of [http://www.java.com Java 1.6] (JRE) is needed to run BaseX.BaseX is platform independent and runs on any system that provides a Java Virtual Machinevery light-weight.BaseX has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x),Linux(SuSE xxx, Debian, Ubuntu) It can be run and OpenBSD (4.x).used in many different ways:
==# 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.# You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the terminal, or want to do batch processing.# 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 [[GUI_TutorialWeb Application|BaseX GUIHTTP Server]] provides [[REST]] and [[WebDAV]] services. With [[RESTXQ]] is , complex web applications can be built, and the visual interface embedded [[DBA]] application allows you to work with BaseX in the features of BaseXbrowser.# It can also be used to create new databases, perform queries or interactivelyexplore embedded as a Java library in your XML dataapplications.
The GUI can be started as follows 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 (get more information [[Startup Options#BaseX GUI|here]]up to 7.x):. It is platform-independent and runs on any system supporting Java.
* Double click on the <code>BaseX.jar</code> file.* Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexgui]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexgui.bat]]</code> scripts.* Execute the command: <code>java -cp BaseX.jar org.basex.BaseXGUI</code>.* On ''Windows'': Double click on the '''BaseX GUI''' start icon.=Startup=
'''Important'''First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available: The BaseX GUI is not synchronized with other BaseX instances. You should avoid accessing the same databasefrom the GUI and the server, esp. if updates are performed.
The standalone version If you have several versions or distributions installed, you can be started as follows (get more information [[Startup Options#BaseX Standalonetype {{Code|here]]):java -version}} on command-line to check which Java version is currently used.
*Run one of If you have Windows, we recommend the <code>[{{Code|.msi}} distributions from [Start_Scripts#Linux.2FMachttps:_basex|basex]]</code>/<code>[[Start Scripts#Windows: basexadoptium.bat|basexnet/ Adoptium].bat]]</code> scripts*Execute The JRE packages are sufficient, but you can also install the command <code>java -cp BaseX.jar orgJDK (Java Development Kit).basex.BaseX</code>* On ''Windows'': Double click on the '''BaseX''' start icon
<b>Important<Next, [https://basex.org/b>: The Standalone client is not synchronized with other download get a fresh copy of BaseX instances.You should avoid accessing the same database ] from the standalone client andthe server, espour homepage. if updates The following distributions are performed.available:
There are several ways of starting The '''Core Package''' is a very compact JAR file. It contains the BaseX database management system, the XQuery processor, the client/server (get more information [[Startup Options#BaseX Server|here]]):architecture, and the graphical user interface. It runs without additional libraries.
* Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexserver]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexserver.bat]]</code> scripts.* Execute the command <code>java -cp BaseX.jar org.basex.BaseXServer</code>.* On ''Windows'': Double click on the '''BaseX Server (Start)''' start icon. This will also start the JAX-RX (HTTP) server.==Full Distributions==
The client version can be started as follows(get more information Global [[Startup Options#BaseX Client]] are stored in the [[Configuration|here.basex configuration file]]):.
*Run one of If BaseX is started via the start scripts or the <code>[[Start_Scripts#Linux.2FMac:_basex|basexclient]]</code>/<code>[[Start Scripts#Windows: basex.baticons, all JAR files in the {{Code|basexclient.bat]]</code> scripts*Execute lib}} directory and its descendant directories will be added to the command <code>java -cp BaseX.jar org.basexclass path.BaseXClient</code>* On ''Windows'': Double click on the '''BaseX Client''' start icon
The default <code>admin</code> user If you work with the ZIP distribution, and if you want to make BaseX globally available, you can be used to connect to add the server: <br/>* <b>Username:</b> <code>admin</code>* <b>Password:</b> <code>admin</code>The password should be changed with the <code>[[Commands#PASSWORD{{Code|PASSWORD]]</code> command after the first loginbin}} directory to your PATH environment variable.<br/>
Please check out our little [[Server Tutorial]] for more details.==Web Archive==
==BaseX JAX-RX Server==The '''WAR Archive''' can be embedded in existing Java web servers.
<font color='orangered'>Deprecated from Version 6.8</font>:The JAX-RX (REST) server can be started as follows (get more information [[Startup Options#BaseX JAX-RX Server|here]]):=Other Distributions==
* Run one Various other distributions are available from the download page, most of which contain only the <code>[[Start_Scripts#Linux.2FMac:_basexjaxrx|basexjaxrx]]</code>/<code>[[Start Scripts#Windows: basexjaxrx.bat|basexjaxrx.bat]]</code> core package and, optionally, scripts* On ''Windows'': Double click on the '''for starting BaseX Server (Start)''' start icon.
<font color='orangered'>Introduced with Version 6.8<If you want to perform parallel (concurrent) read and write operations on your databases, you must use the client/font>:The HTTP server architecture or run BaseX as a web application. You can be started as follows safely open a database in different JVMs (get more information [[Startup Options#BaseX HTTP Server|here]]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.
* Run one of 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 <code>[[Start_Scripts#LinuxGUI or a standalone instance at the same time.2FMac:_basexhttp|basexhttp]]</code>/<code>[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]</code> scripts* On ''Windows'': Double click on the '''BaseX Server (Start)''' start icon
==See also ==More details on concurrency can be found on the [[Server Tutorial]], [[GUI Tutorial]], [[Standalone Tutorial]], [[Getting StartedTransaction Management]]page. =Changelog= ;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[[Category* Updated:Beginner]]BaseXJAXRX has been replaced with BaseXHTTP
no edit summary
=Introduction==BaseX===Please [http://basex.org/download download] the latest BaseX version from our homepage.The official releases include the BaseX JAR file, libraries and optional [[Start Scripts]].If you do not use the Windows version, we recommend to manually add the project’s<code>bin</code> directory to your path environment; this way, you will be able to runBaseX from everywhere in your shell/terminal.
{| class=="wikitable"|-! BaseX Standalone==Version! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-The [[Standalone_Tutorial|BaseX Standalone] interface can be used''older''to enter database commands, or execute automated database and query| 6operations, on command line.|}
==BaseX ServerCore Package==The [[Server_Tutorial|BaseX Server]] is needed to handle the request ofmultiple users (clients). It manages concurrent read and write operations,user permissions and access logs.
In addition, the '''ImportantZIP Package''': If you concurrently access and the databases (especially '''Windows Installer''' contain extra libraries for write transactions)RESTXQ web applications and other advanced features, [[Start Scripts]],and the [[DBA]], a browser-based database administration interface. If you unzip or install BaseX Server is , the way to go. Don't use any other standalone/GUI BaseX instancesto access databases which are also opened by target directory will contain the server.following directories:
{| class="wikitable"|- valign=BaseX Client=="top"! Directory! Description|-| {{Code|bin}}| Start scripts (Windows, Linux).|-| {{Code|data}}| The database directory.|-| {{Code|etc}}| Example data: XML sample, [[Server_TutorialCatalog Resolver|BaseX Clientcatalog and DTD files]] interface .|-| {{Code|lib}}| Extra libraries (Jetty, Tagsoup, …).|-| {{Code|lib/custom}}| Directory in which additional JAR files can be used to sendplaced (such as the Saxon library).|-| {{Code|repo}}commands | [[Repository]] for external XQuery modules (the [http://www.xqueryfunctions.com FunctX] library is included as example).|-| {{Code|src}}| Directory for your XQuery scripts and queries to other source data.|-| {{Code|webapp}}| [[Web Application]] directory: home of the server instanceRESTXQ web application, REST scripts, and [[DBA]].|}
==BaseX HTTP Server=Concurrent Operations=
