Changes

==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.

* the ==Distributions== ===Core Package=== The '''Core Package''' is a small JAR file, which . It contains the database codesystem, the query XQuery processor and the GUI frontendgraphical user interface. It does not require any additional libraries.* the ===Full Distributions=== The '''ZIP ArchivePackage''' and the '''Windows Installer''' contain the BaseX core library and extra libraries for web applications and advanced features, [[Starts 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 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 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 ApplicationArchive''' can be embedded in existing Java web servers. ===Other Distributions=== Various 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</b>, Java 7 is required.* Older versions are 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 want to perform parallel (concurrent) read and write operations on your 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 run and used in various ways:rejected or may even lead to corrupt databases.

* as For example, if you only read data, you can easily run several clients (standalone application, using GUI, database clients) at the [[Graphical User Interface]] or the [[Standalone Mode|Command-Line Interface]]same time. If you update your data,* as [[Database Server|client/server]] applicationhowever, you shouldn’t use the GUI or* as [[Web Application]], called from a web serverstandalone instance at the same time.

BaseX has been tested The [[Standalone Mode]] can be used to execute XQuery expressions or run database commands on several platforms, including Windows (2000, XP, Vista, 7), Max OS X (10command line.x), Linux (SuSE xxx, Debian, Ubuntu) It can also be used both for scripting and OpenBSD batch processing your XML data. It can be started as follows (4.xget more information on all [[Command-Line Options#Standalone|Startup Options]]).:

If you plan It is important to perform concurrent read and write operations on a single database,remember that the standalone mode does ''not'' interact with the client[[#Client/server Server|Client/Server]] architecture is the right choice. 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.=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=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.

(get more information on all [[Command-Line Options#BaseX Server|Startup Options]]):

* 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.

==BaseX Client== 

(get more information on all [[Command-Line Options#BaseX Client|Startup Options]]):

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 to build [[Web Application]]s.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]]):

* You BaseX can also deploy BaseX be deployed as a [[Web Application]]* For Maven users: type in {{Code|mvn jetty:run}} in the {{Code|basex-api}} directory, and press {{Code|Ctrl+c}} to shut down the process (see [[Web Application#MavenServlet Container|Web Application: Mavenweb servlet]] for more details).

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/.