VReplication: Support automatically replacing auto_inc cols with sequ…

…ences (vitessio#16860)

Signed-off-by: Matt Lord <[email protected]>

changelog/21.0/21.0.0/summary.md

@@ -19,17 +19,18 @@
     - **[Reference Table Materialization](#reference-table-materialization)**
     - **[New VEXPLAIN Modes: TRACE and KEYS](#new-vexplain-modes)**
     - **[Errant GTID Detection on VTTablets](#errant-gtid-vttablet)**
+    - **[Automatically Replace MySQL auto_increment Clauses with Vitess Sequences](#auto-replace-mysql-autoinc-with-seq)**
 
-## <a id="major-changes"/>Major Changes
+## <a id="major-changes"/>Major Changes</a>
 
-### <a id="deprecations-and-deletions"/>Deprecations and Deletions
+### <a id="deprecations-and-deletions"/>Deprecations and Deletions</a>
 
-#### <a id="vttablet-flags"/>Deprecated VTTablet Flags
+#### <a id="vttablet-flags"/>Deprecated VTTablet Flags</a>
 
 - `queryserver-enable-settings-pool` flag, added in `v15`, has been on by default since `v17`.
   It is now deprecated and will be removed in a future release.
 
-#### <a id="metric-deletion"/>Deletion of deprecated metrics
+#### <a id="metric-deletion"/>Deletion of deprecated metrics</a>
 
 The following VTOrc metrics were deprecated in `v20`. They have now been deleted.
 
@@ -48,7 +49,7 @@ The following VTOrc metrics were deprecated in `v20`. They have now been deleted
 |          `planned_reparent_counts`           |      
 |      `reparent_shard_operation_timings`      |  
 
-#### <a id="deprecations-metrics"/>Deprecated Metrics
+#### <a id="deprecations-metrics"/>Deprecated Metrics</a>
 
 The following metrics are now deprecated and will be deleted in a future release, please use their replacements.
 
@@ -61,7 +62,7 @@ The following metrics are now deprecated and will be deleted in a future release
 | `vttablet` |   `QueryCacheHits`    |   `QueryEnginePlanCacheHits`    |
 | `vttablet` |  `QueryCacheMisses`   |  `QueryEnginePlanCacheMisses`   |
 
-### <a id="traffic-mirroring"/>Traffic Mirroring
+### <a id="traffic-mirroring"/>Traffic Mirroring</a>
 
 Traffic mirroring is intended to help reduce some of the uncertainty inherent to `MoveTables SwitchTraffic`. When
 traffic mirroring is enabled, VTGate will mirror a percentage of traffic from one keyspace to another.
@@ -74,7 +75,7 @@ $ vtctldclient --server :15999 MoveTables --target-keyspace customer --workflow
 
 Mirror rules can be inspected with `GetMirrorRules`.
 
-### <a id="new-vtgate-shutdown-behavior"/>New VTGate Shutdown Behavior
+### <a id="new-vtgate-shutdown-behavior"/>New VTGate Shutdown Behavior</a>
 
 We added a new option to VTGate to disallow new connections while VTGate is shutting down,
 while allowing existing connections to finish their work until they manually disconnect or until
@@ -84,7 +85,7 @@ This new behavior can be enabled by specifying the new `--mysql-server-drain-ont
 
 You can find more information about this option in the [RFC](https://github.com/vitessio/vitess/issues/15971).
 
-### <a id="tablet-throttler"/>Tablet Throttler: Multi-Metric support
+### <a id="tablet-throttler"/>Tablet Throttler: Multi-Metric support</a>
 
 Up until `v20`, the tablet throttler would only monitor and use a single metric. That would be replication lag, by
 default, or could be the result of a custom query. In this release, we introduce a major redesign so that the throttler 
@@ -111,20 +112,20 @@ Explicit app to metric assignments will override the catch-all configuration.
 Metrics are assigned a default _scope_, which could be `self` (isolated to the tablet) or `shard` (max, aka **worst**
 value among shard tablets). It is further possible to require a different scope for each metric.
 
-### <a id="allow-cross-cell"/>Allow Cross Cell Promotion in PRS
+### <a id="allow-cross-cell"/>Allow Cross Cell Promotion in PRS</a>
 
 Up until now if the users wanted to promote a replica in a different cell from the current primary
 using `PlannedReparentShard`, they had to specify the new primary with the `--new-primary` flag.
 
 We have now added a new flag `--allow-cross-cell-promotion` that lets `PlannedReparentShard` choose a primary in a
 different cell even if no new primary is provided explicitly.
 
-### <a id="recursive-cte"/>Experimental support for recursive CTEs
+### <a id="recursive-cte"/>Experimental support for recursive CTEs</a>
 
 We have added experimental support for recursive CTEs in Vitess. We are marking it as experimental because it is not yet
 fully tested and may have some limitations. We are looking for feedback from the community to improve this feature.
 
-### <a id="tablet-balancer"/>VTGate Tablet Balancer
+### <a id="tablet-balancer"/>VTGate Tablet Balancer</a>
 
 When a VTGate routes a query and has multiple available tablets for a given shard / tablet type (e.g. REPLICA), the
 current default behavior routes the query with local cell affinity and round robin policy. The VTGate Tablet Balancer
@@ -136,7 +137,7 @@ and `--balancer-keyspaces`.
 
 See the [RFC ](https://github.com/vitessio/vitess/issues/12241) for more details on the design and configuration of this feature.
 
-### <a id="query-timeout"/>Query Timeout Override
+### <a id="query-timeout"/>Query Timeout Override</a>
 
 VTGate sends an authoritative query timeout to VTTablet when the `QUERY_TIMEOUT_MS` comment directive,
 `query_timeout` session system variable, or `query-timeout` flag is set.
@@ -152,27 +153,27 @@ A query can also be set to have no timeout by using the `QUERY_TIMEOUT_MS` comme
 Example usage:
 `select /*vt+ QUERY_TIMEOUT_MS=30 */ col from tbl`
 
-### <a id="new-backup-engine"/>New Backup Engine (EXPERIMENTAL)
+### <a id="new-backup-engine"/>New Backup Engine (EXPERIMENTAL)</a>
 
 We are introducing a new backup engine for logical backups in order to support use cases that require something other 
 than physical backups. This feature is experimental and is based on [MySQL Shell](https://dev.mysql.com/doc/mysql-shell/8.0/en/).
 
 The new engine is enabled by using `--backup_engine_implementation=mysqlshell`. There are other options that are required, 
 so please read the [documentation](https://vitess.io/docs/21.0/user-guides/operating-vitess/backup-and-restore/creating-a-backup/) to learn which options are required and how to configure them.
 
-### <a id="dynamic-vreplication-configuration"/>Dynamic VReplication Configuration
+### <a id="dynamic-vreplication-configuration"/>Dynamic VReplication Configuration</a>
 
 Previously, many of the configuration options for VReplication Workflows had to be provided using VTTablet flags. This 
 meant that any change to VReplication configuration required restarting VTTablets. We now allow these to be overridden 
 while creating a workflow or dynamically after the workflow is already in progress.
 
-### <a id="reference-table-materialization"/>Reference Table Materialization
+### <a id="reference-table-materialization"/>Reference Table Materialization</a>
 
 There is a new option in [`Materialize` workflows](https://vitess.io/docs/reference/vreplication/materialize/) to keep a synced copy of [reference or lookup tables](https://vitess.io/docs/reference/vreplication/reference_tables/) 
 (countries, states, zip codes, etc) from an unsharded keyspace, which holds the source of truth for the reference 
 table, to all shards in a sharded keyspace.
 
-### <a id="new-vexplain-modes"/>New VEXPLAIN Modes: TRACE and KEYS
+### <a id="new-vexplain-modes"/>New VEXPLAIN Modes: TRACE and KEYS</a>
 
 #### VEXPLAIN TRACE
 
@@ -202,10 +203,18 @@ filter columns (potential candidates for indexes, primary keys, or sharding keys
 These new `VEXPLAIN` modes enhance Vitess's query analysis capabilities, allowing for more informed decisions about sharding 
 strategies and query optimization.
 
-### <a id="errant-gtid-vttablet"/>Errant GTID Detection on VTTablets
+### <a id="errant-gtid-vttablet"/>Errant GTID Detection on VTTablets</a>
 
 VTTablets now run an errant GTID detection logic before they join the replication stream. So, if a replica has an errant GTID, it will
 not start replicating from the primary. This protects us from running into situations which are very difficult to recover from.
 
 For users running with the vitess-operator on Kubernetes, this change means that replica tablets with errant GTIDs will have broken 
 replication and will report as unready. Users will need to manually replace and clean up these errant replica tablets.
+
+### <a id="auto-replace-mysql-autoinc-with-seq"/>Automatically Replace MySQL auto_increment Clauses with Vitess Sequences</a>
+
+In https://github.com/vitessio/vitess/pull/16860 we added support for replacing MySQL `auto_increment` clauses with [Vitess Sequences](https://vitess.io/docs/reference/features/vitess-sequences/), performing all of the setup and initialization
+work automatically during the [`MoveTables`](https://vitess.io/docs/reference/vreplication/movetables/) workflow. As part of that work we have deprecated the
+[`--remove-sharded-auto-increment` boolean flag](https://vitess.io/docs/20.0/reference/programs/vtctldclient/vtctldclient_movetables/vtctldclient_movetables_create/) and you should begin using the new
+[`--sharded-auto-increment-handling` flag](https://vitess.io/docs/21.0/reference/programs/vtctldclient/vtctldclient_movetables/vtctldclient_movetables_create/) instead. Please see the new
+[`MoveTables` Auto Increment Handling](https://vitess.io/docs/21.0/reference/vreplication/movetables/#auto-increment-handling) documentation for additional details.

go/cmd/vtctldclient/command/vreplication/common/utils.go

@@ -287,7 +287,7 @@ func AddCommonSwitchTrafficFlags(cmd *cobra.Command, initializeTargetSequences b
 	cmd.Flags().BoolVar(&SwitchTrafficOptions.DryRun, "dry-run", false, "Print the actions that would be taken and report any known errors that would have occurred.")
 	cmd.Flags().BoolVar(&SwitchTrafficOptions.Force, "force", false, "Force the traffic switch even if some potentially non-critical actions cannot be performed; for example the tablet refresh fails on some tablets in the keyspace. WARNING: this should be used with extreme caution and only in emergency situations!")
 	if initializeTargetSequences {
-		cmd.Flags().BoolVar(&SwitchTrafficOptions.InitializeTargetSequences, "initialize-target-sequences", false, "When moving tables from an unsharded keyspace to a sharded keyspace, initialize any sequences that are being used on the target when switching writes.")
+		cmd.Flags().BoolVar(&SwitchTrafficOptions.InitializeTargetSequences, "initialize-target-sequences", false, "When moving tables from an unsharded keyspace to a sharded keyspace, initialize any sequences that are being used on the target when switching writes. If the sequence table is not found, and the sequence table reference was fully qualified OR a value was specified for --global-keyspace, then we will attempt to create the sequence table in that keyspace.")
 	}
 }
 

go/cmd/vtctldclient/command/vreplication/movetables/create.go

@@ -40,6 +40,8 @@ var (
 		NoRoutingRules      bool
 		AtomicCopy          bool
 		WorkflowOptions     vtctldatapb.WorkflowOptions
+		// This maps to a WorkflowOptions.ShardedAutoIncrementHandling ENUM value.
+		ShardedAutoIncrementHandlingStr string
 	}{}
 
 	// create makes a MoveTablesCreate gRPC call to a vtctld.
@@ -87,6 +89,20 @@ var (
 				return fmt.Errorf("cannot specify both --tenant-id (i.e. a multi-tenant migration) and --source-shards (i.e. a shard-by-shard migration)")
 			}
 
+			// createOptions.ShardedAutoIncrementHandlingStr is the CLI flag value
+			// provided and we need to map that to the ENUM value for
+			// createOptions.WorkflowOptions.ShardedAutoIncrementHandling which
+			// gets saved in the _vt.vreplication record's options column.
+			createOptions.ShardedAutoIncrementHandlingStr = strings.ToUpper(createOptions.ShardedAutoIncrementHandlingStr)
+			val, ok := vtctldatapb.ShardedAutoIncrementHandling_value[createOptions.ShardedAutoIncrementHandlingStr]
+			if !ok {
+				return fmt.Errorf("invalid value provided for --sharded-auto-increment-handling, valid values are: %s", shardedAutoIncHandlingStrOptions)
+			}
+			createOptions.WorkflowOptions.ShardedAutoIncrementHandling = vtctldatapb.ShardedAutoIncrementHandling(val)
+			if val == int32(vtctldatapb.ShardedAutoIncrementHandling_REPLACE) && createOptions.WorkflowOptions.GlobalKeyspace == "" {
+				fmt.Println("WARNING: no global-keyspace value provided so all sequence table references not fully qualified must be created manually before switching traffic")
+			}
+
 			return nil
 		},
 		RunE: commandCreate,

go/cmd/vtctldclient/command/vreplication/movetables/movetables.go

@@ -17,10 +17,15 @@ limitations under the License.
 package movetables
 
 import (
+	"fmt"
+	"strings"
+
 	"github.com/spf13/cobra"
 
 	"vitess.io/vitess/go/cmd/vtctldclient/command/vreplication/common"
 	"vitess.io/vitess/go/vt/topo/topoproto"
+
+	vtctldatapb "vitess.io/vitess/go/vt/proto/vtctldata"
 )
 
 var (
@@ -32,6 +37,7 @@ var (
 		Aliases:               []string{"movetables"},
 		Args:                  cobra.ExactArgs(1),
 	}
+	shardedAutoIncHandlingStrOptions string
 )
 
 func registerCommands(root *cobra.Command) {
@@ -49,8 +55,16 @@ func registerCommands(root *cobra.Command) {
 	create.Flags().BoolVar(&createOptions.NoRoutingRules, "no-routing-rules", false, "(Advanced) Do not create routing rules while creating the workflow. See the reference documentation for limitations if you use this flag.")
 	create.Flags().BoolVar(&createOptions.AtomicCopy, "atomic-copy", false, "(EXPERIMENTAL) A single copy phase is run for all tables from the source. Use this, for example, if your source keyspace has tables which use foreign key constraints.")
 	create.Flags().StringVar(&createOptions.WorkflowOptions.TenantId, "tenant-id", "", "(EXPERIMENTAL: Multi-tenant migrations only) The tenant ID to use for the MoveTables workflow into a multi-tenant keyspace.")
-	create.Flags().BoolVar(&createOptions.WorkflowOptions.StripShardedAutoIncrement, "remove-sharded-auto-increment", true, "If moving the table(s) to a sharded keyspace, remove any auto_increment clauses when copying the schema to the target as sharded keyspaces should rely on either user/application generated values or Vitess sequences to ensure uniqueness.")
 	create.Flags().StringSliceVar(&createOptions.WorkflowOptions.Shards, "shards", nil, "(EXPERIMENTAL: Multi-tenant migrations only) Specify that vreplication streams should only be created on this subset of target shards. Warning: you should first ensure that all rows on the source route to the specified subset of target shards using your VIndex of choice or you could lose data during the migration.")
+	create.Flags().StringVar(&createOptions.WorkflowOptions.GlobalKeyspace, "global-keyspace", "", "If specified, then attempt to create any global resources here such as sequence tables needed to replace auto_increment table clauses that are removed due to --sharded-auto-increment-handling=REPLACE. The value must be an unsharded keyspace that already exists.")
+	create.Flags().StringVar(&createOptions.ShardedAutoIncrementHandlingStr, "sharded-auto-increment-handling", vtctldatapb.ShardedAutoIncrementHandling_REMOVE.String(),
+		fmt.Sprintf("If moving the table(s) to a sharded keyspace, remove any MySQL auto_increment clauses when copying the schema to the target as sharded keyspaces should rely on either user/application generated values or Vitess sequences to ensure uniqueness. If REPLACE is specified then they are automatically replaced by Vitess sequence definitions. (options are: %s)",
+			shardedAutoIncHandlingStrOptions))
+	// This flag was deprecated in v21 so can be removed in v22+.
+	create.Flags().StringVar(&createOptions.ShardedAutoIncrementHandlingStr, "remove-sharded-auto-increment", vtctldatapb.ShardedAutoIncrementHandling_REMOVE.String(),
+		fmt.Sprintf("If moving the table(s) to a sharded keyspace, remove any MySQL auto_increment clauses when copying the schema to the target as sharded keyspaces should rely on either user/application generated values or Vitess sequences to ensure uniqueness. If REPLACE is specified then they are automatically replaced by Vitess sequence definitions. (options are: %s)",
+			shardedAutoIncHandlingStrOptions))
+	create.Flags().MarkDeprecated("remove-sharded-auto-increment", "please use --sharded-auto-increment-handling instead.")
 	base.AddCommand(create)
 
 	opts := &common.SubCommandsOpts{
@@ -100,4 +114,17 @@ func registerCommands(root *cobra.Command) {
 
 func init() {
 	common.RegisterCommandHandler("MoveTables", registerCommands)
+
+	sb := strings.Builder{}
+	strvals := make([]string, len(vtctldatapb.ShardedAutoIncrementHandling_name))
+	for enumval, strval := range vtctldatapb.ShardedAutoIncrementHandling_name {
+		strvals[enumval] = strval
+	}
+	for i, v := range strvals {
+		if i > 0 {
+			sb.WriteByte(',')
+		}
+		sb.WriteString(v)
+	}
+	shardedAutoIncHandlingStrOptions = sb.String()
 }

go/test/endtoend/vreplication/vreplication_vtctldclient_cli_test.go

@@ -110,8 +110,8 @@ func testMoveTablesFlags1(t *testing.T, mt *iMoveTables, sourceKeyspace, targetK
 	createFlags := []string{"--auto-start=false", "--defer-secondary-keys=false", "--stop-after-copy",
 		"--no-routing-rules", "--on-ddl", "STOP", "--exclude-tables", "customer2",
 		"--tablet-types", "primary,rdonly", "--tablet-types-in-preference-order=true",
-		"--all-cells",
-		"--config-overrides", mapToCSV(overrides),
+		"--all-cells", "--config-overrides", mapToCSV(overrides),
+		"--sharded-auto-increment-handling=REPLACE", fmt.Sprintf("--global-keyspace=%s", sourceKeyspace),
 	}
 	completeFlags := []string{"--keep-routing-rules", "--keep-data"}
 	switchFlags := []string{}
@@ -591,6 +591,10 @@ func validateMoveTablesWorkflow(t *testing.T, workflows []*vtctldatapb.Workflow)
 	require.Equalf(t, 1, len(bls.Filter.Rules), "Rules are %+v", bls.Filter.Rules) // only customer, customer2 should be excluded
 	require.Equal(t, binlogdatapb.OnDDLAction_STOP, bls.OnDdl)
 	require.True(t, bls.StopAfterCopy)
+
+	// Validate the sharded-auto-increment-handling related value handling.
+	require.Equal(t, vtctldatapb.ShardedAutoIncrementHandling_REPLACE, vtctldatapb.ShardedAutoIncrementHandling(wf.Options.ShardedAutoIncrementHandling))
+	require.Equal(t, wf.Source.Keyspace, wf.Options.GlobalKeyspace)
 }
 
 // Test that routing rules can be applied using the vtctldclient CLI for all types of routing rules.