-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate Materialize command to vtctldclient (#14184)
Signed-off-by: Matt Lord <[email protected]>
- Loading branch information
Showing
35 changed files
with
5,001 additions
and
2,753 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
189 changes: 189 additions & 0 deletions
189
go/cmd/vtctldclient/command/vreplication/materialize/create.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,189 @@ | ||
| /* | ||
| Copyright 2023 The Vitess Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package materialize | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| "vitess.io/vitess/go/cmd/vtctldclient/cli" | ||
| "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/common" | ||
| "vitess.io/vitess/go/vt/sqlparser" | ||
| "vitess.io/vitess/go/vt/topo/topoproto" | ||
|
|
||
| vtctldatapb "vitess.io/vitess/go/vt/proto/vtctldata" | ||
| ) | ||
|
|
||
| var ( | ||
| createOptions = struct { | ||
| SourceKeyspace string | ||
| TableSettings tableSettings | ||
| }{} | ||
|
|
||
| // create makes a MaterializeCreate gRPC call to a vtctld. | ||
| create = &cobra.Command{ | ||
| Use: "create", | ||
| Short: "Create and run a Materialize VReplication workflow.", | ||
| Example: `vtctldclient --server localhost:15999 materialize --workflow product_sales --target-keyspace commerce create --source-keyspace commerce --table-settings '[{"target_table": "sales_by_sku", "create_ddl": "create table sales_by_sku (sku varbinary(128) not null primary key, orders bigint, revenue bigint)", "source_expression": "select sku, count(*) as orders, sum(price) as revenue from corder group by sku"}]' --cells zone1 --cells zone2 --tablet-types replica`, | ||
| Long: `Materialize is a lower level VReplication command that allows for generalized materialization | ||
| of tables. The target tables can be copies, aggregations, or views. The target tables are kept | ||
| in sync in near-realtime. The primary flag used to define the materializations (you can have | ||
| multiple per workflow) is table-settings which is a JSON array where each value must contain | ||
| two key/value pairs. The first required key is 'target_table' and it is the name of the table | ||
| in the target-keyspace to store the results in. The second required key is 'source_expression' | ||
| and its value is the select query to run against the source table. An optional key/value pair | ||
| can also be specified for 'create_ddl' which provides the DDL to create the target table if it | ||
| does not exist -- you can alternatively specify a value of 'copy' if the target table schema | ||
| should be copied as-is from the source keyspace. Here's an example value for table-settings: | ||
| [ | ||
| { | ||
| "target_table": "customer_one_email", | ||
| "source_expression": "select email from customer where customer_id = 1" | ||
| }, | ||
| { | ||
| "target_table": "states", | ||
| "source_expression": "select * from states", | ||
| "create_ddl": "copy" | ||
| }, | ||
| { | ||
| "target_table": "sales_by_sku", | ||
| "source_expression": "select sku, count(*) as orders, sum(price) as revenue from corder group by sku", | ||
| "create_ddl": "create table sales_by_sku (sku varbinary(128) not null primary key, orders bigint, revenue bigint)" | ||
| } | ||
| ] | ||
| `, | ||
| SilenceUsage: true, | ||
| DisableFlagsInUseLine: true, | ||
| Aliases: []string{"Create"}, | ||
| Args: cobra.NoArgs, | ||
| PreRunE: func(cmd *cobra.Command, args []string) error { | ||
| if err := common.ParseAndValidateCreateOptions(cmd); err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| }, | ||
| RunE: commandCreate, | ||
| } | ||
| ) | ||
|
|
||
| func commandCreate(cmd *cobra.Command, args []string) error { | ||
| format, err := common.GetOutputFormat(cmd) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| tsp := common.GetTabletSelectionPreference(cmd) | ||
| cli.FinishedParsing(cmd) | ||
|
|
||
| ms := &vtctldatapb.MaterializeSettings{ | ||
| Workflow: common.BaseOptions.Workflow, | ||
| TargetKeyspace: common.BaseOptions.TargetKeyspace, | ||
| SourceKeyspace: createOptions.SourceKeyspace, | ||
| TableSettings: createOptions.TableSettings.val, | ||
| StopAfterCopy: common.CreateOptions.StopAfterCopy, | ||
| Cell: strings.Join(common.CreateOptions.Cells, ","), | ||
| TabletTypes: topoproto.MakeStringTypeCSV(common.CreateOptions.TabletTypes), | ||
| TabletSelectionPreference: tsp, | ||
| } | ||
|
|
||
| req := &vtctldatapb.MaterializeCreateRequest{ | ||
| Settings: ms, | ||
| } | ||
|
|
||
| _, err = common.GetClient().MaterializeCreate(common.GetCommandCtx(), req) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if format == "json" { | ||
| resp := struct { | ||
| Action string | ||
| Status string | ||
| }{ | ||
| Action: "create", | ||
| Status: "success", | ||
| } | ||
| jsonText, _ := cli.MarshalJSONPretty(resp) | ||
| fmt.Println(string(jsonText)) | ||
| } else { | ||
| fmt.Printf("Materialization workflow %s successfully created in the %s keyspace. Use show to view the status.\n", | ||
| common.BaseOptions.Workflow, common.BaseOptions.TargetKeyspace) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // tableSettings is a wrapper around a slice of TableMaterializeSettings | ||
| // proto messages that implements the pflag.Value interface. | ||
| type tableSettings struct { | ||
| val []*vtctldatapb.TableMaterializeSettings | ||
| } | ||
|
|
||
| func (ts *tableSettings) String() string { | ||
| tsj, _ := json.Marshal(ts.val) | ||
| return string(tsj) | ||
| } | ||
|
|
||
| func (ts *tableSettings) Set(v string) error { | ||
| ts.val = make([]*vtctldatapb.TableMaterializeSettings, 0) | ||
| err := json.Unmarshal([]byte(v), &ts.val) | ||
| if err != nil { | ||
| return fmt.Errorf("table-settings is not valid JSON") | ||
| } | ||
| if len(ts.val) == 0 { | ||
| return fmt.Errorf("empty table-settings") | ||
| } | ||
|
|
||
| // Validate the provided queries. | ||
| seenSourceTables := make(map[string]bool) | ||
| for _, tms := range ts.val { | ||
| if tms.TargetTable == "" || tms.SourceExpression == "" { | ||
| return fmt.Errorf("missing target_table or source_expression") | ||
| } | ||
| // Validate that the query is valid. | ||
| stmt, err := sqlparser.Parse(tms.SourceExpression) | ||
| if err != nil { | ||
| return fmt.Errorf("invalid source_expression: %q", tms.SourceExpression) | ||
| } | ||
| // Validate that each source-expression uses a different table. | ||
| // If any of them query the same table the materialize workflow | ||
| // will fail. | ||
| err = sqlparser.Walk(func(node sqlparser.SQLNode) (kontinue bool, err error) { | ||
| switch node := node.(type) { | ||
| case sqlparser.TableName: | ||
| if !node.Name.IsEmpty() { | ||
| if seenSourceTables[node.Name.String()] { | ||
| return false, fmt.Errorf("multiple source_expression queries use the same table: %q", node.Name.String()) | ||
| } | ||
| seenSourceTables[node.Name.String()] = true | ||
| } | ||
| } | ||
| return true, nil | ||
| }, stmt) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (ts *tableSettings) Type() string { | ||
| return "JSON" | ||
| } |
64 changes: 64 additions & 0 deletions
64
go/cmd/vtctldclient/command/vreplication/materialize/materialize.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,64 @@ | ||
| /* | ||
| Copyright 2023 The Vitess Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package materialize | ||
|
|
||
| import ( | ||
| "github.com/spf13/cobra" | ||
|
|
||
| "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/common" | ||
| "vitess.io/vitess/go/vt/topo/topoproto" | ||
| ) | ||
|
|
||
| var ( | ||
| // base is the base command for all actions related to Materialize. | ||
| base = &cobra.Command{ | ||
| Use: "Materialize --workflow <workflow> --target-keyspace <keyspace> [command] [command-flags]", | ||
| Short: "Perform commands related to materializing query results from the source keyspace into tables in the target keyspace.", | ||
| DisableFlagsInUseLine: true, | ||
| Aliases: []string{"materialize"}, | ||
| Args: cobra.ExactArgs(1), | ||
| } | ||
| ) | ||
|
|
||
| func registerCommands(root *cobra.Command) { | ||
| common.AddCommonFlags(base) | ||
| root.AddCommand(base) | ||
|
|
||
| create.Flags().StringSliceVarP(&common.CreateOptions.Cells, "cells", "c", nil, "Cells and/or CellAliases to copy table data from.") | ||
| create.Flags().Var((*topoproto.TabletTypeListFlag)(&common.CreateOptions.TabletTypes), "tablet-types", "Source tablet types to replicate table data from (e.g. PRIMARY,REPLICA,RDONLY).") | ||
| create.Flags().BoolVar(&common.CreateOptions.TabletTypesInPreferenceOrder, "tablet-types-in-preference-order", true, "When performing source tablet selection, look for candidates in the type order as they are listed in the tablet-types flag.") | ||
| create.Flags().StringVar(&createOptions.SourceKeyspace, "source-keyspace", "", "Keyspace where the tables queried in the 'source_expression' values within table-settings live.") | ||
| create.MarkFlagRequired("source-keyspace") | ||
| create.Flags().Var(&createOptions.TableSettings, "table-settings", "A JSON array defining what tables to materialize using what select statements. See the --help output for more details.") | ||
| create.MarkFlagRequired("table-settings") | ||
| create.Flags().BoolVar(&common.CreateOptions.StopAfterCopy, "stop-after-copy", false, "Stop the workflow after it's finished copying the existing rows and before it starts replicating changes.") | ||
| base.AddCommand(create) | ||
|
|
||
| // Generic workflow commands. | ||
| opts := &common.SubCommandsOpts{ | ||
| SubCommand: "Materialize", | ||
| Workflow: "product_sales", | ||
| } | ||
| base.AddCommand(common.GetCancelCommand(opts)) | ||
| base.AddCommand(common.GetShowCommand(opts)) | ||
| base.AddCommand(common.GetStartCommand(opts)) | ||
| base.AddCommand(common.GetStopCommand(opts)) | ||
| } | ||
|
|
||
| func init() { | ||
| common.RegisterCommandHandler("Materialize", registerCommands) | ||
| } |
Oops, something went wrong.