Changes

Jump to navigation Jump to search
2,122 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.
===Java==Introduction=
A Runtime Environment of [http://www.java.com Java 1.6] (JRE) is needed to run BaseX.BaseX is platformvery light-independent and should weight. It can be run on any platform that has a Java Virtual Machine available. BaseX has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x), Linux(SuSE xxx, Debian) and OpenBSD (4.x).used in many different ways:
===# BaseX===comes with a [[GUI|Graphical User Interface]] that offers you tools for managing, querying and visualizing your data and writing sophisticated applications in XQuery.Download the latest # You can start BaseX version for your operating system as a standalone [[http://basex.org/download hereCommand-Line Client]]if you prefer to work in the terminal, or want to do batch processing.Run # The [[Database Server]] is the Windows installerright choice if you have multiple users or clients, or download the <code>BaseXif you use other programming languages and if you don’t require HTTP services.zip</code> archive to get all project components, including the # The [[Starting Script FilesWeb Application| start scriptsHTTP Server]] provides [[REST]] and [[WebDAV]]services. If you do not use the Windows installerWith [[RESTXQ]], we recommend to add the <code>bin</code> directorycomplex web applications can be built, which contains all and the start scripts, embedded [[DBA]] application allows you to your path environment; this way, you can run work with BaseX from every folder in the shell/terminalbrowser.# It can also be embedded as a Java library in your applications.
==BaseX GUI==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 is platform-independent and runs on any system supporting Java.
There are several methods for starting the GUI:=Startup=
*Double click on <code>BaseX.jar</code>*Execute First, ensure that an up-to-date version of the commandJava Runtime Environment (JRE) is available: <code>java -cp BaseX.jar org.basex.BaseXGUI</code>*Start the script <code>basexgui</code> / <code>basexgui.bat</code>
<b>Note</b>: The {| class="wikitable"|-! BaseX GUI is just working on local databases. While you can always accessVersion! Minimum Java Version|-| 10| 11|-local database from a BaseX server instance, you should avoid accessing databases| 9| 8|-| 8| 7|-| ''older''| 6concurrently with the GUI and the Server, esp. if updates are performed.|}
==Starting the BaseX Server==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.
There If you have Windows, we recommend the {{Code|.msi}} distributions from [https://adoptium.net/ Adoptium]. The JRE packages are several methods for starting sufficient, but you can also install the server JDK (get more information [[Startup Advanced|here]]Java Development Kit):.
*Execute the commandNext, [https: <code>java -cp BaseX//basex.jar org.basex.BaseXServer</code>*Start the script <code>basexserver</code> / <code>basexserverdownload get a fresh copy of BaseX] from our homepage.bat</code>The following distributions are available:
<b>Note</b>: For concurrently accessing the databases (especially for write transactions),you have to use the BaseX Server. Please don't use any other BaseX mode with the databasesfrom the BaseX Server while the server is working.==Core Package==
==Starting The '''Core Package''' is a very compact JAR file. It contains the BaseX Client==database management system, the XQuery processor, the client/server architecture, and the graphical user interface. It runs without additional libraries.
There are several methods for starting the client communicating with the server (get more information [[Startup Advanced|here]]):==Full Distributions==
*Execute In addition, the command: <code>java '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the [[DBA]], a browser-cp based database administration interface. If you unzip or install BaseX.jar org.basex.BaseXClient</code>*Start , the target directory will contain the script <code>basexclient</code> / <code>basexclient.bat</code>following directories:
A default admin user {| 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 used to connect: <br/>placed (such as the Saxon library).|-| {{Code|repo}}* <b>Username| [[Repository]] for external XQuery modules (the [http:</b> <code>admin</code>www.xqueryfunctions.com FunctX] library is included as example).|-| {{Code|src}}| Directory for your XQuery scripts and other source data.* <b>Password|-| {{Code|webapp}}| [[Web Application]] directory:</b> <code>admin</code>The password can be changed using home of the <code>RESTXQ web application, REST scripts, and [[Commands#PASSWORD|PASSWORDDBA]]</code> command.<br/>|}
See also Global [[Options]] are stored in the [[Server TutorialConfiguration|.basex configuration file]] section for more details.
==Starting If BaseX is started via the BaseX Standalone Client==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.
There are several methods for starting If you work with the standalone client (get more information [[Startup AdvancedZIP distribution, and if you want to make BaseX globally available, you can add the {{Code|here]]):bin}} directory to your PATH environment variable.
*Execute the command: <code>java -cp BaseX.jar org.basex.BaseX</code>*Start the script <code>basex</code> / <code>basex.bat</code>==Web Archive==
The '''WAR Archive''' can be embedded in existing Java web servers. ==Other Distributions=See also Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX. =Concurrent Operations=[[Server Tutorial]]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. 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=[[Category;Version 10.0* Update: Switched to Java 11 ;Version 9.0* Update: Switched to Java 8 ;Version 8.0* Update:Beginner]]Switched to Java 7 ;Version 7.0__NOTOC__* Updated: BaseXJAXRX has been replaced with BaseXHTTP
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu