Quick start

This guide will get your first QuestDB instance running.

As the goal is to, well, start quickly, we'll presume defaults.

Once running, we'll provide guides for inserting data, configuration and production hosting.

QuestDB already running? Jump ahead! Select a first-party client or ingest method.

Install QuestDB​

Choose from the following options:

Docker​

To use Docker, one must have Docker. You can installation find guides for your platform on the official documentation.

Once Docker is installed, you will need to pull QuestDB's image from Docker Hub and create a container:

docker run \   -p 9000:9000 -p 9009:9009 -p 8812:8812 -p 9003:9003 \   questdb/questdb:8.1.2

For deeper instructions, see the Docker deployment guide.

Homebrew​

To install QuestDB via Homebrew, run the following command:

brew install questdb

On macOS, the location of the root directory of QuestDB and server configuration files depending on the chip:

  • Apple Silicon (M1/M2/M*) chip: /opt/homebrew/var/questdb

  • Intel chip: /usr/local/var/questdb

Binaries​

Download and run QuestDB via binaries.

Select your platform of choice:

Download the binary:

questdb-8.1.2-no-jre-bin.tar.gz

This package does not embed Java.

Use this if there is no package for your platform, such as ARM Linux.

Requires local Java 17.

To check your installed version:

java -version

If you do not have Java, install one of the following:

  • AdoptOpenJDK
  • Amazon Corretto
  • OpenJDK
  • Oracle Java

Other Java distributions might work but are not tested.

For environment variable, point JAVA_HOME to your Java 17 installation folder.

Run QuestDB​

./questdb.sh [start|stop|status] [-d dir] [-f] [-n] [-t tag]
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 is 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.
-nDo not respond to the HUP signal. This keeps QuestDB alive after you close the terminal window where you started it.

Enjoy QuestDB​

Congratulations! 🎉 QuestDB is now running.

The QuestDB Web Console is available by default at: http://localhost:9000.

Also by default, QuestDB will use the following ports:

With that, you're ready to bring your data and enjoy the high performance and reliability of QuestDB.

Bring your data​

Now... Time to really blast-off. 🚀

Next up: Bring your data - the life blood of any database.

Choose from one of our premium ingest-only language clients:

Want more options? See the ingestion overview.

Create new data​

No data yet and still want to trial QuestDB?

There are several quick options:

  1. QuestDB demo instance: Hosted, fully loaded and ready to go. Quickly explore the Web Console and SQL syntax.
  2. Create my first data set guide: create tables, use rnd_ functions and make your own data.
  3. Sample dataset repos: IoT, e-commerce, finance or git logs? Check them out!
  4. Quick start repos: Code-based quick starts that cover ingestion, querying and data visualization using common programming languages and use cases. Also, a cat in a tracksuit.
  5. Time series streaming analytics template: A handy template for near real-time analytics using open source technologies.

Learn QuestDB​

For operators or developers looking for next steps to run an efficient instance, see: