Skip to content

update docs for git remote history configuration #232

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
coffeegoddd merged 18 commits into from
Oct 5, 2026
Merged

update docs for git remote history configuration #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
b9de732
chore(deps-dev): Bump @types/node from 26.4.0 to 26.6.3
dependabot[bot] Oct 1, 2026
6e96146
chore(deps): Bump autoprefixer from 10.5.4 to 10.6.1
dependabot[bot] Oct 1, 2026
e1a4214
chore(deps): Bump postcss from 8.5.26 to 8.5.28
dependabot[bot] Oct 1, 2026
90ad723
chore(deps): Bump @astrojs/markdown-remark from 7.2.4 to 7.3.1
dependabot[bot] Oct 1, 2026
a2cd816
/site/dolt/src/content/reference: add section on history configuration
coffeegoddd Oct 1, 2026
42242cb
Merge pull request #227 from dolthub/dependabot/npm_and_yarn/postcss-…
tbantle22 Oct 1, 2026
99bbac1
Merge pull request #221 from dolthub/dependabot/npm_and_yarn/types/no…
tbantle22 Oct 1, 2026
5797d25
Merge pull request #223 from dolthub/dependabot/npm_and_yarn/autopref…
tbantle22 Oct 1, 2026
81bc029
chore(deps): Bump devalue from 5.9.2 to 5.9.4
dependabot[bot] Oct 1, 2026
632ce2c
Merge pull request #228 from dolthub/dependabot/npm_and_yarn/astrojs/…
tbantle22 Oct 1, 2026
e5cc564
chore(deps): Bump astro from 7.2.9 to 7.3.5
dependabot[bot] Oct 1, 2026
b9b5965
chore(deps): Bump @astrojs/react from 6.0.4 to 7.0.0
dependabot[bot] Oct 1, 2026
fd85ae1
Merge pull request #230 from dolthub/db/history-configuration
coffeegoddd Oct 1, 2026
2290021
Merge pull request #231 from dolthub/dependabot/npm_and_yarn/devalue-…
tbantle22 Oct 1, 2026
f1c43ea
Merge pull request #222 from dolthub/dependabot/npm_and_yarn/astro-7.3.5
tbantle22 Oct 1, 2026
d86a823
Merge pull request #229 from dolthub/dependabot/npm_and_yarn/astrojs/…
tbantle22 Oct 1, 2026
95809b0
[ga-update-docs] Update benchmarks for Dolt v2.4.1
coffeegoddd Oct 5, 2026
1524e2b
Merge pull request #233 from dolthub/coffeegoddd-2.4.1
coffeegoddd Oct 5, 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
1,544 changes: 1,019 additions & 525 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"compile": "tsc --noEmit"
},
"devDependencies": {
"@types/node": "^26.4.0",
"@types/node": "^26.6.3",
"cypress": "^15.21.1",
"remark-heading-id": "^1.0.1",
"typescript": "^5.0.0"
Expand Down
10 changes: 5 additions & 5 deletions site/dolt/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
"generate-hosted-api-v1": "node ../../scripts/generate-hosted-api-v1.mjs"
},
"dependencies": {
"@astrojs/markdown-remark": "^7.2.4",
"@astrojs/react": "^6.0.4",
"@astrojs/markdown-remark": "^7.3.1",
"@astrojs/react": "^7.0.0",
"@dolthub/react-components": "^0.4.3",
"@dolthub/react-hooks": "^0.3.1",
"astro": "^7.2.9",
"autoprefixer": "^10.5.4",
"astro": "^7.3.5",
"autoprefixer": "^10.6.1",
"github-markdown-css": "^5.0.0",
"pagefind": "^1.5.2",
"postcss": "^8.5.3",
"postcss": "^8.5.28",
"react": "^19.2.8",
"react-dom": "^19.2.8",
"react-icons": "^5.7.0",
Expand Down
4 changes: 4 additions & 0 deletions site/dolt/src/content/reference/cli/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,10 @@ Valid configuration variables:

- push.autoSetupRemote - if set to "true" assume --set-upstream on default push when no upstream tracking exists for the current branch.

- git-remote.max-history-commits - maximum reachable Git data commits (default 64). Accepts a non-negative integer; 0 means unlimited.

- git-remote.reset-history-on-prune - reset Git history when obsolete storage entries are removed (default true). Accepts exactly "true" or "false".

Credential helpers use the Bazel credential helper protocol. Dolt invokes the configured executable with the `get` argument and sends the canonical remotesapi origin on stdin:

{"uri":"https://example.com:443"}
Expand Down
10 changes: 5 additions & 5 deletions site/dolt/src/content/reference/sql/benchmarks/correctness.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,18 +55,18 @@ AND col3 IN (3,9,0))))) OR col4 <= 4.25 OR ((col3 = 5))) OR (((col0 >
0)) AND col0 > 6 AND (col4 >= 6.56)))
```

Here are Dolt's sqllogictest results for version `2.4.0`. Tests that
Here are Dolt's sqllogictest results for version `2.4.1`. Tests that
did not run could not complete due to a timeout earlier in the run.
<!-- START___DOLT___CORRECTNESS_RESULTS_TABLE -->
| Results | Count |
|:-------:|:-------:|
| ok | 5937471 |
|:--------|:--------|
| ok | 5937471 |

| Total Tests | 5937471 |
|:-----------:|:-------:|
|:------------|:--------|

| Correctness Percentage | 100.0 |
|:----------------------:|:-----:|
|:-----------------------|:------|
<!-- END___DOLT___CORRECTNESS_RESULTS_TABLE -->
<br/>

Expand Down
56 changes: 28 additions & 28 deletions site/dolt/src/content/reference/sql/benchmarks/latency.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,41 +33,41 @@ attempt to run as many queries as possible in a fixed 2 minute time
window. The `Dolt` and `MySQL` columns show the median latency in
milliseconds (ms) of each query during that 2 minute time window.

The Dolt version is `2.4.0`.
The Dolt version is `2.4.1`.

<!-- START___DOLT___LATENCY_RESULTS_TABLE -->
| Read Tests | MySQL | Dolt | Multiple |
|:-----------------------:|:------:|:------:|:--------:|
| covering\_index\_scan | 16.71 | 2.35 | 0.14 |
| groupby\_scan | 134.9 | 64.47 | 0.48 |
| index\_join | 3.36 | 1.96 | 0.58 |
| index\_join\_scan | 4.25 | 1.37 | 0.32 |
| index\_scan | 344.08 | 200.47 | 0.58 |
| oltp\_point\_select | 0.19 | 0.26 | 1.37 |
| oltp\_read\_only | 3.68 | 5.09 | 1.38 |
| select\_random\_points | 0.36 | 0.52 | 1.44 |
| select\_random\_ranges | 0.39 | 0.67 | 1.72 |
| table\_scan | 344.08 | 204.11 | 0.59 |
| types\_table\_scan | 759.88 | 458.96 | 0.6 |
| reads\_mean\_multiplier | | | 0.84 |
|:------------------------|:-------|:-------|:---------|
| covering\_index\_scan | 18.61 | 2.35 | 0.13 |
| groupby\_scan | 134.9 | 74.46 | 0.55 |
| index\_join | 3.49 | 1.93 | 0.55 |
| index\_join\_scan | 4.25 | 1.34 | 0.32 |
| index\_scan | 356.7 | 200.47 | 0.56 |
| oltp\_point\_select | 0.19 | 0.26 | 1.37 |
| oltp\_read\_only | 3.68 | 5.0 | 1.36 |
| select\_random\_points | 0.36 | 0.52 | 1.44 |
| select\_random\_ranges | 0.39 | 0.65 | 1.67 |
| table\_scan | 356.7 | 200.47 | 0.56 |
| types\_table\_scan | 759.88 | 458.96 | 0.6 |
| reads\_mean\_multiplier | | | 0.83 |

| Write Tests | MySQL | Dolt | Multiple |
|:------------------------:|:-----:|:-----:|:--------:|
| oltp\_delete\_insert | 8.28 | 6.21 | 0.75 |
| oltp\_insert | 4.18 | 3.19 | 0.76 |
| oltp\_read\_write | 9.06 | 11.45 | 1.26 |
| oltp\_update\_index | 4.41 | 3.36 | 0.76 |
| oltp\_update\_non\_index | 4.18 | 3.07 | 0.73 |
| oltp\_write\_only | 5.18 | 6.32 | 1.22 |
| types\_delete\_insert | 8.58 | 6.79 | 0.79 |
| writes\_mean\_multiplier | | | 0.9 |
|:-------------------------|:------|:------|:---------|
| oltp\_delete\_insert | 7.7 | 6.21 | 0.81 |
| oltp\_insert | 4.1 | 3.19 | 0.78 |
| oltp\_read\_write | 8.9 | 11.24 | 1.26 |
| oltp\_update\_index | 4.33 | 3.36 | 0.78 |
| oltp\_update\_non\_index | 4.1 | 3.07 | 0.75 |
| oltp\_write\_only | 5.18 | 6.32 | 1.22 |
| types\_delete\_insert | 8.43 | 6.79 | 0.81 |
| writes\_mean\_multiplier | | | 0.92 |

| TPC-C TPS Tests | MySQL | Dolt | Multiple |
|:---------------------:|:-----:|:-----:|:--------:|
| tpcc-scale-factor-1 | 96.45 | 53.18 | 1.81 |
| tpcc\_tps\_multiplier | | | 1.81 |
|:----------------------|:------|:------|:---------|
| tpcc-scale-factor-1 | 97.33 | 53.48 | 1.82 |
| tpcc\_tps\_multiplier | | | 1.82 |

| Overall Mean Multiple | 1.18 |
|:---------------------:|:----:|
| Overall Mean Multiple | 1.19 |
|:----------------------|:-----|
<!-- END___DOLT___LATENCY_RESULTS_TABLE -->
<br/>
50 changes: 50 additions & 0 deletions site/dolt/src/content/reference/sql/version-control/remotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,56 @@ dolt clone ../remote.git
dolt clone --ref refs/dolt/custom git@github.com:org/repo.git repo2
```

