Skip to content

Document seven undocumented dolt system variables#76

Open
tbantle22 wants to merge 1 commit into
devfrom
document-dolt-sysvars
Open

Document seven undocumented dolt system variables#76
tbantle22 wants to merge 1 commit into
devfrom
document-dolt-sysvars

Conversation

@tbantle22
Copy link
Copy Markdown
Collaborator

Closes #67.

Documents the seven system variables flagged in the cross-check, with scope / default / accepted values sourced from sqle/system_variables.go and sqle/cluster/controller.go.

General system setting variables:

Variable Scope / default What it does
dolt_allow_ci_creation session bool, 0 Gate creation of Dolt CI workflow (dolt_ci_*) tables
dolt_auto_gc_enabled global bool, 1, read at startup Background garbage collection
dolt_optimize_json both bool, 1 Store JSON in Dolt's optimized, diff/merge-able format
dolt_transactions_disabled session bool, 0 Disable the transaction layer (special-purpose tooling)

Replication (cluster) variables — only present when cluster replication is configured:

Variable Scope / default What it does
dolt_cluster_role persist string primary / standby; change via dolt_assume_cluster_role()
dolt_cluster_role_epoch persist int Monotonic epoch tracking role transitions
dolt_cluster_ack_writes_timeout_secs persist int 0–60, 0 Seconds a primary waits for a standby to ack a write

Added matching TOC entries (alphabetical, in the General and Replication groups) and rows in the SQL extensions index. The cluster-role sections cross-link to the existing Replication Role and Epoch section.

Verified astro build is clean and all seven anchors render, plus the #replication-role-and-epoch, #dolt_gc, and /products/dolthub/continuous-integration cross-link targets exist (no dead links).

🤖 Generated with Claude Code

Closes #67. Each section's scope/default/values come from the dolt
source (sqle/system_variables.go, sqle/cluster/controller.go).

General system setting variables:
  - dolt_allow_ci_creation        (session bool, default 0) — gate Dolt CI workflow creation
  - dolt_auto_gc_enabled          (global bool, default 1, startup-only) — background GC
  - dolt_optimize_json            (both bool, default 1) — optimized/diffable JSON storage
  - dolt_transactions_disabled    (session bool, default 0) — disable the txn layer

Replication (cluster) variables:
  - dolt_cluster_role             (persist string) — primary/standby; set via dolt_assume_cluster_role()
  - dolt_cluster_role_epoch       (persist int) — role-transition epoch
  - dolt_cluster_ack_writes_timeout_secs (persist int 0-60, default 0) — primary->standby ack wait

Added matching TOC entries (alphabetical) and rows in the SQL
extensions index. Cluster-role sections cross-link to the existing
"Replication Role and Epoch" section; verified all anchors and
cross-link targets resolve in a build.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.

Document undocumented dolt system variables

1 participant