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.
===BaseX===Please download the latest BaseX version [http://basex.org/download from our homepage].The official releases include the BaseX runnable, [[Start Scripts]], and API filesis very light-weight. If you do not use the Windows installer, we recommend to add the project's <code>bin</code> directory to your path environment; this way, you It can be run BaseX from every folder and used in the shell/terminal.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.There are several ways of starting # You can start BaseX as a standalone [[Command-Line Client]] if you prefer to work in the GUI: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 in the browser.# It can also be embedded as a Java library in your applications.
*Double click BaseX has been tested on the '''BaseX''' icon or the <code>BaseXnumerous platforms, including Windows (2000, XP, Vista, 7, 10, 11), Mac OS X (10.jar</code> file*Run one of the <code>basexgui</code>/<code>basexguix , 11.bat</code> scripts*Execute the command: <code>java -cp BaseXx), Linux (SuSE xxx, Debian, Redhat, CentOS, Ubuntu) and OpenBSD (up to 7.jar orgx).basexIt is platform-independent and runs on any system supporting Java.BaseXGUI</code>
<b>Important</b>: 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.=Startup=
==BaseX Server==First, ensure that an up-to-date version of the Java Runtime Environment (JRE) is available:
There are several ways of starting the server (get more information [[Startup Advanced{|here]]):class="wikitable"|-! BaseX Version! Minimum Java Version|-| 10| 11|-| 9| 8|-| 8| 7|-| ''older''| 6|}
*Click If you have several versions or distributions installed, you can type {{Code|java -version}} on the '''BaseX Server''' icon*Run one of the <code>basexserver</code>/<code>basexserver.bat</code> scripts*Execute the command <code>java -cp BaseX.jar org.basexline to check which Java version is currently used.BaseXServer</code>
<b>Important</b>: For concurrently accessing the databases (especially for write transactions),If you have to use Windows, we recommend the BaseX Server{{Code|. Please don't use any other BaseX mode with the databasesmsi}} distributions from [https://adoptium.net/ Adoptium]. The JRE packages are sufficient, but you can also install the BaseX Server while the server is workingJDK (Java Development Kit).
==Next, [https://basex.org/download get a fresh copy of BaseX Client==] from our homepage. The following distributions are available:
There are several ways of starting the client communicating with the server (get more information [[Startup Advanced|here]]):==Core Package==
*Click on the The '''BaseX ClientCore Package''' icon*Run one of is a very compact JAR file. It contains the BaseX database management system, the XQuery processor, the <code>basexclient</code>/<code>basexclient.bat<client/code> scripts*Execute server architecture, and the command <code>java -cp BaseXgraphical user interface.jar orgIt runs without additional libraries.basex.BaseXClient</code>
The default <code>admin</code> user can be used to connect to the server: <br/>* <b>Username:</b> <code>admin</code>* <b>Password:</b> <code>admin</code>The password should be changed with the <code>[[Commands#PASSWORD|PASSWORD]]</code> command after the first login.<br/>==Full Distributions==
Check out In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and the [[Server TutorialDBA]] section for more details, a browser-based database administration interface.If you unzip or install BaseX, the target directory will contain the following directories:
There Global [[Options]] are several ways of starting stored in the standalone client (get more information [[Startup AdvancedConfiguration|here.basex configuration file]]):.
*Click on the '''If BaseX Standalone''' icon*Run one of is started via the <code>basex</code>/<code>basex.bat</code> start scripts*Execute or the Windows icons, all JAR files in the {{Code|lib}} directory and its descendant directories will be added to the command <code>java -cp BaseX.jar org.basexclass path.BaseX</code>
<b>Important</b>: The Standalone client is not synchronized If you work with other BaseX instances. You should avoid accessing the same databasefrom the standalone client ZIP distribution, and if you want to make BaseX globally available, you can add the server, esp. if updates are performed{{Code|bin}} directory to your PATH environment variable.
no edit summary
=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).
{| class="wikitable"|- valign=BaseX Standalone=="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}}| [[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]].|}
==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
