ttl: show table name for jobs in SHOW SCHEDULES

Previously, `SHOW SCHEDULES` would only show a table's ID for row level
TTL jobs. For the convenience of debugging, this commit upgrades the
`label` column to contain the table's name instead of its ID.

Rather than performing table name resolution at query time, the job name
is set at creation time and updated by the schema change during table
renames. This minimizes the likelihood of `SHOW SCHEDULES` being
rendered unusable when a cluster is in an unstable state.

Epic: CRDB-18322
Fixes: 93774

Author: chrisseto

pkg/ccl/backupccl/restore_job.go

@@ -2239,8 +2239,7 @@ func (r *restoreResumer) publishDescriptors(
 				jobsKnobs,
 				jobs.ScheduledJobTxn(txn),
 				user,
-				mutTable.GetID(),
-				mutTable.GetRowLevelTTL(),
+				mutTable,
 			)
 			if err != nil {
 				return err

pkg/ccl/backupccl/testdata/backup-restore/restore-on-fail-or-cancel-ttl

@@ -34,7 +34,7 @@ job cancel=a
 ----
 
 query-sql
-SELECT count(1) FROM [SHOW SCHEDULES] WHERE label LIKE 'row-level-ttl-%';
+SELECT count(1) FROM [SHOW SCHEDULES] WHERE label LIKE 'row-level-ttl%';
 ----
 0
 
@@ -75,7 +75,7 @@ job cancel=b
 ----
 
 query-sql
-SELECT count(1) FROM [SHOW SCHEDULES] WHERE label LIKE 'row-level-ttl-%';
+SELECT count(1) FROM [SHOW SCHEDULES] WHERE label LIKE 'row-level-ttl%';
 ----
 0
 

pkg/ccl/backupccl/testdata/backup-restore/row_level_ttl

@@ -20,7 +20,7 @@ new-cluster name=s2 share-io-dir=s1 allow-implicit-access
 
 query-sql
 SELECT count(1) FROM [SHOW SCHEDULES]
-WHERE label LIKE 'row-level-ttl-%'
+WHERE label LIKE 'row-level-ttl%'
 ----
 0
 
@@ -43,7 +43,7 @@ CREATE TABLE public.t (
 
 query-sql
 SELECT count(1) FROM [SHOW SCHEDULES]
-WHERE label LIKE 'row-level-ttl-%'
+WHERE label LIKE 'row-level-ttl%'
 ----
 1
 
@@ -53,7 +53,7 @@ DROP DATABASE d
 
 query-sql
 SELECT count(1) FROM [SHOW SCHEDULES]
-WHERE label LIKE 'row-level-ttl-%'
+WHERE label LIKE 'row-level-ttl%'
 ----
 0
 
@@ -76,7 +76,7 @@ CREATE TABLE public.t (
 
 query-sql
 SELECT count(1) FROM [SHOW SCHEDULES]
-WHERE label LIKE 'row-level-ttl-%'
+WHERE label LIKE 'row-level-ttl%'
 ----
 1
 
@@ -86,7 +86,7 @@ DROP DATABASE d
 
 query-sql
 SELECT count(1) FROM [SHOW SCHEDULES]
-WHERE label LIKE 'row-level-ttl-%'
+WHERE label LIKE 'row-level-ttl%'
 ----
 0
 
@@ -113,7 +113,7 @@ CREATE TABLE public.t (
 
 query-sql
 SELECT count(1) FROM [SHOW SCHEDULES]
-WHERE label LIKE 'row-level-ttl-%'
+WHERE label LIKE 'row-level-ttl%'
 ----
 1
 
@@ -123,6 +123,6 @@ DROP TABLE d.public.t
 
 query-sql
 SELECT count(1) FROM [SHOW SCHEDULES]
-WHERE label LIKE 'row-level-ttl-%'
+WHERE label LIKE 'row-level-ttl%'
 ----
 0

pkg/sql/BUILD.bazel

@@ -508,6 +508,7 @@ go_library(
         "//pkg/sql/storageparam/tablestorageparam",
         "//pkg/sql/syntheticprivilege",
         "//pkg/sql/syntheticprivilegecache",
+        "//pkg/sql/ttl/ttlbase",
         "//pkg/sql/types",
         "//pkg/sql/vtable",
         "//pkg/storage",

pkg/sql/check.go

@@ -799,8 +799,7 @@ func (p *planner) RepairTTLScheduledJobForTable(ctx context.Context, tableID int
 		p.ExecCfg().JobsKnobs(),
 		jobs.ScheduledJobTxn(p.InternalSQLTxn()),
 		p.User(),
-		tableDesc.GetID(),
-		tableDesc.GetRowLevelTTL(),
+		tableDesc,
 	)
 	if err != nil {
 		return err

pkg/sql/create_table.go

@@ -59,6 +59,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/storageparam"
 	"github.com/cockroachdb/cockroach/pkg/sql/storageparam/indexstorageparam"
 	"github.com/cockroachdb/cockroach/pkg/sql/storageparam/tablestorageparam"
+	"github.com/cockroachdb/cockroach/pkg/sql/ttl/ttlbase"
 	"github.com/cockroachdb/cockroach/pkg/sql/types"
 	"github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented"
 	"github.com/cockroachdb/cockroach/pkg/util/hlc"
@@ -2416,8 +2417,7 @@ func newTableDesc(
 			params.ExecCfg().JobsKnobs(),
 			jobs.ScheduledJobTxn(params.p.InternalSQLTxn()),
 			params.p.User(),
-			ret.GetID(),
-			ttl,
+			ret,
 		)
 		if err != nil {
 			return nil, err
@@ -2428,27 +2428,25 @@ func newTableDesc(
 }
 
 // newRowLevelTTLScheduledJob returns a *jobs.ScheduledJob for row level TTL
-// for a given table.
+// for a given table. newRowLevelTTLScheduledJob assumes that
+// tblDesc.RowLevelTTL is not nil.
 func newRowLevelTTLScheduledJob(
-	env scheduledjobs.JobSchedulerEnv,
-	owner username.SQLUsername,
-	tblID descpb.ID,
-	ttl *catpb.RowLevelTTL,
+	env scheduledjobs.JobSchedulerEnv, owner username.SQLUsername, tblDesc *tabledesc.Mutable,
 ) (*jobs.ScheduledJob, error) {
 	sj := jobs.NewScheduledJob(env)
-	sj.SetScheduleLabel(fmt.Sprintf("row-level-ttl-%d", tblID))
+	sj.SetScheduleLabel(ttlbase.BuildScheduleLabel(tblDesc))
 	sj.SetOwner(owner)
 	sj.SetScheduleDetails(jobspb.ScheduleDetails{
 		Wait: jobspb.ScheduleDetails_WAIT,
 		// If a job fails, try again at the allocated cron time.
 		OnError: jobspb.ScheduleDetails_RETRY_SCHED,
 	})
 
-	if err := sj.SetSchedule(ttl.DeletionCronOrDefault()); err != nil {
+	if err := sj.SetSchedule(tblDesc.RowLevelTTL.DeletionCronOrDefault()); err != nil {
 		return nil, err
 	}
 	args := &catpb.ScheduledRowLevelTTLArgs{
-		TableID: tblID,
+		TableID: tblDesc.GetID(),
 	}
 	any, err := pbtypes.MarshalAny(args)
 	if err != nil {
@@ -2467,12 +2465,15 @@ func CreateRowLevelTTLScheduledJob(
 	knobs *jobs.TestingKnobs,
 	s jobs.ScheduledJobStorage,
 	owner username.SQLUsername,
-	tblID descpb.ID,
-	ttl *catpb.RowLevelTTL,
+	tblDesc *tabledesc.Mutable,
 ) (*jobs.ScheduledJob, error) {
+	if !tblDesc.HasRowLevelTTL() {
+		return nil, errors.AssertionFailedf("CreateRowLevelTTLScheduledJob called with no .RowLevelTTL: %#v", tblDesc)
+	}
+
 	telemetry.Inc(sqltelemetry.RowLevelTTLCreated)
 	env := JobSchedulerEnv(knobs)
-	j, err := newRowLevelTTLScheduledJob(env, owner, tblID, ttl)
+	j, err := newRowLevelTTLScheduledJob(env, owner, tblDesc)
 	if err != nil {
 		return nil, err
 	}

pkg/sql/descmetadata/BUILD.bazel

@@ -10,10 +10,12 @@ go_library(
         "//pkg/settings",
         "//pkg/sql/catalog/descpb",
         "//pkg/sql/catalog/descs",
+        "//pkg/sql/catalog/tabledesc",
         "//pkg/sql/isql",
         "//pkg/sql/schemachanger/scexec",
         "//pkg/sql/sessiondata",
         "//pkg/sql/sessioninit",
+        "//pkg/sql/ttl/ttlbase",
     ],
 )
 

pkg/sql/descmetadata/metadata_updater.go

@@ -18,10 +18,12 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/settings"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descs"
+	"github.com/cockroachdb/cockroach/pkg/sql/catalog/tabledesc"
 	"github.com/cockroachdb/cockroach/pkg/sql/isql"
 	"github.com/cockroachdb/cockroach/pkg/sql/schemachanger/scexec"
 	"github.com/cockroachdb/cockroach/pkg/sql/sessiondata"
 	"github.com/cockroachdb/cockroach/pkg/sql/sessioninit"
+	"github.com/cockroachdb/cockroach/pkg/sql/ttl/ttlbase"
 )
 
 // metadataUpdater which implements scexec.MetaDataUpdater that is used to update
@@ -94,3 +96,23 @@ func (mu metadataUpdater) DeleteSchedule(ctx context.Context, scheduleID int64)
 	)
 	return err
 }
+
+// UpdateTTLScheduleLabel implement scexec.DescriptorMetadataUpdater.
+func (mu metadataUpdater) UpdateTTLScheduleLabel(
+	ctx context.Context, tbl *tabledesc.Mutable,
+) error {
+	if !tbl.HasRowLevelTTL() {
+		return nil
+	}
+
+	_, err := mu.txn.ExecEx(
+		ctx,
+		"update-ttl-schedule-label",
+		mu.txn.KV(),
+		sessiondata.RootUserSessionDataOverride,
+		"UPDATE system.scheduled_jobs SET schedule_name = $1 WHERE schedule_id = $2",
+		ttlbase.BuildScheduleLabel(tbl),
+		tbl.RowLevelTTL.ScheduleID,
+	)
+	return err
+}