Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
m
The starting script files are available in the Each BaseX.zip and the windows installer for every [[Startup]] mode of BaseX and can be started on every operating system.If you didn't download them or launched with its own Start Script which can't find them you can use the scripts found below on that pagein turn be used with its own range of [[Command-Line Options]].<br The BaseX [https://>Note: Probably you have to modify the path to the jar archive in the scriptbasex.<br org/><br download/>All modes of BaseX can be started with the following scripts:Windows 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|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.
REM Run For the BaseXjava -cp "%BXPATH%" %VM% org.basex.X %*HTTP and database server, there are also stop scripts available:
@endlocal{| class="wikitable"<|- valign="top"! Windows! Linux/pre>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">#!/bin/bash;Version 7.5
# Path to this scriptPWD=`dirname $0`* 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.X "$@"</pre>0
Note* Updated: You The {{Code|basexjaxrx}} scripts have to replace 'X' in the java command line been replaced with the mode you want to start BaseXServer, BaseXGUI or BaseX{{Code|basexhttp}} scripts.
Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"
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. =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/..set CP=%MAIN%/BaseX.jar;%MAIN%/lib/*;%MAIN%/lib/custom/*
REM Paths to distributed files or source directoriesOptions for virtual machineset BXPATHBASEX_JVM=-Xmx1200m %BASEX_JVM% REM Run codejava -cp "%CP%" %BASEX_JVM% org.basex.BaseX %*</syntaxhighlight> ==Linux/Mac: {{Code|basex}}== <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 )" # Core and library classesCP=$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 codejava -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>. =HTTP Server= 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 Path to core and library classesset MAIN=%~dp0/..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 )" # API, core, and library classesCP=$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 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.|}
===Others==Changelog=
