-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
exec_deps.go
567 lines (496 loc) · 17.9 KB
/
exec_deps.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
// 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 scdeps
import (
"context"
"fmt"
"time"
"github.com/cockroachdb/cockroach/pkg/clusterversion"
"github.com/cockroachdb/cockroach/pkg/config"
"github.com/cockroachdb/cockroach/pkg/jobs"
"github.com/cockroachdb/cockroach/pkg/jobs/jobspb"
"github.com/cockroachdb/cockroach/pkg/keys"
"github.com/cockroachdb/cockroach/pkg/kv"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/security/username"
"github.com/cockroachdb/cockroach/pkg/server/telemetry"
"github.com/cockroachdb/cockroach/pkg/settings/cluster"
"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/descs"
"github.com/cockroachdb/cockroach/pkg/sql/oppurpose"
"github.com/cockroachdb/cockroach/pkg/sql/schemachanger/scexec"
"github.com/cockroachdb/cockroach/pkg/sql/schemachanger/scexec/scmutationexec"
"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
"github.com/cockroachdb/cockroach/pkg/sql/sessiondata"
"github.com/cockroachdb/cockroach/pkg/sql/sqltelemetry"
"github.com/cockroachdb/cockroach/pkg/sql/sqlutil"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/errors"
)
// JobRegistry implements the methods the schema changer needs from the
// job registry. Outside of tests this should always be backed by *job.Registry.
type JobRegistry interface {
MakeJobID() jobspb.JobID
CreateJobWithTxn(ctx context.Context, record jobs.Record, jobID jobspb.JobID, txn *kv.Txn) (*jobs.Job, error)
UpdateJobWithTxn(ctx context.Context, jobID jobspb.JobID, txn *kv.Txn, ie sqlutil.InternalExecutor, useReadLock bool, updateFunc jobs.UpdateFn) error
CheckPausepoint(name string) error
}
// NewExecutorDependencies returns an scexec.Dependencies implementation built
// from the given arguments.
func NewExecutorDependencies(
settings *cluster.Settings,
codec keys.SQLCodec,
sessionData *sessiondata.SessionData,
txn *kv.Txn,
ie sqlutil.InternalExecutor,
user username.SQLUsername,
descsCollection *descs.Collection,
jobRegistry JobRegistry,
backfiller scexec.Backfiller,
merger scexec.Merger,
backfillTracker scexec.BackfillerTracker,
backfillFlusher scexec.PeriodicProgressFlusher,
validator scexec.Validator,
clock scmutationexec.Clock,
metadataUpdater scexec.DescriptorMetadataUpdater,
eventLogger scexec.EventLogger,
statsRefresher scexec.StatsRefresher,
testingKnobs *scexec.TestingKnobs,
kvTrace bool,
schemaChangerJobID jobspb.JobID,
statements []string,
) scexec.Dependencies {
return &execDeps{
txnDeps: txnDeps{
txn: txn,
ie: ie,
codec: codec,
descsCollection: descsCollection,
jobRegistry: jobRegistry,
validator: validator,
eventLogger: eventLogger,
statsRefresher: statsRefresher,
schemaChangerJobID: schemaChangerJobID,
schemaChangerJob: nil,
kvTrace: kvTrace,
settings: settings,
},
backfiller: backfiller,
merger: merger,
backfillerTracker: backfillTracker,
metadataUpdater: metadataUpdater,
periodicProgressFlusher: backfillFlusher,
statements: statements,
user: user,
sessionData: sessionData,
clock: clock,
testingKnobs: testingKnobs,
}
}
type txnDeps struct {
txn *kv.Txn
ie sqlutil.InternalExecutor
codec keys.SQLCodec
descsCollection *descs.Collection
jobRegistry JobRegistry
createdJobs []jobspb.JobID
validator scexec.Validator
statsRefresher scexec.StatsRefresher
tableStatsToRefresh []descpb.ID
eventLogger scexec.EventLogger
deletedDescriptors catalog.DescriptorIDSet
schemaChangerJobID jobspb.JobID
schemaChangerJob *jobs.Job
kvTrace bool
settings *cluster.Settings
}
func (d *txnDeps) UpdateSchemaChangeJob(
ctx context.Context, id jobspb.JobID, callback scexec.JobUpdateCallback,
) error {
const useReadLock = false
return d.jobRegistry.UpdateJobWithTxn(ctx, id, d.txn, d.ie, useReadLock, func(
_ *kv.Txn, _ sqlutil.InternalExecutor, md jobs.JobMetadata, ju *jobs.JobUpdater,
) error {
return callback(md, ju.UpdateProgress, ju.UpdatePayload)
})
}
var _ scexec.Catalog = (*txnDeps)(nil)
// MustReadImmutableDescriptors implements the scmutationexec.CatalogReader interface.
func (d *txnDeps) MustReadImmutableDescriptors(
ctx context.Context, ids ...descpb.ID,
) ([]catalog.Descriptor, error) {
flags := tree.CommonLookupFlags{
Required: true,
RequireMutable: false,
AvoidLeased: true,
IncludeOffline: true,
IncludeDropped: true,
AvoidSynthetic: true,
}
return d.descsCollection.GetImmutableDescriptorsByID(ctx, d.txn, flags, ids...)
}
// GetFullyQualifiedName implements the scmutationexec.CatalogReader interface
func (d *txnDeps) GetFullyQualifiedName(ctx context.Context, id descpb.ID) (string, error) {
flags := tree.CommonLookupFlags{
Required: true,
IncludeOffline: true,
IncludeDropped: true,
AvoidLeased: true,
AvoidSynthetic: true,
}
objectDesc, err := d.descsCollection.GetImmutableDescriptorByID(
ctx, d.txn, id, flags,
)
if err != nil {
return "", err
}
// For objects like tables, views, sequences, and types
// we can fetch the fully qualified names.
if objectDesc.DescriptorType() != catalog.Database &&
objectDesc.DescriptorType() != catalog.Schema {
_, databaseDesc, err := d.descsCollection.GetImmutableDatabaseByID(
ctx, d.txn, objectDesc.GetParentID(), flags,
)
if err != nil {
return "", err
}
schemaDesc, err := d.descsCollection.GetImmutableSchemaByID(
ctx, d.txn, objectDesc.GetParentSchemaID(), flags,
)
if err != nil {
return "", err
}
name := tree.MakeTableNameWithSchema(
tree.Name(databaseDesc.GetName()),
tree.Name(schemaDesc.GetName()),
tree.Name(objectDesc.GetName()),
)
return name.FQString(), nil
} else if objectDesc.DescriptorType() == catalog.Database {
return objectDesc.GetName(), nil
} else if objectDesc.DescriptorType() == catalog.Schema {
_, databaseDesc, err := d.descsCollection.GetImmutableDatabaseByID(ctx,
d.txn, objectDesc.GetParentID(), flags,
)
if err != nil {
return "", err
}
return fmt.Sprintf("%s.%s", databaseDesc.GetName(), objectDesc.GetName()), nil
}
return "", errors.Newf("unknown descriptor type : %s\n", objectDesc.DescriptorType())
}
// MustReadMutableDescriptor implements the scexec.Catalog interface.
func (d *txnDeps) MustReadMutableDescriptor(
ctx context.Context, id descpb.ID,
) (catalog.MutableDescriptor, error) {
return d.descsCollection.GetMutableDescriptorByID(ctx, d.txn, id)
}
// AddSyntheticDescriptor is part of the
// scmutationexec.SyntheticDescriptorStateUpdater interface.
func (d *txnDeps) AddSyntheticDescriptor(desc catalog.Descriptor) {
d.descsCollection.AddSyntheticDescriptor(desc)
}
// NewCatalogChangeBatcher implements the scexec.Catalog interface.
func (d *txnDeps) NewCatalogChangeBatcher() scexec.CatalogChangeBatcher {
return &catalogChangeBatcher{
txnDeps: d,
batch: d.txn.NewBatch(),
}
}
type catalogChangeBatcher struct {
*txnDeps
batch *kv.Batch
}
var _ scexec.CatalogChangeBatcher = (*catalogChangeBatcher)(nil)
// CreateOrUpdateDescriptor implements the scexec.CatalogWriter interface.
func (b *catalogChangeBatcher) CreateOrUpdateDescriptor(
ctx context.Context, desc catalog.MutableDescriptor,
) error {
return b.descsCollection.WriteDescToBatch(ctx, b.kvTrace, desc, b.batch)
}
// DeleteName implements the scexec.CatalogWriter interface.
func (b *catalogChangeBatcher) DeleteName(
ctx context.Context, nameInfo descpb.NameInfo, id descpb.ID,
) error {
marshalledKey := catalogkeys.EncodeNameKey(b.codec, nameInfo)
if b.kvTrace {
log.VEventf(ctx, 2, "Del %s", marshalledKey)
}
b.batch.Del(marshalledKey)
return nil
}
// DeleteDescriptor implements the scexec.CatalogChangeBatcher interface.
func (b *catalogChangeBatcher) DeleteDescriptor(ctx context.Context, id descpb.ID) error {
marshalledKey := catalogkeys.MakeDescMetadataKey(b.codec, id)
b.batch.Del(marshalledKey)
if b.kvTrace {
log.VEventf(ctx, 2, "Del %s", marshalledKey)
}
b.deletedDescriptors.Add(id)
b.descsCollection.NotifyOfDeletedDescriptor(id)
return nil
}
// DeleteZoneConfig implements the scexec.CatalogChangeBatcher interface.
func (b *catalogChangeBatcher) DeleteZoneConfig(ctx context.Context, id descpb.ID) error {
zoneKeyPrefix := config.MakeZoneKeyPrefix(b.codec, id)
if b.kvTrace {
log.VEventf(ctx, 2, "DelRange %s", zoneKeyPrefix)
}
b.batch.DelRange(zoneKeyPrefix, zoneKeyPrefix.PrefixEnd(), false /* returnKeys */)
return nil
}
// ValidateAndRun implements the scexec.CatalogChangeBatcher interface.
func (b *catalogChangeBatcher) ValidateAndRun(ctx context.Context) error {
if err := b.descsCollection.ValidateUncommittedDescriptors(ctx, b.txn); err != nil {
return err
}
if err := b.txn.Run(ctx, b.batch); err != nil {
return errors.Wrap(err, "writing descriptors")
}
return nil
}
var _ scexec.TransactionalJobRegistry = (*txnDeps)(nil)
func (d *txnDeps) MakeJobID() jobspb.JobID {
return d.jobRegistry.MakeJobID()
}
func (d *txnDeps) CheckPausepoint(name string) error {
return d.jobRegistry.CheckPausepoint(name)
}
func (d *txnDeps) UseLegacyGCJob(ctx context.Context) bool {
return !d.settings.Version.IsActive(ctx, clusterversion.V22_2UseDelRangeInGCJob)
}
func (d *txnDeps) SchemaChangerJobID() jobspb.JobID {
if d.schemaChangerJobID == 0 {
d.schemaChangerJobID = d.jobRegistry.MakeJobID()
}
return d.schemaChangerJobID
}
func (d *txnDeps) CurrentJob() *jobs.Job {
return d.schemaChangerJob
}
// CreateJob implements the scexec.TransactionalJobRegistry interface.
func (d *txnDeps) CreateJob(ctx context.Context, record jobs.Record) error {
if _, err := d.jobRegistry.CreateJobWithTxn(ctx, record, record.JobID, d.txn); err != nil {
return err
}
d.createdJobs = append(d.createdJobs, record.JobID)
return nil
}
// CreatedJobs implements the scexec.TransactionalJobRegistry interface.
func (d *txnDeps) CreatedJobs() []jobspb.JobID {
return d.createdJobs
}
var _ scexec.IndexSpanSplitter = (*txnDeps)(nil)
// MaybeSplitIndexSpans implements the scexec.IndexSpanSplitter interface.
func (d *txnDeps) MaybeSplitIndexSpans(
ctx context.Context, table catalog.TableDescriptor, indexToBackfill catalog.Index,
) error {
// Only perform splits on the system tenant.
if !d.codec.ForSystemTenant() {
return nil
}
span := table.IndexSpan(d.codec, indexToBackfill.GetID())
const backfillSplitExpiration = time.Hour
expirationTime := d.txn.DB().Clock().Now().Add(backfillSplitExpiration.Nanoseconds(), 0)
return d.txn.DB().AdminSplit(ctx, span.Key, expirationTime, oppurpose.SplitSchema)
}
// GetResumeSpans implements the scexec.BackfillerTracker interface.
func (d *txnDeps) GetResumeSpans(
ctx context.Context, tableID descpb.ID, indexID descpb.IndexID,
) ([]roachpb.Span, error) {
table, err := d.descsCollection.GetImmutableTableByID(ctx, d.txn, tableID, tree.ObjectLookupFlags{
CommonLookupFlags: tree.CommonLookupFlags{
Required: true,
AvoidLeased: true,
AvoidSynthetic: true,
},
})
if err != nil {
return nil, err
}
return []roachpb.Span{table.IndexSpan(d.codec, indexID)}, nil
}
// SetResumeSpans implements the scexec.BackfillerTracker interface.
func (d *txnDeps) SetResumeSpans(
ctx context.Context, tableID descpb.ID, indexID descpb.IndexID, total, done []roachpb.Span,
) error {
panic("implement me")
}
type execDeps struct {
txnDeps
clock scmutationexec.Clock
metadataUpdater scexec.DescriptorMetadataUpdater
backfiller scexec.Backfiller
merger scexec.Merger
backfillerTracker scexec.BackfillerTracker
periodicProgressFlusher scexec.PeriodicProgressFlusher
statements []string
user username.SQLUsername
sessionData *sessiondata.SessionData
testingKnobs *scexec.TestingKnobs
}
func (d *execDeps) Clock() scmutationexec.Clock {
return d.clock
}
var _ scexec.Dependencies = (*execDeps)(nil)
// Catalog implements the scexec.Dependencies interface.
func (d *execDeps) Catalog() scexec.Catalog {
return d
}
// IndexBackfiller implements the scexec.Dependencies interface.
func (d *execDeps) IndexBackfiller() scexec.Backfiller {
return d.backfiller
}
// IndexMerger implements the scexec.Dependencies interface.
func (d *execDeps) IndexMerger() scexec.Merger {
return d.merger
}
// BackfillProgressTracker implements the scexec.Dependencies interface.
func (d *execDeps) BackfillProgressTracker() scexec.BackfillerTracker {
return d.backfillerTracker
}
// PeriodicProgressFlusher implements the scexec.Dependencies interface.
func (d *execDeps) PeriodicProgressFlusher() scexec.PeriodicProgressFlusher {
return d.periodicProgressFlusher
}
func (d *execDeps) Validator() scexec.Validator {
return d.validator
}
// IndexSpanSplitter implements the scexec.Dependencies interface.
func (d *execDeps) IndexSpanSplitter() scexec.IndexSpanSplitter {
return d
}
// TransactionalJobCreator implements the scexec.Dependencies interface.
func (d *execDeps) TransactionalJobRegistry() scexec.TransactionalJobRegistry {
return d
}
// Statements implements the scexec.Dependencies interface.
func (d *execDeps) Statements() []string {
return d.statements
}
// User implements the scexec.Dependencies interface.
func (d *execDeps) User() username.SQLUsername {
return d.user
}
// ClusterSettings implements the scexec.Dependencies interface.
func (d *execDeps) ClusterSettings() *cluster.Settings {
return d.settings
}
// DescriptorMetadataUpdater implements the scexec.Dependencies interface.
func (d *execDeps) DescriptorMetadataUpdater(ctx context.Context) scexec.DescriptorMetadataUpdater {
return d.metadataUpdater
}
// EventLoggerFactory constructs a new event logger with a txn.
type EventLoggerFactory = func(*kv.Txn) scexec.EventLogger
// MetadataUpdaterFactory constructs a new metadata updater with a txn.
type MetadataUpdaterFactory = func(ctx context.Context, descriptors *descs.Collection, txn *kv.Txn) scexec.DescriptorMetadataUpdater
// EventLogger implements scexec.Dependencies
func (d *execDeps) EventLogger() scexec.EventLogger {
return d.eventLogger
}
// GetTestingKnobs implements scexec.Dependencies
func (d *execDeps) GetTestingKnobs() *scexec.TestingKnobs {
return d.testingKnobs
}
// AddTableForStatsRefresh adds a table for stats refresh once we are finished
// executing the current transaction.
func (d *execDeps) AddTableForStatsRefresh(id descpb.ID) {
d.tableStatsToRefresh = append(d.tableStatsToRefresh, id)
}
// getTablesForStatsRefresh gets tables that need refresh for stats.
func (d *execDeps) getTablesForStatsRefresh() []descpb.ID {
return d.tableStatsToRefresh
}
// StatsRefresher implements scexec.Dependencies
func (d *execDeps) StatsRefresher() scexec.StatsRefreshQueue {
return d
}
// Telemetry implements the scexec.Dependencies interface.
func (d *execDeps) Telemetry() scexec.Telemetry {
return d
}
// IncrementSchemaChangeErrorType implemented the scexec.Telemetry interface.
func (d *execDeps) IncrementSchemaChangeErrorType(typ string) {
telemetry.Inc(sqltelemetry.SchemaChangeErrorCounter(typ))
}
// NewNoOpBackfillerTracker constructs a backfill tracker which does not do
// anything. It will always return progress for a given backfill which
// contains a full set of CompletedSpans corresponding to the source index
// span and an empty MinimumWriteTimestamp. Similarly for merges.
func NewNoOpBackfillerTracker(codec keys.SQLCodec) scexec.BackfillerTracker {
return noopBackfillProgress{codec: codec}
}
type noopBackfillProgress struct {
codec keys.SQLCodec
}
func (n noopBackfillProgress) FlushCheckpoint(ctx context.Context) error {
return nil
}
func (n noopBackfillProgress) FlushFractionCompleted(ctx context.Context) error {
return nil
}
func (n noopBackfillProgress) GetBackfillProgress(
ctx context.Context, b scexec.Backfill,
) (scexec.BackfillProgress, error) {
key := n.codec.IndexPrefix(uint32(b.TableID), uint32(b.SourceIndexID))
return scexec.BackfillProgress{
Backfill: b,
CompletedSpans: []roachpb.Span{
{Key: key, EndKey: key.PrefixEnd()},
},
}, nil
}
func (n noopBackfillProgress) GetMergeProgress(
ctx context.Context, m scexec.Merge,
) (scexec.MergeProgress, error) {
p := scexec.MergeProgress{
Merge: m,
CompletedSpans: make([][]roachpb.Span, len(m.SourceIndexIDs)),
}
for i, sourceID := range m.SourceIndexIDs {
prefix := n.codec.IndexPrefix(uint32(m.TableID), uint32(sourceID))
p.CompletedSpans[i] = []roachpb.Span{{Key: prefix, EndKey: prefix.PrefixEnd()}}
}
return p, nil
}
func (n noopBackfillProgress) SetBackfillProgress(
ctx context.Context, progress scexec.BackfillProgress,
) error {
return nil
}
func (n noopBackfillProgress) SetMergeProgress(
ctx context.Context, progress scexec.MergeProgress,
) error {
return nil
}
type noopPeriodicProgressFlusher struct {
}
// NewNoopPeriodicProgressFlusher constructs a new
// PeriodicProgressFlusher which never does anything.
func NewNoopPeriodicProgressFlusher() scexec.PeriodicProgressFlusher {
return noopPeriodicProgressFlusher{}
}
func (n noopPeriodicProgressFlusher) StartPeriodicUpdates(
ctx context.Context, tracker scexec.BackfillerProgressFlusher,
) (stop func() error) {
return func() error { return nil }
}
type constantClock struct {
ts time.Time
}
// NewConstantClock constructs a new clock for use in execution.
func NewConstantClock(ts time.Time) scmutationexec.Clock {
return constantClock{ts: ts}
}
func (c constantClock) ApproximateTime() time.Time {
return c.ts
}