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 frontendif 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 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 on any system that provides animplementation of [http://www.java.com Java] (JRE). With If you have several versions or distributions installed, you can type {{VersionCode|8.0java -version}} of BaseX, we switched on command-line to check which Java 7, because it provides better file handling support, and because Oracle stopped public support for older versionsversion is currently used.
BaseX has been tested on several platforms, including If you have Windows (2000, XP, Vista, 7), Max OS X (10we recommend the {{Code|.msi}} distributions from [https://adoptium.net/ Adoptium].x), Linux (SuSE xxxThe JRE packages are sufficient, Debian, Ubuntu) and OpenBSD but you can also install the JDK (4.xJava Development Kit).
====Concurrent Operations====Next, [https://basex.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 a single database,the client/server architecture is the right choice. You may safely open the same databasein different JVMs (Java virtual machines) for read-only access, and you won’t encounter anyproblems when reading 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 machine.==Core Package==
==BaseX GUI==The [[GUI]] '''Core Package''' is a very compact JAR file. It contains the visual BaseX database management system, the XQuery processor, the client/server architecture, and the graphical user interface to the features of BaseX.It can be used to create new databases, perform queries or interactivelyexplore your XML dataruns without additional libraries.
The GUI can be started as follows (get more information on all [[Command-Line Options#BaseX GUI|Startup Options]]):==Full Distributions==
* Double click on In addition, 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'ZIP Package''': Double click on and the '''BaseX GUIWindows Installer''' icon.* For contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the [[MavenDBA]] users: type in {{Code|mvn exec:java}} in , a browser-based database administration interface. If you unzip or install BaseX, the main target directory of will contain the {{Code|basex}} project.following directories:
Note that {| 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 GUI does ''not'' interact with Saxon library).|-| {{Code|repo}}| [[Repository]] for external XQuery modules (the client[http://server architecturewww.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]].|}
==BaseX Standalone==The Global [[Standalone ModeOptions]] can be used to execute XQuery expressions or run database commands on command lineare stored in the [[Configuration|. It can also be used both for scripting and batch processing your XML databasex configuration file]].
The standalone version can be If BaseX is started as follows(get more information on via the start scripts or the Windows icons, all [[Command-Line Options#BaseX StandaloneJAR files in the {{Code|Startup Options]]):lib}} directory and its descendant directories will be added to the class path.
* Run one of If you work with the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basex.bat]]}} scripts.* Execute ZIP distribution, and if you want to make BaseX globally available, you can add the following command: {{Code|java -cp BaseX.jar org.basex.BaseXbin}}* On ''Windows'': Double click on the '''BaseX''' icondirectory to your PATH environment variable.
Note that the standalone mode does ''not'' interact with the client/server architecture.==Web Archive==
==BaseX Server==The [[Database Server]] comes into play if BaseX is to '''WAR Archive''' can 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]]embedded in existing Java web servers.
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#BaseX Server|Startup Options]]):==Other Distributions==
* 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 Various other distributions are available from the following command: {{Code|java -cp BaseX.jar org.basex.BaseXServer}}. Againdownload page, most of which contain only the {{Code|stop}} keyword will ensure a graceful shutdown.* On ''Windows'': Double click on the '''BaseX Server''' iconcore package and, which will also start the [[#BaseX HTTP Server|HTTP Server]]optionally, or the '''scripts for starting BaseX Server (stop)''' icon.
Pressing {{Code|Ctrl+c}} will close all connections and databases and shut down the server process.=Concurrent Operations=
==If you want to perform parallel (concurrent) read and write operations on your databases, you must use the client/server architecture or run BaseX Client==The [[Database Server|BaseX Client]] interface as a web application. You can be used 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 sendcommands and queries different databases. Update operations from different JVMs to the server instance on command linesame database will be rejected or may even lead to corrupt databases.
It For example, if you only read data, you can be started as followseasily run several clients (get more information on all [[Command-Line Options#BaseX Client|Startup Options]]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.
* Run one of More details on concurrency can be found on the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexclientTransaction Management]]}} 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''' iconpage.
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/> 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. 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;Version 10.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 11
After that, you can open your browser and navigate ;Version 9.0* Update: Switched to the start page http://localhost:8984.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|}
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
