Difference between revisions of "Start Scripts"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/")
Tags: Mobile web edit Mobile edit
(124 intermediate revisions by 6 users not shown)
Line 1: Line 1:
The starting script files are available for every mode of BaseX and can be started on every operating system.<br />
+
Each BaseX  [[Startup]] mode can be launched with its own Start Script which can in turn be used with its own range of [[Command-Line Options]]. The BaseX [https://basex.org/download/ Windows and ZIP distributions] readily include all Start Scripts.
Note: Probably you have to modify the pathes in the script.
 
  
==BaseX Server==
+
* 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|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 BaseX Server an be started with the following scripts:
+
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.
  
===Windows===
+
=Standalone=
  
<pre class="brush:bash">
+
The following scripts launch the standalone version of BaseX:
@setlocal
+
 
 +
==Windows: {{Code|basex.bat}}==
 +
 
 +
<syntaxhighlight lang="batch">
 
@echo off
 
@echo off
 +
setLocal EnableDelayedExpansion
  
REM Path to this script
+
REM Path to core and library classes
set PWD=%~dp0
+
set MAIN=%~dp0/..
 +
set CP=%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*
  
REM Paths to distributed files or source directories
+
REM Options for virtual machine
set BXPATH=basex.jar
+
set BASEX_JVM=-Xmx1200m %BASEX_JVM%
  
REM Options for virtual machine
+
REM Run code
set VM=-Xmx1g
+
java -cp "%CP%" %BASEX_JVM% org.basex.BaseX %*
 +
</syntaxhighlight>
  
REM Run BaseX
+
==Linux/Mac: {{Code|basex}}==
java -cp "%BXPATH%" %VM% org.basex.BaseXServer %*
 
  
@endlocal
+
<syntaxhighlight lang="bash">
</pre>
+
#!/usr/bin/env bash
  
===Others===
+
# Path to this script
 +
FILE="${BASH_SOURCE[0]}"
 +
while [ -h "$FILE" ] ; do
 +
  SRC="$(readlink "$FILE")"
 +
  FILE="$( cd -P "$(dirname "$FILE")" && \
 +
          cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"
 +
done
 +
MAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )"
  
<pre class="brush:bash">
+
# Core and library classes
#!/bin/bash
+
CP=$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH
  
# Path to this script
+
# Options for virtual machine (can be extended by global options)
PWD=`dirname $0`
+
BASEX_JVM="-Xmx2g $BASEX_JVM"
  
# Paths to distributed files or source directories
+
# Run code
BXPATH=basex.jar
+
java -cp "$CP" $BASEX_JVM org.basex.BaseX "$@"
 +
</syntaxhighlight>
  
# Options for virtual machine
+
=GUI, Server, Client=
VM=-Xmx1g
 
  
# Run BaseX
+
If 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>.
java -cp "$BXPATH" $VM org.basex.BaseXServer "$@"
 
</pre>
 
  
==BaseX GUI==
+
=HTTP Server=
  
The BaseX GUI an be started with the following scripts:
+
The scripts for starting the HTTP server, which gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services, can be found below:
  
===Windows===
+
==Windows: {{Code|basexhttp.bat}}==
  
<pre class="brush:bash">
+
<syntaxhighlight lang="batch">
@setlocal
 
 
@echo off
 
@echo off
 +
setLocal EnableDelayedExpansion
 +
 +
REM Path to core and library classes
 +
set MAIN=%~dp0/..
 +
set CP=%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*
 +
 +
REM Options for virtual machine
 +
set BASEX_JVM=-Xmx1200m %BASEX_JVM%
 +
 +
REM Run code
 +
java -cp "%CP%" %BASEX_JVM% org.basex.BaseXHTTP %*
 +
</syntaxhighlight>
 +
 +
==Linux/Mac: {{Code|basexhttp}}==
 +
 +
<syntaxhighlight lang="bash">
 +
#!/usr/bin/env bash
  
REM Path to this script
+
# Path to this script
set PWD=%~dp0
+
FILE="${BASH_SOURCE[0]}"
 +
while [ -h "$FILE" ] ; do
 +
  SRC="$(readlink "$FILE")"
 +
  FILE="$( cd -P "$(dirname "$FILE")" && \
 +
          cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"
 +
done
 +
MAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )"
  
REM Paths to distributed files or source directories
+
# API, core, and library classes
set BXPATH=basex.jar
+
CP=$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH
  
REM Options for virtual machine
+
# Options for virtual machine (can be extended by global options)
set VM=-Xmx1g
+
BASEX_JVM="-Xmx2g $BASEX_JVM"
  
REM Run BaseX
+
# Run code
java -cp "%BXPATH%" %VM% org.basex.BaseXGUI %*
+
java -cp "$CP" $BASEX_JVM org.basex.BaseXHTTP "$@"
 +
</syntaxhighlight>
  
