Skip to content

Commit 21ae50c

Browse files
authored
New intro page & supporting components (#105)
* Streamlines intro, moves context into Why QuestDB page * Adds a set of new story telling components * Resources, Clients & Guides
1 parent 44377c2 commit 21ae50c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+1385
-665
lines changed

documentation/ingestion-overview.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description:
88

99
import Screenshot from "@theme/Screenshot"
1010

11+
import { Clients } from "../src/components/Clients"
12+
1113
QuestDB makes top performance "data-in" easy.
1214

1315
This guide will prepare you to get the most out of (and into!) QuestDB.
@@ -24,13 +26,7 @@ with high volume, [high cardinality](/glossary/high-cardinality/) data streaming
2426

2527
To start quickly, select your language:
2628

27-
- [C & C++](/docs/clients/ingest-c-and-cpp)
28-
- [.NET](/docs/clients/ingest-dotnet)
29-
- [Go](/docs/clients/ingest-go)
30-
- [Java](/docs/clients/java_ilp)
31-
- [Node.js](/docs/clients/ingest-node)
32-
- [Python](/docs/clients/ingest-python)
33-
- [Rust](/docs/clients/ingest-rust)
29+
<Clients />
3430

3531
Our clients utitilize the InfluxDB Line Protocol (ILP) which is an insert-only
3632
protocol that bypasses SQL `INSERT` statements, thus achieving significantly

documentation/introduction.md

Lines changed: 41 additions & 158 deletions
Original file line numberDiff line numberDiff line change
@@ -2,191 +2,74 @@
22
title: Introduction
33
slug: /
44
description:
5-
QuestDB time series database documentation. QuestDB is a fast columnar time
6-
series database that solves ingestion speed bottlenecks
5+
The official QuestDB documentation. Learn how to accelerate your time-series, capital markets, and heavy industry use cases.
6+
custom_edit_url: null
77
---
88

9-
import Screenshot from "@theme/Screenshot"
9+
import { Guides } from '../src/components/Guides'
10+
import { Resources } from '../src/components/Resources'
11+
import { HeroPattern } from '../src/components/HeroPattern'
12+
import { DocButton } from '../src/components/DocButton'
1013

11-
import CodeBlock from "@theme/CodeBlock"
14+
<HeroPattern />
1215

13-
QuestDB is an Apache 2.0 open source columnar database that specializes in time
14-
series.
16+
QuestDB is a top performance database that specializes in time-series.
1517

1618
It offers **category-leading ingestion throughput** and **fast SQL queries**
1719
with operational simplicity.
1820

1921
Given its effiency, QuestDB **reduces operational costs**, all while overcoming
2022
ingestion bottlenecks.
2123

22-
As a result, QuestDB offers greatly simplified overall ingress infrastructure.
24+
As a result, QuestDB amplifies intensive **time-series**, **capital market**, and **heavy industry** use cases.
2325

24-
This introduction provides a brief overview on:
26+
<div className="not-prose mb-16 mt-6 flex gap-3">
27+
<DocButton href="/quick-start" arrow="right" style={{ marginRight: '20px' }}>
28+
<>Quick start</>
29+
</DocButton>
2530

26-
- [Top QuestDB features](#features)
27-
- [Benefits of QuestDB](#benefits)
28-
- [QuestDB Enterprise](#questdb-enterprise)
29-
- [Where to next?](#next-up)
30-
- [Support](#support)
31+
<DocButton href="/docs/ingestion-overview/#first-party-clients" variant="outline" style={{ marginRight: '20px' }}>
32+
<>Explore clients</>
33+
</DocButton>
3134

32-
<hr />
35+
<DocButton href="/docs/why-questdb/" variant="outline" style={{ marginRight: '20px' }}>
36+
<>Why QuestDB?</>
37+
</DocButton>
3338

34-
> **Just want to build? Jump to the [quick start](/docs/quick-start/) guide.**
39+
<DocButton href="https://demo.questdb.io" variant="outline" style={{ marginRight: '20px' }}>
40+
<>Try live demo</>
41+
</DocButton>
42+
</div>
3543

36-
<hr />
44+
## Ingest your data
3745

38-
## Top QuestDB features {#features}
46+
The first step is to get your data into QuestDB.
3947

40-
QuestDB is applied within cutting edge use cases around the world.
48+
We've got a range of first-party clients, protols and methods for ingestion.
4149

42-
Developers are most enthusiastic about the following key features:
50+
Whether you're using first-party clients or interfacing with a third-party tool or library, we've got you covered.
4351

44-
#### Massive ingestion handling & throughput
45-
46-
If you are running into throughput bottlenecks using an existing storage engine
47-
or time series database, QuestDB can help.
48-
49-
#### High performance deduplication & out-of-order indexing
50-
51-
[High data cardinality](/glossary/high-cardinality/) will not lead to
52-
performance degradation.
53-
54-
#### Hardware efficiency
55-
56-
Strong, cost-saving performance on very mninimal hardware, including sensors and
57-
Raspberry Pi.
58-
59-
#### SQL with time series extensions
60-
61-
Fast, SIMD-optimized SQL extensions to cruise through querying and analysis.
62-
63-
No obscure domain-specific languages required.
64-
65-
Greatest hits include:
66-
67-
- [`SAMPLE BY`](/docs/reference/sql/sample-by/) summarizes data into chunks
68-
based on a specified time interval, from a year to a microsecond
69-
- [`WHERE IN`](/docs/reference/sql/where/#time-range) to compress time ranges
70-
into concise intervals
71-
- [`LATEST ON`](/docs/reference/sql/latest-on/) for latest values within
72-
multiple series within a table
73-
- [`ASOF JOIN`](/docs/reference/sql/asof-join/) to associate timestamps between
74-
a series based on proximity; no extra indices required
75-
76-
## Benefits of QuestDB {#benefits}
77-
78-
To avoid ingestion bottlenecks, high performance data ingestion is essential.
79-
80-
But performance is only part of the story.
81-
82-
Efficiency measures how well a database performs relative to its available
83-
resources.
84-
85-
QuestDB, on maximal hardware, significantly outperforms peers:
86-
87-
<Screenshot
88-
alt="A chart showing high-cardinality ingestion performance of InfluxDB, TimescaleDB, and QuestDB"
89-
src="images/benchmark/benchmark_all_q1_2024.webp"
90-
width={650}
91-
title="Benchmark results for QuestDB 7.3.10, InfluxDB 2.7.4 and Timescale 2.14.2"
92-
/>
93-
94-
However, on less robust hardware the difference is even more pronounced, as seen
95-
in the following benchmark.
96-
97-
Even on hardware as light as a Raspberry Pi 5, QuestDB outperforms competitors
98-
on stronger hardware:
99-
100-
<Screenshot
101-
alt="A chart showing high-cardinality ingestion performance of InfluxDB, TimescaleDB, and QuestDB"
102-
src="images/pages/index/min-hardware-comp-graph.webp"
103-
width={550}
104-
title="QuestDB on an RPi5 outperforming competitors on optimal hardware"
105-
/>
106-
107-
Beyond performance and efficiency, with a specialized
108-
[time-series database](/glossary/time-series-database/), you don't need to worry
109-
about:
110-
111-
- out-of-order data
112-
- duplicates
113-
- exactly one semantics
114-
- frequency of ingestion
115-
- many other details you will find in demanding real-world scenarios
116-
117-
QuestDB provides simplified, hyper-fast data ingestion with tremendous
118-
efficiency and therefore value.
119-
120-
Write blazing-fast queries and create real-time
121-
[Grafana](/docs/third-party-tools/grafana/) via familiar SQL:
122-
123-
```questdb-sql title='Navigate time with SQL' demo
124-
SELECT
125-
timestamp, symbol,
126-
first(price) AS open,
127-
last(price) AS close,
128-
min(price),
129-
max(price),
130-
sum(amount) AS volume
131-
FROM trades
132-
WHERE timestamp > dateadd('d', -1, now())
133-
SAMPLE BY 15m;
134-
```
135-
136-
Intrigued? The best way to see whether QuestDB is right for you is to try it
137-
out.
138-
139-
Click _Demo this query_ in the snippet above to visit our demo instance and
140-
experiment.
141-
142-
To bring your own data and learn more, keep reading!
52+
<div className="not-prose">
53+
<DocButton href="/docs/ingestion-overview/" variant="text" arrow="right">
54+
<>Read the ingestion overview</>
55+
</DocButton>
56+
</div>
14357

14458
## QuestDB Enterprise
14559

14660
QuestDB Enterprise offers everything from open source, plus additional features
14761
for running QuestDB at greater scale or significance.
14862

149-
For a breakdown of Enterprise features, see the
150-
[QuestDB Enterprise](/enterprise/) page.
151-
152-
## Where to next? {#next-up}
153-
154-
You'll be inserting data and generating valuable queries in little time.
155-
156-
First, the [quick start](/docs/quick-start/) guide will get you running.
157-
158-
Choose from one of our premium ingest-only language clients:
159-
160-
- [C & C++](/docs/clients/ingest-c-and-cpp)
161-
- [.NET](/docs/clients/ingest-dotnet)
162-
- [Go](/docs/clients/ingest-go)
163-
- [Java](/docs/clients/java_ilp)
164-
- [Node.js](/docs/clients/ingest-node)
165-
- [Python](/docs/clients/ingest-python)
166-
- [Rust](/docs/clients/ingest-rust)
167-
168-
From there, you can learn more about what's to offer.
169-
170-
- [Ingestion overview](/docs/ingestion-overview/) want to see all available
171-
ingestion options? Checkout the overview.
172-
- [Query & SQL Overview](/docs/reference/sql/overview/) learn how to query
173-
QuestDB
174-
- [Web Console](/docs/web-console/) for quick SQL queries, charting and CSV
175-
upload/export functionality
176-
- [Grafana guide](/docs/third-party-tools/grafana/) to visualize your data as
177-
beautiful and functional charts.
178-
- [Capacity planning](/docs/deployment/capacity-planning/) to optimize your
179-
QuestDB deployment for production workloads.
180-
181-
## Support
63+
<div className="not-prose">
64+
<DocButton href="/enterprise/" variant="text" arrow="right">
65+
<>Learn more</>
66+
</DocButton>
67+
</div>
18268

183-
We are happy to help with any question you may have.
69+
## Guides
18470

185-
The team loves a good performance optimization challenge!
71+
<Guides />
18672

187-
Feel free to reach out using the following channels:
73+
## Resources
18874

189-
- [Raise an issue on GitHub](https://github.com/questdb/questdb/issues/new/choose)
190-
- [Join our community forums](https://community.questdb.io/)
191-
- [QuestDB on Stack Overflow](https://stackoverflow.com/questions/tagged/questdb)
192-
- or email us at [hello@questdb.io](mailto:hello@questdb.io)
75+
<Resources />

documentation/sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ module.exports = {
99
type: "doc",
1010
customProps: { tag: "Popular" },
1111
},
12+
{
13+
id: "why-questdb",
14+
type: "doc",
15+
customProps: { tag: "Popular" },
16+
},
1217
{
1318
id: "guides/influxdb-migration",
1419
type: "doc",

0 commit comments

Comments
 (0)