opgen: ensure GC jobs for temp indexes have proper description

Fixes #82169. Release note: None
cockroachdb · Oct 3, 2022 · e1cfe36 · e1cfe36
1 parent 93e55b5
commit e1cfe36
Show file tree

Hide file tree

Showing 156 changed files with 1,022 additions and 237 deletions.
diff --git a/pkg/ccl/schemachangerccl/testdata/end_to_end/create_index b/pkg/ccl/schemachangerccl/testdata/end_to_end/create_index
@@ -385,7 +385,7 @@ upsert descriptor #104
   -  version: "7"
   +  version: "8"
 write *eventpb.FinishSchemaChange to event log
-create job #2 (non-cancelable: true): "GC for "
+create job #2 (non-cancelable: true): "GC for removed temporary index; CREATE INDEX id1 ON defaultdb.public.t1 (id, name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))"
   descriptor IDs: [104]
 update progress of schema change job #1: "all stages completed"
 set schema change job #1 to non-cancellable

diff --git a/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index b/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index
@@ -421,6 +421,9 @@ EXPLAIN (ddl, verbose) CREATE INDEX id1
             │
             ├── • CreateGCJobForIndex
             │     IndexID: 3
+            │     StatementForDropJob:
+            │       Statement: removed temporary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent

diff --git a/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_1_of_7 b/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_1_of_7
@@ -121,8 +121,8 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 1 of 7;
             │     IndexID: 2
             │     StatementForDropJob:
             │       Rollback: true
-            │       Statement: CREATE INDEX id1 ON defaultdb.public.t1 (id, name) STORING (money) PARTITION
-            │         BY LIST (id) (PARTITION p1 VALUES IN (1))
+            │       Statement: removed secondary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent
@@ -131,6 +131,10 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 1 of 7;
             │
             ├── • CreateGCJobForIndex
             │     IndexID: 3
+            │     StatementForDropJob:
+            │       Rollback: true
+            │       Statement: removed temporary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent

diff --git a/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_2_of_7 b/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_2_of_7
@@ -113,8 +113,8 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 2 of 7;
     │       │     IndexID: 2
     │       │     StatementForDropJob:
     │       │       Rollback: true
-    │       │       Statement: CREATE INDEX id1 ON defaultdb.public.t1 (id, name) STORING (money) PARTITION
-    │       │         BY LIST (id) (PARTITION p1 VALUES IN (1))
+    │       │       Statement: removed secondary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+    │       │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
     │       │     TableID: 104
     │       │
     │       ├── • MakeIndexAbsent
@@ -155,6 +155,10 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 2 of 7;
             │
             ├── • CreateGCJobForIndex
             │     IndexID: 3
+            │     StatementForDropJob:
+            │       Rollback: true
+            │       Statement: removed temporary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent

diff --git a/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_3_of_7 b/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_3_of_7
@@ -113,8 +113,8 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 3 of 7;
     │       │     IndexID: 2
     │       │     StatementForDropJob:
     │       │       Rollback: true
-    │       │       Statement: CREATE INDEX id1 ON defaultdb.public.t1 (id, name) STORING (money) PARTITION
-    │       │         BY LIST (id) (PARTITION p1 VALUES IN (1))
+    │       │       Statement: removed secondary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+    │       │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
     │       │     TableID: 104
     │       │
     │       ├── • MakeIndexAbsent
@@ -155,6 +155,10 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 3 of 7;
             │
             ├── • CreateGCJobForIndex
             │     IndexID: 3
+            │     StatementForDropJob:
+            │       Rollback: true
+            │       Statement: removed temporary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent

diff --git a/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_4_of_7 b/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_4_of_7
@@ -113,8 +113,8 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 4 of 7;
     │       │     IndexID: 2
     │       │     StatementForDropJob:
     │       │       Rollback: true
-    │       │       Statement: CREATE INDEX id1 ON defaultdb.public.t1 (id, name) STORING (money) PARTITION
-    │       │         BY LIST (id) (PARTITION p1 VALUES IN (1))
+    │       │       Statement: removed secondary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+    │       │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
     │       │     TableID: 104
     │       │
     │       ├── • MakeIndexAbsent
@@ -155,6 +155,10 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 4 of 7;
             │
             ├── • CreateGCJobForIndex
             │     IndexID: 3
+            │     StatementForDropJob:
+            │       Rollback: true
+            │       Statement: removed temporary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent

