Follow-up from the source-vs-docs cross-check (#64). The statistics surface is only partially documented, and what exists is scattered.
Current state
- ✅ The
dolt_statistics system table is documented in dolt-system-tables.md (it's the only stats table).
- ✅ Eight
dolt_stats_* procedures (flush, gc, info, once, purge, restart, stop, wait) are documented in dolt-sql-procedures.md.
- 🟠 Stats system variables are only mentioned in passing in
sql-support/miscellaneous.md — no per-variable sections in dolt-sysvars.md, and at least one name there is stale.
Gaps to close
1. Stats system variables → proper sections in dolt-sysvars.md. These are registered in dsess/variables.go / sqle/system_variables.go but have no entry in dolt-sysvars.md:
dolt_stats_enableddolt_stats_pauseddolt_stats_memory_onlydolt_stats_branchesdolt_stats_job_intervaldolt_stats_gc_enableddolt_stats_gc_interval
Each needs the standard section (description, scope, default, accepted values). A "Statistics variables" subsection in dolt-sysvars.md probably makes sense, with the index (sql-extensions.md) updated to point at the new anchors instead of the current miscellaneous.md ones.
2. dolt_stats_timers procedure is registered in dprocedures/init.go but undocumented — add it to dolt-sql-procedures.md (or confirm it's internal-only and intentionally omit, as we did with dolt_storage_format).
3. Stale reference: miscellaneous.md mentions dolt_stats_auto_refresh_enabled as the "up to 1.50.x" name. Once the variables are documented properly, reconcile/clean up that section so it points at the canonical docs rather than restating settings inline.
Out of scope / tracked elsewhere
Surfaced during the cross-check for #43 (see #64).
Follow-up from the source-vs-docs cross-check (#64). The statistics surface is only partially documented, and what exists is scattered.
Current state
dolt_statisticssystem table is documented indolt-system-tables.md(it's the only stats table).dolt_stats_*procedures (flush,gc,info,once,purge,restart,stop,wait) are documented indolt-sql-procedures.md.sql-support/miscellaneous.md— no per-variable sections indolt-sysvars.md, and at least one name there is stale.Gaps to close
1. Stats system variables → proper sections in
dolt-sysvars.md. These are registered indsess/variables.go/sqle/system_variables.gobut have no entry indolt-sysvars.md:dolt_stats_enableddolt_stats_pauseddolt_stats_memory_onlydolt_stats_branchesdolt_stats_job_intervaldolt_stats_gc_enableddolt_stats_gc_intervalEach needs the standard section (description, scope, default, accepted values). A "Statistics variables" subsection in
dolt-sysvars.mdprobably makes sense, with the index (sql-extensions.md) updated to point at the new anchors instead of the currentmiscellaneous.mdones.2.
dolt_stats_timersprocedure is registered indprocedures/init.gobut undocumented — add it todolt-sql-procedures.md(or confirm it's internal-only and intentionally omit, as we did withdolt_storage_format).3. Stale reference:
miscellaneous.mdmentionsdolt_stats_auto_refresh_enabledas the "up to 1.50.x" name. Once the variables are documented properly, reconcile/clean up that section so it points at the canonical docs rather than restating settings inline.Out of scope / tracked elsewhere
dolt_stats_*functions (all 9) are tracked in Doltgres: document the procedures that ship via dprocedures.DoltProcedures but aren't on the functions page #65 (deliberately skipped there for now).Surfaced during the cross-check for #43 (see #64).