sql/schemachanger: add enum type values as an element

Previously, our decomposition of enum types only included
an element for the type itself. This was inadequate because
for multi-region support we need to be able to iterate over
the values for an enum. This patch adds further decomposition
for enums.

Release note: None

pkg/ccl/schemachangerccl/testdata/decomp/multiregion

@@ -964,3 +964,18 @@ ElementState:
     objectId: 105
     parentSchemaId: 106
   Status: PUBLIC
+- EnumTypeValue:
+    logicalRepresentation: us-east1
+    physicalRepresentation: QA==
+    typeId: 105
+  Status: PUBLIC
+- EnumTypeValue:
+    logicalRepresentation: us-east2
+    physicalRepresentation: gA==
+    typeId: 105
+  Status: PUBLIC
+- EnumTypeValue:
+    logicalRepresentation: us-east3
+    physicalRepresentation: wA==
+    typeId: 105
+  Status: PUBLIC

pkg/ccl/schemachangerccl/testdata/end_to_end/drop_database_multiregion_primary_region

@@ -227,6 +227,9 @@ upsert descriptor #105
   +    - ABSENT
   +    - DROPPED
   +    - ABSENT
+  +    - ABSENT
+  +    - ABSENT
+  +    - ABSENT
   +    jobId: "1"
   +    relevantStatements:
   +    - statement:
@@ -241,6 +244,9 @@ upsert descriptor #105
   +    - 19
   +    - 20
   +    - 21
+  +    - 22
+  +    - 23
+  +    - 24
   +    targets:
   +    - elementProto:
   +        namespace:
@@ -297,6 +303,33 @@ upsert descriptor #105
   +        subWorkId: 1
   +      targetStatus: ABSENT
   +    - elementProto:
+  +        enumTypeValue:
+  +          logicalRepresentation: us-east1
+  +          physicalRepresentation: QA==
+  +          typeId: 105
+  +      metadata:
+  +        sourceElementId: 3
+  +        subWorkId: 1
+  +      targetStatus: ABSENT
+  +    - elementProto:
+  +        enumTypeValue:
+  +          logicalRepresentation: us-east2
+  +          physicalRepresentation: gA==
+  +          typeId: 105
+  +      metadata:
+  +        sourceElementId: 3
+  +        subWorkId: 1
+  +      targetStatus: ABSENT
+  +    - elementProto:
+  +        enumTypeValue:
+  +          logicalRepresentation: us-east3
+  +          physicalRepresentation: wA==
+  +          typeId: 105
+  +      metadata:
+  +        sourceElementId: 3
+  +        subWorkId: 1
+  +      targetStatus: ABSENT
+  +    - elementProto:
   +        objectParent:
   +          objectId: 105
   +          parentSchemaId: 106
@@ -432,13 +465,13 @@ upsert descriptor #107
   +        statement: DROP DATABASE multi_region_test_db CASCADE
   +        statementTag: DROP DATABASE
   +    targetRanks:
-  +    - 22
-  +    - 23
-  +    - 24
   +    - 25
   +    - 26
   +    - 27
   +    - 28
+  +    - 29
+  +    - 30
+  +    - 31
   +    targets:
   +    - elementProto:
   +        namespace:
@@ -556,9 +589,6 @@ upsert descriptor #108
   +        statement: DROP DATABASE multi_region_test_db CASCADE
   +        statementTag: DROP DATABASE
   +    targetRanks:
-  +    - 29
-  +    - 30
-  +    - 31
   +    - 32
   +    - 33
   +    - 34
@@ -576,6 +606,9 @@ upsert descriptor #108
   +    - 46
   +    - 47
   +    - 48
+  +    - 49
+  +    - 50
+  +    - 51
   +    targets:
   +    - elementProto:
   +        namespace:
@@ -830,9 +863,6 @@ upsert descriptor #108
   -        statement: DROP DATABASE multi_region_test_db CASCADE
   -        statementTag: DROP DATABASE
   -    targetRanks:
-  -    - 29
-  -    - 30
-  -    - 31
   -    - 32
   -    - 33
   -    - 34
@@ -850,6 +880,9 @@ upsert descriptor #108
   -    - 46
   -    - 47
   -    - 48
+  -    - 49
+  -    - 50
+  -    - 51
   -    targets:
   -    - elementProto:
   -        namespace:

pkg/sql/schemachanger/scbuild/testdata/drop_database

@@ -237,11 +237,11 @@ DROP DATABASE db1 CASCADE
       usesSequenceIds:
       - 107
     tableId: 110
-- [[ColumnFamily:{DescID: 109, ColumnFamilyID: 0, Name: primary}, ABSENT], PUBLIC]
+- [[ColumnFamily:{DescID: 109, Name: primary, ColumnFamilyID: 0}, ABSENT], PUBLIC]
   details:
     name: primary
     tableId: 109