diff --git a/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_5_of_7 b/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_5_of_7
@@ -155,8 +155,8 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 5 of 7;
             │     IndexID: 2
             │     StatementForDropJob:
             │       Rollback: true
-            │       Statement: CREATE INDEX id1 ON defaultdb.public.t1 (id, name) STORING (money) PARTITION
-            │         BY LIST (id) (PARTITION p1 VALUES IN (1))
+            │       Statement: removed secondary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent
@@ -165,6 +165,10 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 5 of 7;
             │
             ├── • CreateGCJobForIndex
             │     IndexID: 3
+            │     StatementForDropJob:
+            │       Rollback: true
+            │       Statement: removed temporary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent

diff --git a/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_6_of_7 b/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_6_of_7
@@ -155,8 +155,8 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 6 of 7;
             │     IndexID: 2
             │     StatementForDropJob:
             │       Rollback: true
-            │       Statement: CREATE INDEX id1 ON defaultdb.public.t1 (id, name) STORING (money) PARTITION
-            │         BY LIST (id) (PARTITION p1 VALUES IN (1))
+            │       Statement: removed secondary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent
@@ -165,6 +165,10 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 6 of 7;
             │
             ├── • CreateGCJobForIndex
             │     IndexID: 3
+            │     StatementForDropJob:
+            │       Rollback: true
+            │       Statement: removed temporary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent

diff --git a/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_7_of_7 b/pkg/ccl/schemachangerccl/testdata/explain_verbose/create_index.rollback_7_of_7
@@ -155,8 +155,8 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 7 of 7;
             │     IndexID: 2
             │     StatementForDropJob:
             │       Rollback: true
-            │       Statement: CREATE INDEX id1 ON defaultdb.public.t1 (id, name) STORING (money) PARTITION
-            │         BY LIST (id) (PARTITION p1 VALUES IN (1))
+            │       Statement: removed secondary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent
@@ -165,6 +165,10 @@ EXPLAIN (ddl, verbose) rollback at post-commit stage 7 of 7;
             │
             ├── • CreateGCJobForIndex
             │     IndexID: 3
+            │     StatementForDropJob:
+            │       Rollback: true
+            │       Statement: removed temporary index; CREATE INDEX id1 ON defaultdb.public.t1 (id,
+            │         name) STORING (money) PARTITION BY LIST (id) (PARTITION p1 VALUES IN (1))
             │     TableID: 104
             │
             ├── • MakeIndexAbsent

