-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ingestion: add planHook for ingestion job
This change adds the boiler plate plan hook that configures and starts up the ingestion job. Release note: None
- Loading branch information
1 parent
4269f1b
commit 320a77b
Showing
6 changed files
with
146 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
129 changes: 129 additions & 0 deletions
129
pkg/ccl/streamingccl/streamingest/stream_ingestion_planning.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| // Copyright 2020 The Cockroach Authors. | ||
| // | ||
| // Licensed as a CockroachDB Enterprise file under the Cockroach Community | ||
| // License (the "License"); you may not use this file except in compliance with | ||
| // the License. You may obtain a copy of the License at | ||
| // | ||
| // https://github.com/cockroachdb/cockroach/blob/master/licenses/CCL.txt | ||
|
|
||
| package streamingest | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/ccl/streamingccl" | ||
| "github.com/cockroachdb/cockroach/pkg/ccl/utilccl" | ||
| "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/settings/cluster" | ||
| "github.com/cockroachdb/cockroach/pkg/sql" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/catalog/colinfo" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/sem/tree" | ||
| "github.com/cockroachdb/cockroach/pkg/util/hlc" | ||
| "github.com/cockroachdb/cockroach/pkg/util/log" | ||
| "github.com/cockroachdb/cockroach/pkg/util/tracing" | ||
| "github.com/cockroachdb/errors" | ||
| ) | ||
|
|
||
| func streamIngestionJobDescription( | ||
| p sql.PlanHookState, streamIngestion *tree.StreamIngestion, | ||
| ) (string, error) { | ||
| ann := p.ExtendedEvalContext().Annotations | ||
| return tree.AsStringWithFQNames(streamIngestion, ann), nil | ||
| } | ||
|
|
||
| func ingestionPlanHook( | ||
| ctx context.Context, stmt tree.Statement, p sql.PlanHookState, | ||
| ) (sql.PlanHookRowFn, colinfo.ResultColumns, []sql.PlanNode, bool, error) { | ||
| ingestionStmt, ok := stmt.(*tree.StreamIngestion) | ||
| if !ok { | ||
| return nil, nil, nil, false, nil | ||
| } | ||
|
|
||
| fromFn, err := p.TypeAsStringArray(ctx, tree.Exprs(ingestionStmt.From), "INGESTION") | ||
| if err != nil { | ||
| return nil, nil, nil, false, err | ||
| } | ||
|
|
||
| fn := func(ctx context.Context, _ []sql.PlanNode, resultsCh chan<- tree.Datums) error { | ||
| ctx, span := tracing.ChildSpan(ctx, stmt.StatementTag()) | ||
| defer span.Finish() | ||
|
|
||
| if err := utilccl.CheckEnterpriseEnabled( | ||
| p.ExecCfg().Settings, p.ExecCfg().ClusterID(), p.ExecCfg().Organization(), | ||
| "RESTORE FROM REPLICATION STREAM", | ||
| ); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| from, err := fromFn() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // We only support a TENANT target, so error out if that is nil. | ||
| if ingestionStmt.Targets.Tenant == (roachpb.TenantID{}) { | ||
| return errors.Newf("no tenant specified in ingestion query: %s", ingestionStmt.String()) | ||
| } | ||
|
|
||
| if ingestionStmt.Targets.Types != nil || ingestionStmt.Targets.Databases != nil || | ||
| ingestionStmt.Targets.Tables != nil || ingestionStmt.Targets.Schemas != nil { | ||
| return errors.Newf("unsupported target in ingestion query, "+ | ||
| "only tenant ingestion is supported: %s", ingestionStmt.String()) | ||
| } | ||
|
|
||
| // TODO(adityamaru): Add privileges checks. Probably the same as RESTORE. | ||
|
|
||
| prefix := keys.MakeTenantPrefix(ingestionStmt.Targets.Tenant) | ||
| streamIngestionDetails := jobspb.StreamIngestionDetails{ | ||
| StreamAddress: streamingccl.StreamAddress(from[0]), | ||
| Span: roachpb.Span{Key: prefix, EndKey: prefix.Next()}, | ||
| // TODO: Figure out what the initial ts should be. | ||
| StartTime: hlc.Timestamp{}, | ||
| } | ||
|
|
||
| jobDescription, err := streamIngestionJobDescription(p, ingestionStmt) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| jr := jobs.Record{ | ||
| Description: jobDescription, | ||
| Username: p.User(), | ||
| Progress: jobspb.StreamIngestionProgress{}, | ||
| Details: streamIngestionDetails, | ||
| } | ||
|
|
||
| var sj *jobs.StartableJob | ||
| if err := p.ExecCfg().DB.Txn(ctx, func(ctx context.Context, txn *kv.Txn) error { | ||
| sj, err = p.ExecCfg().JobRegistry.CreateStartableJobWithTxn(ctx, jr, txn) | ||
| return err | ||
| }); err != nil { | ||
| if sj != nil { | ||
| if cleanupErr := sj.CleanupOnRollback(ctx); cleanupErr != nil { | ||
| log.Warningf(ctx, "failed to cleanup StartableJob: %v", cleanupErr) | ||
| } | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| return sj.Start(ctx) | ||
| } | ||
|
|
||
| return fn, utilccl.BulkJobExecutionResultHeader, nil, false, nil | ||
| } | ||
|
|
||
| func init() { | ||
| sql.AddPlanHook(ingestionPlanHook) | ||
| jobs.RegisterConstructor( | ||
| jobspb.TypeStreamIngestion, | ||
| func(job *jobs.Job, settings *cluster.Settings) jobs.Resumer { | ||
| return &streamIngestionResumer{ | ||
| job: job, | ||
| } | ||
| }, | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters