Skip to content

Commit 13d16cc

Browse files
authored
Merge pull request #2722 from dolthub/macneale4/branch-activity-tracking
branch activity tracking docs
2 parents ad2e2f7 + 5d19961 commit 13d16cc

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

packages/dolt/content/reference/sql/server/configuration.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -651,6 +651,21 @@ behavior: { auto_gc_behavior: { enable: true, archive_level: 1 } }
651651
% dolt sql-server --config config.yaml
652652
```
653653
654+
### `branch_activity_tracking`
655+
656+
**Default**: false
657+
658+
**Values**: true, false, null
659+
660+
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.
661+
662+
**Example**:
663+
```sh
664+
% cat config.yaml
665+
behavior: { branch_activity_tracking: true } }
666+
% dolt sql-server --config config.yaml
667+
```
668+
654669
## `listener`
655670
656671
The listener section of `config.yaml` is configuration for the SQL server transport layer.

packages/dolt/content/reference/sql/version-control/dolt-system-tables.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,9 @@ Get all the tags.
423423
424424
## `dolt_branch_activity`
425425
`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.
426+
427+
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.
428+
426429
### Schema
427430
428431
```text

0 commit comments

Comments
 (0)