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]] page, are also included mode can be launched with its own Start Script which can in the official releasesturn be used with its own range of [[Command-Line Options]].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.
===Windows===If BaseX 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.
===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 )"
Note: Please replace 'XXX' with either <code>BaseXServer</code>=GUI, <code>BaseXClient</code>Server, <code>BaseX</code>, or <code>BaseXGUI</code>.Client=
==If you would like to launch the GUI, Server or Client version of BaseX REST Server==The scripts for starting , please replace the [[JAX-RX API|REST Server]] can be found belowclass name in <code>org.basex.BaseX</code> with either <code>BaseXGUI</code>, <code>BaseXServer</code> or <code>BaseXClient</code>.
<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 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=: {{Code|basexhttp}}==
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 "$FILE")/.." && pwd )" # API, core, and library classesCP=$MAIN/BaseX.jar:$0`MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH # Options for virtual machine (can be extended by global options)BASEX_JVM="-Xmx2g $BASEX_JVM" # Run codejava -cp "$CP" $BASEX_JVM org.basex.BaseXHTTP "$@"</syntaxhighlight> =Included Start Scripts= The BaseX [https://basex.org/download/ Windows and ZIP distributions] readily include the following Start Scripts: {| class="wikitable"|- 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.|} For the BaseX HTTP and database server, there are also stop scripts available: {| class="wikitable"|- valign="top"! Windows! Linux/Mac! width="40%" | Description|- valign="top"|- valign="top"| {{Code|basexhttpstop.bat}}| {{Code|basexhttpstop}}| Stops the BaseX HTTP Server.|- valign="top"| {{Code|basexserverstop.bat}}| {{Code|basexserverstop}}| Stops the BaseX database server.|} =Changelog= ;Version 7.5
# Paths to distributed files or source directoriesBASEX=$PWD/basex* Updated: Static dependencies removed from Windows batch scripts.jarBASEXAPI=$PWD/basex-api.jar
# ClasspathLIB=$PWD/../libCP=$BASEX:$BASEXAPI:$LIB/jax-rx-1;Version 7.2.8.jar:$LIB/jetty-6.1.25.jar:$LIB/jetty-util-6.1.25.jar:CP=$CP:$LIB/servlet-api-2.5-20081211.jar:$LIB/jersey-server-1.4.jar:$LIB/jersey-core-1.4.jar:$LIB/asm-3.1.jar
# Options for virtual machineVM=-Xmx1g* Updated: The {{Code|BaseXHTTP}} start class moved from {{Code|org.basex.api}} to {{Code|org.basex}}.
# Run JAX-RX serverjava -cp "$CP" $VM org;Version 7.basex.api.jaxrx.JaxRxServer "$@"</pre>0
[[Category* Updated:JAX-RX]][[Category:Developer]][[Category:Beginner]]The {{Code|basexjaxrx}} scripts have been replaced with the {{Code|basexhttp}} scripts.
Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"
=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.XXX 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>
===Windows==HTTP Server=
REM ClasspathPath to core and library classesset LIBMAIN=%PWD%~dp0/../libset CP=%BASEX%;%BASEXAPI%;%LIBMAIN%/jax-rx-1.2.8BaseX.jar;%LIBMAIN%/jetty-6.1.25.jar;%LIB%/jetty-util-6.1.25.jar;set CP=%CP%;%LIB%lib/servlet-api-2.5-20081211.jar*;%LIBMAIN%/jersey-server-1.4.jar;%LIB%lib/jersey-core-1.4.jar;%LIB%custom/asm-3.1.jar*
REM Options for virtual machine
set VMBASEX_JVM=-Xmx1gXmx1200m %BASEX_JVM%
REM Run JAX-RX servercodejava -cp "%CP%;." %VMBASEX_JVM% org.basex.api.jaxrx.JaxRxServer BaseXHTTP %*</presyntaxhighlight>
<pre classsyntaxhighlight lang="brush:bash">#!/usr/bin/env bash
# Path to this script
