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 [[Start ScriptsDBA]], and some additional optional filesapplication allows you to work with BaseX in the browser.* the '''WAR Archive''' # 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 a 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 an implementation of If you have Windows, we recommend the {{Code|.msi}} distributions from [httphttps://wwwadoptium.javanet/ Adoptium].com Java] (The JRE).Since <b>Version 8.0</b> of BaseXpackages are sufficient, but you can also install the JDK (Java 7 is mandatory, 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 database commands on command line. It can also be used both for scripting , and batch processing your XML data. It can be started as follows (get more information on all the [[CommandDBA]], a browser-Line Options#based database administration interface. If you unzip or install BaseX Standalone|Startup Options]]), the target directory will contain the following directories:
* Run one of the {| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|[[Start_Scripts#bin}}| Start scripts (Windows, Linux).2FMac|-| {{Code|data}}| The database directory.|-| {{Code|etc}}| Example data:_basexXML sample, [[Catalog Resolver|basexcatalog and DTD files]].|-| {{Code|lib}}| Extra libraries (Jetty, Tagsoup, …).|-| {{Code|lib/custom}} or | Directory in which additional JAR files can be placed (such as the Saxon library).|-| {{Code|repo}}|[[Start Scripts#WindowsRepository]] for external XQuery modules (the [http: basex//www.bat|basexxqueryfunctions.bat]com FunctX]library is included as example).|-| {{Code|src}} | Directory for your XQuery scriptsand other source data.* Execute the following command: |-| {{Code|java -cp BaseX.jar org.basex.BaseXwebapp}}* On ''Windows''| [[Web Application]] directory: Double click on home of the '''BaseX''' iconRESTXQ web application, REST scripts, and [[DBA]].|}
It is important to remember that the standalone mode does ''not'' interact with Global [[Options]] are stored in the [[#Client/ServerConfiguration|Client/Server.basex configuration file]] architecture.
==Graphical User Interface==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 class path.
The [[GUI]] is If you work with the visual interface ZIP distribution, and if you want to the features of make BaseX.It globally available, you can be used add the {{Code|bin}} directory to create new databases, perform queries or interactivelyexplore your XML dataPATH environment variable.
It can be started as follows (get more information on all [[Command-Line Options#BaseX GUI|Startup Options]]):==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 The ''Windows'WAR Archive': Double click on the '''BaseX GUI''' icon.* For [[Maven]] users: type in {{Code|mvn exec:java}} can be embedded in the main directory of the {{Code|basex}} projectexisting Java web servers.
Note that the GUI does ''not'' interact with the client/server architecture.==Other Distributions==
==Client/Server==Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
The [[Database Server]] comes into play if BaseX is If you want to be used bymore than one user perform parallel (clientconcurrent). It handles concurrent [[Transaction_Management|read and write transactions]]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,provides [[User Management|user management]] and [[Logging|logs all user interactions]]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.
By defaultFor 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 server listens to GUI or a standalone instance at the port {{Code|1984}}same time.There are several ways of 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 More details on concurrency can be found on the '''BaseX Server''' icon, which will also start the [[#BaseX HTTP Server|HTTP ServerTransaction Management]], or the '''BaseX Server (stop)''' iconpage.
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.
==HTTP Server==;Version 10.0* Update: Switched to Java 11
With the HTTP Server, BaseX can be used as [[Web Application]];Version 9.It provides access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services.An instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server] will be created,which by default listens to the port {{Code|8984}}. Additionally, the BaseX Server willbe started, which is accessible on port {{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]]):0* Run one of the {{Code|[[Start_Scripts#Linux.2FMacUpdate:_basexhttp|basexhttp]]}} or {{Code|[[Start Scripts#Windows: 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.* BaseX can also be deployed as [[Web Application#Servlet Container|web servlet]]. 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==
==StandaloneFull Distributions==
===Server==Concurrent Operations=
;Version 8.0
* Update: Switched to Java 7
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
