Add --no-routing-rules functionality to vtctld

Signed-off-by: Rohit Nayak <rohit@planetscale.com>

go/cmd/vtctldclient/command/movetables.go

@@ -234,6 +234,7 @@ var (
  DeferSecondaryKeys bool
  AutoStart bool
  StopAfterCopy bool
+ NoRoutingRules bool
  }{}
  moveTablesSwitchTrafficOptions = struct {
  Cells []string
@@ -283,6 +284,7 @@ func commandMoveTablesCreate(cmd *cobra.Command, args []string) error {
  DeferSecondaryKeys: moveTablesCreateOptions.DeferSecondaryKeys,
  AutoStart: moveTablesCreateOptions.AutoStart,
  StopAfterCopy: moveTablesCreateOptions.StopAfterCopy,
+ NoRoutingRules: moveTablesCreateOptions.NoRoutingRules,
  }
 
  resp, err := client.MoveTablesCreate(commandCtx, req)
@@ -524,6 +526,7 @@ func init() {
  MoveTablesCreate.Flags().BoolVar(&moveTablesCreateOptions.DeferSecondaryKeys, "defer-secondary-keys", false, "Defer secondary index creation for a table until after it has been copied")
  MoveTablesCreate.Flags().BoolVar(&moveTablesCreateOptions.AutoStart, "auto-start", true, "Start the MoveTables workflow after creating it")
  MoveTablesCreate.Flags().BoolVar(&moveTablesCreateOptions.StopAfterCopy, "stop-after-copy", false, "Stop the MoveTables workflow after it's finished copying the existing rows and before it starts replicating changes")
+ MoveTablesCreate.Flags().BoolVar(&moveTablesCreateOptions.NoRoutingRules, "no-routing-rules", false, "(Advanced) MoveTables Create only. Do not create routing rules while creating the workflow. See the reference documentation for limitations if you use this flag.")
  MoveTables.AddCommand(MoveTablesCreate)
 
  MoveTables.AddCommand(MoveTablesShow)

go/vt/vtctl/workflow/materializer_test.go

@@ -522,3 +522,56 @@ func TestMoveTablesDDLFlag(t *testing.T) {
  })
  }
 }
+
+// TestMoveTablesNoRoutingRules confirms that MoveTables does not create routing rules if --no-routing-rules is specified.
+func TestMoveTablesNoRoutingRules(t *testing.T) {
+ ms := &vtctldatapb.MaterializeSettings{
+ Workflow: "workflow",
+ SourceKeyspace: "sourceks",
+ TargetKeyspace: "targetks",
+ TableSettings: []*vtctldatapb.TableMaterializeSettings{{
+ TargetTable: "t1",
+ SourceExpression: "select * from t1",
+ }},
+ }
+
+ ctx, cancel := context.WithCancel(context.Background())
+ defer cancel()
+ env := newTestMaterializerEnv(t, ctx, ms, []string{"0"}, []string{"0"})
+ defer env.close()
+ // This is the default and go does not marshal defaults
+ // for prototext fields so we use the default insert stmt.
+ //insert = fmt.Sprintf(`/insert into .vreplication\(.*on_ddl:%s.*`, onDDLAction)
+ //env.tmc.expectVRQuery(100, "/.*", &sqltypes.Result{})
+
+ // TODO: we cannot test the actual query generated w/o having a
+ // TabletManager. Importing the tabletmanager package, however, causes
+ // a circular dependency.
+ // The TabletManager portion is tested in rpc_vreplication_test.go.
+ env.tmc.expectVRQuery(100, mzCheckJournal, &sqltypes.Result{})
+ env.tmc.expectVRQuery(200, mzSelectFrozenQuery, &sqltypes.Result{})
+ env.tmc.expectVRQuery(200, getWorkflowQuery, getWorkflowRes)
+ env.tmc.expectVRQuery(200, mzGetCopyState, &sqltypes.Result{})
+ env.tmc.expectVRQuery(200, mzGetWorkflowStatusQuery, getWorkflowStatusRes)
+ env.tmc.expectVRQuery(200, mzGetLatestCopyState, &sqltypes.Result{})
+
+ targetShard, err := env.topoServ.GetShardNames(ctx, ms.TargetKeyspace)
+ require.NoError(t, err)
+ sourceShard, err := env.topoServ.GetShardNames(ctx, ms.SourceKeyspace)
+ require.NoError(t, err)
+ want := fmt.Sprintf("shard_streams:{key:\"%s/%s\" value:{streams:{id:1 tablet:{cell:\"%s\" uid:200} source_shard:\"%s/%s\" position:\"MySQL56/9d10e6ec-07a0-11ee-ae73-8e53f4cf3083:1-97\" status:\"running\" info:\"VStream Lag: 0s\"}}}",
+ ms.TargetKeyspace, targetShard[0], env.cell, ms.SourceKeyspace, sourceShard[0])
+
+ res, err := env.ws.MoveTablesCreate(ctx, &vtctldatapb.MoveTablesCreateRequest{
+ Workflow: ms.Workflow,
+ SourceKeyspace: ms.SourceKeyspace,
+ TargetKeyspace: ms.TargetKeyspace,
+ IncludeTables: []string{"t1"},
+ NoRoutingRules: true,
+ })
+ require.NoError(t, err)
+ require.Equal(t, want, fmt.Sprintf("%+v", res))
+ rr, err := env.ws.ts.GetRoutingRules(ctx)
+ require.NoError(t, err)
+ require.Zerof(t, len(rr.Rules), "routing rules should be empty, found %+v", rr.Rules)
+}

