Changes

Jump to navigation Jump to search
634 bytes added ,  13:33, 27 July 2022
no edit summary
==Requirements==This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
=Introduction==Java===A Runtime Environment of [http://www.java.com Java 1.6] (JRE) is needed to run BaseX.BaseX is platform independent and runs on any system that provides a Java Virtual Machine. BaseX has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x), Linux(SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).
===BaseX===is very light-weight. It can be run and used in many different ways:
Please # BaseX comes with a [http://basex[GUI|Graphical User Interface]] that offers you tools for managing, querying and visualizing your data and writing sophisticated applications in XQuery.org/download download# You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the latest BaseX version from our homepageterminal, or want to do batch processing.# The official releases include [[Database Server]] is the BaseX runnableright choice if you have multiple users or clients, or if you use other programming languages and if you don’t require HTTP services.# The [[Start ScriptsWeb Application|HTTP Server]] provides [[REST]], and API files[[WebDAV]] services.If you do not use the Windows installerWith [[RESTXQ]], or use another operating systemcomplex web applications can be built, we recommendand the embedded [[DBA]] application allows you to add work with BaseX in the project’s <code>bin</code> directory to your path environment; this way,browser.you will # It can also be able to run BaseX from everywhere embedded as a Java library in your shell/terminalapplications.
==BaseX GUI==There are several ways of starting the GUI has been tested on numerous platforms, including Windows (get more information [[Startup Options#BaseX GUI|here]]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 is platform-independent and runs on any system supporting Java.
*Double click on the '''BaseX GUI''' icon or the <code>BaseX.jar</code> file*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexgui]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexgui.bat]]</code> scripts*Execute the command: <code>java -cp BaseX.jar org.basex.BaseXGUI</code>=Startup=
'''Important'''First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available: The BaseX GUI is not synchronized with other BaseX instances. You should avoid accessing the same databasefrom the GUI and the server, esp. if updates are performed.
{| class=="wikitable"|-! BaseX Server==Version! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-| ''older''| 6There are several ways of starting the server (get more information [[Startup Options#BaseX Server|here]]):}
*Double click If you have several versions or distributions installed, you can type {{Code|java -version}} on the '''BaseX Server (Start)''' icon. This will also start the JAX-RX server.*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexserver]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexserver.bat]]</code> scripts*Execute the command <code>java -cp BaseX.jar org.basexline to check which Java version is currently used.BaseXServer</code>
'''Important''': If you concurrently access the databases (especially for write transactions)have Windows,we recommend the BaseX Server is the way to go{{Code|.msi}} distributions from [https://adoptium. Don't use any other standalonenet/GUI BaseX instancesto access databases which Adoptium]. The JRE packages are sufficient, but you can also opened by install the serverJDK (Java Development Kit).
==BaseX Client==There are several ways Next, [https://basex.org/download get a fresh copy of starting the client version (get more information [[Startup Options#BaseX Client|here]])from our homepage. The following distributions are available:
*Double click on the '''BaseX Client''' icon*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basex|basexclient]]</code>/<code>[[Start Scripts#Windows: basex.bat|basexclient.bat]]</code> scripts*Execute the command <code>java -cp BaseX.jar org.basex.BaseXClient</code>==Core Package==
The default <code>admin</code> user can be used to connect to '''Core Package''' is a very compact JAR file. It contains the BaseX database management system, the server: <br/>* <b>Username:</b> <code>admin</code>* <b>Password:</b> <code>admin</code>The password should be changed with XQuery processor, the <code>[[Commands#PASSWORD|PASSWORD]]<client/code> command after server architecture, and the first logingraphical user interface. It runs without additional libraries.<br/>
Please check out our little [[Server Tutorial]] for more details.==Full Distributions==
==In addition, the '''ZIP Package''' and the '''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 Standalone==, the target directory will contain the following directories:
There are several ways of starting the standalone version {| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|bin}}| Start scripts (get more information Windows, Linux).|-| {{Code|data}}| The database directory.|-| {{Code|etc}}| Example data: XML sample, [[Startup Options#BaseX StandaloneCatalog Resolver|herecatalog 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]].|}
*Double click on the '''BaseX''' icon*Run one of the <code>Global [[Start_Scripts#Linux.2FMac:_basex|basexOptions]]</code>/<code>are stored in the [[Start Scripts#Windows: basexConfiguration|.bat|basex.batconfiguration file]]</code> scripts*Execute the command <code>java -cp BaseX.jar org.basex.BaseX</code>
<b>Important</b>: The Standalone client If BaseX is not synchronized with other BaseX instances. You should avoid accessing started via the same databasefrom start scripts or the standalone client Windows icons, all JAR files in the {{Code|lib}} directory and its descendant directories will be added to the server, esp. if updates are performedclass path.
==If you work with the ZIP distribution, and if you want to make BaseX JAX-RX Server==globally available, you can add the {{Code|bin}} directory to your PATH environment variable.
<font color='orangered'>Deprecated from Version 6.8</font>:The JAX-RX (REST) server can be started as follows (get more information [[Startup Options#BaseX JAX-RX Server|here]]):=Web Archive==
*Double click on the The '''BaseX Server (Start)WAR Archive''' icon*Run one of the <code>[[Start_Scripts#Linuxcan be embedded in existing Java web servers.2FMac:_basexjaxrx|basexjaxrx]]</code>/<code>[[Start Scripts#Windows: basexjaxrx.bat|basexjaxrx.bat]]</code> scripts
==BaseX HTTP ServerOther Distributions==
<font color='orangered'>Introduced with Version 6Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.8</font>:The HTTP server can be started as follows (get more information [[Startup Options#BaseX HTTP Server|here]]):
*Double click on the '''BaseX Server (Start)''' icon*Run one of the <code>[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]</code>/<code>[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]</code> scripts=Concurrent Operations=
==See also ==If you want to perform parallel (concurrent) read and write operations on your databases, you must use the client/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 Tutorial]]For example, if you only read data, you can easily run several clients (standalone, [[GUI Tutorial]], [[Standalone Tutorial]]database clients) in parallel. If you update your data, however, you shouldn’t use the GUI or a standalone instance at the same time. More details on concurrency can be found on the [[Getting StartedTransaction Management]]page. =Changelog= ;Version 10.0* Update: Switched to Java 11 [[Category;Version 9.0* Update: Switched to Java 8 ;Version 8.0* Update: Switched to Java 7 ;Version 7.0* Updated:Beginner]]BaseXJAXRX has been replaced with BaseXHTTP
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu