Changes

Jump to navigation Jump to search
1,667 bytes added ,  11:56, 2 July 2020
m
Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"
The following scripts, which are referenced in 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]] articles, are also included in the Windows and ZIP . The BaseX [httphttps://basex.org/products/download/ release filesWindows and ZIP distributions]readily include all Start Scripts.
* We recommend you to manually add the BaseX {{Code|bin}} directory of your BaseX directory to the [httphttps://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 or the GitHub source[[Maven]], you can use directly run the scripts from in the {{Code|etc}} directory of our GitHub [https://github.com/BaseXdb/basex/tree/master/basex-core/etc basex-core/etc] and [https://github.com/BaseXdb/basex-api/tree/master/basex-api/etc basex-api/etc] repositoriessub-directories of the project.
=If BaseX Main Package=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.
The following scripts launch the standalone version of BaseX. Please replace the class name in <code>org.basex.BaseX</code> with either <code>BaseXClient</code>, <code>BaseXServer</code>, or <code>BaseXGUI</code> to run the client, server or GUI version.=Standalone=
==WindowsThe following scripts launch the standalone version of BaseX: basex.bat==
==Windows: {{Code|basex.bat}}== <pre classsyntaxhighlight lang="brush:bashbatch">
@echo off
setLocal EnableDelayedExpansion
REM Path to this scriptcore and library classesset PWDMAIN=%~dp0 REM Core and library classes/..set CP=%PWDMAIN%/../BaseX.jarset LIB=;%PWDMAIN%/../libfor /R "%LIB%" %%a in (*.jar) do set CP=!CP!;%MAIN%a/lib/custom/*
REM Options for virtual machine
set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%
REM Run code
java -cp "%CP%" %VMBASEX_JVM% org.basex.BaseX %*</presyntaxhighlight>
==Linux/Mac: {{Code|basex}}==
<pre classsyntaxhighlight lang="brush:bash">#!/usr/bin/env bash
# Path to this script
cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"
done
BXMAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )"
# Core and library classes
CP="$BXMAIN/BaseX.jar"CP=":$CPMAIN/lib/*:$(for JAR in "$BX"MAIN/lib/custom/*.jar; do echo -n ":$JAR"; done)"CLASSPATH
# 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.BaseX "$@"</presyntaxhighlight>
=BaseX HTTP GUI, Server, Client=
The scripts for starting If you would like to launch the HTTP serverGUI, Server or Client version of BaseX, which gives access to please replace the [[REST]], [[RESTXQ]] and [[WebDAV]] servicesclass name in <code>org.basex.BaseX</code> with either <code>BaseXGUI</code>, can be found below<code>BaseXServer</code> or <code>BaseXClient</code>.
==Windows: basexhttp.bat=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}}== <pre classsyntaxhighlight lang="brush:bashbatch">
@echo off
setLocal EnableDelayedExpansion
REM Path to this scriptcore and library classesset PWDMAIN=%~dp0 REM Core and library classes/..set CP=%PWDMAIN%/../BaseX.jarset LIB=;%PWDMAIN%/../libfor /R "%LIB%" %%a in (*.jar) do set CP=!CP!;%MAIN%afor /R "%LIB%" %%a in (lib/custom/*.jar) do set CP=!CP!;%%a
REM Options for virtual machine
set VMBASEX_JVM=-Xmx512mXmx1200m %BASEX_JVM%
REM Run code
java -cp "%CP%;." %VMBASEX_JVM% org.basex.BaseXHTTP %*</presyntaxhighlight>
==Linux/Mac: {{Code|basexhttp}}==
<pre classsyntaxhighlight lang="brush:bash">#!/usr/bin/env bash
# Path to this script
cd -P "$(dirname "$SRC")" && pwd )/$(basename "$SRC")"
done
BXMAIN="$( cd -P "$(dirname "$FILE")/.." && pwd )"BXCORE="$( cd -P "$BX/../basex" && pwd )"
# API, core, and library classes
CP="$BXMAIN/BaseX.jar$(printf ":%s" "$BX/BaseX.jar" "$BXMAIN/lib/"*.jar ":$BXCOREMAIN/target/classes" "$BXCORElib/libcustom/"*.jar)":$CLASSPATH
# 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.BaseXHTTP "$@"</presyntaxhighlight=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.45
* Updated: Static dependencies removed from Windows batch scripts.
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu