Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
==Requirements==This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
A Runtime Environment of [http://www.java.com Java 1.6] (JRE) is needed to run BaseX.BaseX is platform-independant and should 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).=Introduction=
===BaseX===Download the latest BaseX version for your operating system [http://basex.org/download here].Run the Windows installer, or download the <code>BaseX.zip</code> archive, to get all project components including the [[Starting Script Files| start scripts]]is very light-weight. We highly recommend to add the <code>bin</code> directory, which contains all the start scripts, to your path environment; this way, you It can be run BaseX from every folder and used in the shell/terminal. The Windows installer is adding the scripts to the path environment automatically.many different ways:
== Starting # 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.# You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the terminal, or want to do batch processing.# The [[Database Server]] is the right choice if you have multiple users or clients, or if you use other programming languages and if you don’t require HTTP services.# The [[Web Application|HTTP Server]] provides [[REST]] and [[WebDAV]] services. With [[RESTXQ]], complex web applications can be built, and the embedded [[DBA]] application allows you to work with BaseX GUI==in the browser.# It can also be embedded as a Java library in your applications.
There are several methods for starting the GUI:BaseX 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.
*Double click on <code>BaseX.jar</code>*Execute command: <code>java -cp BaseX.jar org.basex.BaseXGUI</code>*Starting the script <code>basexgui</code> / <code>basexgui.bat</code>=Startup=
Note: The BaseX GUI is just working on local databases. Anyway you canset your local database path First, ensure that an up-to -date version of 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 Server.Java Runtime Environment (JRE) is available:
There are If you have several methods for starting the Server (get more information [[Startup Advancedversions or distributions installed, you can type {{Code|here]]):java -version}} on command-line to check which Java version is currently used.
*Execute commandIf you have Windows, we recommend the {{Code|.msi}} distributions from [https: <code>java -cp BaseX//adoptium.jar org.basexnet/ Adoptium].BaseXServer</code>*Starting The JRE packages are sufficient, but you can also install the script <code>basexserver</code> / <code>basexserverJDK (Java Development Kit).bat</code>
NoteNext, [https: For using the databases concurrently (especially for write transactions) you have to use the BaseX Server//basex.Please don't use any other org/download get a fresh copy of BaseX mode with the databases ] from the BaseX Server while the server is onour homepage.The following distributions are available:
There are several methods for starting The '''Core Package''' is a very compact JAR file. It contains the Client (get more information [[Startup Advanced|here]]):BaseX database management system, the XQuery processor, the client/server architecture, and the graphical user interface. It runs without additional libraries.
*Execute command: <code>java -cp BaseX.jar org.basex.BaseXClient</code>*Starting the script <code>basexclient</code> / <code>basexclient.bat</code>==Full Distributions==
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 In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the <code>[[Commands#PASSWORD|PASSWORDDBA]]</code> command, a browser-based database administration interface.<br/>If you unzip or install BaseX, the target directory will contain the following directories:
See also {| 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 Saxon library).|-| {{Code|repo}}| [[Server TutorialRepository]]for external XQuery modules (the [http://www.xqueryfunctions.com FunctX] section library is included as example).|-| {{Code|src}}| Directory for more detailsyour XQuery scripts and other source data.|-| {{Code|webapp}}| [[Web Application]] directory: home of the RESTXQ web application, REST scripts, and [[DBA]].|}
==Starting Global [[Options]] are stored in the BaseX Standalone==[[Configuration|.basex configuration file]].
There are several methods for starting If BaseX is started via the Standalone mode (get more information [[Startup Advancedstart scripts or the Windows icons, all JAR files in the {{Code|here]]):lib}} directory and its descendant directories will be added to the class path.
*Execute command: <code>java -cp BaseX.jar org.basex.If you work with the ZIP distribution, and if you want to make BaseX</code>*Starting globally available, you can add the script <code>basex</code> / <code>basex{{Code|bin}} directory to your PATH environment variable.bat</code>
no edit summary
{| class==Starting the "wikitable"|-! BaseX Server==Version! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-| ''older''| 6|}
===Starting the BaseX Client=Core Package==
==See also Web Archive==[[Server Tutorial]]The '''WAR Archive''' can be embedded in existing Java web servers. ==Other Distributions== 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= ;Version 10.0* Update: Switched to Java 11 ;Version 9.0* Update: Switched to Java 8 [[Category;Version 8.0* Update:Beginner]]Switched to Java 7 ;Version 7.0__NOTOC__* Updated: BaseXJAXRX has been replaced with BaseXHTTP
