Skip to content

Commit f4c7e22

Browse files
committed
Update cluster settings, deprecations, finalization, backward-incompatible, and anchor link CSS
1 parent a263e63 commit f4c7e22

File tree

6 files changed

+40
-33
lines changed

6 files changed

+40
-33
lines changed
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
- Bullet
1+
There are no backward-incompatible changes.
2+
{% comment %}TODO: Are removed settings 'backward incompatbile' because if you downgrade you lose what you had set?{% endcomment %}

src/current/_includes/releases/v25.4/cluster-setting-changes.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,61 @@ Changes to [cluster settings]({% link v25.4/cluster-settings.md %}) should be re
22

33
<h5 id="v25-4-0-settings-added">New settings</h5>
44

5-
- `changefeed.progress.frontier_persistence.interval`
5+
- `changefeed.progress.frontier_persistence.interval` (default: `30s`)
66

77
Changefeeds will now periodically persist their entire span frontiers so that fewer duplicates will need to be emitted during restarts. The default persistence interval is 30s, but this can be configured with the `changefeed.progress.frontier_persistence.interval` cluster setting. [#153491][#153491]
88

9-
- `log.channel_compatibility_mode.enabled`
9+
- `log.channel_compatibility_mode.enabled` (default: `true`)
1010

1111
- In a future major release, changefeed events will be logged to the `CHANGEFEED` logging channel instead of `TELEMETRY`. To test the impact of this change before upgrading, set the cluster setting `log.channel_compatibility_mode.enabled` to `false`. This redirects changefeed logs to the `CHANGEFEED` channel and should be tested only in non-production environments. [#151807][#151807]
1212
- In a future major release, SQL performance events will be logged to the `SQL_EXEC` channel instead of the `SQL_PERF` and `SQL_INTERNAL_PERF` channels. To test the impact of this change, you can set the new cluster setting `log.channel_compatibility_mode.enabled` to `false`. This redirects SQL performance logs to the `SQL_EXEC` channel. This setting should not be used in production environments, as it may affect downstream logging pipelines. [#151827][#151827]
1313
- In a future major release, `sampled_query` and `sampled_transaction` events will move from the `TELEMETRY` channel to the `SQL_EXEC` logging channel. To test for potential logging pipeline impacts of these changes, set `log.channel_compatibility_mode.enabled` to `false`. Avoid testing in production, as this setting changes live log behavior. [#151949][#151949]
1414

15-
- `sql.catalog.allow_leased_descriptors.enabled`
15+
- `sql.catalog.allow_leased_descriptors.enabled` (default: `false`)
1616

1717
Added the `sql.catalog.allow_leased_descriptors.enabled` cluster setting, which is false by default. When set to true, queries that access the `pg_catalog` or `information_schema` can use cached leased descriptors to populate the data in those tables, with the tradeoff that some of the data could be stale. [#154491][#154491]
1818

19-
- `sql.log.scan_row_count_misestimate.enabled`
19+
- `sql.log.scan_row_count_misestimate.enabled` (default: `false`)
2020

2121
Added a cluster setting (`sql.log.scan_row_count_misestimate.enabled`) that enables logging a warning on the gateway node when optimizer estimates for scans are inaccurate. The log message includes the table and index being scanned, the estimated and actual row counts, the time since the last table stats collection, and the table's estimated staleness. [#155123][#155123]
2222

23-
- `sql.schema.approx_max_object_count`
23+
- `sql.schema.approx_max_object_count` (default: `20000`)
2424

2525
Added cluster setting `sql.schema.approx_max_object_count` (default: 20,000) to prevent creation of new schema objects when the limit is exceeded. The check uses cached table statistics for performance and is approximate - it may not be immediately accurate until table statistics are updated by the background statistics refreshing job. Clusters that have been running stably with a larger object count should raise the limit or disable the limit by setting the value to 0. In future releases, the default value for this setting will be raised as more CockroachDB features support larger object counts. [#154576][#154576]
2626

27-
- `sql.trace.txn.include_internal.enabled`
27+
- `sql.stats.error_on_concurrent_create_stats.enabled` (default: `true`)
28+
29+
Introduced the cluster setting `sql.stats.error_on_concurrent_create_stats.enabled`, which modifies how CockroachDB reacts to concurrent auto stats jobs. The default, `true`, maintains the previous behavior. Setting `sql.stats.error_on_concurrent_create_stats.enabled` to `false` will cause the concurrent auto stats job to be skipped with just a log entry and no increased error counters. [#149538][#149538]
30+
31+
- `sql.trace.txn.include_internal.enabled` (default: `true`)
2832

2933
You can now exclude internal transactions from probabilistic transaction tracing and latency-based logging by setting the `sql.trace.txn.include_internal.enabled` cluster setting to false. This setting is enabled by default to preserve the current behavior, but disabling it is recommended when debugging customer workloads to reduce noise in trace output. [#151433][#151433]
3034

31-
- `sql.trace.txn.jaeger_json_output.enabled`
35+
- `sql.trace.txn.jaeger_json_output.enabled` (default: `false`)
3236

3337
You can now output transaction traces to the logs in Jaeger-compatible JSON format. This is controlled by the `sql.trace.txn.jaeger_json_output.enabled` cluster setting, which is disabled by default. When enabled, traces triggered by probabilistic sampling or statement latency thresholds will be formatted for easier ingestion by tools that support the Jaeger tracing format. [#151414][#151414]
3438

35-
- `storage.unhealthy_write_duration` {% comment %}Verify with Eng{% endcomment %}
39+
- `storage.unhealthy_write_duration` (default: `20s`) {% comment %}Verify with Eng{% endcomment %}
3640

3741
Added the cluster setting `storage.unhealthy_write_duration` (defaults to 20s), which is used to indicate to the allocator that a store's disk is unhealthy. The cluster setting `kv.allocator.disk_unhealthy_io_overload_score` controls the overload score assigned to a store with an unhealthy disk, where a higher score results in preventing lease or replica transfers to the store, or shedding of leases by the store. The default value of that setting is 0, so the allocator behavior is unaffected. [#154459][#154459]
3842

3943
<h5 id="v25-4-0-settings-changed-default">Settings with changed defaults</h5>
4044

41-
- `feature.vector_index.enabled` {% comment %}Verify with Eng{% endcomment %}
45+
- `feature.vector_index.enabled` now defaults to `true`. Vector indexing is now enabled by default. [#155561][#155561]
4246

43-
The value of `feature.vector_index.enabled` now defaults to `true`. Vector indexing is now enabled by default. [#155561][#155561]
47+
- `storage.value_separation.enabled` now defaults to `true`. {% comment %}TODO: Verify with annrpom - Is this backward-incompatible due to significant storage behavior change?{% endcomment %}This enables [value separation]({% link v25.4/architecture/storage-layer.md %}#value-separation) for SSTables, where values exceeding a certain size threshold are stored in separate blob files rather than inline in the SSTable. This helps improve write performance (write amplification) by avoiding rewriting such values during compactions. [#148857][#148857]
4448

45-
<h5 id="v25-4-0-settings-other-changes">Other setting changes</h5>
49+
<h5 id="v25-4-0-settings-removed">Removed settings</h5>
4650

47-
- `bulkio.backup.deprecated_full_backup_with_subdir.enabled` {% comment %}Verify with msbutler{% endcomment %}
51+
- `bulkio.backup.deprecated_full_backup_with_subdir.enabled` {% comment %}TODO: Verify with msbutler - Is this backward-incompatible since backups fail if set to true?{% endcomment %}
4852

4953
Removed the `bulkio.backup.deprecated_full_backup_with_subdir.enabled` cluster setting, since backups will now fail if this is set to true. [#153628][#153628]
5054

51-
- `storage.columnar_blocks.enabled`
55+
- `storage.columnar_blocks.enabled` {% comment %}TODO: Verify with jbowens - Is this backward-incompatible since it can't be disabled anymore?{% endcomment %}
5256

5357
Removed the `storage.columnar_blocks.enabled` cluster setting; columnar blocks are always enabled. [#149371][#149371]
5458

55-
- `sql.stats.error_on_concurrent_create_stats.enabled`
56-
57-
Introduced the cluster setting `sql.stats.error_on_concurrent_create_stats.enabled`, which modifies how CockroachDB reacts to concurrent auto stats jobs. The default, `true`, maintains the previous behavior. Setting `sql.stats.error_on_concurrent_create_stats.enabled` to `false` will cause the concurrent auto stats job to be skipped with just a log entry and no increased error counters. [#149538][#149538]
59+
<h5 id="v25-4-0-settings-other-changes">Other setting changes</h5>
5860

5961
- `sql.ttl.replan_flow_threshold` {% comment %}Verify with spilchen{% endcomment %}
6062

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
The following deprecations/removals are announced in v25.3.
1+
The following deprecations/removals are announced in v25.4.
22

3-
- Bullet
4-
- Bullet
5-
- Bullet
6-
[#][#]
3+
- The functionality provided by session variable `enforce_home_region_follower_reads_enabled` was deprecated in v24.2.4 and is now removed. {% comment %}TODO: Verify with michae2 - Is this backward-incompatible?{% endcomment %}(The variable itself remains for backward compatibility but has no effect.) Note that the related session variable `enforce_home_region` is **not** deprecated and still functions normally. [#148314][#148314]
74

8-
[#]: https://github.com/cockroachdb/cockroach/pull/
9-
[#]: https://github.com/cockroachdb/cockroach/pull/
10-
[#]: https://github.com/cockroachdb/cockroach/pull/
5+
- The cluster settings `storage.columnar_blocks.enabled` and `bulkio.backup.deprecated_full_backup_with_subdir.enabled` have been removed. For details, refer to [Removed settings](#v25-4-0-settings-removed).
6+
7+
- The bespoke restore and import event logs have been deprecated. For any deployment that is reliant on those logs, use the status change event log which now plumbs the SQL user that owns the job. [#153889][#153889]
8+
9+
- The `incremental_location` backup option is now deprecated and will be removed in a future release. This feature was added so customers could define different TTL policies for incremental backups vs full backups. Users can still do this since incremental backups are by default stored in a distinct directory relative to full backups (`{collection_root}/incrementals`). [#153890][#153890]
10+
11+
[#148314]: https://github.com/cockroachdb/cockroach/pull/148314
12+
[#153889]: https://github.com/cockroachdb/cockroach/pull/153889
13+
[#153890]: https://github.com/cockroachdb/cockroach/pull/153890
Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
During a major-version upgrade, certain features and performance improvements are not available until the upgrade is finalized. In v25.3, these are:
1+
During a major-version upgrade, certain features and performance improvements are not available until the upgrade is finalized. In v25.4, these are:
22

3-
- Bullet
4-
- Bullet
5-
- Bullet
6-
- Bullet
7-
- Bullet
3+
- **Partial statistics with constraining predicates**: {% comment %}TODO: Verify with michae2{% endcomment %}The ability to manually create single-column partial statistics on boolean predicate expressions using a constraining `WHERE` clause in `CREATE STATISTICS` statements. For details, refer to the [release note](#v25-4-0-alpha-2-partial-statistics).
4+
- **Changefeed span frontier persistence**: {% comment %}TODO: Verify with Eng{% endcomment %}Changefeeds now periodically persist their entire span frontiers so that fewer duplicates need to be emitted during restarts. The default persistence interval is 30 seconds, configurable with the `changefeed.progress.frontier_persistence.interval` cluster setting. For details, refer to the [release note](#v25-4-0-alpha-2-changefeed-frontier-persistence).

src/current/_includes/releases/v25.4/v25.4.0-alpha.2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Release Date: September 23, 2025
88

99
- `CREATE USER` and `GRANT` role operations now wait for full-cluster visibility of the new user table version rather than blocking on convergence. [#150747][#150747]
1010
- Introduced the `inspect_errors` system table. [#151821][#151821]
11-
- You now manually create single-column partial statistics on boolean predicate expressions that can become simple index scans. These statistics can be created by adding a constraining `WHERE` expression to `CREATE STATISTICS`.
11+
- <a name="v25-4-0-alpha-2-partial-statistics"></a>You now manually create single-column partial statistics on boolean predicate expressions that can become simple index scans. These statistics can be created by adding a constraining `WHERE` expression to `CREATE STATISTICS`.
1212

1313
For example:
1414

@@ -39,7 +39,7 @@ Release Date: September 23, 2025
3939

4040
<h3 id="v25-4-0-alpha-2-performance-improvements">Performance improvements</h3>
4141

42-
- Changefeeds will now
42+
- <a name="v25-4-0-alpha-2-changefeed-frontier-persistence"></a>Changefeeds will now
4343
periodically persist their entire span frontiers so that
4444
fewer duplicates will need to be emitted during restarts.
4545
The default persistence interval is 30s, but this can be

src/current/css/customstyles.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,10 @@ td > div.anchored
101101
scroll-margin-top: 100px;
102102
}
103103

104+
a[name] {
105+
scroll-margin-top: 100px;
106+
}
107+
104108
table {
105109
overflow-x: auto;
106110
width: 100%;

0 commit comments

Comments
 (0)