-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
alter_database.go
859 lines (761 loc) · 26.5 KB
/
alter_database.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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
// Copyright 2020 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 sql
import (
"context"
"fmt"
"github.com/cockroachdb/cockroach/pkg/keys"
"github.com/cockroachdb/cockroach/pkg/security"
"github.com/cockroachdb/cockroach/pkg/server/telemetry"
"github.com/cockroachdb/cockroach/pkg/sql/catalog"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/dbdesc"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/multiregion"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/typedesc"
"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgcode"
"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror"
"github.com/cockroachdb/cockroach/pkg/sql/roleoption"
"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
"github.com/cockroachdb/cockroach/pkg/sql/sqlerrors"
"github.com/cockroachdb/cockroach/pkg/sql/sqltelemetry"
"github.com/cockroachdb/cockroach/pkg/util/log/eventpb"
"github.com/cockroachdb/errors"
)
type alterDatabaseOwnerNode struct {
n *tree.AlterDatabaseOwner
desc *dbdesc.Mutable
}
// AlterDatabaseOwner transforms a tree.AlterDatabaseOwner into a plan node.
func (p *planner) AlterDatabaseOwner(
ctx context.Context, n *tree.AlterDatabaseOwner,
) (planNode, error) {
if err := checkSchemaChangeEnabled(
ctx,
p.ExecCfg(),
"ALTER DATABASE",
); err != nil {
return nil, err
}
_, dbDesc, err := p.Descriptors().GetMutableDatabaseByName(ctx, p.txn, string(n.Name),
tree.DatabaseLookupFlags{Required: true})
if err != nil {
return nil, err
}
return &alterDatabaseOwnerNode{n: n, desc: dbDesc}, nil
}
func (n *alterDatabaseOwnerNode) startExec(params runParams) error {
newOwner := n.n.Owner
oldOwner := n.desc.GetPrivileges().Owner()
if err := params.p.checkCanAlterDatabaseAndSetNewOwner(params.ctx, n.desc, newOwner); err != nil {
return err
}
// If the owner we want to set to is the current owner, do a no-op.
if newOwner == oldOwner {
return nil
}
if err := params.p.writeNonDropDatabaseChange(
params.ctx,
n.desc,
tree.AsStringWithFQNames(n.n, params.Ann()),
); err != nil {
return err
}
return nil
}
// checkCanAlterDatabaseAndSetNewOwner handles privilege checking and setting new owner.
// Called in ALTER DATABASE and REASSIGN OWNED BY.
func (p *planner) checkCanAlterDatabaseAndSetNewOwner(
ctx context.Context, desc catalog.MutableDescriptor, newOwner security.SQLUsername,
) error {
if err := p.checkCanAlterToNewOwner(ctx, desc, newOwner); err != nil {
return err
}
// To alter the owner, the user also has to have CREATEDB privilege.
if err := p.CheckRoleOption(ctx, roleoption.CREATEDB); err != nil {
return err
}
privs := desc.GetPrivileges()
privs.SetOwner(newOwner)
// Log Alter Database Owner event. This is an auditable log event and is
// recorded in the same transaction as the table descriptor update.
return p.logEvent(ctx,
desc.GetID(),
&eventpb.AlterDatabaseOwner{
DatabaseName: desc.GetName(),
Owner: newOwner.Normalized(),
})
}
func (n *alterDatabaseOwnerNode) Next(runParams) (bool, error) { return false, nil }
func (n *alterDatabaseOwnerNode) Values() tree.Datums { return tree.Datums{} }
func (n *alterDatabaseOwnerNode) Close(context.Context) {}
type alterDatabaseAddRegionNode struct {
n *tree.AlterDatabaseAddRegion
desc *dbdesc.Mutable
}
// AlterDatabaseAddRegion transforms a tree.AlterDatabaseAddRegion into a plan node.
func (p *planner) AlterDatabaseAddRegion(
ctx context.Context, n *tree.AlterDatabaseAddRegion,
) (planNode, error) {
if err := checkSchemaChangeEnabled(
ctx,
p.ExecCfg(),
"ALTER DATABASE",
); err != nil {
return nil, err
}
_, dbDesc, err := p.Descriptors().GetMutableDatabaseByName(ctx, p.txn, string(n.Name),
tree.DatabaseLookupFlags{Required: true},
)
if err != nil {
return nil, err
}
return &alterDatabaseAddRegionNode{n: n, desc: dbDesc}, nil
}
// GetMultiRegionEnumAddValuePlacementCCL is the public hook point for the
// CCL-licensed code to determine the placement for a new region inside
// a region enum.
var GetMultiRegionEnumAddValuePlacementCCL = func(
execCfg *ExecutorConfig, typeDesc *typedesc.Mutable, region tree.Name,
) (tree.AlterTypeAddValue, error) {
return tree.AlterTypeAddValue{}, sqlerrors.NewCCLRequiredError(
errors.New("adding regions to a multi-region database requires a CCL binary"),
)
}
func (n *alterDatabaseAddRegionNode) startExec(params runParams) error {
// To add a region, the user has to have CREATEDB privileges, or be an admin user.
if err := params.p.CheckRoleOption(params.ctx, roleoption.CREATEDB); err != nil {
return err
}
// If we get to this point and the database is not a multi-region database, it means that
// the database doesn't yet have a primary region. Since we need a primary region before
// we can add a region, return an error here.
if !n.desc.IsMultiRegion() {
return errors.WithHintf(
pgerror.Newf(pgcode.InvalidDatabaseDefinition, "cannot add region %s to database %s",
n.n.Region.String(),
n.n.Name.String(),
),
"you must add a PRIMARY REGION first using ALTER DATABASE %s PRIMARY REGION %s",
n.n.Name.String(),
n.n.Region.String(),
)
}
if err := params.p.validateZoneConfigForMultiRegionDatabaseWasNotModifiedByUser(
params.ctx,
&n.desc.Immutable,
); err != nil {
return err
}
telemetry.Inc(sqltelemetry.AlterDatabaseAddRegionCounter)
if err := params.p.checkRegionIsCurrentlyActive(
params.ctx,
descpb.RegionName(n.n.Region),
); err != nil {
return err
}
// Get the type descriptor for the multi-region enum.
typeDesc, err := params.p.Descriptors().GetMutableTypeVersionByID(
params.ctx,
params.p.txn,
n.desc.RegionConfig.RegionEnumID,
)
if err != nil {
return err
}
placement, err := GetMultiRegionEnumAddValuePlacementCCL(
params.p.ExecCfg(),
typeDesc,
n.n.Region,
)
if err != nil {
return err
}
// Add the new region value to the enum. This function adds the value to the enum and
// persists the new value to the supplied type descriptor.
jobDesc := fmt.Sprintf("Adding new region value %q to %q", tree.EnumValue(n.n.Region), tree.RegionEnum)
if err := params.p.addEnumValue(
params.ctx,
typeDesc,
&placement,
jobDesc,
); err != nil {
if pgerror.GetPGCode(err) == pgcode.DuplicateObject {
return errors.Newf("region %q already added to database", n.n.Region)
}
return err
}
// Validate the type descriptor after the changes. We have to do this explicitly here, because
// we're using an internal call to addEnumValue above which doesn't perform validation.
if err := validateDescriptor(params.ctx, params.p, typeDesc); err != nil {
return err
}
// Log Alter Database Add Region event. This is an auditable log event and is
// recorded in the same transaction as the database descriptor, type
// descriptor, and zone configuration updates.
return params.p.logEvent(params.ctx,
n.desc.GetID(),
&eventpb.AlterDatabaseAddRegion{
DatabaseName: n.desc.GetName(),
RegionName: n.n.Region.String(),
})
}
func (n *alterDatabaseAddRegionNode) Next(runParams) (bool, error) { return false, nil }
func (n *alterDatabaseAddRegionNode) Values() tree.Datums { return tree.Datums{} }
func (n *alterDatabaseAddRegionNode) Close(context.Context) {}
type alterDatabaseDropRegionNode struct {
n *tree.AlterDatabaseDropRegion
desc *dbdesc.Mutable
removingPrimaryRegion bool
toDrop []*typedesc.Mutable
}
// AlterDatabaseDropRegion transforms a tree.AlterDatabaseDropRegion into a plan node.
func (p *planner) AlterDatabaseDropRegion(
ctx context.Context, n *tree.AlterDatabaseDropRegion,
) (planNode, error) {
if err := checkSchemaChangeEnabled(
ctx,
p.ExecCfg(),
"ALTER DATABASE",
); err != nil {
return nil, err
}
_, dbDesc, err := p.Descriptors().GetMutableDatabaseByName(ctx, p.txn, string(n.Name),
tree.DatabaseLookupFlags{Required: true})
if err != nil {
return nil, err
}
// To drop the region, the user has to have CREATEDB privileges,
// or be an admin user.
if err := p.CheckRoleOption(ctx, roleoption.CREATEDB); err != nil {
return nil, err
}
if !dbDesc.IsMultiRegion() {
return nil, pgerror.New(pgcode.InvalidDatabaseDefinition, "database has no regions to drop")
}
if err := p.validateZoneConfigForMultiRegionDatabaseWasNotModifiedByUser(
ctx,
&dbDesc.Immutable,
); err != nil {
return nil, err
}
removingPrimaryRegion := false
var toDrop []*typedesc.Mutable
if dbDesc.RegionConfig.PrimaryRegion == descpb.RegionName(n.Region) {
removingPrimaryRegion = true
typeID, err := dbDesc.MultiRegionEnumID()
if err != nil {
return nil, err
}
typeDesc, err := p.Descriptors().GetMutableTypeVersionByID(ctx, p.txn, typeID)
if err != nil {
return nil, err
}
// Ensure that there's only 1 region on the multi-region enum (the primary
// region) as this can only be dropped once all other regions have been
// dropped. This check must account for regions that are transitioning,
// as transitions aren't guaranteed to succeed.
regions, err := typeDesc.RegionNamesIncludingTransitioning()
if err != nil {
return nil, err
}
if len(regions) != 1 {
return nil, errors.WithHintf(
errors.Newf("cannot drop region %q", dbDesc.RegionConfig.PrimaryRegion),
"You must designate another region as the primary region using "+
"ALTER DATABASE %s PRIMARY REGION <region name> or remove all other regions before "+
"attempting to drop region %q", dbDesc.GetName(), n.Region,
)
}
// When the last region is removed from the database, we also clean up
// detritus multi-region type descriptor. This includes both the
// type descriptor and its array counterpart.
toDrop = append(toDrop, typeDesc)
arrayTypeDesc, err := p.Descriptors().GetMutableTypeVersionByID(ctx, p.txn, typeDesc.ArrayTypeID)
if err != nil {
return nil, err
}
toDrop = append(toDrop, arrayTypeDesc)
for _, desc := range toDrop {
// canDropTypeDesc ensures that there are no references to tables on the
// type descriptor. This is what we expect when dropping the final
// (primary) region from a database, as REGIONAL BY ROW tables and
// REGIONAL BY TABLE tables (homed explicitly in the final region) will
// store a reference on the type descriptor. It is sufficient to simply
// check for stored references and not go through the validation that
// happens in the type_schema changer in this scenario.
if err := p.canDropTypeDesc(ctx, desc, tree.DropRestrict); err != nil {
return nil, errors.Wrapf(
err, "error removing primary region from database %s", dbDesc.Name)
}
}
}
// Ensure survivability goal and number of regions after the drop jive.
regionConfig, err := SynthesizeRegionConfig(ctx, p.txn, dbDesc.ID, p.Descriptors())
if err != nil {
return nil, err
}
if err := multiregion.CanDropRegion(regionConfig); err != nil {
return nil, err
}
return &alterDatabaseDropRegionNode{
n,
dbDesc,
removingPrimaryRegion,
toDrop,
}, nil
}
// removeLocalityConfigFromAllTablesInDB removes the locality config from all
// tables under the supplied database.
func removeLocalityConfigFromAllTablesInDB(
ctx context.Context, p *planner, desc *dbdesc.Immutable,
) error {
if !desc.IsMultiRegion() {
return errors.AssertionFailedf(
"cannot remove locality configs from tables in non multi-region database with ID %d",
desc.GetID(),
)
}
b := p.Txn().NewBatch()
if err := forEachTableDesc(ctx, p, desc, hideVirtual,
func(immutable *dbdesc.Immutable, _ string, desc catalog.TableDescriptor) error {
mutDesc, err := p.Descriptors().GetMutableTableByID(ctx, p.txn, desc.GetID(), tree.ObjectLookupFlags{})
if err != nil {
return err
}
mutDesc.LocalityConfig = nil
if err := p.writeSchemaChangeToBatch(ctx, mutDesc, b); err != nil {
return err
}
return nil
}); err != nil {
return err
}
return p.Txn().Run(ctx, b)
}
func (n *alterDatabaseDropRegionNode) startExec(params runParams) error {
typeDesc, err := params.p.Descriptors().GetMutableTypeVersionByID(
params.ctx,
params.p.txn,
n.desc.RegionConfig.RegionEnumID,
)
if err != nil {
return err
}
if n.removingPrimaryRegion {
telemetry.Inc(sqltelemetry.AlterDatabaseDropPrimaryRegionCounter)
for _, desc := range n.toDrop {
jobDesc := fmt.Sprintf("drop multi-region enum with ID %d", desc.ID)
err := params.p.dropTypeImpl(params.ctx, desc, jobDesc, true /* queueJob */)
if err != nil {
return err
}
}
err = removeLocalityConfigFromAllTablesInDB(params.ctx, params.p, &n.desc.Immutable)
if err != nil {
return errors.Wrap(err, "error removing locality configs from tables")
}
n.desc.UnsetMultiRegionConfig()
if err := discardMultiRegionFieldsForDatabaseZoneConfig(
params.ctx,
n.desc.ID,
params.p.txn,
params.p.execCfg,
); err != nil {
return err
}
} else {
telemetry.Inc(sqltelemetry.AlterDatabaseDropRegionCounter)
// dropEnumValue tries to remove the region value from the multi-region type
// descriptor. Among other things, it validates that the region is not in
// use by any tables. A region is considered "in use" if either a REGIONAL BY
// TABLE table is explicitly homed in that region or a row in a REGIONAL BY
// ROW table is homed in that region. The type schema changer is responsible
// for all the requisite validation.
if err := params.p.dropEnumValue(params.ctx, typeDesc, tree.EnumValue(n.n.Region)); err != nil {
return err
}
}
if err := params.p.writeNonDropDatabaseChange(
params.ctx,
n.desc,
tree.AsStringWithFQNames(n.n, params.Ann()),
); err != nil {
return err
}
// Log Alter Database Drop Region event. This is an auditable log event and is
// recorded in the same transaction as the table descriptor update.
return params.p.logEvent(params.ctx,
n.desc.GetID(),
&eventpb.AlterDatabaseDropRegion{
DatabaseName: n.desc.GetName(),
RegionName: n.n.Region.String(),
})
}
func (n *alterDatabaseDropRegionNode) Next(runParams) (bool, error) { return false, nil }
func (n *alterDatabaseDropRegionNode) Values() tree.Datums { return tree.Datums{} }
func (n *alterDatabaseDropRegionNode) Close(context.Context) {}
type alterDatabasePrimaryRegionNode struct {
n *tree.AlterDatabasePrimaryRegion
desc *dbdesc.Mutable
}
// AlterDatabasePrimaryRegion transforms a tree.AlterDatabasePrimaryRegion into a plan node.
func (p *planner) AlterDatabasePrimaryRegion(
ctx context.Context, n *tree.AlterDatabasePrimaryRegion,
) (planNode, error) {
if err := checkSchemaChangeEnabled(
ctx,
p.ExecCfg(),
"ALTER DATABASE",
); err != nil {
return nil, err
}
_, dbDesc, err := p.Descriptors().GetMutableDatabaseByName(ctx, p.txn, string(n.Name),
tree.DatabaseLookupFlags{Required: true},
)
if err != nil {
return nil, err
}
return &alterDatabasePrimaryRegionNode{n: n, desc: dbDesc}, nil
}
// switchPrimaryRegion performs the work in ALTER DATABASE ... PRIMARY REGION for the case
// where the database is already a multi-region database.
func (n *alterDatabasePrimaryRegionNode) switchPrimaryRegion(params runParams) error {
telemetry.Inc(sqltelemetry.SwitchPrimaryRegionCounter)
// First check if the new primary region has been added to the database. If not, return
// an error, as it must be added before it can be used as a primary region.
prevRegionConfig, err := SynthesizeRegionConfig(params.ctx, params.p.txn, n.desc.ID, params.p.Descriptors())
if err != nil {
return err
}
found := false
for _, r := range prevRegionConfig.Regions() {
if r == descpb.RegionName(n.n.PrimaryRegion) {
found = true
break
}
}
if !found {
return errors.WithHintf(
pgerror.Newf(pgcode.InvalidName,
"region %s has not been added to the database",
n.n.PrimaryRegion.String(),
),
"you must add the region to the database before setting it as primary region, using "+
"ALTER DATABASE %s ADD REGION %s",
n.n.Name.String(),
n.n.PrimaryRegion.String(),
)
}
// Get the type descriptor for the multi-region enum.
typeDesc, err := params.p.Descriptors().GetMutableTypeVersionByID(
params.ctx,
params.p.txn,
n.desc.RegionConfig.RegionEnumID)
if err != nil {
return err
}
// To update the primary region we need to modify the database descriptor,
// update the multi-region enum, and write a new zone configuration.
n.desc.RegionConfig.PrimaryRegion = descpb.RegionName(n.n.PrimaryRegion)
if err := params.p.writeNonDropDatabaseChange(
params.ctx,
n.desc,
tree.AsStringWithFQNames(n.n, params.Ann()),
); err != nil {
return err
}
// Update the primary region in the type descriptor, and write it back out.
typeDesc.RegionConfig.PrimaryRegion = descpb.RegionName(n.n.PrimaryRegion)
if err := params.p.writeTypeDesc(params.ctx, typeDesc); err != nil {
return err
}
updatedRegionConfig, err := SynthesizeRegionConfig(
params.ctx, params.p.txn, n.desc.ID, params.p.Descriptors(),
)
if err != nil {
return err
}
// Update the database's zone configuration.
if err := ApplyZoneConfigFromDatabaseRegionConfig(
params.ctx,
n.desc.ID,
updatedRegionConfig,
params.p.txn,
params.p.execCfg,
); err != nil {
return err
}
return nil
}
// addDefaultLocalityConfigToAllTables adds a default locality config to all
// tables inside the supplied database. The default locality config indicates
// that the table is a REGIONAL BY TABLE table homed in the primary region of
// the database.
func addDefaultLocalityConfigToAllTables(
ctx context.Context, p *planner, dbDesc *dbdesc.Immutable, regionEnumID descpb.ID,
) error {
if !dbDesc.IsMultiRegion() {
return errors.AssertionFailedf(
"cannot add locality config to tables in non multi-region database with ID %d",
dbDesc.GetID(),
)
}
b := p.Txn().NewBatch()
if err := forEachTableDesc(ctx, p, dbDesc, hideVirtual,
func(immutable *dbdesc.Immutable, _ string, desc catalog.TableDescriptor) error {
mutDesc, err := p.Descriptors().GetMutableTableByID(
ctx, p.txn, desc.GetID(), tree.ObjectLookupFlags{},
)
if err != nil {
return err
}
if err := checkCanConvertTableToMultiRegion(dbDesc, mutDesc); err != nil {
return err
}
if err := p.alterTableDescLocalityToRegionalByTable(
ctx, tree.PrimaryRegionNotSpecifiedName, mutDesc, regionEnumID,
); err != nil {
return err
}
if err := p.writeSchemaChangeToBatch(ctx, mutDesc, b); err != nil {
return err
}
return nil
}); err != nil {
return err
}
return p.Txn().Run(ctx, b)
}
// checkCanConvertTableToMultiRegion checks whether a given table can be converted
// to a multi-region table.
func checkCanConvertTableToMultiRegion(
dbDesc catalog.DatabaseDescriptor, tableDesc catalog.TableDescriptor,
) error {
if tableDesc.GetPrimaryIndex().GetPartitioning().NumColumns > 0 {
return errors.WithDetailf(
pgerror.Newf(
pgcode.ObjectNotInPrerequisiteState,
"cannot convert database %s to a multi-region database",
dbDesc.GetName(),
),
"cannot convert table %s to a multi-region table as it is partitioned",
tableDesc.GetName(),
)
}
for _, idx := range tableDesc.NonDropIndexes() {
if idx.GetPartitioning().NumColumns > 0 {
return errors.WithDetailf(
pgerror.Newf(
pgcode.ObjectNotInPrerequisiteState,
"cannot convert database %s to a multi-region database",
dbDesc.GetName(),
),
"cannot convert table %s to a multi-region table as it has index/constraint %s with partitioning",
tableDesc.GetName(),
idx.GetName(),
)
}
}
// TODO(#57668): check zone configurations are not set here
return nil
}
// setInitialPrimaryRegion sets the primary region in cases where the database
// isn't already a multi-region database.
func (n *alterDatabasePrimaryRegionNode) setInitialPrimaryRegion(params runParams) error {
telemetry.Inc(sqltelemetry.SetInitialPrimaryRegionCounter)
// Create the region config structure to be added to the database descriptor.
regionConfig, err := params.p.maybeInitializeMultiRegionMetadata(
params.ctx,
tree.SurvivalGoalDefault,
n.n.PrimaryRegion,
[]tree.Name{n.n.PrimaryRegion},
)
if err != nil {
return err
}
// Set the region config on the database descriptor.
if err := n.desc.SetInitialMultiRegionConfig(regionConfig); err != nil {
return err
}
if err := addDefaultLocalityConfigToAllTables(
params.ctx,
params.p,
&n.desc.Immutable,
regionConfig.RegionEnumID(),
); err != nil {
return err
}
// Write the modified database descriptor.
if err := params.p.writeNonDropDatabaseChange(
params.ctx,
n.desc,
tree.AsStringWithFQNames(n.n, params.Ann()),
); err != nil {
return err
}
// Initialize that multi-region database by creating the multi-region enum
// and the database-level zone configuration.
return params.p.maybeInitializeMultiRegionDatabase(params.ctx, n.desc, regionConfig)
}
func (n *alterDatabasePrimaryRegionNode) startExec(params runParams) error {
// To add a region, the user has to have CREATEDB privileges, or be an admin user.
if err := params.p.CheckRoleOption(params.ctx, roleoption.CREATEDB); err != nil {
return err
}
// Block adding a primary region to the system database. This ensures that the system
// database can never be made into a multi-region database.
if n.desc.GetID() == keys.SystemDatabaseID {
return pgerror.Newf(
pgcode.FeatureNotSupported,
"adding a primary region to the system database is not supported",
)
}
// There are two paths to consider here: either this is the first setting of
// the primary region, OR we're updating the primary region. In the case where
// this is the first setting of the primary region, the call will turn the
// database into a "multi-region" database. This requires creating a
// RegionConfig structure in the database descriptor, creating a multi-region
// enum, and setting up the database-level zone configuration. The second case
// is simpler, as the multi-region infrastructure is already setup. In this
// case we just need to update the database and type descriptor, and the zone
// config.
if !n.desc.IsMultiRegion() {
// No need for zone configuration validation here, as #59719 will block
// getting into this state if there are zone configurations applied at the
// database level.
err := n.setInitialPrimaryRegion(params)
if err != nil {
return err
}
} else {
if err := params.p.validateZoneConfigForMultiRegionDatabaseWasNotModifiedByUser(
params.ctx,
&n.desc.Immutable,
); err != nil {
return err
}
err := n.switchPrimaryRegion(params)
if err != nil {
return err
}
}
// Log Alter Database Primary Region event. This is an auditable log event and
// is recorded in the same transaction as the database descriptor, and zone
// configuration updates.
return params.p.logEvent(params.ctx,
n.desc.GetID(),
&eventpb.AlterDatabasePrimaryRegion{
DatabaseName: n.desc.GetName(),
PrimaryRegionName: n.n.PrimaryRegion.String(),
})
}
func (n *alterDatabasePrimaryRegionNode) Next(runParams) (bool, error) { return false, nil }
func (n *alterDatabasePrimaryRegionNode) Values() tree.Datums { return tree.Datums{} }
func (n *alterDatabasePrimaryRegionNode) Close(context.Context) {}
func (n *alterDatabasePrimaryRegionNode) ReadingOwnWrites() {}
type alterDatabaseSurvivalGoalNode struct {
n *tree.AlterDatabaseSurvivalGoal
desc *dbdesc.Mutable
}
// AlterDatabaseSurvivalGoal transforms a tree.AlterDatabaseSurvivalGoal into a plan node.
func (p *planner) AlterDatabaseSurvivalGoal(
ctx context.Context, n *tree.AlterDatabaseSurvivalGoal,
) (planNode, error) {
if err := checkSchemaChangeEnabled(
ctx,
p.ExecCfg(),
"ALTER DATABASE",
); err != nil {
return nil, err
}
_, dbDesc, err := p.Descriptors().GetMutableDatabaseByName(ctx, p.txn, string(n.Name),
tree.DatabaseLookupFlags{Required: true},
)
if err != nil {
return nil, err
}
return &alterDatabaseSurvivalGoalNode{n: n, desc: dbDesc}, nil
}
func (n *alterDatabaseSurvivalGoalNode) startExec(params runParams) error {
// To change the survival goal, the user has to have CREATEDB privileges, or be an admin user.
if err := params.p.CheckRoleOption(params.ctx, roleoption.CREATEDB); err != nil {
return err
}
// If the database is not a multi-region database, the survival goal cannot be changed.
if !n.desc.IsMultiRegion() {
return errors.WithHintf(
pgerror.New(pgcode.InvalidName,
"database must have associated regions before a survival goal can be set",
),
"you must first add a primary region to the database using "+
"ALTER DATABASE %s PRIMARY REGION <region_name>",
n.n.Name.String(),
)
}
if err := params.p.validateZoneConfigForMultiRegionDatabaseWasNotModifiedByUser(
params.ctx,
&n.desc.Immutable,
); err != nil {
return err
}
telemetry.Inc(
sqltelemetry.AlterDatabaseSurvivalGoalCounter(
n.n.SurvivalGoal.TelemetryName(),
),
)
// Update the survival goal in the database descriptor
survivalGoal, err := TranslateSurvivalGoal(n.n.SurvivalGoal)
if err != nil {
return err
}
n.desc.RegionConfig.SurvivalGoal = survivalGoal
if err := params.p.writeNonDropDatabaseChange(
params.ctx,
n.desc,
tree.AsStringWithFQNames(n.n, params.Ann()),
); err != nil {
return err
}
regionConfig, err := SynthesizeRegionConfig(params.ctx, params.p.txn, n.desc.ID, params.p.Descriptors())
if err != nil {
return err
}
if err := multiregion.ValidateRegionConfig(regionConfig); err != nil {
return err
}
// Update the database's zone configuration.
if err := ApplyZoneConfigFromDatabaseRegionConfig(
params.ctx,
n.desc.ID,
regionConfig,
params.p.txn,
params.p.execCfg,
); err != nil {
return err
}
// Update all REGIONAL BY TABLE tables' zone configurations. This is required as replica
// placement for REGIONAL BY TABLE tables is dependant on the survival goal.
if err := params.p.updateZoneConfigsForAllTables(params.ctx, n.desc); err != nil {
return err
}
// Log Alter Database Survival Goal event. This is an auditable log event and
// is recorded in the same transaction as the database descriptor, and zone
// configuration updates.
return params.p.logEvent(params.ctx,
n.desc.GetID(),
&eventpb.AlterDatabaseSurvivalGoal{
DatabaseName: n.desc.GetName(),
SurvivalGoal: survivalGoal.String(),
},
)
}
func (n *alterDatabaseSurvivalGoalNode) Next(runParams) (bool, error) { return false, nil }
func (n *alterDatabaseSurvivalGoalNode) Values() tree.Datums { return tree.Datums{} }
func (n *alterDatabaseSurvivalGoalNode) Close(context.Context) {}