Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
==Getting Started==
====Requirements====
====Concurrent Operations====
==Standalone==For example, if you only read data, you can easily run several clients (standalone, GUI, database clients) at the same time. If you update your data, however, you shouldn’t use the GUI or a standalone instance at the same time.
==Graphical User Interface==
The GUI It can be started as follows (get more information on all [[Command-Line Options#BaseX GUI|Startup Options]]):
==Client/Server==
===Server===
===Client===
By defaultIt provides access to the [[REST]], an [[RESTXQ]] and [[WebDAV]] services.An instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server] is startedwill 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]]):
[[Category:Beginner]]
no edit summary
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
First of all, [http://basex.org/download download] BaseX from our homepage.
The following distributions are available:
* the '''Core Package''' is a JAR file, which contains the database codesystem, the query processor and the GUI frontend. It is runs completely without additional libraries.* the '''ZIP Archive''' and the '''Windows Installer''' 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.
Some additional distributions are available from the download page,
* as standalone application, using the [[#Standalone|Standalone]] mode or the [[#Graphical User Interface|Graphical User Interface]],
* as [[#Client/Server|Client/Server]] application, or
* as [[#Web ApplicationHTTP Server|Web Application]], called from a web server.
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 the [http://www.java.com Java] Runtime Environment (JRE)]:* Since <b>Version 9</b> of BaseX, Java 8 is required. With {{* Since <b>Version|8.0}} of BaseX</b>, we switched to Java 7, because it provides better file handling support, and because Oracle stopped public support for older is required.* Older versionsare based on Java 6.
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).
If you plan want to perform parallel (concurrent ) read and write operations on a single databaseyour databases, youshould must use the client/server architecutre architecture or deploy it BaseX as web application.You may can safely open the same a database in different JVMs (Java virtual machines) forread-only access, and you won’t will not encounter any problems when reading from or and writingto different databases, but your update operations from different JVMs to the same database will be rejected if the databaseor may even lead to be written to is currently opened by another virtual machinecorrupt databases.
More details on concurrency are found in the [[Transaction Management]] article. =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#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.
* 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.
The [[GUI]] is the visual interface to the features of BaseX.
explore your XML data.
* Double click on the {{Code|BaseX.jar}} file.
Note that the GUI does ''not'' interact with the client/server architecture.
The [[Database Server]] comes into play if BaseX is to be used by
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.
The [[Database Server|BaseX Client]] interface can be used to send
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/>
We provide additional clients in various [[Clients|programming languages]] (language bindings), which allow you to communicate with BaseX from other programming lanaguges.
==Web Application=HTTP Server=
With the HTTP Server, BaseX can be used as [[Web Application]].
* 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 users: type in {{Code|mvn jetty:run}} in In the first two cases, the {{Code|basexcommand-api}} directory, and press {{Code|Ctrl+c}} line output will look similar to shut down the process following lines (see the JSP warning message [[Web Application#Maven|Web Applicationhttp: Maven//stackoverflow.com/questions/3521654/missing-jsp-support-in-jetty-or-confusing-log-message can be ignored]] for more details).:
<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: 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{classref}.LEVEL=DEBUG</pre> After that, you can e. g. open your browser and navigate to the RESTXQ start page http://localhost:8984.
=Changelog=
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
