Changes

The following scripts, which are mentioned on the Each BaseX [[Startup]] and mode can be launched with its own Start Script which can in turn be used with its own range of [[Startup Command-Line Options]] pages, are also included in our official '''Windows''' and '''ZIP''' release files, and available in our . The BaseX [https://githubbasex.comorg/BaseXdbdownload/basex-dist/tree/master/bin GitHub repositoryWindows and ZIP distributions]:readily include all Start Scripts.

* We recommend you to manually add the {{Code|bin}} directory of your BaseX directory to the [https://en.wikipedia.org/wiki/PATH_(variable) PATH variable] of your environment.* You can copy the start scripts to another location in your file system. After that, you should edit the scripts and assign the BaseX directory to the {{Code|MAIN}} variable.* The Windows installer automatically adds the project’s <code>{{Code|bin</code> }} directory to your path environment.* With the ZIP distributionIf you work with [[Maven]], you need to manually modify can directly run the path to scripts in the <code>PATH<[https://github.com/BaseXdb/basex/tree/master/basex-core/etc basex-core/etc] and [https://github.com/BaseXdb/basex/tree/master/basex-api/etc basex-api/code> environment variableetc] sub-directories of the project.

==If BaseX Main Package==terminates with an {{Code|Out of Memory}} or {{Code|Java heap space}} error, you can assign more RAM via the {{Code|-Xmx}} flag (see below). The conservative value that was chosen in our distributions ensures that BaseX will also run on 32 bit JVMs.

===WindowsThe following scripts launch the standalone version of BaseX: basex.bat===

==Windows: {{Code|basex.bat}}== <pre classsyntaxhighlight lang="brush:bashbatch">@setlocal

REM Path to this scriptcore and library classesset PWDMAIN=%~dp0 REM Paths to distributed files or source directories/..set BXPATHCP=basex%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*

set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%

REM ClasspathRun codeset LIB=java -cp "%PWD%/../libset CP=%BASEX" %;BASEX_JVM%LIB%/lucene-analyzers-3org.0basex.2.jar;%LIB%/tagsoup-1.2.jar;%LIBBaseX %*</snowball.jarsyntaxhighlight>

REM Run BaseXjava -cp "%CP%" %VM% org.==Linux/Mac: {{Code|basex.BaseX %*</pre>}}==

===Linux/Mac: basex=== <pre classsyntaxhighlight lang="brush:bash">#!/usr/bin/env bash

PWDFILE=`"${BASH_SOURCE[0]}"while [ -h "$FILE" ] ; do SRC="$(readlink "$FILE")" FILE="$( cd -P "$(dirname "$FILE")" && \ cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"doneMAIN="$( cd -P "$(dirname "$0`FILE")/.." && pwd )"

# Paths to distributed files or source directoriesCore and library classesBXPATHCP=basex$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH

# Options for virtual machine(can be extended by global options)VMBASEX_JVM="-Xmx512mXmx2g $BASEX_JVM"

# ClasspathRun codeLIB=java -cp "$PWD/../libCP=$BASEX:$LIB/lucene-analyzers-3.0.2.jar:" $LIB/tagsoup-1BASEX_JVM org.2basex.jar:BaseX "$LIB@"</snowball.jarsyntaxhighlight>

==If you would like to launch the GUI, Server or Client version of BaseX JAX-RX Server==Deprecated from , please replace the class name in <font color='orangered'code>Version 6org.8basex.BaseX</code> with either <code>BaseXGUI</fontcode>, <code>BaseXServer</code> or <code>BaseXClient</code>: The scripts for starting the [[JAX-RX API|JAX-RX Server]] can be found below.

===Windows: basexjaxrx.bat==HTTP Server=

<pre class="brushThe scripts for starting the HTTP server, which gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services, can be found below:bash">@setlocal@echo off

REM Path to this scriptset PWD=%~dp0=Windows: {{Code|basexhttp.bat}}==

REM ClasspathPath to core and library classesset LIBMAIN=%PWD%~dp0/../libset CP=%BASEX%;%BASEXAPI%;%LIBMAIN%/jax-rx-1.2.9BaseX.jar;%LIBMAIN%/jetty-6.1.25.jar;%LIB%lib/jetty-util-6.1.25.jarset CP=%CP%*;%LIBMAIN%/servlet-api-2.5-20081211.jar;%LIB%lib/jersey-server-1.4.jar;%LIB%custom/jersey-core-1.4.jar;%LIB%/asm-3.1.jar*

set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%

java -cp "%CP%" %VMBASEX_JVM% org.basex.api.jaxrx.JaxRxServer BaseXHTTP %*</presyntaxhighlight>

===Linux/Mac: basexjaxrx={{Code|basexhttp}}==

<pre classsyntaxhighlight lang="brush:bash">#!/usr/bin/env bash

PWDFILE=`dirname "${BASH_SOURCE[0`]}"while [ -h "$FILE" ] ; do# Paths to distributed files or source directories SRC="$(readlink "$FILE")"BASEX FILE="$PWD( cd -P "$(dirname "$FILE")" && \ cd -P "$(dirname "$SRC")" && pwd )/basex.jar$(basename "$SRC")"doneBASEXAPIMAIN="$( cd -P "$(dirname "$PWDFILE")/basex-api.jar." && pwd )"

