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 runs completely without 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.* the '''WAR Application''' can be embedded in existing Java web servers.

Some additional distributions are available from the download pageAfter BaseX has been unzipped or installed,most of which contain only the core package and, optionally, scripts for starting BaseX.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 very light-weightstarted 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. It  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 run 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 used in various ways:, optionally, scripts for starting BaseX.

It can also be embedded as library in your own applicationBaseX 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 If you want to perform parallel (2000, XP, Vista, 7concurrent)read and write operations on your databases, Max OS X you must use the client/server architecture or deploy BaseX as web application. You can safely open a database in different JVMs (10.xJava virtual machines)for read-only access, Linux (SuSE xxx, Debianand you will not encounter any problems when reading from and writing to different databases, Ubuntu) and OpenBSD (4.x)but update operations from different JVMs to the same database will be rejected or may even lead to corrupt databases.

If you plan to perform concurrent read and write operations More details on a single database, youshould use the client/server architecutre or deploy it as web application.You may safely open the same database concurrency are found in different JVMs (Java virtual machines) forread-only access, and you 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[[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]]):

It is important to remember that the standalone mode does ''not'' interact with the [[#Client/Server|Client/Server]] architecture.

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

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

===Client===

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

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

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