go/vt/vtctl/workflow/server.go

@@ -1096,39 +1096,43 @@ func (s *Server) MoveTablesCreate(ctx context.Context, req *vtctldatapb.MoveTabl
  // Now that the streams have been successfully created, let's put the associated
  // routing rules in place.
  if externalTopo == nil {
- // Save routing rules before vschema. If we save vschema first, and routing
- // rules fails to save, we may generate duplicate table errors.
- if mz.isPartial {
- if err := createDefaultShardRoutingRules(mz.ctx, mz.ms, mz.ts); err != nil {
- return nil, err
+ if req.NoRoutingRules {
+ log.Warningf("Found --no-routing-rules flag, not creating routing rules for workflow %s.%s", targetKeyspace, req.Workflow)
+ } else {
+ // Save routing rules before vschema. If we save vschema first, and routing
+ // rules fails to save, we may generate duplicate table errors.
+ if mz.isPartial {
+ if err := createDefaultShardRoutingRules(mz.ctx, mz.ms, mz.ts); err != nil {
+ return nil, err
+ }
  }
- }
 
- rules, err := topotools.GetRoutingRules(ctx, s.ts)
- if err != nil {
- return nil, err
- }
- for _, table := range tables {
- toSource := []string{sourceKeyspace + "." + table}
- rules[table] = toSource
- rules[table+"@replica"] = toSource
- rules[table+"@rdonly"] = toSource
- rules[targetKeyspace+"."+table] = toSource
- rules[targetKeyspace+"."+table+"@replica"] = toSource
- rules[targetKeyspace+"."+table+"@rdonly"] = toSource
- rules[targetKeyspace+"."+table] = toSource
- rules[sourceKeyspace+"."+table+"@replica"] = toSource
- rules[sourceKeyspace+"."+table+"@rdonly"] = toSource
- }
- if err := topotools.SaveRoutingRules(ctx, s.ts, rules); err != nil {
- return nil, err
- }
-
- if vschema != nil {
- // We added to the vschema.
- if err := s.ts.SaveVSchema(ctx, targetKeyspace, vschema); err != nil {
+ rules, err := topotools.GetRoutingRules(ctx, s.ts)
+ if err != nil {
+ return nil, err
+ }
+ for _, table := range tables {
+ toSource := []string{sourceKeyspace + "." + table}
+ rules[table] = toSource
+ rules[table+"@replica"] = toSource
+ rules[table+"@rdonly"] = toSource
+ rules[targetKeyspace+"."+table] = toSource
+ rules[targetKeyspace+"."+table+"@replica"] = toSource
+ rules[targetKeyspace+"."+table+"@rdonly"] = toSource
+ rules[targetKeyspace+"."+table] = toSource
+ rules[sourceKeyspace+"."+table+"@replica"] = toSource
+ rules[sourceKeyspace+"."+table+"@rdonly"] = toSource
+ }
+ if err := topotools.SaveRoutingRules(ctx, s.ts, rules); err != nil {
  return nil, err
  }
+
+ if vschema != nil {
+ // We added to the vschema.
+ if err := s.ts.SaveVSchema(ctx, targetKeyspace, vschema); err != nil {
+ return nil, err
+ }
+ }
  }
  }
  if err := s.ts.RebuildSrvVSchema(ctx, nil); err != nil {

proto/vtctldata.proto

@@ -1021,6 +1021,8 @@ message MoveTablesCreateRequest {
  bool defer_secondary_keys = 16;
  // Start the workflow after creating it.
  bool auto_start = 17;
+ // NoRoutingRules is set to true if routing rules should not be created on the target when the workflow is created.
+ bool no_routing_rules = 18;
 }
 
 message MoveTablesCreateResponse {