administrator, editor
3
edits
Changes
Jump to navigation
Jump to search
====BaseX====Please First of all, [http://basex.org/download download] the latest BaseX version from our homepage.The official releases include the BaseX JAR file, libraries and optional [[Start Scripts]].If you do not use an installer, we recommend to manually add the project’s{{Code|bin}} directory to your path environment; this way, you will be able to runBaseX from everywhere in your shell/terminal.following distributions are available:
====Java====A Runtime Environment of [http://www.java.com Java 1.6] (JRE) * the '''Core Package''' is needed to run BaseXa JAR file, which contains the database code, the query processor and the GUI frontend.BaseX is platform independent and It runs on any system that provides a Java Virtual Machinecompletely without additional libraries.BaseX has been tested on * the '''ZIP Archive''' and the '''Windows (2000Installer''' contain libraries for web applications and advanced features, XP[[Start Scripts]], Vista, 7), Max OS X (10and some additional optional files.x),Linux(SuSE xxx, Debian, Ubuntu) and OpenBSD (4.x)* the '''WAR Archive''' can be embedded in existing Java web servers.
==BaseX GUI==
The GUI It can be started as follows (get more information on all [[Startup Command-Line Options#BaseX GUI|Startup Options]]):
Note that the standalone mode does ''not'' interact with the client/server architecture.==Server==
==BaseX Server==
Please check out the article on the We provide additional clients in various [[Database ServerClients|programming languages]] for more details.
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}}.
The HTTP Server It can be started as follows(get more information on all [[Startup Command-Line Options#BaseX HTTP Server|Startup Options]]):
[[Category:Beginner]]
fixed broken anchor-link
This article is part of the [[Getting Started]] Guide.It tells you how to get BaseX running.
==Requirements=Getting Started=
Some additional 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 [[#Standalone|Standalone]] mode or the [[#Graphical User Interface|Graphical User Interface]],* as [[#Client/Server|Client/Server]] application, or* as [[#HTTP Server|Web Application]], called from a web server. It can also be embedded as a library in your own application. ===Requirements=== 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). ==Synchronization=Concurrent Operations=== If you plan to concurrently perform concurrent read and write your dataoperations on a single database, you should resort to use theclient/server architecturearchitecutre or deploy it as web application. This is because the GUI, the standalone clientand You may safely open the client/server architecture of BaseX all work same database in different JVMs (Javavirtual machines) forread-only access, and are not synchronized among each otheryou won’t encounter any problems when reading from or writingto different databases, but your update operations will be rejected if the databaseto 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. You should It can be awarestarted 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.that, in * Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseX}}* On ''Windows'': Double click on the worst case, databases might get corrupt if you use '''BaseX instances''' icon.in different JVMs and try It is important to enforce updatesremember that the standalone mode does ''not'' interact with the [[#Client/Server|Client/Server]] architecture. =Graphical User Interface=
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.
* 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 enter database commands, or execute automated database operations and queries, on command line. The standalone version can be started as follows(get more information on all [[Startup 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.
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 [[Startup 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 [[Startup 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/>
==BaseX HTTP Server==
* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]}} or {{Code|[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]}} scripts. Add 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.
* For BaseX can also be deployed as [[MavenWeb Application#Servlet Container|web servlet]] users. In 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:8984HTTP Server was started (port:run}} in 8984).</pre> You can adjust the Jetty logging level by adding the main directory of 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}} project.LEVEL=DEBUG</pre> After that, you can e. g. open your browser and press {{Code|Ctrl+c}} navigate to shut down the process.* You may also want to deploy BaseX as a [[Web Application]]RESTXQ start page http://localhost:8984.
=Changelog=
;Version 8.0
* Update: Switched to Java 7
;Version 7.0
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
