Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
* as a standalone application, using the [[Graphical User Interface]] or the [[Standalone Mode|Command-Line Interface]]* as a [[Database Server|client/server]] application* as a [[Web Application]], both embedded or client/server-based=Getting Started=
'''ImportantFirst of all, [http:''' If you plan to concurrently read and write your data, the client/serverarchitecture is mandatory/basex. This is because the standalone applications and theclientorg/server architecture of download download] BaseX all work in different JVMs (Java virtual machines)from our homepage.and The following distributions are not synchronized among each other. You should be aware that, in the worst case,databases might get corrupt if you use BaseX in different modes and try to enforce updates.available:
==Requirements==* the '''Core Package''' is a JAR file, which contains the database system, 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, [[Start Scripts]], and some additional optional files.* the '''WAR Archive''' can be embedded in existing Java web servers.
====BaseX====Please [http://basex.org/Some additional distributions are available from the download download] the latest BaseX version from our homepage.page,The official releases include most of which contain only the BaseX JAR file, libraries core package 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 wayoptionally, you will be able to runscripts for starting BaseX from everywhere in your shell/terminal.
==BaseX GUI==
The GUI It can be started as follows (get more information on all [[Startup Command-Line Options#BaseX GUI|Startup Options]]):
The standalone version can be started as follows(get more information on all [[Startup Options#BaseX Standalone|Startup Options]]):==Server==
* 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.
==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}}.
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 [[Startup Command-Line Options#BaseX HTTP Server|Startup Options]]):
[[Category:Beginner]]
→Getting Started
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running. The application can be run and used in various ways:
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. ====Java=Requirements===A Runtime Environment BaseX is platform-independent and runs on any system that provides an implementation of the [http://www.java.com Java 1.6] Runtime Environment (JRE) is needed to run BaseX].Since <b>Version 9.0</b> of BaseX , Java 8 is platform independent required. BaseX 8.x works with Java 7, and runs previous versions were based on any system that provides a Java Virtual Machine6. 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 databases, you must use the client/server architecture or deploy BaseX as 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, but update operations from different JVMs to the same database will be rejected or may even lead to corrupt databases. More details 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#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=
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 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 [[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. 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
