scexec: add deferred mutation to rename TTL schedule

This will make sure the TTL schedule name matches the new table name
when a table is renamed, just as the legacy schema changer does.

Release note: None

Author: rafiss

pkg/sql/descmetadata/BUILD.bazel

@@ -9,9 +9,9 @@ go_library(
         "//pkg/jobs/jobspb",
         "//pkg/keys",
         "//pkg/settings",
+        "//pkg/sql/catalog",
         "//pkg/sql/catalog/descpb",
         "//pkg/sql/catalog/descs",
-        "//pkg/sql/catalog/tabledesc",
         "//pkg/sql/isql",
         "//pkg/sql/schemachanger/scexec",
         "//pkg/sql/sem/catconstants",

pkg/sql/descmetadata/metadata_updater.go

@@ -12,9 +12,9 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/jobs/jobspb"
 	"github.com/cockroachdb/cockroach/pkg/keys"
 	"github.com/cockroachdb/cockroach/pkg/settings"
+	"github.com/cockroachdb/cockroach/pkg/sql/catalog"
 	"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/sem/catconstants"
@@ -96,7 +96,7 @@ func (mu metadataUpdater) DeleteSchedule(ctx context.Context, scheduleID jobspb.
 
 // UpdateTTLScheduleLabel implement scexec.DescriptorMetadataUpdater.
 func (mu metadataUpdater) UpdateTTLScheduleLabel(
-	ctx context.Context, tbl *tabledesc.Mutable,
+	ctx context.Context, tbl catalog.TableDescriptor,
 ) error {
 	if !tbl.HasRowLevelTTL() {
 		return nil
@@ -109,7 +109,7 @@ func (mu metadataUpdater) UpdateTTLScheduleLabel(
 		sessiondata.NodeUserSessionDataOverride,
 		"UPDATE system.scheduled_jobs SET schedule_name = $1 WHERE schedule_id = $2",
 		ttlbase.BuildScheduleLabel(tbl),
-		tbl.RowLevelTTL.ScheduleID,
+		tbl.GetRowLevelTTL().ScheduleID,
 	)
 	return err
 }

pkg/sql/schemachanger/scdeps/sctestdeps/test_deps.go

@@ -30,7 +30,6 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/multiregion"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/nstree"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/schemadesc"
-	"github.com/cockroachdb/cockroach/pkg/sql/catalog/tabledesc"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/typedesc"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/zone"
 	"github.com/cockroachdb/cockroach/pkg/sql/privilege"
@@ -692,6 +691,8 @@ func (s *TestState) mustReadImmutableDescriptor(id descpb.ID) (catalog.Descripto
 // mustReadMutableDescriptor looks up a descriptor and returns a mutable
 // deep copy.
 func (s *TestState) mustReadMutableDescriptor(id descpb.ID) (catalog.MutableDescriptor, error) {
+	//
+
 	u := s.uncommittedInMemory.LookupDescriptor(id)
 	if u == nil {
 		return nil, errors.Wrapf(catalog.ErrDescriptorNotFound, "reading mutable descriptor #%d", id)
@@ -1332,8 +1333,8 @@ func (s *TestState) DeleteSchedule(ctx context.Context, id jobspb.ScheduleID) er
 }
 
 // UpdateTTLScheduleLabel implements scexec.DescriptorMetadataUpdater
-func (s *TestState) UpdateTTLScheduleLabel(ctx context.Context, tbl *tabledesc.Mutable) error {
-	s.LogSideEffectf("update ttl schedule label #%d", tbl.ID)
+func (s *TestState) UpdateTTLScheduleLabel(ctx context.Context, tbl catalog.TableDescriptor) error {
+	s.LogSideEffectf("update ttl schedule label #%d", tbl.GetID())
 	return nil
 }
 

pkg/sql/schemachanger/scexec/BUILD.bazel

@@ -29,7 +29,6 @@ go_library(
         "//pkg/sql/catalog/catalogkeys",
         "//pkg/sql/catalog/descpb",
         "//pkg/sql/catalog/nstree",
-        "//pkg/sql/catalog/tabledesc",
         "//pkg/sql/pgwire/pgcode",
         "//pkg/sql/pgwire/pgerror",
         "//pkg/sql/schemachanger/scerrors",

pkg/sql/schemachanger/scexec/dependencies.go

@@ -19,7 +19,6 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/catalogkeys"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
-	"github.com/cockroachdb/cockroach/pkg/sql/catalog/tabledesc"
 	"github.com/cockroachdb/cockroach/pkg/sql/schemachanger/scexec/scmutationexec"
 	"github.com/cockroachdb/cockroach/pkg/sql/sessiondata"
 	"github.com/cockroachdb/cockroach/pkg/util/hlc"
@@ -371,7 +370,7 @@ type DescriptorMetadataUpdater interface {
 
 	// UpdateTTLScheduleLabel updates the schedule_name for the TTL Scheduled Job
 	// of the given table.
-	UpdateTTLScheduleLabel(ctx context.Context, tbl *tabledesc.Mutable) error
+	UpdateTTLScheduleLabel(ctx context.Context, tbl catalog.TableDescriptor) error
 }
 
 type TemporarySchemaCreator interface {

pkg/sql/schemachanger/scexec/exec_deferred_mutation.go

@@ -28,6 +28,7 @@ type deferredState struct {
 	scheduleIDsToDelete          []jobspb.ScheduleID
 	statsToRefresh               catalog.DescriptorIDSet
 	indexesToSplitAndScatter     []indexesToSplitAndScatter
+	ttlScheduleMetadataUpdates   []ttlScheduleMetadataUpdate
 	gcJobs
 }
 
@@ -41,6 +42,11 @@ type indexesToSplitAndScatter struct {
 	copyIndexID catid.IndexID
 }
 
+type ttlScheduleMetadataUpdate struct {
+	tableID descpb.ID
+	newName string
+}
+
 type schemaChangerJobUpdate struct {
 	isNonCancelable       bool
 	runningStatus         redact.RedactableString
@@ -76,6 +82,16 @@ func (s *deferredState) RefreshStats(descriptorID descpb.ID) {
 	s.statsToRefresh.Add(descriptorID)
 }
 
+func (s *deferredState) UpdateTTLScheduleMetadata(
+	ctx context.Context, tableID descpb.ID, newName string,
+) error {
+	s.ttlScheduleMetadataUpdates = append(s.ttlScheduleMetadataUpdates, ttlScheduleMetadataUpdate{
+		tableID: tableID,
+		newName: newName,
+	})
+	return nil
+}
+
 func (s *deferredState) AddNewSchemaChangerJob(
 	jobID jobspb.JobID,
 	stmts []scpb.Statement,
@@ -190,6 +206,21 @@ func (s *deferredState) exec(
 			return err
 		}
 	}
+	for _, ttlUpdate := range s.ttlScheduleMetadataUpdates {
+		descs, err := c.MustReadImmutableDescriptors(ctx, ttlUpdate.tableID)
+		if err != nil {
+			return err
+		}
+		desc := descs[0]
+		// Skip if this isn't a table descriptor
+		tableDesc, ok := desc.(catalog.TableDescriptor)
+		if !ok {
+			continue
+		}
+		if err := m.UpdateTTLScheduleLabel(ctx, tableDesc); err != nil {
+			return err
+		}
+	}
 	for _, idx := range s.indexesToSplitAndScatter {
 		descs, err := c.MustReadImmutableDescriptors(ctx, idx.tableID)
 		if err != nil {

pkg/sql/schemachanger/scexec/executor_external_test.go

@@ -526,7 +526,7 @@ func (noopMetadataUpdater) DeleteSchedule(ctx context.Context, scheduleID jobspb
 
 // UpdateTTLScheduleLabel implements scexec.DescriptorMetadataUpdater.
 func (noopMetadataUpdater) UpdateTTLScheduleLabel(
-	ctx context.Context, tbl *tabledesc.Mutable,
+	ctx context.Context, tbl catalog.TableDescriptor,
 ) error {
 	return nil
 }

pkg/sql/schemachanger/scexec/scmutationexec/dependencies.go

@@ -148,4 +148,7 @@ type DeferredMutationStateUpdater interface {
 	AddIndexForMaybeSplitAndScatter(
 		tableID catid.DescID, indexID catid.IndexID, copyIndexID catid.IndexID,
 	)
+
+	// UpdateTTLScheduleMetadata updates the TTL schedule metadata for a table.
+	UpdateTTLScheduleMetadata(ctx context.Context, tableID descpb.ID, newName string) error
 }

pkg/sql/schemachanger/scexec/scmutationexec/table.go

@@ -30,3 +30,9 @@ func (i *immediateVisitor) SetTableSchemaLocked(
 	tbl.SchemaLocked = op.Locked
 	return nil
 }
+
+func (d *deferredVisitor) UpdateTTLScheduleMetadata(
+	ctx context.Context, op scop.UpdateTTLScheduleMetadata,
+) error {
+	return d.DeferredMutationStateUpdater.UpdateTTLScheduleMetadata(ctx, op.TableID, op.NewName)
+}

pkg/sql/schemachanger/scop/deferred_mutation.go

@@ -97,3 +97,12 @@ type MaybeAddSplitForIndex struct {
 	IndexID     descpb.IndexID
 	CopyIndexID descpb.IndexID
 }
+
+// UpdateTTLScheduleMetadata updates the TTL schedule metadata for a table
+// when its name changes. This ensures TTL jobs continue to work properly
+// after table renames.
+type UpdateTTLScheduleMetadata struct {
+	deferredMutationOp
+	TableID descpb.ID
+	NewName string
+}