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. 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 '''WAR 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 be embedded in existing Java web serversadd the {{Code|bin}} directory to your PATH environment variable.

BaseX is very light-weight. It The '''WAR Archive''' can be run and used embedded in various ways:existing Java web servers. ===Other Distributions===

* as standalone applicationVarious other distributions are available from the download page, using most of which contain only the [[Standalone|Standalone]] mode or the [[#GUI|Graphical User Interface]]core package and,* as [[#Client/Server|Client/Server]] applicationoptionally, or* as [[#Web Application|Web Application]], called from a web serverscripts for starting BaseX.

BaseX is platform-independent and runs has been tested on any system that provides animplementation of [http://www.java.com Java] several platforms, including Windows (JRE2000, XP, Vista, 7), Max OS X (10. With {{Version|8.0}} of BaseXx), we switched to Java 7Linux (SuSE xxx, because it provides better file handling supportDebian, Ubuntu) and because Oracle stopped public support for older versionsOpenBSD (4.x).

If For example, if you plan to perform concurrent only read and write operations on a single data, you can easily run several clients (standalone, GUI, databaseclients) at the same time. If you update your data, however, youshould shouldn’t use the client/server architecutre GUI or deploy it as web application.You may safely open a standalone instance at the same database 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 machinetime.

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 [[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]]):

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

==GUI=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#Servlet Container|web servlet]]. * For Maven usersIn 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]):run}} in  <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{{Code|basex-apiclassref}} directory.LEVEL=DEBUG</pre> After that, you can e. g. open your browser and press {{Code|Ctrl+c}} navigate to shut down the process (see [[Web Application#Maven|Web ApplicationRESTXQ start page http://localhost: Maven]] for more details)8984. ==Database Administration==

After thatThe [[DBA]] is a web-based database administration interface. It allows you to create and administrate databases, evaluate queries in realtime, you view log files, manage users, etc. It can open your browser and navigate to the start page be accessed via http://localhost:8984/dba/.