@endlocal
+
=Included Start Scripts=
</pre>
 
  
===Others===
+
The BaseX [https://basex.org/download/ Windows and ZIP distributions] readily include the following Start Scripts:
  
==BaseX Standalone==
+
{| 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.
 +
|}
  
The BaseX Standalone an be started with the following scripts:
+
For the BaseX HTTP and database server, there are also stop scripts available:
  
===Windows===
+
{| 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.
 +
|}
  
<pre class="brush:bash">
+
=Changelog=
@setlocal
 
@echo off
 
  
REM Path to this script
+
;Version 7.5
set PWD=%~dp0
 
  
REM Paths to distributed files or source directories
+
* Updated: Static dependencies removed from Windows batch scripts.
set BXPATH=basex.jar
 
  
REM Options for virtual machine
+
;Version 7.2
set VM=-Xmx1g
 
  
REM Run BaseX
+
* Updated: The {{Code|BaseXHTTP}} start class moved from {{Code|org.basex.api}} to {{Code|org.basex}}.
java -cp "%BXPATH%" %VM% org.basex.BaseX %*
 
  
@endlocal
+
;Version 7.0
</pre>
 
  
===Others===
+
* Updated: The {{Code|basexjaxrx}} scripts have been replaced with the {{Code|basexhttp}} scripts.

Revision as of 11:56, 2 July 2020

Each BaseX Startup mode can be launched with its own Start Script which can in turn be used with its own range of Command-Line Options. The BaseX Windows and ZIP distributions readily include all Start Scripts.

  • We recommend you to manually add the bin directory of your BaseX directory to the 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 MAIN variable.
  • The Windows installer automatically adds the project’s bin directory to your path environment.
  • If you work with Maven, you can directly run the scripts in the basex-core/etc and basex-api/etc sub-directories of the project.

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

Standalone

The following scripts launch the standalone version of BaseX:

Windows: basex.bat

<syntaxhighlight lang="batch"> @echo off setLocal EnableDelayedExpansion

REM Path to core and library classes set MAIN=%~dp0/.. set CP=%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*

REM Options for virtual machine set BASEX_JVM=-Xmx1200m %BASEX_JVM%

REM Run code java -cp "%CP%" %BASEX_JVM% org.basex.BaseX %* </syntaxhighlight>

Linux/Mac: basex

<syntaxhighlight lang="bash">

  1. !/usr/bin/env bash
  1. Path to this script

FILE="${BASH_SOURCE[0]}" while [ -h "$FILE" ] ; do

 SRC="$(readlink "$FILE")"
 FILE="$( cd -P "$(dirname "$FILE")" && \
          cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"

done MAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )"

  1. Core and library classes

CP=$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH

  1. Options for virtual machine (can be extended by global options)

BASEX_JVM="-Xmx2g $BASEX_JVM"

  1. Run code

java -cp "$CP" $BASEX_JVM org.basex.BaseX "$@" </syntaxhighlight>

GUI, Server, Client

If you would like to launch the GUI, Server or Client version of BaseX, please replace the class name in org.basex.BaseX with either BaseXGUI, BaseXServer or BaseXClient.

HTTP Server

The scripts for starting the HTTP server, which gives access to the REST, RESTXQ and WebDAV services, can be found below:

Windows: basexhttp.bat

<syntaxhighlight lang="batch"> @echo off setLocal EnableDelayedExpansion

REM Path to core and library classes set MAIN=%~dp0/.. set CP=%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*

REM Options for virtual machine set BASEX_JVM=-Xmx1200m %BASEX_JVM%

REM Run code java -cp "%CP%" %BASEX_JVM% org.basex.BaseXHTTP %* </syntaxhighlight>

Linux/Mac: basexhttp

<syntaxhighlight lang="bash">

  1. !/usr/bin/env bash
  1. Path to this script

FILE="${BASH_SOURCE[0]}" while [ -h "$FILE" ] ; do

 SRC="$(readlink "$FILE")"
 FILE="$( cd -P "$(dirname "$FILE")" && \
          cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"

done MAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )"

  1. API, core, and library classes

CP=$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH

  1. Options for virtual machine (can be extended by global options)

BASEX_JVM="-Xmx2g $BASEX_JVM"

  1. Run code

java -cp "$CP" $BASEX_JVM org.basex.BaseXHTTP "$@" </syntaxhighlight>

Included Start Scripts

The BaseX Windows and ZIP distributions readily include the following Start Scripts:

Windows Linux/Mac Description
basex.bat basex Launches the BaseX standalone mode.
basexclient.bat basexclient Starts a BaseX client.
basexgui.bat basexgui Starts the BaseX GUI.
basexhttp.bat basexhttp Starts the BaseX HTTP Server.
basexserver.bat basexserver Starts the BaseX database server.

For the BaseX HTTP and database server, there are also stop scripts available:

Windows Linux/Mac Description
basexhttpstop.bat basexhttpstop Stops the BaseX HTTP Server.
basexserverstop.bat basexserverstop Stops the BaseX database server.

Changelog

Version 7.5
  • Updated: Static dependencies removed from Windows batch scripts.
Version 7.2
  • Updated: The BaseXHTTP start class moved from org.basex.api to org.basex.
Version 7.0
  • Updated: The basexjaxrx scripts have been replaced with the basexhttp scripts.