# ClasspathLIB=$PWD/../libAPI, core, and library classesCP=$BASEX:$BASEXAPI:$LIBMAIN/jax-rx-1.2.9BaseX.jar:$LIBMAIN/jetty-6.1.25.jar:$LIBlib/jetty-util-6.1.25.jarCP=$CP*:$LIBMAIN/servlet-api-2.5-20081211.jar:$LIBlib/jersey-server-1.4.jar:$LIBcustom/jersey-core-1.4.jar*:$LIB/asm-3.1.jarCLASSPATH

# Options for virtual machine(can be extended by global options)VMBASEX_JVM="-Xmx512mXmx2g $BASEX_JVM"

java -cp "$CP" $VM BASEX_JVM org.basex.api.jaxrx.JaxRxServer BaseXHTTP "$@"</presyntaxhighlight>

=Included Start Scripts=BaseX HTTP Server==Introduced with <font color='orangered'>Version 6.8</font>: The scripts for starting the HTTP server, which allows access to the [[REST]] and [[WebDAV]] services, can be found below.

===The BaseX [https://basex.org/download/ Windowsand ZIP distributions] readily include the following Start Scripts: basexhttp.bat===

<pre {| class="brush:bashwikitable">@echo off|- valign="top"! Windows! Linux/Mac! Description|- valign="top"| {{Code|basex.bat}}| {{Code|basex}}| Launches the BaseX standalone mode.|- valign="top"| {{Code|basexclient.bat}}| {{Code|basexclient}}| Starts a BaseX client.|- valign="top"| {{Code|basexgui.bat}}| {{Code|basexgui}}| Starts the BaseX GUI.|- valign="top"| {{Code|basexhttp.bat}}| {{Code|basexhttp}}| Starts the BaseX HTTP Server.|- valign="top"| {{Code|basexserver.bat}}| {{Code|basexserver}}| Starts the BaseX database server.setlocal|}

REM Paths to distributed files or source directories{| class="wikitable"|- valign="top"! Windows! Linux/Macset BASEX! width="40%PWD%/../" | Description|- valign="top"|- valign="top"| {{Code|basexhttpstop.bat}}| {{Code|basexhttpstop}}| Stops the BaseX HTTP Server./basex/target/classesset BASEXAPI|- valign=%PWD%/"top"| {{Code|basexserverstop.bat}}| {{Code|basexserverstop}}| Stops the BaseX database server./target/classes|}

REM Classpathset LIB=%PWD%/../libset CPChangelog=%BASEX%;%BASEXAPI%;%LIB%/commons-fileupload-1.2.2.jar;%LIB%/jetty-6.1.26.jarset CP=%CP%;%LIB%/jetty-util-6.1.26.jar;%LIB%/lucene-analyzers-3.0.2.jar;%LIB%/milton-api-1.6.4.jarset CP=%CP%;%LIB%/resolver.jar;%LIB%/servlet-api-2.5-20081211.jar;%LIB%/snowball.jar;%LIB%/tagsoup-1.2.jar

REM Options for virtual machineset VM=-Xmx512m REM Run codejava -cp "%CP%;Version 7." %VM% org.basex.api.BaseXHTTP %*</pre> ===Linux/Mac: basexhttp=== <pre class="brush:bash">#!/bin/bash # Path to this scriptPWD=`dirname $0`5

# Paths to distributed files or source directoriesBASEX=$PWD/* Updated: Static dependencies removed from Windows batch scripts../../basex/target/classesBASEXAPI=$PWD/../target/classes

# ClasspathLIB=$PWD/../libCP=$BASEX:$BASEXAPI:$LIB/commons-fileupload-1.2.2.jar:$LIB/jetty-6.1.26.jarCP=$CP:$LIB/jetty-util-6.1.26.jar:$LIB/lucene-analyzers-3.0;Version 7.2.jar:$LIB/milton-api-1.6.4.jarCP=$CP:$LIB/resolver.jar:$LIB/servlet-api-2.5-20081211.jar:$LIB/snowball.jar:$LIB/tagsoup-1.2.jar

# Run codejava -cp "$CP" $VM org;Version 7.basex.api.BaseXHTTP "$@"</pre>0

[[Category* Updated:JAX-RX]][[Category:REST]][[Category:Beginner]][[Category:Developer]]The {{Code|basexjaxrx}} scripts have been replaced with the {{Code|basexhttp}} scripts.