dolthub / dolthub/docs-2

Doltgres: document the procedures that ship via dprocedures.DoltProcedures but aren't on the functions page

Open
#65 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
2
Forks
1
Avg merge
4h 41m
Merged PRs (30d)
40

Description

Doltgres re-uses dolt's `DoltProcedures` slice — see [`server/functions/dolt_procedures.go`](https://github.com/dolthub/doltgresql/blob/main/server/functions/dolt_procedures.go) — so it ships every procedure dolt has as a callable function. But the doltgres docs at [`reference/sql/version-control/dolt-sql-functions.md`](https://github.com/dolthub/docs-2/blob/main/site/doltgres/src/content/reference/sql/version-control/dolt-sql-functions.md) only cover 22 of the ~37 available.

Missing from doltgres docs:

- `dolt_count_commits`
- `dolt_rm`
- `dolt_stash`
- `dolt_stats_flush`, `dolt_stats_gc`, `dolt_stats_info`, `dolt_stats_once`, `dolt_stats_purge`, `dolt_stats_restart`, `dolt_stats_stop`, `dolt_stats_wait`, `dolt_stats_timers`
- `dolt_thread_dump`
- `dolt_update_column_tag`

(`dolt_commit_hash_out` is in flight as part of #58 — track separately.)

Most of these can be ported with light adaptation from the dolt-sql-procedures page since the implementation is the same; the doltgres calling convention is `SELECT … FROM` instead of `CALL`. Add the resulting anchors to `site/doltgres/src/content/reference/sql/version-control/sql-extensions.md` once each is documented.

Surfaced during the source-vs-docs cross-check for #43 (see #64).

Contributor guide

Open the contributing guide

Research direction

Start with server/functions/dolt_procedures.go and compare the listed procedures with the existing dolt-sql-procedures documentation. Document each missing procedure using the Doltgres SELECT … FROM calling convention, then add the resulting anchors to site/doltgres/src/content/reference/sql/version-control/sql-extensions.md; completion means all listed procedures are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
databases, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.