#### History configuration

Git remotes retain earlier Git data commits to help Git compute incremental transfers. Longer histories can improve transfer performance but keep obsolete storage objects reachable for longer. These settings control the history of the backing Git data ref (by default `refs/dolt/data`), not the database's Dolt commit history.

| Setting | Default | Accepted values and behavior |
| --- | --- | --- |
| `git-remote.max-history-commits` | `64` | A non-negative integer. When the existing history reaches this limit, the next write starts a new parentless Git commit. This resets the chain rather than keeping a sliding window. `0` disables the length limit. |
| `git-remote.reset-history-on-prune` | `true` | Exactly `true` or `false`. When `true`, removing obsolete storage entries also starts a parentless Git commit. When `false`, the parent history is retained subject to the length limit. |

Resetting Git history allows Git garbage collection to reclaim objects that are no longer reachable. It does not guarantee immediate disk reclamation. Disabling prune-triggered resets still removes obsolete entries from the current Git tree, but earlier commits keep their objects reachable.

Configure these settings with [`dolt config`](/cli-reference/cli#dolt-config). For example, increase the default history limit for all local repositories:

```bash
dolt config --global --set git-remote.max-history-commits 256
```

For unlimited retention, set **both** options in the local Dolt repository:

```bash
dolt config --local --set git-remote.max-history-commits 0
dolt config --local --set git-remote.reset-history-on-prune false
```

Setting only the length limit to `0` still allows history resets when pruning is enabled.

Settings are resolved in this order, from highest to lowest priority:

1. Environment variables.
2. The initiating Dolt repository's local configuration.
3. Global configuration.
4. Built-in defaults.

| Environment variable | Overrides |
| --- | --- |
| `DOLT_GIT_REMOTE_MAX_HISTORY_COMMITS` | `git-remote.max-history-commits` |
| `DOLT_GIT_REMOTE_RESET_HISTORY_ON_PRUNE` | `git-remote.reset-history-on-prune` |

For example, override both settings for one push:

```bash
DOLT_GIT_REMOTE_MAX_HISTORY_COMMITS=256 \
DOLT_GIT_REMOTE_RESET_HISTORY_ON_PRUNE=false \
dolt push origin main
```

Invalid values, including negative history limits and boolean values other than `true` or `false`, return an error when opening the Git remote. Empty environment values are invalid; unset an override to use configuration-file values again.

These settings are supplied by the process accessing the remote. Since writes update the shared Git data-ref history, coordinate settings among writers to the same remote. For SQL operations, configure the server's environment or the relevant Dolt repository/global config; these are not SQL system variables or `config.yaml` fields. An already-open remote store retains its settings, so restart a running SQL server after changing them.

#### SQL examples

From SQL (e.g. `dolt sql` / `sql-server`), pass `--ref` as an argument to `dolt_remote()` / `dolt_clone()` when needed:
Expand Down
10 changes: 5 additions & 5 deletions site/doltgres/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
"preview": "astro preview --port 4323"
},
"dependencies": {
"@astrojs/markdown-remark": "^7.2.4",
"@astrojs/react": "^6.0.4",
"@astrojs/markdown-remark": "^7.3.1",
"@astrojs/react": "^7.0.0",
"@dolthub/react-components": "^0.4.3",
"@dolthub/react-hooks": "^0.3.1",
"astro": "^7.2.9",
"autoprefixer": "^10.5.4",
"astro": "^7.3.5",
"autoprefixer": "^10.6.1",
"github-markdown-css": "^5.0.0",
"pagefind": "^1.5.2",
"postcss": "^8.5.3",
"postcss": "^8.5.28",
"react": "^19.2.8",
"react-dom": "^19.2.8",
"react-icons": "^5.7.0",
Expand Down
10 changes: 5 additions & 5 deletions site/doltlab/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
"preview": "astro preview --port 4322"
},
"dependencies": {
"@astrojs/markdown-remark": "^7.2.4",
"@astrojs/react": "^6.0.4",
"@astrojs/markdown-remark": "^7.3.1",
"@astrojs/react": "^7.0.0",
"@dolthub/react-components": "^0.4.3",
"@dolthub/react-hooks": "^0.3.1",
"astro": "^7.2.9",
"autoprefixer": "^10.5.4",
"astro": "^7.3.5",
"autoprefixer": "^10.6.1",
"github-markdown-css": "^5.0.0",
"pagefind": "^1.5.2",
"postcss": "^8.5.3",
"postcss": "^8.5.28",
"react": "^19.2.8",
"react-dom": "^19.2.8",
"react-icons": "^5.7.0",
Expand Down
Loading