-- [[ColumnFamily:{DescID: 110, ColumnFamilyID: 0, Name: primary}, ABSENT], PUBLIC]
+- [[ColumnFamily:{DescID: 110, Name: primary, ColumnFamilyID: 0}, ABSENT], PUBLIC]
   details:
     name: primary
     tableId: 110
@@ -734,6 +734,11 @@ DROP DATABASE db1 CASCADE
   details:
     arrayTypeId: 116
     typeId: 115
+- [[EnumTypeValue:{DescID: 115, Name: a}, ABSENT], PUBLIC]
+  details:
+    logicalRepresentation: a
+    physicalRepresentation: gA==
+    typeId: 115
 - [[IndexColumn:{DescID: 109, ColumnID: 1, IndexID: 1}, ABSENT], PUBLIC]
   details:
     columnId: 1

pkg/sql/schemachanger/scbuild/testdata/drop_owned_by

@@ -151,11 +151,11 @@ DROP OWNED BY r
       usesSequenceIds:
       - 106
     tableId: 109
-- [[ColumnFamily:{DescID: 108, ColumnFamilyID: 0, Name: primary}, ABSENT], PUBLIC]
+- [[ColumnFamily:{DescID: 108, Name: primary, ColumnFamilyID: 0}, ABSENT], PUBLIC]
   details:
     name: primary
     tableId: 108
-- [[ColumnFamily:{DescID: 109, ColumnFamilyID: 0, Name: primary}, ABSENT], PUBLIC]
+- [[ColumnFamily:{DescID: 109, Name: primary, ColumnFamilyID: 0}, ABSENT], PUBLIC]
   details:
     name: primary
     tableId: 109
@@ -428,6 +428,11 @@ DROP OWNED BY r
   details:
     arrayTypeId: 112
     typeId: 111
+- [[EnumTypeValue:{DescID: 111, Name: a}, ABSENT], PUBLIC]
+  details:
+    logicalRepresentation: a
+    physicalRepresentation: gA==
+    typeId: 111
 - [[IndexColumn:{DescID: 108, ColumnID: 1, IndexID: 1}, ABSENT], PUBLIC]
   details:
     columnId: 1

pkg/sql/schemachanger/scbuild/testdata/drop_schema

@@ -227,7 +227,7 @@ DROP SCHEMA defaultdb.SC1 CASCADE
       usesSequenceIds:
       - 106
     tableId: 107
-- [[ColumnFamily:{DescID: 107, ColumnFamilyID: 0, Name: primary}, ABSENT], PUBLIC]
+- [[ColumnFamily:{DescID: 107, Name: primary, ColumnFamilyID: 0}, ABSENT], PUBLIC]
   details:
     name: primary
     tableId: 107
@@ -710,6 +710,11 @@ DROP SCHEMA defaultdb.SC1 CASCADE
   details:
     arrayTypeId: 113
     typeId: 112
+- [[EnumTypeValue:{DescID: 112, Name: a}, ABSENT], PUBLIC]
+  details:
+    logicalRepresentation: a
+    physicalRepresentation: gA==
+    typeId: 112
 - [[IndexColumn:{DescID: 107, ColumnID: 1, IndexID: 1}, ABSENT], PUBLIC]
   details:
     columnId: 1

pkg/sql/schemachanger/scbuild/testdata/drop_table

@@ -117,7 +117,7 @@ DROP TABLE defaultdb.shipments CASCADE;
       usesSequenceIds:
       - 106
     tableId: 109
-- [[ColumnFamily:{DescID: 109, ColumnFamilyID: 0, Name: primary}, ABSENT], PUBLIC]
+- [[ColumnFamily:{DescID: 109, Name: primary, ColumnFamilyID: 0}, ABSENT], PUBLIC]
   details:
     name: primary
     tableId: 109

pkg/sql/schemachanger/scbuild/testdata/drop_type

@@ -25,6 +25,11 @@ DROP TYPE defaultdb.typ
   details:
     arrayTypeId: 105
     typeId: 104
+- [[EnumTypeValue:{DescID: 104, Name: a}, ABSENT], PUBLIC]
+  details:
+    logicalRepresentation: a
+    physicalRepresentation: gA==
+    typeId: 104
 - [[Namespace:{DescID: 104, Name: typ, ReferencedDescID: 100}, ABSENT], PUBLIC]
   details:
     databaseId: 100

pkg/sql/schemachanger/scdecomp/decomp.go

@@ -173,6 +173,13 @@ func (w *walkCtx) walkType(typ catalog.TypeDescriptor) {
 			ArrayTypeID:   typ.GetArrayTypeID(),
 			IsMultiRegion: typ.GetKind() == descpb.TypeDescriptor_MULTIREGION_ENUM,
 		})
