Skip to content

docs: stale-information audit applied to the repository Markdown - #47

Merged
singhpratech merged 1 commit into
mainfrom
docs/audit-fixes-0904
Sep 4, 2026
Merged

docs: stale-information audit applied to the repository Markdown#47
singhpratech merged 1 commit into
mainfrom
docs/audit-fixes-0904

Conversation

@singhpratech

Copy link
Copy Markdown
Owner

A stale-information audit over the repository's Markdown turned up 35 findings; 23 of them concern files in this repo and are applied here. The 12 about gh-pages (index.html, bench/index.html, sitemap.xml, status.json) and the one about pkg.go.dev are left to the session that owns the site and the release tags.

Almost all of them are the same shape: the 2026-09-03 batch added SingleStore, SAP HANA Express, Exasol, Altibase, Kinetica, Actian Ingres and IBM Db2 for i, and sentences written in the present tense before it never moved. Dated campaign records are untouched.

Counts reconciled to the source of truth

53 databases on Linux, 45 macOS, 48 Windows; 24 distinct drivers; 27 upstream reports across fifteen projects, three fixed by their maintainers plus unixODBC's mitigation.

  • README.md — the upstream bullet named three projects "so far"; it names the record now.
  • docs/community/faq.md — the database enumeration gained the seven; the upstream paragraph the other 24 reports.
  • docs/ROADMAP.md — "measured against all 46" → all 53 (261 of 265 Linux cells); SAP HANA dropped from the vendor-download help-wanted row (it is verified on all three OSes); the manifest and driver="odbc" by name scoped to Windows as well, since cmake --install writes it there.
  • bench/BENCHMARKS.md — psqlodbc drives fourteen PostgreSQL-wire databases, not eleven; the "eight drivers in the compat matrix" sentence put in the past tense it was written in.

Driver documentation caught up with src/odbc_driver.c

  • docs/reference/quirks.md — a row for each of altibase, libodbchdb, kinetica, iiodbcdriver, exaodbc and cwbodbc + DB2/400, listing the flags OdbcDetectQuirks actually sets and the reason from the same block's comment; iiodbcdriver added to the autodetected sqllen_32bit rule; glossary rows for wide_sql, ddl_timestamp_type_name, binary_param_as_varchar, null_decimal_param_as_char, zero_row_suffix and decimal_fixed_precision/decimal_fixed_scale.
  • prefer_param_arrays is set for four drivers today (MariaDB Connector/ODBC before 3.2, Vertica, Altibase, SAP HANA) — docs/languages/rust.md, docs/how-it-works/performance.md, and the glossary.
  • wchar_as_utf8 gained Altibase and Actian Ingres in docs/reference/types.md, which also gained bind rows for Exasol's two parameter quirks.
  • docs/languages/csharp.md no longer calls the Apache .NET binding "official"; nothing in the repo's prose does.

Static TLS table measured, not estimated

readelf -r <lib> | grep -c R_X86_64_TPOFF64 was run on all six new Linux driver libraries (SAP HANA client, Exasol, Altibase, Kinetica, Ingres, IBM i Access). All six report 0, so docs/TROUBLESHOOTING.md now has 24 rows and "exactly one has any" holds as stated. The affected library is shared by twelve matrix entries now, SingleStore included.

Benchmark statistics recomputed from the tables

  • bench/LANGUAGE_BENCHMARKS.md — recounted from the Results table: 47 databases have an ADBC fetch in all five languages (was 42), spreads ≤1.25× on 28 and ≤1.5× on 38; adbc-driver-jni is slowest on 20 of the 47, Python next at 10; 40 rows have an ingest number in all five, Python slowest on 13, Java 9, Rust 8.
  • bench/RUST_BENCHMARKS.md — the provenance sentence covers the seven rows taken 2026-09-04; the "four databases have no ADBC column" paragraph rewritten from the table as it stands: every row has an ADBC fetch, ten have no ADBC ingest, and the cratedb / spanner / duckdb gaps it described are closed.
  • bench/MATRIX_BENCHMARKS.md — no rows were lost (7a6a521 and main are byte-identical), so nothing was restored; a note now says which nine rows are the 2026-09-04 run and which twelve are from 2026-08. It sits in the prose tail the generator preserves, so a re-run keeps it.
  • bench/README.md — the matrix file is 21 databases, not 46; the macOS language file covers 44 of the 45 macOS-passing databases (Db2 for i not measured there).
  • bench/BENCHMARKS-windows.md — the status headline keeps its dated figures and gains the third measurement: 48 of 53 databases, 219 of 240 cells.
  • bench/LANGUAGE_BENCHMARKS-macos.md — 215 of 225 cells, with 191 kept as the count before the sixth batch.
  • bench/BENCHMARKS-macos.md — batch 2 is not "(in progress)"; it closes in its own section.

Docs only: no change under src/, tests/ or any package.

🤖 Generated with Claude Code

https://claude.ai/code/session_013ZWm8DfxFwdn7LyyVAM9s5

…stics brought up to the 2026-09-03 batch

The 2026-09-03 batch (SingleStore, SAP HANA Express, Exasol, Altibase,
Kinetica, Actian Ingres, IBM Db2 for i) left present-tense claims behind it
in the Markdown. This is the audit's confirmed in-repo findings, applied:

- Counts: 53 Linux / 45 macOS / 48 Windows, 24 distinct drivers, 27 upstream
  reports across fifteen projects (three fixed), twelve MySQL-wire entries
  through one Connector/ODBC, fourteen PostgreSQL-wire through psqlodbc.
- docs/reference/quirks.md: a row for each of the six new drivers with the
  flags OdbcDetectQuirks actually sets, iiodbcdriver added to the
  autodetected sqllen_32bit rule, and glossary entries for wide_sql,
  ddl_timestamp_type_name, binary_param_as_varchar, null_decimal_param_as_char,
  zero_row_suffix and decimal_fixed_precision/scale.
- docs/TROUBLESHOOTING.md: the six new Linux driver libraries measured with
  readelf -r ... R_X86_64_TPOFF64 (all zero), so the static-TLS table is now
  24 rows and "exactly one has any" still holds.
- prefer_param_arrays is four drivers now (MariaDB < 3.2, Vertica, Altibase,
  SAP HANA) and wchar_as_utf8 two more (Altibase, Ingres) — rust.md,
  performance.md, types.md.
- bench: LANGUAGE_BENCHMARKS.md statistics recomputed from the table as it
  stands (47 all-five fetch rows, 40 all-five ingest); RUST_BENCHMARKS.md
  provenance and the ten rows with no ADBC ingest rewritten from the table;
  MATRIX_BENCHMARKS.md says which rows are the 2026-09-04 run; the macOS,
  Windows and bench/README.md headline figures reconciled.
- No binding or project is called "official" any more (docs/languages/csharp.md).

Dated campaign sentences are left as history throughout.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013ZWm8DfxFwdn7LyyVAM9s5
@singhpratech
singhpratech merged commit 1fad208 into main Sep 4, 2026
4 checks passed
@singhpratech
singhpratech deleted the docs/audit-fixes-0904 branch September 4, 2026 19:57
singhpratech added a commit that referenced this pull request Sep 4, 2026
…nts, bench statistics, no "official"

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013ZWm8DfxFwdn7LyyVAM9s5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant