-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
type_desc_builder.go
199 lines (179 loc) · 6.5 KB
/
type_desc_builder.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
// 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 typedesc
import (
"github.com/cockroachdb/cockroach/pkg/sql/catalog"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/catprivilege"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
"github.com/cockroachdb/cockroach/pkg/sql/privilege"
"github.com/cockroachdb/cockroach/pkg/util/hlc"
"github.com/cockroachdb/cockroach/pkg/util/protoutil"
"github.com/cockroachdb/errors"
)
// TypeDescriptorBuilder is an extension of catalog.DescriptorBuilder
// for type descriptors.
type TypeDescriptorBuilder interface {
catalog.DescriptorBuilder
BuildImmutableType() catalog.TypeDescriptor
BuildExistingMutableType() *Mutable
BuildCreatedMutableType() *Mutable
}
type typeDescriptorBuilder struct {
original *descpb.TypeDescriptor
maybeModified *descpb.TypeDescriptor
mvccTimestamp hlc.Timestamp
isUncommittedVersion bool
changes catalog.PostDeserializationChanges
}
var _ TypeDescriptorBuilder = &typeDescriptorBuilder{}
// NewBuilder returns a new TypeDescriptorBuilder instance by delegating to
// NewBuilderWithMVCCTimestamp with an empty MVCC timestamp.
//
// Callers must assume that the given protobuf has already been treated with the
// MVCC timestamp beforehand.
func NewBuilder(desc *descpb.TypeDescriptor) TypeDescriptorBuilder {
return NewBuilderWithMVCCTimestamp(desc, hlc.Timestamp{})
}
// NewBuilderWithMVCCTimestamp creates a new TypeDescriptorBuilder instance
// for building table descriptors.
func NewBuilderWithMVCCTimestamp(
desc *descpb.TypeDescriptor, mvccTimestamp hlc.Timestamp,
) TypeDescriptorBuilder {
return newBuilder(
desc,
mvccTimestamp,
false, /* isUncommittedVersion */
catalog.PostDeserializationChanges{},
)
}
func newBuilder(
desc *descpb.TypeDescriptor,
mvccTimestamp hlc.Timestamp,
isUncommittedVersion bool,
changes catalog.PostDeserializationChanges,
) TypeDescriptorBuilder {
b := &typeDescriptorBuilder{
original: protoutil.Clone(desc).(*descpb.TypeDescriptor),
mvccTimestamp: mvccTimestamp,
isUncommittedVersion: isUncommittedVersion,
changes: changes,
}
return b
}
// DescriptorType implements the catalog.DescriptorBuilder interface.
func (tdb *typeDescriptorBuilder) DescriptorType() catalog.DescriptorType {
return catalog.Type
}
// RunPostDeserializationChanges implements the catalog.DescriptorBuilder
// interface.
func (tdb *typeDescriptorBuilder) RunPostDeserializationChanges() (err error) {
defer func() {
err = errors.Wrapf(err, "type %q (%d)", tdb.original.Name, tdb.original.ID)
}()
// Set the ModificationTime field before doing anything else.
// Other changes may depend on it.
mustSetModTime, err := descpb.MustSetModificationTime(
tdb.original.ModificationTime, tdb.mvccTimestamp, tdb.original.Version, tdb.original.State,
)
if err != nil {
return err
}
tdb.maybeModified = protoutil.Clone(tdb.original).(*descpb.TypeDescriptor)
if mustSetModTime {
tdb.maybeModified.ModificationTime = tdb.mvccTimestamp
tdb.changes.Add(catalog.SetModTimeToMVCCTimestamp)
}
fixedPrivileges := catprivilege.MaybeFixPrivileges(
&tdb.maybeModified.Privileges,
tdb.maybeModified.GetParentID(),
tdb.maybeModified.GetParentSchemaID(),
privilege.Type,
tdb.maybeModified.GetName(),
)
if fixedPrivileges {
tdb.changes.Add(catalog.UpgradedPrivileges)
}
return nil
}
// RunRestoreChanges implements the catalog.DescriptorBuilder interface.
func (tdb *typeDescriptorBuilder) RunRestoreChanges(_ func(id descpb.ID) catalog.Descriptor) error {
return nil
}
// BuildImmutable implements the catalog.DescriptorBuilder interface.
func (tdb *typeDescriptorBuilder) BuildImmutable() catalog.Descriptor {
return tdb.BuildImmutableType()
}
// BuildImmutableType returns an immutable type descriptor.
func (tdb *typeDescriptorBuilder) BuildImmutableType() catalog.TypeDescriptor {
desc := tdb.maybeModified
if desc == nil {
desc = tdb.original
}
imm := makeImmutable(desc, tdb.isUncommittedVersion, tdb.changes)
return &imm
}
// BuildExistingMutable implements the catalog.DescriptorBuilder interface.
func (tdb *typeDescriptorBuilder) BuildExistingMutable() catalog.MutableDescriptor {
return tdb.BuildExistingMutableType()
}
// BuildExistingMutableType returns a mutable descriptor for a type
// which already exists.
func (tdb *typeDescriptorBuilder) BuildExistingMutableType() *Mutable {
if tdb.maybeModified == nil {
tdb.maybeModified = protoutil.Clone(tdb.original).(*descpb.TypeDescriptor)
}
clusterVersion := makeImmutable(tdb.original, false, /* isUncommitedVersion */
catalog.PostDeserializationChanges{})
return &Mutable{
immutable: makeImmutable(tdb.maybeModified, false /* isUncommitedVersion */, tdb.changes),
ClusterVersion: &clusterVersion,
}
}
// BuildCreatedMutable implements the catalog.DescriptorBuilder interface.
func (tdb *typeDescriptorBuilder) BuildCreatedMutable() catalog.MutableDescriptor {
return tdb.BuildCreatedMutableType()
}
// BuildCreatedMutableType returns a mutable descriptor for a type
// which is in the process of being created.
func (tdb *typeDescriptorBuilder) BuildCreatedMutableType() *Mutable {
desc := tdb.maybeModified
if desc == nil {
desc = tdb.original
}
return &Mutable{
immutable: makeImmutable(desc, tdb.isUncommittedVersion, tdb.changes),
}
}
func makeImmutable(
desc *descpb.TypeDescriptor,
isUncommittedVersion bool,
changes catalog.PostDeserializationChanges,
) immutable {
immutDesc := immutable{
TypeDescriptor: *desc,
isUncommittedVersion: isUncommittedVersion,
changes: changes,
}
// Initialize metadata specific to the TypeDescriptor kind.
switch immutDesc.Kind {
case descpb.TypeDescriptor_ENUM, descpb.TypeDescriptor_MULTIREGION_ENUM:
immutDesc.logicalReps = make([]string, len(desc.EnumMembers))
immutDesc.physicalReps = make([][]byte, len(desc.EnumMembers))
immutDesc.readOnlyMembers = make([]bool, len(desc.EnumMembers))
for i := range desc.EnumMembers {
member := &desc.EnumMembers[i]
immutDesc.logicalReps[i] = member.LogicalRepresentation
immutDesc.physicalReps[i] = member.PhysicalRepresentation
immutDesc.readOnlyMembers[i] =
member.Capability == descpb.TypeDescriptor_EnumMember_READ_ONLY
}
}
return immutDesc
}