OrientDB Server - server

The OrientDB Server is a Java application that manages database operations, retrieval and storage. The shell script server provides a convenient command-line interface to use in configuring and launching the OrientDB Server.

OrientDB provides a server.sh shell script for starting the server on Linux operating systems and a server.bat batch file for starting it on Windows.

Configuration Environmental Variables

OrientDB manages most of its configuration options through various XML configuration files. However, there are a handful of environmental variables that it utilizes when starting the Server. When the script runs, it check these variables to determine whether any value has been set on them. In the event that it finds none, it instead sets a sensible default value.

On Linux, you can set the environmental variable using the export command:

$ export ORIENTDB_HOME=/opt/orientdb/3.2.30/

The following environmental variables are used by server.sh:

Variable NameDefaultDescription
$CONFIG_FILE$ORIENTDB_HOME/config/orientdb-server-config.xmlXML configuration file for the server
$JAVA_HOME$PATH/javaPath to Java home directory, used when you have multiple installations of Java available on the host
$JAVA_OPTS_SCRIPT-Djna.nosys=true -XX:+HeapDumpOnOutOfMemoryError -Djava.awt.headless=true -Dfile.encoding=UTF8 -Drhino.opt.level=9Defines
$ORIENTDB_HOMEcurrent working directoryOrientDB installation directory
$ORIENTDB_LOG_CONF$ORIENTDB_HOME/config/orientdb-server-log.propertiesPath to Java properties file you want to use
$ORIENTDB_OPTS_MEMORY-Xms2G -Xmx2GMemory options, defaults to 2GB of heap
$ORIENTDB_PID$ORIENTDB_HOME/bin/orient.pidPath to the process id (.pid) file
$ORIENTDB_SETTINGSDefault settings for OrientDB
$ORIENTDB_WWW_PATH$ORIENTDB_HOME/www/Path to web resources, defaults to the interface to launch OrientDB Studio

The server.sh script also accepts argument. If one of the arguments is debug, the script enables the following Java options -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044. Any additional arguments are passed directly to the java program.