Skip to content

Commit a346f28

Browse files
authored
docs: Update QuestDB docs (#8364)
1 parent 896156b commit a346f28

File tree

1 file changed

+41
-3
lines changed
  • docs/pages/product/configuration/data-sources

1 file changed

+41
-3
lines changed

docs/pages/product/configuration/data-sources/questdb.mdx

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ redirect_from:
55

66
# QuestDB
77

8+
[QuestDB][questdb] is a high-performance [time-series database][time-series-database-glossary] which helps you overcome ingestion bottlenecks.
9+
810
<WarningBox>
911

1012
The driver for QuestDB is supported by its vendor. Please report any issues to
@@ -14,13 +16,38 @@ their [Slack][questdb-slack].
1416

1517
## Prerequisites
1618

17-
- The hostname for the [QuestDB][questdb] database server
19+
- The hostname for the QuestDB database server
20+
- If QuestDB is not running, checkout the QuestDB [quick start][questdb-quick-start]
21+
- [Docker][docker] (optional)
1822

1923
## Setup
2024

21-
### Manual
25+
### Docker
26+
27+
Create a dockerfile within the project directory:
28+
29+
```yaml title=docker-compose.yml
30+
version: "2.2"
31+
32+
services:
33+
cube:
34+
environment:
35+
- CUBEJS_DEV_MODE=true
36+
image: "cubejs/cube:latest"
37+
ports:
38+
- "4000:4000"
39+
volumes:
40+
- ".:/cube/conf"
41+
questdb:
42+
container_name: questdb
43+
hostname: questdb
44+
image: "questdb/questdb:latest"
45+
ports:
46+
- "9000:9000"
47+
- "8812:8812"
48+
```
2249
23-
Add the following to a `.env` file in your Cube project:
50+
Within your project directory, create an `.env` file:
2451

2552
```dotenv
2653
CUBEJS_DB_TYPE=questdb
@@ -31,6 +58,14 @@ CUBEJS_DB_USER=admin
3158
CUBEJS_DB_PASS=quest
3259
```
3360

61+
Finally, bring it all up with Docker:
62+
63+
```bash title=shell
64+
docker-compose up -d
65+
```
66+
67+
Access Cube at http://localhost:4000 & QuestDB at http://localhost:9000
68+
3469
## Environment Variables
3570

3671
| Environment Variable | Description | Possible Values | Required |
@@ -46,3 +81,6 @@ CUBEJS_DB_PASS=quest
4681

4782
[questdb]: https://questdb.io/
4883
[questdb-slack]: https://slack.questdb.io/
84+
[time-series-database-glossary]: https://questdb.io/glossary/time-series/database/
85+
[questdb-quick-start]: https://questdb.io/docs/quick-start/
86+
[docker]: https://docs.docker.com/get-docker/

0 commit comments

Comments
 (0)