Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
First of all, [http://basex.org/download download] BaseX from our homepageis very light-weight.The following distributions are availableIt can be run and used in many different ways:
* the '''Core Package''' is # BaseX comes with a JAR file[[GUI|Graphical User Interface]] that offers you tools for managing, which contains 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 database codeterminal, or want to do batch processing.# The [[Database Server]] is the query processor right choice if you have multiple users or clients, or if you use other programming languages and the GUI frontend. It runs completely without additional librariesif you don’t require HTTP services.* the '''ZIP Archive''' # The [[Web Application|HTTP Server]] provides [[REST]] and the '''Windows Installer''' contain libraries for [[WebDAV]] services. With [[RESTXQ]], complex web applications can be built, and advanced features, the embedded [[Starts ScriptsDBA]], and some additional optional filesapplication allows you to work with BaseX in the browser.* the '''WAR Application''' # It can also be embedded as a Java library in existing Java web serversyour applications.
Some additional distributions are available from the download pageBaseX has been tested on numerous platforms, including Windows (2000, XP, Vista, 7, 10, 11),most of which contain only the core package andMac OS X (10.x , 11.x), Linux (SuSE xxx, Debian, Redhat, optionallyCentOS, scripts for starting BaseXUbuntu) and OpenBSD (up to 7.x). It is platform-independent and runs on any system supporting Java.
BaseX is very light-weight. It can be run and used in various ways:=Startup=
* as standalone applicationFirst, using the [[Graphical User Interface]] or ensure that an up-to-date version of the [[Standalone Mode|Command-Line Interface]],* as [[Database Server|client/server]] application, or* as [[Web Application]], called from a web server.Java Runtime Environment (JRE) is available:
It can also be embedded as library in your own application.{| class="wikitable"|-! BaseX Version! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-| ''older''| 6|}
====Requirements====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.
BaseX is platform-independent and runs on any system that provides animplementation of If you have Windows, we recommend the {{Code|.msi}} distributions from [httphttps://wwwadoptium.javanet/ Adoptium].com Java] (The JRE). With {{Version|8.0}} of BaseXpackages are sufficient, we switched to but you can also install the JDK (Java 7, because it provides better file handling support, and because Oracle stopped public support for older versionsDevelopment Kit).
BaseX has been tested on several platforms, including Windows (2000, XP, Vista, 7)Next, Max OS X (10[https://basex.x), Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x)org/download get a fresh copy of BaseX] from our homepage.The following distributions are available:
If you plan to perform concurrent read and write operations on The '''Core Package''' is a single very compact JAR file. It contains the BaseX databasemanagement system, the XQuery processor, youshould use the client/server architecutre or deploy it as web application.You may safely open the same database in different JVMs (Java virtual machines) forread-only accessarchitecture, and you won’t encounter any problems when reading from or writingto different databases, but your update operations will be rejected if the databaseto be written to is currently opened by another virtual machinegraphical user interface. It runs without additional libraries.
The GUI can be started as follows (get more information on all In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[CommandStart Scripts]], and the [[DBA]], a browser-Line Options#based database administration interface. If you unzip or install BaseX GUI|Startup Options]]), the target directory will contain the following directories:
* Double click on the {| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|BaseX.jarbin}} file| Start scripts (Windows, Linux).* Run one of the |-| {{Code|[[Start_Scripts#Linuxdata}}| The database directory.2FMac:_basex|-|basexgui]]}} or {{Code|etc}}| Example data: XML sample, [[Start Scripts#Windows: basex.batCatalog Resolver|basexgui.batcatalog and DTD files]].|-| {{Code|lib}} scripts| Extra libraries (Jetty, Tagsoup, …).* Execute the following command: |-| {{Code|java -cp BaseX.jar org.basex.BaseXGUIlib/custom}}* On ''Windows'': Double click on | Directory in which additional JAR files can be placed (such as the '''BaseX GUI''' iconSaxon library).* For |-| {{Code|repo}}| [[MavenRepository]] usersfor external XQuery modules (the [http: type in //www.xqueryfunctions.com FunctX] library is included as example).|-| {{Code|mvn exec:javasrc}} in the main directory of the | Directory for your XQuery scripts and other source data.|-| {{Code|basexwebapp}} project| [[Web Application]] directory: home of the RESTXQ web application, REST scripts, and [[DBA]].|}
Note that Global [[Options]] are stored in the GUI does ''not'' interact with the client/server architecture[[Configuration|.basex configuration file]].
==If BaseX Standalone==The [[Standalone Mode]] can is started via the start scripts or the Windows icons, all JAR files in the {{Code|lib}} directory and its descendant directories will be used added to execute XQuery expressions or run database commands on command line. It can also be used both for scripting and batch processing your XML datathe class path.
The standalone version If you work with the ZIP distribution, and if you want to make BaseX globally available, you can be started as follows(get more information on all [[Command-Line Options#BaseX Standaloneadd the {{Code|Startup Options]]):bin}} directory to your PATH environment variable.
* 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.==Web Archive==
Note that the standalone mode does The ''not'WAR Archive' interact with the client/server architecture'' can be embedded in existing Java web servers.
By defaultVarious other distributions are available from the download page, most of which contain only the server listens to the port {{Code|1984}}.There are several ways of core package and, optionally, scripts for starting and stopping the server(get more information on all [[Command-Line Options#BaseX Server|Startup Options]]):.
* 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 Server''' icon, which will also start the [[#BaseX HTTP Server|HTTP Server]], or the '''BaseX Server (stop)''' icon.=Concurrent Operations=
Pressing {{Code|Ctrl+c}} 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 a web application. You can safely open a database in different JVMs (Java virtual machines) for read-only access, and you will close all connections not encounter any problems when reading from and writing to different databases and shut down . Update operations from different JVMs to the server processsame database will be rejected or may even lead to corrupt databases.
==BaseX Client==The [[Database Server|BaseX Client]] interface For example, if you only read data, you can be used to sendcommands and queries to easily run several clients (standalone, GUI, database clients) in parallel. If you update your data, however, you shouldn’t use the server GUI or a standalone instance on command lineat the same time.
It More details on concurrency can be started as follows(get more information found on all the [[Command-Line Options#BaseX Client|Startup OptionsTransaction Management]]):page.
* 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. 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/> Please check out the article on the [[Database Server]] for more details. ==BaseX HTTP Server=Changelog=
The HTTP Server gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] Services of BaseX;Version 10.0By default, it starts an instance of the [http* Update://jetty.codehaus.org/jetty/ Jetty Web Server],which by default listens Switched to the port {{Code|8984}}, and the BaseX Server, which listens to {{Code|1984}}.Java 11
To run the HTTP Server, you need to [http://basex;Version 9.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]]):0* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]}} or {{Code|[[Start Scripts#WindowsUpdate: basexhttp.bat|basexhttp.bat]]}} scripts. Call the script with the {{Code|stop}} keyword Switched to gracefully shut down the server.* On ''Windows'': Double click on the '''BaseX Server''' or '''BaseX Server (stop)''' icon.* You can also deploy BaseX as a [[Web Application]]* For Maven users: type in {{Code|mvn jetty:run}} in the {{Code|basex-api}} directory, and press {{Code|Ctrl+c}} to shut down the process (see [[Web Application#Maven|Web Application: Maven]] for more details). After that, you can open your browser and navigate to the start page http://localhost:8984. =Changelog=Java 8
[[Category:Beginner]]
no edit summary
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
==Getting Started=Introduction=
====Concurrent Operations==Core Package==
==BaseX GUIFull Distributions==The [[GUI]] is the visual interface to the features of BaseX.It can be used to create new databases, perform queries or interactivelyexplore your XML data.
==BaseX ServerOther Distributions==The [[Database Server]] comes into play if BaseX is to be used bymore than one user (client). It handles concurrent [[Transaction_Management|read and write transactions]],provides [[User Management|user management]] and [[Logging|logs all user interactions]].
;Version 8.0
* Update: Switched to Java 7
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
