Skip to content

Revise ColdFront architecture diagram in README #107

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.

Sign up for GitHub

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
susan-pgedge merged 3 commits into from
Oct 8, 2026
Merged

Revise ColdFront architecture diagram in README #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3cb46b7
Revise ColdFront architecture diagram in README
zaidshabbir25 Oct 7, 2026
ea4cc92
Update architecture diagram in index.md
zaidshabbir25 Oct 8, 2026
a28c70a
fix: close the left box in the architecture diagram, fix spacing
Oct 8, 2026
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
54 changes: 33 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,27 +66,39 @@ ColdFront runs inside PostgreSQL and rewrites each statement to the correct
tier, so the application sees one relation:

```text
Application
│
SELECT / INSERT / UPDATE / DELETE
against one relation: "events"
│
PostgreSQL 16 / 17 / 18
events VIEW: reads union hot + cold
coldfront extension: routes writes by tier
┌─────────────┴───────────────┐
│ │
hot tier cold tier
_events: native PostgreSQL pg_duckdb: in-process DuckDB
range partitions Iceberg reads + writes
│ │
│ Lakekeeper (Iceberg REST catalog)
│ │
│ object store, S3 / Azure / GCS
│ (Parquet data + Iceberg metadata)
│ ▲
└──── Archiver (Go, cron) ────┘
moves partitions past the hot window: hot → cold
Application
│
SELECT / INSERT / UPDATE / DELETE
on one relation: "events"
│
┌────────────────────────────▼─────────────────────────────┐
│ PostgreSQL 16 / 17 / 18 │
│ │
│ events view: reads return hot + cold rows │
│ coldfront extension: routes writes by tier. │
└───────────┬─────────────────────────────────┬────────────┘
│ │
HOT TIER COLD TIER
recent rows, local disk older rows, object storage
│ │
┌──────────▼───────────┐ ┌────────────▼────────────┐
│ _events │ │ pg_duckdb │
│ native PostgreSQL │ │ in-process DuckDB │
│ range partitions │ │ Iceberg reads + writes │
└──────────┬───────────┘ └────────────┬────────────┘
│ │
│ ┌───────────▼─────────────┐
│ │ Lakekeeper │
│ │ Iceberg REST catalog │
│ └───────────┬─────────────┘
│ │
│ │
│ ┌───────────▼─────────────────────┐
│ │ Object store, S3 / Azure / GCS │
│ │ │
└── Archiver (Go) ───▶│(Parquet data + Iceberg metadata)│
└─────────────────────────────────┘
cron job: moves partitions out of the hot window: hot -> cold
```

## Installation
Expand Down
54 changes: 33 additions & 21 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,27 +40,39 @@ ColdFront runs inside PostgreSQL and rewrites each statement to the correct
tier, so the application sees one relation:

```text
Application
│
SELECT / INSERT / UPDATE / DELETE
against one relation: "events"
│
PostgreSQL 16 / 17 / 18
events VIEW: reads union hot + cold
coldfront extension: routes writes by tier
┌─────────────┴───────────────┐
│ │
hot tier cold tier
_events: native PostgreSQL pg_duckdb: in-process DuckDB
range partitions Iceberg reads + writes
│ │
│ Lakekeeper (Iceberg REST catalog)
│ │
│ object store, S3 / Azure / GCS
│ (Parquet data + Iceberg metadata)
│ ▲
└──── Archiver (Go, cron) ────┘
moves partitions past the hot window: hot → cold
Application
│
SELECT / INSERT / UPDATE / DELETE
on one relation: "events"
│
┌────────────────────────────▼─────────────────────────────┐
│ PostgreSQL 16 / 17 / 18 │
│ │
│ events view: reads return hot + cold rows │
│ coldfront extension: routes writes by tier. │
└───────────┬─────────────────────────────────┬────────────┘
│ │
HOT TIER COLD TIER
recent rows, local disk older rows, object storage
│ │
┌──────────▼───────────┐ ┌────────────▼────────────┐
│ _events │ │ pg_duckdb │
│ native PostgreSQL │ │ in-process DuckDB │
│ range partitions │ │ Iceberg reads + writes │
└──────────┬───────────┘ └────────────┬────────────┘
│ │
│ ┌───────────▼─────────────┐
│ │ Lakekeeper │
│ │ Iceberg REST catalog │
│ └───────────┬─────────────┘
│ │
│ │
│ ┌───────────▼─────────────────────┐
│ │ Object store, S3 / Azure / GCS │
│ │ │
└── Archiver (Go) ───▶│(Parquet data + Iceberg metadata)│
└─────────────────────────────────┘
cron job: moves partitions out of the hot window: hot -> cold
```

## Quickstart
Expand Down
Loading