Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
* as standalone application, using the [[#Standalone|Standalone]] mode or the BaseX comes with a [[#Graphical User InterfaceGUI|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.#Client/Server|Client/The [[Database Server]] applicationis the right choice if you have multiple users or clients, orif you use other programming languages and if you don’t require HTTP services.* as # The [[#Web Application|HTTP Server|Web Application]] provides [[REST]] and [[WebDAV]] services. With [[RESTXQ]], called from complex web applications can be built, and the embedded [[DBA]] application allows you to work with BaseX in the browser.# It can also be embedded as a web serverJava library in your applications.
First of all, [http://basex.org/download download] BaseX from our homepage.The following distributions are available:=Startup=
==Distributions==First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:
The '''Core Package''' If you have several versions or distributions installed, you can type {{Code|java -version}} on command-line to check which Java version is a small JAR file. It contains the database system, the XQuery processor and the graphical user interface. It does not require any additional librariescurrently used.
===Full Distributions===If you have Windows, we recommend the {{Code|.msi}} distributions from [https://adoptium.net/ Adoptium]. The JRE packages are sufficient, but you can also install the JDK (Java Development Kit).
The '''ZIP Package''' and the '''Windows Installer''' contain the BaseX core library and extra libraries for web applications and advanced featuresNext, [[Start Scripts]https://basex.org/download get a fresh copy of BaseX], and some additional optional filesfrom our homepage.The following distributions are available:
After BaseX has been unzipped or installed, the following directories will be available:==Core Package==
* {{Code|bin/}}: Start scripts (Windows, Linux)The '''Core Package''' is a very compact JAR file.* {{Code|data/}}: Database directory. See [[Configuration]] for more details.* {{Code|etc/}}: Example data: XML sampleIt contains the BaseX database management system, [[Catalog Resolver|catalog and DTD files]].* {{Code|lib/}}: Extra libraries (Jettythe XQuery processor, Tagsoup, …).* {{Code|libthe client/custom/}}: Directoryserver architecture, in which additional JAR files can be placed (such as and the Saxon library)graphical user interface.* {{Code|repo/}}: [[Repository]] (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: RESTXQ web application, REST scripts, [[DBA]]It runs without additional libraries.
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 classpath.==Full Distributions==
If you work with In addition, the '''ZIP distributionPackage''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and if the [[DBA]], a browser-based database administration interface. If you want to make unzip or install BaseX globally available, you can add the {{Code|bin}} target directory to your PATH environment variable.will contain the following directories:
The '''WAR Archive''' can be embedded Global [[Options]] are stored in existing Java web serversthe [[Configuration|.basex configuration file]].
===Other Distributions===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.
Various other distributions are available from If you work with the download pageZIP distribution, most of which contain only the core package andif you want to make BaseX globally available, optionally, scripts for starting BaseXyou can add the {{Code|bin}} directory to your PATH environment variable.
BaseX is platform-independent and runs on any system that provides an implementation of the [http://www.java.com The '''WAR Archive''' can be embedded in existing Java Runtime Environment (JRE)]:* Since <b>Version 9</b> of BaseX, Java 8 is required.* Since <b>Version 8</b>, Java 7 is required.* Older versions are based on Java 6web servers.
BaseX has been tested on several platforms, including Windows (2000, XP, Vista, 7), Max OS X (10.x),Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).==Other Distributions==
==Concurrent Operations==Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
If you want to perform parallel (concurrent) read and write operations on your databases, 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 databases.=Concurrent Operations=
For example, if you only read data, If you can easily run several clients want to perform parallel (standalone, GUI, database clientsconcurrent) at the same time. If you update read and write operations on your data, howeverdatabases, you shouldn’t must use the GUI client/server architecture or run BaseX as a web application. You can safely open a standalone instance at 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 timedatabase will be rejected or may even lead to corrupt databases.
More details on concurrency are found 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 [[Transaction Management]] articleGUI or a standalone instance at the same time.
=Standalone=More details on concurrency can be found on the [[Transaction Management]] page.
The [[Standalone Mode]] 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 [[Command-Line Options#Standalone|Startup Options]]): * 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. It is important to remember that the standalone mode does ''not'' interact with the [[#Client/Server|Client/Server]] architecture. =Graphical User Interface= 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. It can be started as follows (get more information on all [[Command-Line Options#GUI|Startup Options]]): * 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. Note that the GUI does ''not'' interact with the client/server architecture. =Client/Server= ==Server== 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]]. 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. ==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 to build [[Web Application]]s.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.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -D{classref}.LEVEL=DEBUG</pre> After that, you can e. g. open your browser and navigate to the RESTXQ start page http://localhost:8984. ==Database Administration=Changelog=
The [[DBA]] is a web-based database administration interface;Version 10. It allows you 0* Update: Switched to create and administrate databases, evaluate queries in realtime, view log files, manage users, etc.Java 11
It can be accessed via http://localhost:8984/dba/;Version 9.0 =Changelog=* Update: Switched to Java 8
no edit summary
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
=Getting StartedIntroduction=
BaseX is very light-weight. It can be run and used in various many different ways:
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 (up to 7.x). It can also be embedded as a library in your own applicationis platform-independent and runs on any system supporting Java.
{| class===Core Package==="wikitable"|-! BaseX Version! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-| ''older''| 6|}
{| class="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 Archive===Application]] directory: home of the RESTXQ web application, REST scripts, and [[DBA]].|}
==RequirementsWeb Archive==
;Version 8.0
* Update: Switched to Java 7
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
