titledescription
Command-line options
Command-line options reference documentation.

QuestDB may be started, stopped and passed configuration options from the command line. On Windows, the QuestDB server can also start an interactive session.

Options

The following sections describe the options that may be passed to QuestDB when starting the server from the command line.

  1. ./questdb.sh [start|stop|status] [-d dir] [-f] [-t tag]
  1. questdb [start|stop|status] [-d dir] [-f] [-t tag]
  1. questdb.exe [start|stop|status|install|remove] \
  2.   [-d dir] [-f] [-j JAVA_HOME] [-t tag]

Start

start - starts QuestDB as a service.

OptionDescription
-dExpects a dir directory value which is a folder that will be used as QuestDB’s root directory. For more information and the default values, see the default root section below.
-tExpects a tag string value which will be as a tag for the service. This option allows users to run several QuestDB services and manage them separately. If this option omitted, the default tag will be questdb.
-fForce re-deploying the Web Console. Without this option, the Web Console is cached and deployed only when missing.
-jWindows only! This option allows to specify a path to JAVA_HOME.
  1. ./questdb.sh start [-d dir] [-f] [-t tag]
  1. questdb start [-d dir] [-f] [-t tag]
  1. questdb.exe start [-d dir] [-f] [-j JAVA_HOME] [-t tag]

Default root directory

By default, QuestDB’s root directory will be the following:

  1. $HOME/.questdb
  1. /usr/local/var/questdb
  1. C:\Windows\System32\questdb

Stop

stop - stops a service.

OptionDescription
-tExpects a tag string value which to stop a service by tag. If this is omitted, the default tag will be questdb
  1. ./questdb.sh stop
  1. questdb stop
  1. questdb.exe stop

Status

status - shows the status for a service.

OptionDescription
-tExpects a tag string value which to stop a service by tag. If this is omitted, the default will be questdb
  1. ./questdb.sh status
  1. questdb status
  1. questdb.exe status

Install (Windows)

install - installs the Windows QuestDB service. The service will start automatically at startup.

  1. questdb.exe install

Remove (Windows)

remove - removes the Windows QuestDB service. It will no longer start at startup.

  1. questdb.exe remove

Interactive session (Windows)

You can start QuestDB interactively by running questdb.exe. This will launch QuestDB interactively in the active Shell window. QuestDB will be stopped when the Shell is closed.

Default root directory

When started interactively, QuestDB’s root directory defaults to the current directory.

Stop

To stop, press Ctrl+C in the terminal or close it directly.