Skip to content

Fix architecture pages typos and inconsistencies #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions documentation/guides/architecture/memory-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,3 @@ QuestDB leverages both memory mapping and explicit memory management techniques,
- Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
- [QuestDB GitHub Repository](https://github.com/questdb/questdb)
- [QuestDB Documentation](/docs)



4 changes: 1 addition & 3 deletions documentation/guides/architecture/networking-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ might be incompatible if they rely heavily on PostgreSQL metadata, as QuestDB im
overview of some key differences on QuestDB schema design, please visit our
[Schema Design Essentials](/docs/guides/schema-design-essentials/) guide.

The default port number for the pg-wire interface is `8812`.
The default port number for the PGWire interface is `8812`.

### HTTP Rest API

Expand All @@ -50,5 +50,3 @@ The default port number for the minimal HTTP server is `9003`.
- Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
- [QuestDB GitHub Repository](https://github.com/questdb/questdb)
- [QuestDB Documentation](/docs)


1 change: 0 additions & 1 deletion documentation/guides/architecture/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,3 @@ QuestDB provides real-time metrics, a health check endpoint, and logging to moni
- Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
- [QuestDB GitHub Repository](https://github.com/questdb/questdb)
- [QuestDB Documentation](/docs)

4 changes: 1 addition & 3 deletions documentation/guides/architecture/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ QuestDB is comprised of several key components:
QuestDB is specifically designed for time-series, and it provides several optimizations, such as a designated timestamp, sequential reads, materialized views, and in-memory processing.

- **[Data ingestion engine](/docs/guides/architecture/data-ingestion):**
TSupports both bulk and streaming ingestion. It writes data to a row-based write-ahead
Supports both bulk and streaming ingestion. It writes data to a row-based write-ahead
log (WAL) and then converts it into a columnar format. In QuestDB Enterprise, the WAL segments
are shipped to object storage for replication.

Expand All @@ -56,8 +56,6 @@ QuestDB is comprised of several key components:
The engine includes a web console for running SQL statements, bulk loading CSV files, and displaying monitoring dashboards. QuestDB Enterprise supports single sign-on (SSO) in the web console.




## Design patterns & best practices throughout the codebase

- **Immutable data structures:**
Expand Down
2 changes: 1 addition & 1 deletion documentation/guides/architecture/query-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ to process data in table page frames for better CPU use.
/>

- **JIT compilation and Vectorized processing:**
Queries with a `WHERE` clause [compile](/docs/concept/jit-compiler) critical parts of the execution plan to native machine code (SIMD AVX-2 instructions) just in time. Vectorised instructions apply
Queries with a `WHERE` clause [compile](/docs/concept/jit-compiler) critical parts of the execution plan to native machine code (SIMD AVX-2 instructions) just in time. Vectorized instructions apply
the same operation to many data elements simultaneously. This maximizes CPU cache use and reduces overhead.

- **Multi-threaded execution:**
Expand Down
3 changes: 1 addition & 2 deletions documentation/guides/architecture/replication-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ primary to replicate changes to the object store, even if there are no read repl
could be used for point-in-time recovery.

For demanding scenarios, QuestDB Enterprise allows [multi-primary ingestion](/docs/operations/multi-primary-ingestion/),
which allows both increasing the write throughput, and enabling high availabilty. In order to enable multi-primary ingestion,
which allows both increasing the write throughput, and enabling high availability. In order to enable multi-primary ingestion,
a `Distributed Sequencer` instance will need to be created.


Expand Down Expand Up @@ -57,4 +57,3 @@ across primaries.
- Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
- [QuestDB GitHub Repository](https://github.com/questdb/questdb)
- [QuestDB Documentation](/docs)

4 changes: 2 additions & 2 deletions documentation/guides/architecture/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ description: QuestDB implements enterprise-grade security with TLS, single-sign-
fine-grained granularity.

- **Built-in admin and read-only users:**
QuestDB includes built-in admin and read-only users for the pgwire protocol and HTTP endpoints using HTTP Basic Auth.
QuestDB includes built-in admin and read-only users for the PGWire protocol and HTTP endpoints using HTTP Basic Auth.

- **HTTP basic authentication:**
You can enable HTTP Basic Authentication for the HTTP API, web console, and pgwire
You can enable HTTP Basic Authentication for the HTTP API, web console, and PGWire
protocol. Health-check and metrics endpoints can be configured independently.

- **Token-based authentication:**
Expand Down
2 changes: 1 addition & 1 deletion documentation/guides/architecture/storage-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ concurrent data ingestion, modifications, and schema changes without locking the
appears consistent to all readers, even during ongoing write operations.


- **TableWriter**: Changes stored in the WAL are stored in columnar format by the TableWriter. The TableWriter
- **TableWriter**: Changes in the WAL are stored in columnar format by the TableWriter. The TableWriter
also handles and resolves out-of-order data writes, and enables deduplication. Column files use an
[append model](/docs/concept/storage-model/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ sequential reads, materialized-views, or in-memory processing.

- QuestDB supports materialized views for `SAMPLE BY` queries, including those joining with other tables.

- Materialized sampled intervals are automatically refreshed whenever the base table receivews new or updated rows.
- Materialized sampled intervals are automatically refreshed whenever the base table receives new or updated rows.

- Materialized views can be chained, with the output of one being the input of another one, and support TTLs for lifecycle management.

Expand Down Expand Up @@ -107,12 +107,10 @@ Varchar data (column file):
+---+---+---+---+---+---+---+---+---+---+---+
| H | e | l | l | o | | w | o | r | l | d |
+---+---+---+---+---+---+---+---+---+---+---+

```

## Next Steps

- Back to the [QuestDB Architecture](/docs/guides/architecture/questdb-architecture) overview
- [QuestDB GitHub Repository](https://github.com/questdb/questdb)
- [QuestDB Documentation](/docs)