Skip to content

publish branch activity doc updates #2723

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
macneale4 merged 2 commits into from
Nov 19, 2025
Merged

publish branch activity doc updates #2723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d19961
branch activity tracking docs
macneale4 Nov 19, 2025
13d16cc
Merge pull request #2722 from dolthub/macneale4/branch-activity-tracking
macneale4 Nov 19, 2025
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
15 changes: 15 additions & 0 deletions packages/dolt/content/reference/sql/server/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,21 @@ behavior: { auto_gc_behavior: { enable: true, archive_level: 1 } }
% dolt sql-server --config config.yaml
```

### `branch_activity_tracking`

**Default**: false

**Values**: true, false, null

This flag is used to enable the `dolt_branch_activity` [system table](https://docs.dolthub.com/sql-reference/version-control/dolt-system-tables#dolt_branch_activity). This feature can impact performance on high-throughput servers, so it is disabled by default.

**Example**:
```sh
% cat config.yaml
behavior: { branch_activity_tracking: true } }
% dolt sql-server --config config.yaml
```

## `listener`

The listener section of `config.yaml` is configuration for the SQL server transport layer.
Expand Down
3 changes: 3 additions & 0 deletions packages/dolt/content/reference/sql/version-control/dolt-system-tables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,9 @@ Get all the tags.

## `dolt_branch_activity`
`dolt_branch_activity` provides insights into branch usage within the lifetime of a running `dolt sql-server`. This table helps administrators identify stale or unused branches. The data is global to the server, and it not related to the persisted data in the database. For the reason, the `system_start_time` column will always be the start time of your server, and the `last_read` and `last_write` columns should be considered in relation to that time. Activity for branches which have been deleted will not be included in this table.

For performance reasons, this table is only available if you opt-in to enable it. See [server configuration](https://docs.dolthub.com/sql-reference/server/configuration#branch_activity_tracking) for details.

### Schema

```text
Expand Down