diff --git a/packages/dolt/content/reference/sql/server/configuration.md b/packages/dolt/content/reference/sql/server/configuration.md index 74c19c91..e4e2431a 100644 --- a/packages/dolt/content/reference/sql/server/configuration.md +++ b/packages/dolt/content/reference/sql/server/configuration.md @@ -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. diff --git a/packages/dolt/content/reference/sql/version-control/dolt-system-tables.md b/packages/dolt/content/reference/sql/version-control/dolt-system-tables.md index bccb6ca2..0a13f5d0 100644 --- a/packages/dolt/content/reference/sql/version-control/dolt-system-tables.md +++ b/packages/dolt/content/reference/sql/version-control/dolt-system-tables.md @@ -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