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 systemterminal, 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 is 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 [[#HTTP Server|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 Runtime Environment (The JRE)].Since <b>Version 9.0</b> of BaseXpackages are sufficient, but you can also install the JDK (Java 8 is required. BaseX 8.x works with Java 7, and previous versions were based on Java 6Development 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 want to perform parallel (concurrent) read and write operations on your databasesThe '''Core Package''' is a very compact JAR file. It contains the BaseX database management system, the XQuery processor, you must use the client/server architecture or deploy BaseX as 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 operations from different JVMs to the same database will be rejected or may even lead to corrupt databasesgraphical user interface. It runs without additional libraries.
For example, if you only read data, you can easily run several clients (standalone, GUI, database clients) at the same time. If you update your data, however, you shouldn’t use the GUI or a standalone instance at the same time.==Full Distributions==
More details on concurrency are found in In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the [[Transaction ManagementDBA]] article, a browser-based database administration interface.If you unzip or install BaseX, the target directory will contain the following directories:
The Global [[Standalone ModeOptions]] 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 are stored in the [[Command-Line Options#StandaloneConfiguration|Startup Options.basex configuration file]]):.
* Run one of If BaseX is started via the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} start scripts or {{Code|[[Start Scripts#the Windows: basex.bat|basex.bat]]}} scripts.* Execute icons, all JAR files in the following command: {{Code|java -cp BaseX.jar org.basex.BaseXlib}}* On ''Windows'': Double click on directory and its descendant directories will be added to the '''BaseX''' iconclass path.
It is important If you work with the ZIP distribution, and if you want to remember that make BaseX globally available, you can add the standalone mode does ''not'' interact with the [[#Client/Server{{Code|Client/Server]] architecturebin}} directory to your PATH environment variable.
It can be started as follows (get more information on all [[Command-Line Options#GUI|Startup Options]]):==Other Distributions==
* Double click on Various other distributions are available from the {{Code|BaseX.jar}} file.* Run one download page, most of which contain only the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexgui]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexgui.bat]]}} core package and, optionally, scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXGUI}}* On ''Windows'': Double click on the '''for starting BaseX GUI''' icon.* For [[Maven]] users: type in {{Code|mvn exec:java}} in the main directory of the {{Code|basex}} project.
Note that the GUI does ''not'' interact with the client/server architecture.=Concurrent Operations=
=ClientIf you want to perform parallel (concurrent) read and write operations on your databases, you must use the client/Server=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.
==Server==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 GUI or a standalone instance at the same time.
The [[Database Server]] comes into play if BaseX is to More details on concurrency can be used bymore than one user (client). It handles concurrent [[Transaction_Management|read and write transactions]],provides found on the [[User Transaction Management|user management]] and [[Logging|logs all user interactions]]page.
By default, the server listens to the port {{Code|1984}}.There are several ways of starting and stopping the server(get more information on all [[Command-Line Options#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 [[#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#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 additional clients in various [[Clients|programming languages]]. =HTTP Server= With the HTTP Server, BaseX can be used as [[Web Application]].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}}. It can be started as follows (get more information on all [[Command-Line Options#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.* BaseX can also be deployed as [[Web Application#Servlet Container|web servlet]]. In the first two cases, the command-line output will look similar to the following lines (the JSP warning message [http://stackoverflow.com/questions/3521654/missing-jsp-support-in-jetty-or-confusing-log-message can be ignored]): <pre class="brush:xml">[main] INFO org.eclipse.jetty.server.Server - jetty-8.1.18.v20150929[main] INFO org.eclipse.jetty.webapp.StandardDescriptorProcessor - NO JSP Support for /, did not find org.apache.jasper.servlet.JspServlet[main] INFO org.eclipse.jetty.server.AbstractConnector - Started SelectChannelConnector@0.0.0.0:8984HTTP Server was started (port: 8984).</pre> You can adjust the Jetty logging level by adding the following properties to the start script:
<pre class="brush:xml">-Dorg.eclipse;Version 10.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -D{classref}.LEVEL=DEBUG0</pre>* Update: Switched to Java 11
After that, you can e;Version 9. g. open your browser and navigate 0* Update: Switched to the RESTXQ start page http://localhost:8984. =Changelog=Java 8
no edit summary
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
=Getting StartedIntroduction=
===Concurrent Operations=Core Package==
{| class=Standalone"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 Saxon 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]].|}
=Graphical User Interface=Web Archive==
The [[GUI]] is the visual interface to the features of BaseX.It '''WAR Archive''' can be used to create new databases, perform queries or interactivelyexplore your XML dataembedded in existing Java web servers.
;Version 8.0
* Update: Switched to Java 7
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
