Experimental: Multi-tenant import support in Vitess #15128
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| /* | ||
| Copyright 2024 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 command | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| "vitess.io/vitess/go/cmd/vtctldclient/cli" | ||
| "vitess.io/vitess/go/json2" | ||
|
|
||
| vschemapb "vitess.io/vitess/go/vt/proto/vschema" | ||
| vtctldatapb "vitess.io/vitess/go/vt/proto/vtctldata" | ||
| ) | ||
|
|
||
| var ( | ||
| // ApplyKeyspaceRoutingRules makes an ApplyKeyspaceRoutingRules gRPC call to a vtctld. | ||
| ApplyKeyspaceRoutingRules = &cobra.Command{ | ||
| Use: "ApplyKeyspaceRoutingRules {--rules RULES | --rules-file RULES_FILE} [--cells=c1,c2,...] [--skip-rebuild] [--dry-run]", | ||
| Short: "Applies the provided keyspace routing rules.", | ||
| DisableFlagsInUseLine: true, | ||
| Args: cobra.NoArgs, | ||
| RunE: commandApplyKeyspaceRoutingRules, | ||
| } | ||
| // GetKeyspaceRoutingRules makes a GetKeyspaceRoutingRules gRPC call to a vtctld. | ||
| GetKeyspaceRoutingRules = &cobra.Command{ | ||
| Use: "GetKeyspaceRoutingRules", | ||
| Short: "Displays the currently active keyspace routing rules as a JSON document.", | ||
| Long: "Displays the currently active keyspace routing rules as a JSON document.", | ||
| DisableFlagsInUseLine: true, | ||
| Args: cobra.NoArgs, | ||
| RunE: commandGetKeyspaceRoutingRules, | ||
| } | ||
| ) | ||
|
|
||
| var applyKeyspaceRoutingRulesOptions = struct { | ||
| Rules string | ||
| RulesFilePath string | ||
| Cells []string | ||
| SkipRebuild bool | ||
| DryRun bool | ||
| }{} | ||
|
|
||
| func commandApplyKeyspaceRoutingRules(cmd *cobra.Command, args []string) error { | ||
| if applyKeyspaceRoutingRulesOptions.Rules != "" && applyKeyspaceRoutingRulesOptions.RulesFilePath != "" { | ||
| return fmt.Errorf("cannot pass both --rules (=%s) and --rules-file (=%s)", applyKeyspaceRoutingRulesOptions.Rules, applyKeyspaceRoutingRulesOptions.RulesFilePath) | ||
| } | ||
|
|
||
| if applyKeyspaceRoutingRulesOptions.Rules == "" && applyKeyspaceRoutingRulesOptions.RulesFilePath == "" { | ||
| return errors.New("must pass exactly one of --rules or --rules-file") | ||
| } | ||
|
|
||
| cli.FinishedParsing(cmd) | ||
|
|
||
| var rulesBytes []byte | ||
| if applyKeyspaceRoutingRulesOptions.RulesFilePath != "" { | ||
| data, err := os.ReadFile(applyKeyspaceRoutingRulesOptions.RulesFilePath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| rulesBytes = data | ||
| } else { | ||
| rulesBytes = []byte(applyKeyspaceRoutingRulesOptions.Rules) | ||
| } | ||
|
|
||
| srr := &vschemapb.KeyspaceRoutingRules{} | ||
| if err := json2.Unmarshal(rulesBytes, &srr); err != nil { | ||
| return err | ||
| } | ||
| // Round-trip so when we display the result it's readable. | ||
| data, err := cli.MarshalJSON(srr) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if applyKeyspaceRoutingRulesOptions.DryRun { | ||
| fmt.Printf("[DRY RUN] Would have saved new KeyspaceRoutingRules object:\n%s\n", data) | ||
|
|
||
| if applyRoutingRulesOptions.SkipRebuild { | ||
| fmt.Println("[DRY RUN] Would not have rebuilt VSchema graph, would have required operator to run RebuildVSchemaGraph for changes to take effect.") | ||
| } else { | ||
| fmt.Print("[DRY RUN] Would have rebuilt the VSchema graph") | ||
| if len(applyRoutingRulesOptions.Cells) == 0 { | ||
| fmt.Print(" in all cells\n") | ||
| } else { | ||
| fmt.Printf(" in the following cells: %s.\n", strings.Join(applyKeyspaceRoutingRulesOptions.Cells, ", ")) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| _, err = client.ApplyKeyspaceRoutingRules(commandCtx, &vtctldatapb.ApplyKeyspaceRoutingRulesRequest{ | ||
| KeyspaceRoutingRules: srr, | ||
| SkipRebuild: applyKeyspaceRoutingRulesOptions.SkipRebuild, | ||
| RebuildCells: applyKeyspaceRoutingRulesOptions.Cells, | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| fmt.Printf("New KeyspaceRoutingRules object:\n%s\nIf this is not what you expected, check the input data (as JSON parsing will skip unexpected fields).\n", data) | ||
|
|
||
| if applyRoutingRulesOptions.SkipRebuild { | ||
| fmt.Println("Skipping rebuild of VSchema graph as requested, you will need to run RebuildVSchemaGraph for the changes to take effect.") | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func commandGetKeyspaceRoutingRules(cmd *cobra.Command, args []string) error { | ||
| cli.FinishedParsing(cmd) | ||
|
|
||
| resp, err := client.GetKeyspaceRoutingRules(commandCtx, &vtctldatapb.GetKeyspaceRoutingRulesRequest{}) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| data, err := cli.MarshalJSON(resp.KeyspaceRoutingRules) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| fmt.Printf("%s\n", data) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func init() { | ||
| ApplyKeyspaceRoutingRules.Flags().StringVarP(&applyKeyspaceRoutingRulesOptions.Rules, "rules", "r", "", "Shard routing rules, specified as a string") | ||
| ApplyKeyspaceRoutingRules.Flags().StringVarP(&applyKeyspaceRoutingRulesOptions.RulesFilePath, "rules-file", "f", "", "Path to a file containing shard routing rules specified as JSON") | ||
| ApplyKeyspaceRoutingRules.Flags().StringSliceVarP(&applyKeyspaceRoutingRulesOptions.Cells, "cells", "c", nil, "Limit the VSchema graph rebuilding to the specified cells. Ignored if --skip-rebuild is specified.") | ||
| ApplyKeyspaceRoutingRules.Flags().BoolVar(&applyKeyspaceRoutingRulesOptions.SkipRebuild, "skip-rebuild", false, "Skip rebuilding the SrvVSchema objects.") | ||
| ApplyKeyspaceRoutingRules.Flags().BoolVarP(&applyKeyspaceRoutingRulesOptions.DryRun, "dry-run", "d", false, "Validate the specified shard routing rules and note actions that would be taken, but do not actually apply the rules to the topo.") | ||
| Root.AddCommand(ApplyKeyspaceRoutingRules) | ||
|
|
||
| Root.AddCommand(GetKeyspaceRoutingRules) | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,7 @@ Usage: | |
| Available Commands: | ||
| AddCellInfo Registers a local topology service in a new cell by creating the CellInfo. | ||
| AddCellsAlias Defines a group of cells that can be referenced by a single name (the alias). | ||
| ApplyKeyspaceRoutingRules Applies the provided keyspace routing rules. | ||
| ApplyRoutingRules Applies the VSchema routing rules. | ||
| ApplySchema Applies the schema change to the specified keyspace on every primary, running in parallel on all shards. The changes are then propagated to replicas via replication. | ||
| ApplyShardRoutingRules Applies the provided shard routing rules. | ||
|
|
@@ -38,6 +39,7 @@ Available Commands: | |
| GetCellsAliases Gets all CellsAlias objects in the cluster. | ||
| GetFullStatus Outputs a JSON structure that contains full status of MySQL including the replication information, semi-sync information, GTID information among others. | ||
| GetKeyspace Returns information about the given keyspace from the topology. | ||
| GetKeyspaceRoutingRules Displays the currently active keyspace routing rules as a JSON document. | ||
| GetKeyspaces Returns information about every keyspace in the topology. | ||
| GetPermissions Displays the permissions for a tablet. | ||
| GetRoutingRules Displays the VSchema routing rules. | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -168,6 +168,7 @@ func waitForQueryResult(t *testing.T, conn *mysql.Conn, database string, query s | |
| for { | ||
| qr := execVtgateQuery(t, conn, database, query) | ||
| require.NotNil(t, qr) | ||
| log.Infof("query %q returned %v", query, qr.Rows) | ||
|
There was a problem hiding this comment. Do you want to keep this log line for merge? |
||
| if want == fmt.Sprintf("%v", qr.Rows) { | ||
| return | ||
| } | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about extending
ApplyRoutingRulesandGetRoutingRulesto take optional keyspace and shard arguments? Then we won't have so many separate commands. We can then also deprecate and deleteApplyShardRoutingRulesandGetShardRoutingRules.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Keyspace, Routing and Shard rules are quite different in terms of functionality. It might be better to have them separate because of that.
We can't have a table routing rule just for a shard for example. Also each of these takes a rules file and those files cannot contain a combination of table and keyspace for example.
Maybe we can have think of a RoutingRule umbrella command:
table,keyspaceandshardsubcommands andapplyandgetactions. But it will be a non-trivial refactor.