+		for ord := 0; ord < typ.NumEnumMembers(); ord++ {
+			w.ev(descriptorStatus(typ), &scpb.EnumTypeValue{
+				TypeID:                 typ.GetID(),
+				PhysicalRepresentation: typ.GetMemberPhysicalRepresentation(ord),
+				LogicalRepresentation:  typ.GetMemberLogicalRepresentation(ord),
+			})
+		}
 	default:
 		panic(errors.AssertionFailedf("unsupported type kind %q", typ.GetKind()))
 	}

pkg/sql/schemachanger/scdecomp/testdata/other

@@ -176,6 +176,11 @@ ElementState:
     objectId: 110
     parentSchemaId: 106
   Status: PUBLIC
+- EnumTypeValue:
+    logicalRepresentation: a
+    physicalRepresentation: gA==
+    typeId: 110
+  Status: PUBLIC
 
 decompose
 v1

pkg/sql/schemachanger/scdecomp/testdata/type

@@ -52,6 +52,16 @@ ElementState:
     objectId: 104
     parentSchemaId: 101
   Status: PUBLIC
+- EnumTypeValue:
+    logicalRepresentation: hello
+    physicalRepresentation: QA==
+    typeId: 104
+  Status: PUBLIC
+- EnumTypeValue:
+    logicalRepresentation: hi
+    physicalRepresentation: gA==
+    typeId: 104
+  Status: PUBLIC
 
 decompose
 tbl

pkg/sql/schemachanger/scpb/elements.proto

@@ -112,6 +112,9 @@ message ElementProto {
 
   // Object elements.
   ObjectParent object_parent = 100 [(gogoproto.moretags) = "parent:\"AliasType, EnumType, Table, View, Sequence\""];
+
+  // Enum type elements
+  EnumTypeValue enum_type_value = 120 [(gogoproto.moretags) = "parent:\"EnumType\""];
 }
 
 // TypeT is a wrapper for a types.T which contains its user-defined type ID
@@ -483,3 +486,9 @@ message IndexColumn {
   // Direction is only populated for KEY columns.
   sql.catalog.catpb.IndexColumn.Direction direction = 6;
 }
+
+message EnumTypeValue {
+  uint32 type_id = 1 [(gogoproto.customname) = "TypeID", (gogoproto.casttype) = "github.com/cockroachdb/cockroach/pkg/sql/sem/catid.DescID"];
+  bytes physical_representation = 2;
+  string logical_representation = 3;
+}

pkg/sql/schemachanger/scpb/uml/table.puml

@@ -256,6 +256,12 @@ object ObjectParent
 ObjectParent :  ObjectID
 ObjectParent :  ParentSchemaID
 
+object EnumTypeValue
+
+EnumTypeValue :  TypeID
+EnumTypeValue : []PhysicalRepresentation
+EnumTypeValue :  LogicalRepresentation
+
 Table <|-- ColumnFamily
 Table <|-- Column
 View <|-- Column
@@ -332,4 +338,5 @@ EnumType <|-- ObjectParent
 Table <|-- ObjectParent
 View <|-- ObjectParent
 Sequence <|-- ObjectParent
+EnumType <|-- EnumTypeValue
 @enduml

pkg/sql/schemachanger/scplan/internal/opgen/BUILD.bazel

@@ -21,6 +21,7 @@ go_library(
         "opgen_database_region_config.go",
         "opgen_database_role_setting.go",
         "opgen_enum_type.go",
+        "opgen_enum_type_value.go",
         "opgen_foreign_key_constraint.go",
         "opgen_index_column.go",
         "opgen_index_comment.go",

pkg/sql/schemachanger/scplan/internal/opgen/opgen_enum_type_value.go

@@ -0,0 +1,37 @@
+// Copyright 2021 The Cockroach Authors.
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package opgen
+
+import (
+	"github.com/cockroachdb/cockroach/pkg/sql/schemachanger/scop"
+	"github.com/cockroachdb/cockroach/pkg/sql/schemachanger/scpb"
+)
+
+func init() {
+	opRegistry.register((*scpb.EnumTypeValue)(nil),
+		toPublic(
+			scpb.Status_ABSENT,
+			to(scpb.Status_PUBLIC,
+				emit(func(this *scpb.EnumTypeValue) scop.Op {
+					return notImplemented(this)
+				}),
+			),
+		),
+		toAbsent(
+			scpb.Status_PUBLIC,
+			to(scpb.Status_ABSENT,
+				emit(func(this *scpb.EnumTypeValue) scop.Op {
+					return notImplemented(this)
+				}),
+			),
+		),
+	)
+}

pkg/sql/schemachanger/scplan/internal/rules/op_drop.go

@@ -231,6 +231,7 @@ func init() {
 				(*scpb.ColumnFamily)(nil),
 				(*scpb.Owner)(nil),
 				(*scpb.UserPrivileges)(nil),
+				(*scpb.EnumTypeValue)(nil),
 			),
 			joinOnDescID(desc.el, dep.el, descID),
 			desc.joinTarget(),