Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
m
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 the official releases.You might need to modify the path to the The BaseX directory to get them running[https://basex.org/download/ Windows and ZIP distributions] readily include all Start Scripts.
==* We recommend you to manually add the {{Code|bin}} directory of your BaseX Main Package==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|bin}} directory to your path environment.* If you work with [[Maven]], you can directly run the scripts in the [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/etc] sub-directories of the project.
The following scripts launch If BaseX terminates with an {{Code|Out of Memory}} or {{Code|Java heap space}} error, you can assign more RAM via the standalone version of BaseX{{Code|-Xmx}} flag (see below). Please replace <code>The conservative value that was chosen in our distributions ensures that BaseX</code> with either <code>BaseXClient</code>, <code>BaseXServer</code>, or <code>BaseXGUI</code> to will also run the client, server or GUI versionon 32 bit JVMs.
===Linux/Mac (: {{Code|basex)=}}==
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 )"
===Windows (basexjaxrxIf you would like to launch the GUI, Server or Client version of BaseX, please replace the class name in <code>org.basex.BaseX</code> with either <code>BaseXGUI</code>, <code>BaseXServer</code> or <code>BaseXClient</code>.bat)===
<pre class="brush:bash">HTTP Server=@setlocal@echo offThe scripts for starting the HTTP server, which gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services, can be found below:
REM Path to this scriptset PWD=%~dp0=Windows: {{Code|basexhttp.bat}}==
REM Paths to distributed files or source directories<syntaxhighlight lang="batch">set BASEX=%PWD%/basex-%BXVERSION%.jar @echo offset BASEXAPI=%PWD%/basex-api-%BXVERSION%.jarsetLocal EnableDelayedExpansion
===Linux/Mac (basexjaxrx)=: {{Code|basexhttp}}==
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 )"
===The BaseX [https://basex.org/download/ Windows===and ZIP distributions] readily include the following Start Scripts:
<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 Path to this scriptset PWD=%~dp0For the BaseX HTTP and database server, there are also stop scripts available:
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.jar;%LIB%/jetty-util-6.1.26.jar;%LIB%/lucene-analyzers-3.0.2.jar;%LIB%/milton-api-1.6.4.jar;%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;Version 7.5
REM Run codejava -cp "%CP%;* Updated: Static dependencies removed from Windows batch scripts." %VM% org.basex.api.BaseXHTTP %*</pre>
===Linux/Mac===;Version 7.2
<pre * Updated: The {{Code|BaseXHTTP}} start class="brush:bash">#!/bin/bashmoved from {{Code|org.basex.api}} to {{Code|org.basex}}.
# Path to this scriptPWD=`dirname $0` # Paths to distributed files or source directoriesBASEX=$PWD/../../basex/target/classesBASEXAPI=$PWD/../target/classes # ClasspathLIB=$PWD/../libCP=$BASEX:$BASEXAPI:$LIB/commons-fileupload-1.2.2.jar:$LIB/jetty-6.1.26.jar:$LIB/jetty-util-6.1.26.jar:$LIB/lucene-analyzers-3;Version 7.0.2.jar:$LIB/milton-api-1.6.4.jar:$LIB/resolver.jar:$LIB/servlet-api-2.5-20081211.jar:$LIB/snowball.jar:$LIB/tagsoup-1.2.jar # Options for virtual machineVM=-Xmx512m # Run codejava -cp "$CP" $VM org.basex.api.BaseXHTTP "$@"</pre>
[[Category* Updated:JAX-RX]][[Category:REST]][[Category:Beginner]][[Category:Developer]]The {{Code|basexjaxrx}} scripts have been replaced with the {{Code|basexhttp}} scripts.
Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"
===Windows (basex.bat)==Standalone=
The following scripts launch the standalone version of BaseX: ==Windows: {{Code|basex.bat}}== <pre classsyntaxhighlight lang="brush:bashbatch">@setlocal
@echo off
setLocal EnableDelayedExpansion
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/*
REM Options for virtual machine
set VMBASEX_JVM=-Xmx1gXmx1200m %BASEX_JVM%
REM Run BaseXcodejava -cp "%BXPATHCP%" %VMBASEX_JVM% org.basex.BaseX %*</presyntaxhighlight>
<pre classsyntaxhighlight lang="brush:bash">#!/usr/bin/env bash
# Path to this script
# 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="-Xmx1gXmx2g $BASEX_JVM"
# Run BaseXcodejava -cp "$BXPATHCP" $VM BASEX_JVM org.basex.XXX BaseX "$@"</presyntaxhighlight>
==BaseX JAX-RX Server==The scripts for starting the [[JAX-RX API|JAX-RX GUI, Server]] can be found below (deprecated from <font color, Client='orangered'>Version 6.8</font>).
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*
REM Options for virtual machine
set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%
REM Run code
java -cp "%CP%" %VMBASEX_JVM% org.basex.api.jaxrx.JaxRxServer BaseXHTTP %*</presyntaxhighlight>
<pre classsyntaxhighlight lang="brush:bash">#!/usr/bin/env bash
# Path to this script
# 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"
# Run code
java -cp "$CP" $VM BASEX_JVM org.basex.api.jaxrx.JaxRxServer BaseXHTTP "$@"</presyntaxhighlight>
=Included Start Scripts=BaseX HTTP Server==The scripts for starting the HTTP server, which allows access to the [[REST]] and [[WebDAV]] services, can be found below (introduced with <font color='orangered'>Version 6.8</font>).
