Skip to content

docs: publish the compatibility matrix as machine-readable data #146

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
singhpratech merged 2 commits into from
Sep 24, 2026
Merged

docs: publish the compatibility matrix as machine-readable data #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ff5709
docs: publish the compatibility matrix as machine-readable data
singhpratech Sep 24, 2026
6224267
Make the generator reproducible and dependency-free
singhpratech Sep 24, 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
9 changes: 9 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,15 @@ jobs:
# surface in the Release workflow's crate job, after the tag.
- name: Bundled C sources match src/
run: diff -rq src rust/csrc/src
# docs/compatibility.json is generated from docs/COMPATIBILITY.md and the harness's
# DBS dict. Regenerating it here means the published data cannot drift from the
# table, and the generator's own count assertion (53 / 45 / 48) fails the build if a
# row changes without the figures quoted in README.md and docs/index.md changing too.
- name: Generated compatibility data is current
run: |
python3 scripts/gen_compatibility_json.py
git diff --exit-code -- docs/compatibility.json \
|| { echo "docs/compatibility.json is stale: run scripts/gen_compatibility_json.py"; exit 1; }

# PostgreSQL through psqlodbc, on a real server: pins the temporal precision and
# zone mapping, the current-schema option, schema-level GetObjects and the array
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ Everything below except the benchmark index lives under [`docs/`](docs/index.md)
[Building from source and testing](docs/reference/building.md) ·
[Troubleshooting](docs/TROUBLESHOOTING.md)

**Project** — [Compatibility, 53 databases × 3 operating systems](docs/COMPATIBILITY.md) ·
**Project** — [Compatibility, 53 databases × 3 operating systems](docs/COMPATIBILITY.md) ([as JSON](docs/compatibility.json)) ·
[Benchmarks, by OS](bench/README.md) · [Upstream](docs/UPSTREAM.md) ·
[Roadmap](docs/ROADMAP.md) · [FAQ](docs/community/faq.md) ·
[Contributing](docs/community/contributing.md) ·
Expand Down
5 changes: 5 additions & 0 deletions docs/COMPATIBILITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,11 @@ not gaps in the driver, and are recorded as such. `pending` and `not run` mean n
Details and the machine descriptions: [`bench/BENCHMARKS-macos.md`](../bench/BENCHMARKS-macos.md),
[`bench/BENCHMARKS-windows.md`](../bench/BENCHMARKS-windows.md).

The same results, with the quirks each entry needs, are published as machine-readable
data in [`compatibility.json`](compatibility.json) — generated from this table and from
the harness in `tests/compat/test_matrix.py` by `scripts/gen_compatibility_json.py`, and
checked in CI, so it cannot drift from what is written here.

| entry | Linux | macOS arm64 | Windows x64 |
|---|---|---|---|
| sqlite | PASS | PASS (SQLite 3.51.0) | PASS (SQLite 3.43.2, SQLite3 ODBC Driver) |
Expand Down
Loading
Loading