Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
m
The starting script files mentioned in the Each BaseX [[Startup Overview|startup overview]] are available in the BaseX.zip or mode can be launched with the Windows Installer. They its own Start Script which can in turn be used for every mode with its own range of [[Command-Line Options]]. The BaseX and started on every operating system[https://basex.If you didn't org/download them or can't find them you can use the scripts below on that page/ Windows and ZIP distributions] readily include all Start Scripts.
Note* 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 might need 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 modify the {{Code|MAIN}} variable.* The Windows installer automatically adds the project’s {{Code|bin}} directory to your path to environment.* If you work with [[Maven]], you can directly run the scripts in the <code>BaseX[https://github.com/BaseXdb/basex/tree/master/basex-core/etc basex-core/etc] and [https://github.jar<com/BaseXdb/basex/tree/master/basex-api/code> archive in etc basex-api/etc] sub-directories of the scriptproject.
All modes If BaseX terminates with an {{Code|Out of BaseX Memory}} or {{Code|Java heap space}} error, you can be started with assign more RAM via the following scripts:{{Code|-Xmx}} flag (see below). The conservative value that was chosen in our distributions ensures that BaseX will also run on 32 bit JVMs.
REM Path to this scriptset PWD=%~dp0HTTP Server=
REM Run # API, core, and library classesCP=$MAIN/BaseXjava -cp "%BXPATH%" %VM% org.basex.XXX %jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH
@endlocal# Options for virtual machine (can be extended by global options)</pre>BASEX_JVM="-Xmx2g $BASEX_JVM"
===Others===# Run codejava -cp "$CP" $BASEX_JVM org.basex.BaseXHTTP "$@"</syntaxhighlight>
<pre class="brush:bash">#!/bin/bashIncluded Start Scripts=
# Path to this scriptThe BaseX [https://basex.org/download/ Windows and ZIP distributions] readily include the following Start Scripts:PWD{| 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=`dirname $0` ;Version 7.5 * Updated: Static dependencies removed from Windows batch scripts.
# Paths to distributed files or source directoriesBXPATH=basex;Version 7.jar#BXPATH=$PWD/../target/classes2
# Options for virtual machineVM=-Xmx1g* Updated: The {{Code|BaseXHTTP}} start class moved from {{Code|org.basex.api}} to {{Code|org.basex}}.
# Run BaseXjava -cp "$BXPATH" $VM org;Version 7.basex.XXX "$@"</pre>0
Note* Updated: You The {{Code|basexjaxrx}} scripts have to replace 'XXX' in the Java command line been replaced with the mode you want to start, which is either <code>BaseXServer</code>, <code>BaseXGUI</code>, or <code>BaseX</code>{{Code|basexhttp}} scripts.
Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"
===Windows==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 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: {{Code|basex}}==
<syntaxhighlight lang="bash">
#!/usr/bin/env bash
# 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 )"
# Core and library classes
CP=$MAIN/BaseX.jar:$MAIN/lib/*:$MAIN/lib/custom/*:$CLASSPATH
# Options for virtual machine (can be extended by global options)
BASEX_JVM="-Xmx2g $BASEX_JVM"
# 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 <code>org.basex.BaseX</code> with either <code>BaseXGUI</code>, <code>BaseXServer</code> or <code>BaseXClient</code>.
The scripts for starting the HTTP server, which gives access to the [[REST]], [[RESTXQ]] and [[WebDAV]] services, can be found below: ==Windows: {{Code|basexhttp.bat}}== <syntaxhighlight lang="batch">@echo offsetLocal EnableDelayedExpansion REM Paths Path to distributed files or source directoriescore and library classesset BXPATHMAIN=basex%~dp0/..jarREM set BXPATHCP=%PWDMAIN%/BaseX..jar;%MAIN%/lib/*;%MAIN%/lib/targetcustom/classes*
REM Options for virtual machine
set VMBASEX_JVM=-Xmx1gXmx1200m %BASEX_JVM% REM Run codejava -cp "%CP%" %BASEX_JVM% org.basex.BaseXHTTP %*</syntaxhighlight> ==Linux/Mac: {{Code|basexhttp}}== <syntaxhighlight lang="bash">#!/usr/bin/env bash # Path to this scriptFILE="${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 )"
