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 servers (deprecated)your applications.
* as standalone application, using the [[Graphical User Interface]] or the [[Standalone Mode|Command-Line Interface]],* as [[Database Server|client/server]] application, or* as [[Web Application]], called from a web server.=Startup=
====Requirements====First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:
====Concurrent Operations====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 GUI==The Next, [[GUI]] is the visual interface to the features https://basex.org/download get a fresh copy of BaseX] from our homepage.It can be used to create new databases, perform queries or interactivelyexplore your XML data.The following distributions are available:
The GUI can be started as follows (get more information on all [[Command-Line Options#BaseX GUI|Startup Options]]):==Core Package==
* 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'': Double click on the Core Package'''is a very compact JAR file. It contains the BaseX GUI''' icon.* For [[Maven]] users: type in {{Code|mvn exec:java}} in database management system, the XQuery processor, the main directory of client/server architecture, and the {{Code|basex}} projectgraphical user interface. It runs without additional libraries.
Note that the GUI does ''not'' interact with the client/server architecture.==Full Distributions==
==BaseX Standalone==The In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the [[Standalone ModeDBA]] can be used to execute XQuery expressions or run , a browser-based database commands on command line. It can also be used both for scripting and batch processing your XML dataadministration interface.If you unzip or install BaseX, the target directory will contain the following directories:
* Run one of the {{Code|Global [[Start_Scripts#Linux.2FMac:_basex|basexOptions]]}} or {{Code|are stored in the [[Start Scripts#Windows: basexConfiguration|.bat|basex.batconfiguration file]]}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseX}}* On ''Windows'': Double click on the '''BaseX''' icon.
Note that If BaseX is started via the standalone mode does ''not'' interact with start scripts or the client/server architectureWindows icons, all JAR files in the {{Code|lib}} directory and its descendant directories will be added to the class path.
==BaseX Server==The [[Database Server]] comes into play If you work with the ZIP distribution, and if you want to make BaseX is to be used bymore than one user (client). It handles concurrent [[Transaction_Management|read and write transactions]]globally available,provides [[User Managementyou can add the {{Code|user management]] and [[Logging|logs all user interactions]]bin}} directory to your PATH environment variable.
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]]):==Web Archive==
* 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 The ''Windows'WAR Archive': Double click on the '''BaseX Server''' icon, which will also start the [[#BaseX HTTP Server|HTTP Server]], or the '''BaseX Server (stop)''' iconcan be embedded in existing Java web servers.
Pressing {{Code|Ctrl+c}} will close all connections and databases and shut down the server process.==Other Distributions==
==BaseX Client==The [[Database Server|Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting 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]]):=Concurrent Operations=
* Run one of If you want to perform parallel (concurrent) read and write operations on your databases, you must use the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexclient]]}} client/server architecture or {{Code|[[Start Scripts#Windows: basex.bat|basexclientrun BaseX as a web application.bat]]}} scripts.* Execute the following command: {{Code|java You can safely open a database in different JVMs (Java virtual machines) for read-cp BaseX.jar org.basexonly access, and you will not encounter any problems when reading from and writing to different databases.BaseXClient}}* On ''Windows'': Double click on Update operations from different JVMs to the '''BaseX Client''' iconsame database will be rejected or may even lead to corrupt databases.
The default {{Code|admin}} user For example, if you only read data, you 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 easily run several clients (standalone, GUI, database clients) in parallel. If you update your data, however, you shouldn’t use the {{Code|[[Commands#PASSWORD|PASSWORD]]}} command after GUI or a standalone instance at the first loginsame time.<br/>
Please check out the article More details on concurrency can be found on the [[Database ServerTransaction Management]] for more detailspage.
The HTTP Server gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] Services of BaseX;Version 10.0By default, it starts an instance of the [http* Update://jetty.codehaus.org/jetty/ Jetty Web Server],which by default listens Switched to the port {{Code|8984}}, and the BaseX Server, which listens to {{Code|1984}}.Java 11
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 9. It can then be started as follows0(get more information on all [[Command-Line Options#BaseX HTTP Server|Startup Options]])* Update:Switched to Java 8
* 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 8.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 main directory of the {{Code|basex-api}} project, and press {{Code|Ctrl+c}} Switched to shut down the process (see [[Web Application#Maven|Web Application: Maven]] for more details). =Changelog=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=
BaseX can be run 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 used in various ways:OpenBSD (up to 7.x). It is platform-independent and runs on any system supporting Java.
{| class="wikitable"|-! BaseX is platform independent and runs on any system that provides anVersionimplementation of [http://www.java.com ! Minimum Java 1.6] (JRE).Version|-| 10| 11|-| 9| 8|-| 8It has been tested on Windows (2000, XP, Vista, | 7), Max OS X (10.x),Linux(SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).|-| ''older''| 6|}
If you plan to perform concurrent read and write operations on a single databasehave Windows,we recommend the client{{Code|.msi}} distributions from [https://adoptium.net/server architecture is the right choiceAdoptium]. You may safely open The JRE packages are sufficient, but you can also install the same databasein different JVMs JDK (Java virtual machinesDevelopment Kit) 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.
{| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|bin}}| Start scripts (Windows, Linux).|-| {{Code|data}}| The standalone version 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 started placed (such as followsthe Saxon library).|-| {{Code|repo}}| [[Repository]] for external XQuery modules (get more information on all the [[Commandhttp://www.xqueryfunctions.com FunctX] library is included as example).|-| {{Code|src}}| Directory for your XQuery scripts and other source data.|-Line Options#BaseX Standalone| {{Code|webapp}}|Startup Options[[Web Application]])directory:home of the RESTXQ web application, REST scripts, and [[DBA]].|}
==BaseX HTTP Server=Changelog=
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
