Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
First of all, please [http://basex.org/download download] BaseX from our homepageis very light-weight.The following versions 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 frontendif you don’t require HTTP services.* the '''ZIP Archive'''# The [[Web Application|HTTP Server]] provides [[REST]] and [[WebDAV]] services. With [[RESTXQ]], the '''Windows Installer''' and the '''Mac OSX''' package contain libraries for 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 BaseX has been tested on numerous platforms, including Windows (2000, XP, Vista, 7, 10, 11), Mac OS X (10.x , 11.x), Linux distributions are available from the download page(SuSE xxx, Debian,which contain only the core package andRedhat, optionallyCentOS, scripts for starting BaseXUbuntu) and OpenBSD (up to 7.x). It is platform-independent and runs on any system supporting Java.
BaseX 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:
BaseX is platform independent and runs If you have several versions or distributions installed, you can type {{Code|java -version}} on any system that provides animplementation of [http://www.java.com command-line to check which Java 1.6] (JRE).It has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x),Linux(SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x)version is currently used.
====Concurrent Operations====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).
If you plan to perform concurrent read and write operations on a single databaseNext,the client[https:/server architecture is the right choice/basex. You may safely open the same databasein different JVMs (Java virtual machines) for read-only access, and you won’t encounter anyproblems when reading org/download get a fresh copy of BaseX] from or writing to different databases, but your update operations willbe rejected if the database to be written to is currently opened by another virtual machineour homepage.The following distributions are available:
* 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.==Full Distributions==
Note that In addition, the GUI does ''not'ZIP Package' interact with '' and the client/server architecture'''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the [[DBA]], a browser-based database administration interface.If you unzip or install BaseX, the target directory will contain the following directories:
The standalone version can be started as follows(get more information on all Global [[Command-Line Options#BaseX Standalone]] are stored in the [[Configuration|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.
Note that If you work with the standalone mode does ''not'' interact with ZIP distribution, and if you want to make BaseX globally available, you can add the client/server architecture{{Code|bin}} directory to your PATH environment variable.
By default, the server listens to the port {{Code|1984}}The '''WAR Archive''' can be embedded in existing Java web servers.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 on the '''BaseX Server''' icon, which will also start the [[#BaseX HTTP Server|HTTP Server]], or the '''BaseX Server (stop)''' icon.==Other Distributions==
Pressing {{Code|Ctrl+c}} will close all connections and databases Various other distributions are available from the download page, most of which contain only the core package and shut down the server process, optionally, scripts for starting BaseX.
It can be started as followsIf you want to perform parallel (get more information concurrent) read and write operations on all [[Command-Line Options#your databases, you must use the client/server architecture or run BaseX Client|Startup Options]]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.
* Run one of 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 {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexclient]]}} GUI 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 a standalone instance at the '''BaseX Client''' iconsame time.
The default {{Code|admin}} user More details on concurrency can be used to connect to found on the server: <br/>* <b>Username:</b> {{Code|admin}}* <b>Password:</b> {{Code|admin}}The password should be changed with the {{Code|[[Commands#PASSWORD|PASSWORDTransaction Management]]}} command after the first loginpage.<br/>
Please check out the article on the [[Database Server]] for more details. =Changelog=BaseX HTTP Server== The HTTP Server gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] Services of BaseX.By default, it starts an instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server],which by default 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;Version 10. It can then be started as follows0(get more information on all [[Command-Line Options#BaseX HTTP Server|Startup Options]])* Update:Switched to Java 11
* 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;Version 9.0* On ''Windows''Update: 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}} Switched to shut down the process (see [[Web Application#Maven|Web Application: Maven]] for more details).Java 8
=Changelog=;Version 8.0* Update: Switched to Java 7
[[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=
{| class====Requirements===="wikitable"|-! BaseX Version! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-| ''older''| 6|}
==BaseX GUICore Package==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.
The GUI can be started as follows (get more information on all [[Command-Line Options#'''Core Package''' is a very compact JAR file. It contains the BaseX GUI|Startup Options]]):database management system, the XQuery processor, the client/server architecture, and the graphical user interface. It runs without additional libraries.
{| class="wikitable"|- valign=BaseX Standalone=="top"! Directory! Description|-| {{Code|bin}}| Start scripts (Windows, Linux).|-| {{Code|data}}| The database directory.|-| {{Code|etc}}| Example data: XML sample, [[Standalone ModeCatalog Resolver|catalog and DTD files]] .|-| {{Code|lib}}| Extra libraries (Jetty, Tagsoup, …).|-| {{Code|lib/custom}}| Directory in which additional JAR files can be used to execute placed (such as the Saxon library).|-| {{Code|repo}}| [[Repository]] for external XQuery expressions or run database commands on command linemodules (the [http://www.xqueryfunctions.com FunctX] library is included as example). It can also be used both |-| {{Code|src}}| Directory for scripting your XQuery scripts and batch processing your XML other source data.|-| {{Code|webapp}}| [[Web Application]] directory: home of the RESTXQ web application, REST scripts, and [[DBA]].|}
==BaseX ServerWeb Archive==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]].
=Concurrent Operations=BaseX Client==The [[Database Server|BaseX Client]] interface can be used to sendcommands and queries to the server instance on command line.
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