diff --git a/pkg/sql/schemachanger/scplan/internal/opgen/op_funcs.go b/pkg/sql/schemachanger/scplan/internal/opgen/op_funcs.go
@@ -54,12 +54,19 @@ func newLogEventOp(e scpb.Element, md *targetsWithElementMap) *scop.LogEvent {
 
 func statementForDropJob(e scpb.Element, md *targetsWithElementMap) scop.StatementForDropJob {
 	stmtID := md.Targets[md.elementToTarget[e]].Metadata.StatementID
+	stmt := redact.RedactableString(md.Statements[stmtID].RedactedStatement).StripMarkers()
+	switch e.(type) {
+	case *scpb.PrimaryIndex:
+		stmt = "removed primary index; " + stmt
+	case *scpb.SecondaryIndex:
+		stmt = "removed secondary index; " + stmt
+	case *scpb.TemporaryIndex:
+		stmt = "removed temporary index; " + stmt
+	}
 	return scop.StatementForDropJob{
 		// Using the redactable string but with stripped markers gives us a
 		// normalized and fully-qualified string value for display use.
-		Statement: redact.RedactableString(
-			md.Statements[stmtID].RedactedStatement,
-		).StripMarkers(),
+		Statement:   stmt,
 		StatementID: stmtID,
 		Rollback:    md.InRollback,
 	}

diff --git a/pkg/sql/schemachanger/scplan/internal/opgen/opgen_temporary_index.go b/pkg/sql/schemachanger/scplan/internal/opgen/opgen_temporary_index.go
@@ -49,10 +49,11 @@ func init() {
 				}),
 			),
 			to(scpb.Status_ABSENT,
-				emit(func(this *scpb.TemporaryIndex) *scop.CreateGCJobForIndex {
+				emit(func(this *scpb.TemporaryIndex, md *targetsWithElementMap) *scop.CreateGCJobForIndex {
 					return &scop.CreateGCJobForIndex{
-						TableID: this.TableID,
-						IndexID: this.IndexID,
+						TableID:             this.TableID,
+						IndexID:             this.IndexID,
+						StatementForDropJob: statementForDropJob(this, md),
 					}
 				}),
 				emit(func(this *scpb.TemporaryIndex) *scop.MakeIndexAbsent {

diff --git a/pkg/sql/schemachanger/scplan/testdata/alter_table_add_column b/pkg/sql/schemachanger/scplan/testdata/alter_table_add_column
@@ -377,6 +377,9 @@ PostCommitNonRevertiblePhase stage 2 of 3 with 5 MutationType ops
   ops:
     *scop.CreateGCJobForIndex
       IndexID: 3
+      StatementForDropJob:
+        Statement: removed temporary index; ALTER TABLE defaultdb.public.foo ADD COLUMN
+          j INT8 NOT NULL DEFAULT 123
       TableID: 104
     *scop.MakeIndexAbsent
       IndexID: 3
@@ -396,7 +399,8 @@ PostCommitNonRevertiblePhase stage 3 of 3 with 4 MutationType ops
     *scop.CreateGCJobForIndex
       IndexID: 1
       StatementForDropJob:
-        Statement: ALTER TABLE defaultdb.public.foo ADD COLUMN j INT8 NOT NULL DEFAULT 123
+        Statement: removed primary index; ALTER TABLE defaultdb.public.foo ADD COLUMN j
+          INT8 NOT NULL DEFAULT 123
       TableID: 104
     *scop.MakeIndexAbsent
       EventBase:
@@ -742,6 +746,9 @@ PostCommitNonRevertiblePhase stage 2 of 3 with 5 MutationType ops
   ops:
     *scop.CreateGCJobForIndex
       IndexID: 3
+      StatementForDropJob:
+        Statement: removed temporary index; ALTER TABLE defaultdb.public.foo ADD COLUMN
+          j INT8 DEFAULT 123
       TableID: 104
     *scop.MakeIndexAbsent
       IndexID: 3
@@ -761,7 +768,8 @@ PostCommitNonRevertiblePhase stage 3 of 3 with 4 MutationType ops
     *scop.CreateGCJobForIndex
       IndexID: 1
       StatementForDropJob:
-        Statement: ALTER TABLE defaultdb.public.foo ADD COLUMN j INT8 DEFAULT 123
+        Statement: removed primary index; ALTER TABLE defaultdb.public.foo ADD COLUMN j
+          INT8 DEFAULT 123
       TableID: 104
     *scop.MakeIndexAbsent
       EventBase:
@@ -1023,6 +1031,9 @@ PostCommitNonRevertiblePhase stage 2 of 3 with 5 MutationType ops
   ops:
     *scop.CreateGCJobForIndex
       IndexID: 3
+      StatementForDropJob:
+        Statement: removed temporary index; ALTER TABLE defaultdb.public.foo ADD COLUMN
+          a INT8 AS (i + 1) STORED
       TableID: 104
     *scop.MakeIndexAbsent
       IndexID: 3
@@ -1042,7 +1053,8 @@ PostCommitNonRevertiblePhase stage 3 of 3 with 4 MutationType ops
     *scop.CreateGCJobForIndex
       IndexID: 1
       StatementForDropJob:
-        Statement: ALTER TABLE defaultdb.public.foo ADD COLUMN a INT8 AS (i + 1) STORED
+        Statement: removed primary index; ALTER TABLE defaultdb.public.foo ADD COLUMN a
+          INT8 AS (i + 1) STORED
       TableID: 104
     *scop.MakeIndexAbsent
       EventBase:
@@ -1519,12 +1531,18 @@ PostCommitNonRevertiblePhase stage 2 of 3 with 7 MutationType ops
   ops:
     *scop.CreateGCJobForIndex
       IndexID: 3
+      StatementForDropJob:
+        Statement: removed temporary index; ALTER TABLE defaultdb.public.t ALTER PRIMARY
+          KEY USING COLUMNS (j)
       TableID: 108
     *scop.MakeIndexAbsent
       IndexID: 3
       TableID: 108
     *scop.CreateGCJobForIndex
       IndexID: 5
+      StatementForDropJob:
+        Statement: removed temporary index; ALTER TABLE defaultdb.public.t ALTER PRIMARY
+          KEY USING COLUMNS (j)
       TableID: 108
     *scop.MakeIndexAbsent
       IndexID: 5
@@ -1544,7 +1562,8 @@ PostCommitNonRevertiblePhase stage 3 of 3 with 4 MutationType ops
     *scop.CreateGCJobForIndex
       IndexID: 1
       StatementForDropJob:
-        Statement: ALTER TABLE defaultdb.public.t ALTER PRIMARY KEY USING COLUMNS (j)
+        Statement: removed primary index; ALTER TABLE defaultdb.public.t ALTER PRIMARY KEY
+          USING COLUMNS (j)
       TableID: 108
     *scop.MakeIndexAbsent
       EventBase:
@@ -1947,7 +1966,8 @@ PostCommitNonRevertiblePhase stage 2 of 2 with 8 MutationType ops
     *scop.CreateGCJobForIndex
       IndexID: 1
       StatementForDropJob:
-        Statement: ALTER TABLE defaultdb.public.baz ADD COLUMN g INT8 UNIQUE DEFAULT 1
+        Statement: removed primary index; ALTER TABLE defaultdb.public.baz ADD COLUMN g
+          INT8 UNIQUE DEFAULT 1
       TableID: 109
     *scop.MakeIndexAbsent
       EventBase:
@@ -1963,12 +1983,18 @@ PostCommitNonRevertiblePhase stage 2 of 2 with 8 MutationType ops
       TableID: 109
     *scop.CreateGCJobForIndex
       IndexID: 3
+      StatementForDropJob:
+        Statement: removed temporary index; ALTER TABLE defaultdb.public.baz ADD COLUMN
+          g INT8 UNIQUE DEFAULT 1
       TableID: 109
     *scop.MakeIndexAbsent
       IndexID: 3
       TableID: 109
     *scop.CreateGCJobForIndex
       IndexID: 5
+      StatementForDropJob:
+        Statement: removed temporary index; ALTER TABLE defaultdb.public.baz ADD COLUMN
+          g INT8 UNIQUE DEFAULT 1
       TableID: 109
     *scop.MakeIndexAbsent
       IndexID: 5

diff --git a/pkg/sql/schemachanger/scplan/testdata/alter_table_alter_primary_key b/pkg/sql/schemachanger/scplan/testdata/alter_table_alter_primary_key
@@ -358,7 +358,8 @@ PostCommitNonRevertiblePhase stage 2 of 4 with 12 MutationType ops
     *scop.CreateGCJobForIndex
       IndexID: 1
       StatementForDropJob:
-        Statement: ALTER TABLE defaultdb.public.t ALTER PRIMARY KEY USING COLUMNS (k)
+        Statement: removed primary index; ALTER TABLE defaultdb.public.t ALTER PRIMARY KEY
+          USING COLUMNS (k)
       TableID: 104
     *scop.MakeIndexAbsent
       EventBase:
@@ -380,6 +381,9 @@ PostCommitNonRevertiblePhase stage 2 of 4 with 12 MutationType ops
       TableID: 104
     *scop.CreateGCJobForIndex
       IndexID: 3
+      StatementForDropJob:
+        Statement: removed temporary index; ALTER TABLE defaultdb.public.t ALTER PRIMARY
+          KEY USING COLUMNS (k)
       TableID: 104
     *scop.MakeIndexAbsent
       IndexID: 3
@@ -390,6 +394,9 @@ PostCommitNonRevertiblePhase stage 2 of 4 with 12 MutationType ops
       TableID: 104
     *scop.CreateGCJobForIndex
       IndexID: 5
+      StatementForDropJob:
+        Statement: removed temporary index; ALTER TABLE defaultdb.public.t ALTER PRIMARY
+          KEY USING COLUMNS (k)
       TableID: 104
     *scop.MakeIndexAbsent
       IndexID: 5
@@ -432,7 +439,8 @@ PostCommitNonRevertiblePhase stage 4 of 4 with 6 MutationType ops
     *scop.CreateGCJobForIndex
       IndexID: 2
       StatementForDropJob:
-        Statement: ALTER TABLE defaultdb.public.t ALTER PRIMARY KEY USING COLUMNS (k)
+        Statement: removed primary index; ALTER TABLE defaultdb.public.t ALTER PRIMARY KEY
+          USING COLUMNS (k)
       TableID: 104
     *scop.MakeIndexAbsent
       EventBase: