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 ensure that an up-to-date version of the [[#Standalone|Standalone]] mode or the [[#Graphical User Interface|Graphical User Interface]],* as [[#Client/Server|Client/Server]] application, or* as [[#Web Application|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 In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Standalone ModeStart Scripts]] can be used to execute XQuery expressions or run , and the [[DBA]], a browser-based database commands on command line. It can also be used both for scripting and batch processing your XML dataadministration interface.If you unzip or install BaseX, the target directory will contain the following directories:
* Run one of the {{Code|Global [[Start_Scripts#Linux.2FMac:_basex|basexOptions]]}} or {{Code|are stored in the [[Start Scripts#Windows: basexConfiguration|.bat|basex.batconfiguration file]]}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseX}}* On ''Windows'': Double click on the '''BaseX''' icon.
Note that If BaseX is started via the standalone mode does ''not'' interact with start scripts or the client/server architectureWindows icons, all JAR files in the {{Code|lib}} directory and its descendant directories will be added to the class path.
==Graphical User Interface==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.
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.==Web Archive==
* Double click on the {{Code|BaseX.jar}} file.* 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.==Other Distributions==
Note that Various other distributions are available from the GUI does ''not'' interact with download page, most of which contain only the client/server architecturecore package and, optionally, scripts for starting BaseX.
===Server===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 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.
The [[Database Server]] comes into play For example, if BaseX is to be used bymore than one user you only read data, you can easily run several clients (clientstandalone, GUI, database clients)in parallel. It handles concurrent [[Transaction_Management|read and write transactions]]If you update your data, however,provides [[User Management|user management]] and [[Logging|logs all user interactions]]you shouldn’t use the GUI or a standalone instance at the same time.
By default, the server listens to More details on concurrency can be found on the port {{Code|1984}}.There are several ways of starting and stopping the server(get more information on all [[Command-Line Options#BaseX Server|Startup OptionsTransaction Management]]):page.
* 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. Pressing {{Code|Ctrl+c}} will close all connections and databases and shut down the server process. =Changelog==Client=== The [[Database Server|BaseX Client]] interface can be used to sendcommands and queries to the server instance on command line. It can be started as follows(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.* 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. ==Web Application== With the HTTP Server, BaseX can be used as [[Web Application]].By default, an instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server] is started,which listens to the port {{Code|8984}}, and the BaseX Server, which listens to {{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.* 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 ;Version 10.0* Update: Switched to the start page http://localhost:8984.Java 11
=Changelog=;Version 9.0* Update: Switched to 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==
==StandaloneFull Distributions==
{| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|bin}}| Start scripts (Windows, Linux).|-| {{Code|data}}| The standalone version 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 started placed (such as followsthe Saxon library).|-| {{Code|repo}}| [[Repository]] for external XQuery modules (get more information on all the [[Commandhttp://www.xqueryfunctions.com FunctX] library is included as example).|-| {{Code|src}}| Directory for your XQuery scripts and other source data.|-Line Options#BaseX Standalone| {{Code|webapp}}|Startup Options[[Web Application]])directory:home of the RESTXQ web application, REST scripts, and [[DBA]].|}
The GUI '''WAR Archive''' can be started as follows (get more information on all [[Command-Line Options#BaseX GUI|Startup Options]]):embedded in existing Java web servers.
==Client/Server=Concurrent Operations=
;Version 8.0
* Update: Switched to Java 7
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
