Skip to content

Latest commit

 

History

History
265 lines (193 loc) · 7.34 KB

quick-start.mdx

File metadata and controls

265 lines (193 loc) · 7.34 KB
Raw
title description
Quick start
Get started with QuestDB, as quickly as possible. Instructions for docker, homebrew, our binaries, and more.

import Screenshot from "@theme/Screenshot";

import Button from "@theme/Button";

import InterpolateReleaseData from "../src/components/InterpolateReleaseData";

import NoJrePrerequisite from "./quick-start-utils/_no-jre-prerequisites.partial.mdx";

import CodeBlock from "@theme/CodeBlock";

import { TabsPlatforms } from "../src/modules/TabsPlatforms";

import RunWindows from "./quick-start-utils/_run-windows.partial.mdx";

import OptionsNotWindows from "./quick-start-utils/_options-not-windows.partial.mdx";

import OptionsWindows from "./quick-start-utils/_options-windows.partial.mdx";

import Tabs from "@theme/Tabs";

import TabItem from "@theme/TabItem";

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:

<InterpolateReleaseData renderText={(release) => ( {docker run \\ -p 9000:9000 -p 9009:9009 -p 8812:8812 -p 9003:9003 \\ questdb/questdb:${release.name}} )} />

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

export const platforms = [ { label: "Linux", value: "linux" }, { label: "Windows", value: "windows" }, { label: "Any (no JVM)", value: "noJre" }, ];

Download and run QuestDB via binaries.

Select your platform of choice:

<TabsPlatforms platforms={platforms} render={({ platform, href }) => { const filename = href.split("/").reverse()[0]; switch (platform) { case "noJre": return ; case "windows": return ( <> Download the executable: {" "}

{filename}

The default root directory becomes:

{C:\\Windows\\System32\\qdbroot} </> ); default: return ( <> Download the binary:{" "}

{filename}

Next, unpack it:{" "}

{tar -xvf ${filename}} The default directory becomes:

{$HOME/.questdb} </> ); } }} />

Run QuestDB

<Tabs defaultValue="nix" values={[ { label: "Linux/No JVM", value: "nix" }, { label: "macOS (Homebrew)", value: "macos" }, { label: "Windows", value: "windows" }, ]}>

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

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: