Changes

Jump to navigation Jump to search
969 bytes added ,  12:20, 12 April 2017
fixed broken anchor-link
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
==Getting Started==
First of all, please [http://basex.org/download download] BaseX from our homepage.The following versions distributions are available:
* the '''Core Package''' is a JAR file, which contains the database code, the query processor and the GUI frontend. It runs completely without additional libraries.* the '''ZIP Archive''', and the '''Windows Installer''' and the '''Mac OSX''' package contain libraries for web applications and advanced features, [[Starts Start Scripts]] , and some additional optional files.* the '''WAR ApplicationArchive''' can be embedded in existing Java web servers (deprecated).
Some additional Linux distributions are available from the download page,most of which contain only the core package and, optionally, scripts for starting BaseX.
BaseX is very light-weight. It can be run and used in various ways:
* as standalone application, using the [[Graphical User Interface#Standalone|Standalone]] mode or the [[Standalone Mode#Graphical User Interface|Command-Line Graphical User Interface]],* as [[Database #Client/Server|clientClient/serverServer]] application, or* as [[#HTTP Server|Web Application]], called from a web server.
====Requirements====It can also be embedded as a library in your own application.
BaseX is platform independent and runs on any system that provides animplementation of [http://www.java.com Java 1.6] (JRE).It has been tested on Windows (2000, XP, Vista, 7), Max OS X (10.x),Linux(SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x).===Requirements===
====Concurrent Operations====BaseX is platform-independent and runs on any system that provides an implementation of [http://www.java.com Java] (JRE).Since <b>Version 8.0</b> of BaseX, Java 7 is mandatory, because it provides better file handling support,and because Oracle stopped public support for older versions.
BaseX has been tested on several platforms, including Windows (2000, XP, Vista, 7), Max OS X (10.x),Linux (SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x). ===Concurrent Operations=== If you plan to perform concurrent read and write operations on a single database,youshould use the client/server architecture is the right choicearchitecutre or deploy it as web application. You may safely open the same databasein different JVMs (Java virtual machines) for read-only access, and you won’t encounter anyproblems when reading from or writing to different databases, but your update operations willbe rejected if the database to be written to is currently opened by another virtual machine. =Standalone= The [[Standalone Mode]] can be used to execute XQuery expressions or run database commands on command line. It can also be used both for scripting and batch processing your XML data. It can be started as follows (get more information on all [[Command-Line Options#Standalone|Startup Options]]): * Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basex.bat]]}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseX}}* On ''Windows'': Double click on the '''BaseX''' icon. It is important to remember that the standalone mode does ''not'' interact with the [[#Client/Server|Client/Server]] architecture. =Graphical User Interface=
==BaseX GUI==
The [[GUI]] is the visual interface to the features of BaseX.
It can be used to create new databases, perform queries or interactively
explore your XML data.
The GUI It can be started as follows (get more information on all [[Command-Line Options#BaseX GUI|Startup Options]]):
* Double click on the {{Code|BaseX.jar}} file.
Note that the GUI does ''not'' interact with the client/server architecture.
=Client/Server=BaseX Standalone==The [[Standalone Mode]] can be used to execute XQuery expressions or run database commands on command line. It can also be used both for scripting and batch processing your XML data. The standalone version can be started as follows(get more information on all [[Command-Line Options#BaseX Standalone|Startup Options]]): * Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basex.bat]]}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseX}}* On ''Windows'': Double click on the '''BaseX''' icon.
Note that the standalone mode does ''not'' interact with the client/server architecture.==Server==
==BaseX Server==
The [[Database Server]] comes into play if BaseX is to be used by
more than one user (client). It handles concurrent [[Transaction_Management|read and write transactions]],
By default, the server listens to the port {{Code|1984}}.
There are several ways of starting and stopping the server
(get more information on all [[Command-Line Options#BaseX Server|Startup Options]]):
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexserver]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexserver.bat]]}} scripts. Add the {{Code|stop}} keyword to gracefully shut down the server.
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXServer}}. Again, the {{Code|stop}} keyword will ensure a graceful shutdown.
* On ''Windows'': Double click on the '''BaseX Server''' icon, which will also start the [[#BaseX HTTP Server|HTTP Server]], or the '''BaseX Server (stop)''' icon.
Pressing {{Code|Ctrl+c}} will close all connections and databases and shut down the server process.
==BaseX Client== 
The [[Database Server|BaseX Client]] interface can be used to send
commands and queries to the server instance on command line.
It can be started as follows
(get more information on all [[Command-Line Options#BaseX Client|Startup Options]]):
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexclient]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexclient.bat]]}} scripts.
The password should be changed with the {{Code|[[Commands#PASSWORD|PASSWORD]]}} command after the first login.<br/>
Please check out the article on the We provide additional clients in various [[Database ServerClients|programming languages]] for more details.
==BaseX HTTP Server==
The With the HTTP Server gives , BaseX can be used as [[Web Application]].It provides access to the [[REST]], [[RESTXQ]] and [[WebDAV]] Services of BaseXservices.By default, it starts an An instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server]will be created,which by default listens to the port {{Code|8984}}. Additionally, and the BaseX Serverwillbe started, which listens to is accessible on port {{Code|1984}}.
To run the HTTP Server, you need to [http://basex.org/products/download/ download] one of the full distributions of BaseX (exe, zip, war), as the JAR version does not include any additionally required libraries. It can then be started as follows(get more information on all [[Command-Line Options#BaseX HTTP Server|Startup Options]]):
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]}} or {{Code|[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]}} scripts. Call the script with the {{Code|stop}} keyword to gracefully shut down the server.
* On ''Windows'': Double click on the '''BaseX Server''' or '''BaseX Server (stop)''' icon.
* You BaseX can also deploy BaseX be deployed as a [[Web Application#Servlet Container|web servlet]].* For Maven usersIn the first two cases, the command-line output will look similar to the following lines (the JSP warning message [http: type //stackoverflow.com/questions/3521654/missing-jsp-support-in {{Code|mvn -jetty-or-confusing-log-message can be ignored]): <pre class="brush:xml">[main] INFO org.eclipse.jetty.server.Server - jetty-8.1.18.v20150929[main] INFO org.eclipse.jetty.webapp.StandardDescriptorProcessor - NO JSP Support for /, did not find org.apache.jasper.servlet.JspServlet[main] INFO org.eclipse.jetty.server.AbstractConnector - Started SelectChannelConnector@0.0.0.0:run}} in 8984HTTP Server was started (port: 8984).</pre> You can adjust the Jetty logging level by adding the following properties to the start script: <pre class="brush:xml">-Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -D{{Code|basex-apiclassref}} directory.LEVEL=DEBUG</pre> After that, you can e. g. open your browser and press {{Code|Ctrl+c}} navigate to shut down the process (see [[Web Application#Maven|Web ApplicationRESTXQ start page http://localhost: Maven]] for more details)8984.
=Changelog=
 
;Version 8.0
 
* Update: Switched to Java 7
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
 
[[Category:Beginner]]
administrator, editor
3

edits

Navigation menu