Merge pull request #142833 from cockroachdb/blathers/backport-release-24.3-142061

release-24.3: sql: add notice delete rate limit is per leaseholder when configured

Author: Dedej-Bergin

pkg/sql/alter_table.go

@@ -749,6 +749,13 @@ func (n *alterTableNode) startExec(params runParams) error {
 				return err
 			}
 
+			paramIsDelete := t.StorageParams.GetVal("ttl_delete_rate_limit") != nil
+			paramIsSelect := t.StorageParams.GetVal("ttl_select_rate_limit") != nil
+
+			if paramIsDelete || paramIsSelect {
+				printTTLRateLimitNotice(params.ctx, params.p)
+			}
+
 		case *tree.AlterTableResetStorageParams:
 			setter := tablestorageparam.NewSetter(n.tableDesc)
 			if err := storageparam.Reset(

pkg/sql/create_table.go

@@ -1402,6 +1402,14 @@ func NewTableDesc(
 	); err != nil {
 		return nil, err
 	}
+
+	paramIsDelete := n.StorageParams.GetVal("ttl_delete_rate_limit") != nil
+	paramIsSelect := n.StorageParams.GetVal("ttl_select_rate_limit") != nil
+
+	if paramIsDelete || paramIsSelect {
+		printTTLRateLimitNotice(ctx, evalCtx.ClientNoticeSender)
+	}
+
 	setter.TableDesc.RowLevelTTL = setter.UpdatedRowLevelTTL
 
 	indexEncodingVersion := descpb.StrictIndexColumnIDGuaranteesVersion

pkg/sql/logictest/testdata/logic_test/cluster_settings

@@ -448,3 +448,25 @@ query B
 SHOW CLUSTER SETTING sql.explain_analyze.include_ru_estimation.enabled FOR TENANT "cluster-10"
 ----
 false
+
+subtest notice_on_ttl_default_rate_limit
+
+query T noticetrace
+SET CLUSTER SETTING sql.ttl.default_delete_rate_limit = 90;
+----
+NOTICE: The TTL rate limit is per leaseholder per table.
+DETAIL: See the documentation for additional details: https://www.cockroachlabs.com/docs/v24.3/row-level-ttl#ttl-storage-parameters
+
+statement ok
+SET CLUSTER SETTING sql.ttl.default_delete_rate_limit = 100;
+
+query T noticetrace
+SET CLUSTER SETTING sql.ttl.default_select_rate_limit = 100;
+----
+NOTICE: The TTL rate limit is per leaseholder per table.
+DETAIL: See the documentation for additional details: https://www.cockroachlabs.com/docs/v24.3/row-level-ttl#ttl-storage-parameters
+
+statement ok
+SET CLUSTER SETTING sql.ttl.default_select_rate_limit = 0;
+
+subtest end

pkg/sql/logictest/testdata/logic_test/row_level_ttl

@@ -766,6 +766,7 @@ subtest end
 
 subtest set_ttl_params
 
+onlyif config weak-iso-level-configs
 statement ok
 CREATE TABLE tbl_set_ttl_params (
   id INT PRIMARY KEY
@@ -781,6 +782,25 @@ CREATE TABLE tbl_set_ttl_params (
   ttl_disable_changefeed_replication = true
 )
 
+skipif config weak-iso-level-configs
+query T noticetrace
+CREATE TABLE tbl_set_ttl_params (
+  id INT PRIMARY KEY
+) WITH (
+  ttl_expire_after = '10 minutes',
+  ttl_select_batch_size = 10,
+  ttl_delete_batch_size = 20,
+  ttl_select_rate_limit = 30,
+  ttl_delete_rate_limit = 40,
+  ttl_pause = true,
+  ttl_row_stats_poll_interval = '1 minute',
+  ttl_label_metrics = true,
+  ttl_disable_changefeed_replication = true
+)
+----
+NOTICE: The TTL rate limit is per leaseholder per table.
+DETAIL: See the documentation for additional details: https://www.cockroachlabs.com/docs/v24.3/row-level-ttl#ttl-storage-parameters
+
 query T
 SELECT create_statement FROM [SHOW CREATE TABLE tbl_set_ttl_params]
 ----
@@ -790,6 +810,14 @@ CREATE TABLE public.tbl_set_ttl_params (
   CONSTRAINT tbl_set_ttl_params_pkey PRIMARY KEY (id ASC)
 ) WITH (ttl = 'on', ttl_expire_after = '00:10:00':::INTERVAL, ttl_select_batch_size = 10, ttl_delete_batch_size = 20, ttl_select_rate_limit = 30, ttl_delete_rate_limit = 40, ttl_pause = true, ttl_row_stats_poll_interval = '1m0s', ttl_label_metrics = true, ttl_disable_changefeed_replication = true)
 
+skipif config weak-iso-level-configs
+query T noticetrace
+ALTER TABLE tbl_set_ttl_params SET (ttl_select_batch_size = 110, ttl_delete_batch_size = 120, ttl_select_rate_limit = 130, ttl_delete_rate_limit = 140, ttl_row_stats_poll_interval = '2m0s')
+----
+NOTICE: The TTL rate limit is per leaseholder per table.
+DETAIL: See the documentation for additional details: https://www.cockroachlabs.com/docs/v24.3/row-level-ttl#ttl-storage-parameters
+
+onlyif config weak-iso-level-configs
 statement ok
 ALTER TABLE tbl_set_ttl_params SET (ttl_select_batch_size = 110, ttl_delete_batch_size = 120, ttl_select_rate_limit = 130, ttl_delete_rate_limit = 140, ttl_row_stats_poll_interval = '2m0s')
 

pkg/sql/set_cluster_setting.go

@@ -232,6 +232,10 @@ func (p *planner) SetClusterSetting(
 		return nil, err
 	}
 
+	if name == "sql.ttl.default_delete_rate_limit" || name == "sql.ttl.default_select_rate_limit" {
+		printTTLRateLimitNotice(ctx, p)
+	}
+
 	csNode := setClusterSettingNode{
 		name:    name,
 		st:      st,
@@ -241,6 +245,18 @@ func (p *planner) SetClusterSetting(
 	return &csNode, nil
 }
 
+func printTTLRateLimitNotice(ctx context.Context, p eval.ClientNoticeSender) {
+	ttlDocDetail := "See the documentation for additional details: " +
+		docs.URL("row-level-ttl#ttl-storage-parameters")
+	p.BufferClientNotice(
+		ctx,
+		errors.WithDetail(
+			pgnotice.Newf("The TTL rate limit is per leaseholder per table."),
+			ttlDocDetail,
+		),
+	)
+}
+
 func (p *planner) getAndValidateTypedClusterSetting(
 	ctx context.Context, name settings.SettingName, expr tree.Expr, setting settings.NonMaskedSetting,
 ) (tree.TypedExpr, error) {