Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
Here you find all instructions you need for starting the three modes This article is part of BaseX. After you successfully started BaseX just follow the instructions in the [[Getting Started]] guideGuide. It tells you how to get BaseX running.
All you need is an installation of Java 1.6 and the BaseX application. BaseX is platformvery light-independant 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:
===Java 1# 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.6===A Runtime Environment of Java 1# You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the terminal, or want to do batch processing.6 (JRE) # The [[Database Server]] is needed to run BaseX. If the right choice if you haven't installed it yethave multiple users or clients, please visit or if you use other programming languages and if you don’t require HTTP services.# The [[Web Application|HTTP Server]] provides [[http://wwwREST]] and [[WebDAV]] services.javaWith [[RESTXQ]], complex web applications can be built, and the embedded [[DBA]] application allows you to work with BaseX in the browser.com java.com]# It can also be embedded as a Java library in your applications.
===BaseX===Download the latest BaseX version for your operating system [http://basex.org/download here].Run the has been tested on numerous platforms, including Windows Installer(2000, XP, Vista, 7, 10, or download the <code>BaseX11), Mac OS X (10.zip</code> archivex , to get all project components including the [[Starting Script Files| start scripts]]11. We highly recommend to add the <code>bin</code> directoryx), Linux (SuSE xxx, Debian, Redhat, which contains all the start scriptsCentOS, Ubuntu) and OpenBSD (up to your path environment; this way, you can run BaseX from every folder in the shell/terminal7.x). It is platform-independent and runs on any system supporting Java.
There are several methods for starting First, ensure that an up-to-date version of the GUIJava Runtime Environment (JRE) is available:
*Double click on <code>{| class="wikitable"|-! BaseX.jar</code>Version! Minimum Java Version|-*Execute command: <code>java | 10| 11|-cp BaseX.jar org.basex.BaseXGUI</code>*Starting the script <code>basexgui</code> / <code>basexgui.bat</code>| 9| 8|-| 8| 7|-| ''older''| 6|}
Note: The BaseX GUI is just working on local databases. Anyway If you have several versions or distributions installed, you canset your local database path type {{Code|java -version}} on command-line to the BaseX Server database path accessing it over the network. In this case we suggest you to avoid accessing databases concurrently with the GUI and the Servercheck which Java version is currently used.
==Starting If you have Windows, we recommend the BaseX Server=={{Code|.msi}} distributions from [https://adoptium.net/ Adoptium]. The JRE packages are sufficient, but you can also install the JDK (Java Development Kit).
There are several methods for starting the Server (Next, [https://basex.org/download get more information [[Startup Advanced|herea fresh copy of BaseX]])from our homepage. The following distributions are available:
*Execute command: <code>java -cp BaseX.jar org.basex.BaseXServer</code>*Starting the script <code>basexserver</code> / <code>basexserver.bat</code>==Core Package==
Note: For using The '''Core Package''' is a very compact JAR file. It contains the databases concurrently (especially for write transactions) you have to use BaseX database management system, the BaseX Server.Please don't use any other BaseX modes with XQuery processor, the BaseX Server databases while client/server architecture, and the Server is ongraphical user interface. It runs without additional libraries.
There are several methods In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for starting 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 Clientfollowing directories:
*Execute command: <code>java {| class="wikitable"|- valign="top"! Directory! Description|-| {{Code|bin}}| Start scripts (Windows, Linux).|-cp BaseX| {{Code|data}}| The database directory.jar org|-| {{Code|etc}}| Example data: XML sample, [[Catalog Resolver|catalog and DTD files]].basex|-| {{Code|lib}}| Extra libraries (Jetty, Tagsoup, …).BaseXClient<|-| {{Code|lib/code>custom}}| Directory in which additional JAR files can be placed (such as the Saxon library).|-| {{Code|repo}}*Starting | [[Repository]] for external XQuery modules (the script <code>basexclient<[http:/code> / <code>basexclientwww.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]].bat</code>|}
A default admin user can be used to connect: <br/>* <b>Username:</b> <code>admin</code>* <b>Password:</b> <code>admin</code>The password can be changed using Global [[Options]] are stored in the <code>[[Commands#PASSWORDConfiguration|PASSWORD.basex configuration file]]</code> command.<br/>
See also If BaseX is started via the [[Server Tutorial]] section for more detailsstart scripts or the Windows icons, all JAR files in the {{Code|lib}} directory and its descendant directories will be added to the class path.
==Starting If you work with the ZIP distribution, and if you want to make BaseX Standalone==globally available, you can add the {{Code|bin}} directory to your PATH environment variable.
There are several methods for starting the Standalone mode:==Web Archive==
*Execute command: <code>java -cp BaseXThe '''WAR Archive''' can be embedded in existing Java web servers.jar org.basex.BaseX</code>*Starting the script <code>basex</code> / <code>basex.bat</code>
no edit summary
==Requirements=Introduction=
== Starting the BaseX GUI=Startup=
===Starting the BaseX Client=Full Distributions==
==See also Other Distributions==[[Server Tutorial]]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= 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: Switched to Java 7 ;Version 7.0* Updated:Beginner]]BaseXJAXRX has been replaced with BaseXHTTP
