Changes

Jump to navigation Jump to search
2,317 bytes added ,  12:50, 30 July 2018
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
==Getting Started== 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.
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 code, the query processor and the GUI frontend. It 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.==Distributions==
Some additional distributions are available from the download page,most of which contain only the core package and, optionally, scripts for starting BaseX.===Core Package===
BaseX The '''Core Package''' is very light-weighta small JAR file. It contains the database system, the XQuery processor and the graphical user interface. It does not require any additional libraries. ===Full Distributions=== The '''ZIP Package''' and the '''Windows Installer''' contain the BaseX core library and extra libraries for web applications and advanced features, [[Start Scripts]], and some additional optional files. After BaseX has been unzipped or installed, the following directories will be available: * {{Code|bin/}}: Start scripts (Windows, Linux).* {{Code|data/}}: Database directory. See [[Configuration]] for more details.* {{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 run placed (such as the Saxon library).* {{Code|repo/}}: [[Repository]] (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: RESTXQ web application, REST scripts, [[DBA]]. If BaseX is started via the start scripts or the Windows icons, all JAR files in the {{Code|lib}} directory and used its descendant directories will be added to the classpath. If you work with the ZIP distribution, and if you want to make BaseX globally available, you can add the {{Code|bin}} directory to your PATH environment variable. ===Web Archive=== The '''WAR Archive''' can be embedded in various ways:existing Java web servers.
* 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 Application|Web Application]], called from a web server.===Other Distributions===
It can also be embedded as a library in your own applicationVarious other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
====Requirements====
BaseX is platform-independent and runs on any system that provides an implementation of the [http://www.java.com Java] Runtime Environment (JRE)]:* Since <b>Version 9</b> of BaseX, Java 8 is required.* Since <b>Version 8.0</b> of BaseX, Java 7 is mandatory, because it provides better file handling support,required.and because Oracle stopped public support for older * 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).
====Concurrent Operations====
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.
==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.
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.
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.
explore your XML data.
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==
===Server===
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.
===Client===
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|BaseX Clientsprogramming languages]], which allow you to communicate with BaseX from other programming lanaguges.
==HTTP Server==
With the HTTP Server, BaseX can be used as to build [[Web Application]]s.
It provides access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services.
An instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server] will be created,
be started, which 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.
* BaseX can also be deployed as [[Web Application#Servlet Container|web servlet]].
In the first two cases, the command-line output will look similar to the following lines (the JSP warning message [http://stackoverflow.com/questions/3521654/missing-jsp-support-in-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: 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. ==Database Administration== The [[DBA]] is a web-based database administration interface. It allows you to create and administrate databases, evaluate queries in realtime, view log files, manage users, etc. It can be accessed via http://localhost:8984/dba/.
=Changelog=
* Updated: BaseXJAXRX has been replaced with BaseXHTTP
 
[[Category:Beginner]]
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu