Skip to content

Commit

Permalink
Initial Materialize command work
Browse files Browse the repository at this point in the history
Signed-off-by: Matt Lord <[email protected]>
  • Loading branch information
mattlord committed Oct 5, 2023
1 parent e73ce91 commit c50f781
Show file tree
Hide file tree
Showing 19 changed files with 3,642 additions and 2,370 deletions.
1 change: 1 addition & 0 deletions go/cmd/vtctldclient/command/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import (
// These imports ensure init()s within them get called and they register their commands/subcommands.
vreplcommon "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/common"
_ "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/lookupvindex"
_ "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/materialize"
_ "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/movetables"
_ "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/reshard"
_ "vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/vdiff"
Expand Down
4 changes: 2 additions & 2 deletions go/cmd/vtctldclient/command/vreplication/common/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,8 @@ func AddCommonCreateFlags(cmd *cobra.Command) {
cmd.Flags().BoolVar(&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.")
cmd.Flags().StringVar(&CreateOptions.OnDDL, "on-ddl", onDDLDefault, "What to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE.")
cmd.Flags().BoolVar(&CreateOptions.DeferSecondaryKeys, "defer-secondary-keys", false, "Defer secondary index creation for a table until after it has been copied.")
cmd.Flags().BoolVar(&CreateOptions.AutoStart, "auto-start", true, "Start the MoveTables workflow after creating it.")
cmd.Flags().BoolVar(&CreateOptions.StopAfterCopy, "stop-after-copy", false, "Stop the MoveTables workflow after it's finished copying the existing rows and before it starts replicating changes.")
cmd.Flags().BoolVar(&CreateOptions.AutoStart, "auto-start", true, "Start the workflow after creating it.")
cmd.Flags().BoolVar(&CreateOptions.StopAfterCopy, "stop-after-copy", false, "Stop the workflow after it's finished copying the existing rows and before it starts replicating changes.")
}

var SwitchTrafficOptions = struct {
Expand Down
161 changes: 161 additions & 0 deletions go/cmd/vtctldclient/command/vreplication/materialize/create.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
/*
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 customer create --source-keyspace commerce --table-settings 'target-table=sales_by_sku,"source-query=select sku, count(*), sum(price) from corder group by order_id"' --cells zone1 --cells zone2 --tablet-types replica`,
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,
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")
}

// You cannot have multiple source expressions against the
// same table.
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"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
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"
)

var (
// materialize is the base command for all actions related to Materialize.
materialize = &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(materialize)
root.AddCommand(materialize)

common.AddCommonCreateFlags(create)
create.Flags().StringVar(&createOptions.SourceKeyspace, "source-keyspace", "", "Keyspace where the tables are being moved from.")
create.MarkFlagRequired("source-keyspace")
create.Flags().Var(&createOptions.TableSettings, "table-settings", "A JSON array where each value must contain two key/value pairs. The first key is 'target_table' and it is the name of the table in the target-keyspace to store the results in. The second key is 'source_expression' and its value is the select to run against the source table. An optional k/v pair can be specified for 'create_ddl' which provides the DDL to create the target table if it does not exist.")
create.MarkFlagRequired("table-settings")
root.AddCommand(create)

opts := &common.SubCommandsOpts{
SubCommand: "Materialize",
Workflow: "product_sales",
}
materialize.AddCommand(common.GetShowCommand(opts))

materialize.AddCommand(common.GetStartCommand(opts))
materialize.AddCommand(common.GetStopCommand(opts))

materialize.AddCommand(common.GetCancelCommand(opts))
}

func init() {
common.RegisterCommandHandler("Materialize", registerCommands)
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import (
var (
// moveTables is the base command for all actions related to moveTables.
moveTables = &cobra.Command{
Use: "MoveTables --workflow <workflow> --keyspace <keyspace> [command] [command-flags]",
Use: "MoveTables --workflow <workflow> --target-keyspace <keyspace> [command] [command-flags]",
Short: "Perform commands related to moving tables from a source keyspace to a target keyspace.",
DisableFlagsInUseLine: true,
Aliases: []string{"movetables"},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import (
var (
// reshard is the base command for all actions related to reshard.
reshard = &cobra.Command{
Use: "Reshard --workflow <workflow> --keyspace <keyspace> [command] [command-flags]",
Use: "Reshard --workflow <workflow> --target-keyspace <keyspace> [command] [command-flags]",
Short: "Perform commands related to resharding a keyspace.",
DisableFlagsInUseLine: true,
Aliases: []string{"reshard"},
Expand Down
2 changes: 1 addition & 1 deletion go/cmd/vtctldclient/command/vreplication/vdiff/vdiff.go
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ var (

// base is the base command for all actions related to VDiff.
base = &cobra.Command{
Use: "VDiff --workflow <workflow> --keyspace <keyspace> [command] [command-flags]",
Use: "VDiff --workflow <workflow> --target-keyspace <keyspace> [command] [command-flags]",
Short: "Perform commands related to diffing tables involved in a VReplication workflow between the source and target.",
DisableFlagsInUseLine: true,
Aliases: []string{"vdiff"},
Expand Down
1 change: 1 addition & 0 deletions go/flags/endtoend/vtctldclient.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Available Commands:
GetWorkflows Gets all vreplication workflows (Reshard, MoveTables, etc) in the given keyspace.
LegacyVtctlCommand Invoke a legacy vtctlclient command. Flag parsing is best effort.
LookupVindex Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows.
Materialize Perform commands related to materializing query results from the source keyspace into tables in the target keyspace.
MoveTables Perform commands related to moving tables from a source keyspace to a target keyspace.
OnlineDDL Operates on online DDL (schema migrations).
PingTablet Checks that the specified tablet is awake and responding to RPCs. This command can be blocked by other in-flight operations.
Expand Down
Loading

0 comments on commit c50f781

Please sign in to comment.