Flags migration: Most pending flags migrated for all binaries (vitessio#18624)

Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: Claude <[email protected]>

Author: rohit-nayak-ps

go/cmd/topo2topo/cli/topo2topo.go

@@ -29,6 +29,7 @@ import (
 	"vitess.io/vitess/go/vt/sqlparser"
 	"vitess.io/vitess/go/vt/topo"
 	"vitess.io/vitess/go/vt/topo/helpers"
+	"vitess.io/vitess/go/vt/utils"
 )
 
 var (
@@ -60,12 +61,12 @@ It can also be used to compare data between two topologies.`,
 func init() {
 	servenv.MoveFlagsToCobraCommand(Main)
 
-	Main.Flags().StringVar(&fromImplementation, "from_implementation", fromImplementation, "topology implementation to copy data from")
-	Main.Flags().StringVar(&fromServerAddress, "from_server", fromServerAddress, "topology server address to copy data from")
-	Main.Flags().StringVar(&fromRoot, "from_root", fromRoot, "topology server root to copy data from")
-	Main.Flags().StringVar(&toImplementation, "to_implementation", toImplementation, "topology implementation to copy data to")
-	Main.Flags().StringVar(&toServerAddress, "to_server", toServerAddress, "topology server address to copy data to")
-	Main.Flags().StringVar(&toRoot, "to_root", toRoot, "topology server root to copy data to")
+	utils.SetFlagStringVar(Main.Flags(), &fromImplementation, "from-implementation", fromImplementation, "topology implementation to copy data from")
+	utils.SetFlagStringVar(Main.Flags(), &fromServerAddress, "from-server", fromServerAddress, "topology server address to copy data from")
+	utils.SetFlagStringVar(Main.Flags(), &fromRoot, "from-root", fromRoot, "topology server root to copy data from")
+	utils.SetFlagStringVar(Main.Flags(), &toImplementation, "to-implementation", toImplementation, "topology implementation to copy data to")
+	utils.SetFlagStringVar(Main.Flags(), &toServerAddress, "to-server", toServerAddress, "topology server address to copy data to")
+	utils.SetFlagStringVar(Main.Flags(), &toRoot, "to-root", toRoot, "topology server root to copy data to")
 	Main.Flags().BoolVar(&compare, "compare", compare, "compares data between topologies")
 	Main.Flags().BoolVar(&doKeyspaces, "do-keyspaces", doKeyspaces, "copies the keyspace information")
 	Main.Flags().BoolVar(&doShards, "do-shards", doShards, "copies the shard information")

go/cmd/vtbackup/cli/vtbackup.go

@@ -201,25 +201,25 @@ func init() {
 
 	servenv.MoveFlagsToCobraCommand(Main)
 
-	Main.Flags().DurationVar(&minBackupInterval, "min_backup_interval", minBackupInterval, "Only take a new backup if it's been at least this long since the most recent backup.")
-	Main.Flags().DurationVar(&minRetentionTime, "min_retention_time", minRetentionTime, "Keep each old backup for at least this long before removing it. Set to 0 to disable pruning of old backups.")
-	Main.Flags().IntVar(&minRetentionCount, "min_retention_count", minRetentionCount, "Always keep at least this many of the most recent backups in this backup storage location, even if some are older than the min_retention_time. This must be at least 1 since a backup must always exist to allow new backups to be made")
-	Main.Flags().BoolVar(&initialBackup, "initial_backup", initialBackup, "Instead of restoring from backup, initialize an empty database with the provided init-db-sql-file and upload a backup of that for the shard, if the shard has no backups yet. This can be used to seed a brand new shard with an initial, empty backup. If any backups already exist for the shard, this will be considered a successful no-op. This can only be done before the shard exists in topology (i.e. before any tablets are deployed).")
-	Main.Flags().BoolVar(&allowFirstBackup, "allow_first_backup", allowFirstBackup, "Allow this job to take the first backup of an existing shard.")
-	Main.Flags().BoolVar(&restartBeforeBackup, "restart_before_backup", restartBeforeBackup, "Perform a mysqld clean/full restart after applying binlogs, but before taking the backup. Only makes sense to work around xtrabackup bugs.")
+	utils.SetFlagDurationVar(Main.Flags(), &minBackupInterval, "min-backup-interval", minBackupInterval, "Only take a new backup if it's been at least this long since the most recent backup.")
+	utils.SetFlagDurationVar(Main.Flags(), &minRetentionTime, "min-retention-time", minRetentionTime, "Keep each old backup for at least this long before removing it. Set to 0 to disable pruning of old backups.")
+	utils.SetFlagIntVar(Main.Flags(), &minRetentionCount, "min-retention-count", minRetentionCount, "Always keep at least this many of the most recent backups in this backup storage location, even if some are older than the min_retention_time. This must be at least 1 since a backup must always exist to allow new backups to be made")
+	utils.SetFlagBoolVar(Main.Flags(), &initialBackup, "initial-backup", initialBackup, "Instead of restoring from backup, initialize an empty database with the provided init-db-sql-file and upload a backup of that for the shard, if the shard has no backups yet. This can be used to seed a brand new shard with an initial, empty backup. If any backups already exist for the shard, this will be considered a successful no-op. This can only be done before the shard exists in topology (i.e. before any tablets are deployed).")
+	utils.SetFlagBoolVar(Main.Flags(), &allowFirstBackup, "allow-first-backup", allowFirstBackup, "Allow this job to take the first backup of an existing shard.")
+	utils.SetFlagBoolVar(Main.Flags(), &restartBeforeBackup, "restart-before-backup", restartBeforeBackup, "Perform a mysqld clean/full restart after applying binlogs, but before taking the backup. Only makes sense to work around xtrabackup bugs.")
 	Main.Flags().BoolVar(&upgradeSafe, "upgrade-safe", upgradeSafe, "Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades.")
 
 	// vttablet-like flags
 	utils.SetFlagStringVar(Main.Flags(), &initDbNameOverride, "init-db-name-override", initDbNameOverride, "(init parameter) override the name of the db used by vttablet")
 	utils.SetFlagStringVar(Main.Flags(), &initKeyspace, "init-keyspace", initKeyspace, "(init parameter) keyspace to use for this tablet")
 	utils.SetFlagStringVar(Main.Flags(), &initShard, "init-shard", initShard, "(init parameter) shard to use for this tablet")
 	Main.Flags().IntVar(&concurrency, "concurrency", concurrency, "(init restore parameter) how many concurrent files to restore at once")
-	Main.Flags().StringVar(&incrementalFromPos, "incremental_from_pos", incrementalFromPos, "Position, or name of backup from which to create an incremental backup. Default: empty. If given, then this backup becomes an incremental backup from given position or given backup. If value is 'auto', this backup will be taken from the last successful backup position.")
+	utils.SetFlagStringVar(Main.Flags(), &incrementalFromPos, "incremental-from-pos", incrementalFromPos, "Position, or name of backup from which to create an incremental backup. Default: empty. If given, then this backup becomes an incremental backup from given position or given backup. If value is 'auto', this backup will be taken from the last successful backup position.")
 
 	// mysqlctld-like flags
 	utils.SetFlagIntVar(Main.Flags(), &mysqlPort, "mysql-port", mysqlPort, "MySQL port")
 	utils.SetFlagStringVar(Main.Flags(), &mysqlSocket, "mysql-socket", mysqlSocket, "Path to the mysqld socket file")
-	Main.Flags().DurationVar(&mysqlTimeout, "mysql_timeout", mysqlTimeout, "how long to wait for mysqld startup")
+	utils.SetFlagDurationVar(Main.Flags(), &mysqlTimeout, "mysql-timeout", mysqlTimeout, "how long to wait for mysqld startup")
 	Main.Flags().DurationVar(&mysqlShutdownTimeout, "mysql-shutdown-timeout", mysqlShutdownTimeout, "how long to wait for mysqld shutdown")
 	utils.SetFlagStringVar(Main.Flags(), &initDBSQLFile, "init-db-sql-file", initDBSQLFile, "path to .sql file to run after mysql_install_db")
 	Main.Flags().BoolVar(&detachedMode, "detach", detachedMode, "detached mode - run backups detached from the terminal")

go/cmd/vtbench/cli/vtbench.go

@@ -30,6 +30,7 @@ import (
 	"vitess.io/vitess/go/vt/grpccommon"
 	"vitess.io/vitess/go/vt/logutil"
 	"vitess.io/vitess/go/vt/servenv"
+	"vitess.io/vitess/go/vt/utils"
 	"vitess.io/vitess/go/vtbench"
 
 	// Import and register the gRPC vtgateconn client
@@ -139,7 +140,7 @@ func init() {
 
 	Main.Flags().StringVar(&host, "host", host, "VTGate host(s) in the form 'host1,host2,...'")
 	Main.Flags().IntVar(&port, "port", port, "VTGate port")
-	Main.Flags().StringVar(&unixSocket, "unix_socket", unixSocket, "VTGate unix socket")
+	utils.SetFlagStringVar(Main.Flags(), &unixSocket, "unix-socket", unixSocket, "VTGate unix socket")
 	Main.Flags().StringVar(&protocol, "protocol", protocol, "Client protocol, either mysql (default), grpc-vtgate, or grpc-vttablet")
 	Main.Flags().StringVar(&user, "user", user, "Username to connect using mysql (password comes from the db-credentials-file)")
 	Main.Flags().StringVar(&db, "db", db, "Database name to use when connecting / running the queries (e.g. @replica, keyspace, keyspace/shard etc)")

go/cmd/vtclient/cli/vtclient.go

@@ -39,6 +39,7 @@ import (
 	"vitess.io/vitess/go/vt/logutil"
 	"vitess.io/vitess/go/vt/servenv"
 	"vitess.io/vitess/go/vt/sqlparser"
+	"vitess.io/vitess/go/vt/utils"
 	"vitess.io/vitess/go/vt/vitessdriver"
 	"vitess.io/vitess/go/vt/vterrors"
 	"vitess.io/vitess/go/vt/vtgate/vtgateconn"
@@ -92,16 +93,16 @@ func InitializeFlags() {
 	Main.Flags().BoolVar(&jsonOutput, "json", jsonOutput, "Output JSON instead of human-readable table")
 	Main.Flags().IntVar(&parallel, "parallel", parallel, "DMLs only: Number of threads executing the same query in parallel. Useful for simple load testing.")
 	Main.Flags().IntVar(&count, "count", count, "DMLs only: Number of times each thread executes the query. Useful for simple, sustained load testing.")
-	Main.Flags().IntVar(&minSeqID, "min_sequence_id", minSeqID, "min sequence ID to generate. When max_sequence_id > min_sequence_id, for each query, a number is generated in [min_sequence_id, max_sequence_id) and attached to the end of the bind variables.")
-	Main.Flags().IntVar(&maxSeqID, "max_sequence_id", maxSeqID, "max sequence ID.")
-	Main.Flags().BoolVar(&useRandom, "use_random_sequence", useRandom, "use random sequence for generating [min_sequence_id, max_sequence_id)")
+	utils.SetFlagIntVar(Main.Flags(), &minSeqID, "min-sequence-id", minSeqID, "min sequence ID to generate. When max-sequence-id > min-sequence-id, for each query, a number is generated in [min-sequence-id, max-sequence-id) and attached to the end of the bind variables.")
+	utils.SetFlagIntVar(Main.Flags(), &maxSeqID, "max-sequence-id", maxSeqID, "max sequence ID.")
+	utils.SetFlagBoolVar(Main.Flags(), &useRandom, "use-random-sequence", useRandom, "use random sequence for generating [min-sequence-id, max-sequence-id)")
 	Main.Flags().IntVar(&qps, "qps", qps, "queries per second to throttle each thread at.")
 
 	acl.RegisterFlags(Main.Flags())
 	grpccommon.RegisterFlags(Main.Flags())
 	servenv.RegisterMySQLServerFlags(Main.Flags())
 
-	bindVariables = newBindvars(Main.Flags(), "bind_variables", "bind variables as a json list")
+	bindVariables = newBindvars(Main.Flags(), "bind-variables", "bind variables as a json list")
 }
 
 type bindvars []any
@@ -146,7 +147,7 @@ func (bv *bindvars) Type() string {
 
 func newBindvars(fs *pflag.FlagSet, name, usage string) *bindvars {
 	var bv bindvars
-	fs.Var(&bv, name, usage)
+	utils.SetFlagVar(fs, &bv, name, usage)
 	return &bv
 }
 

go/cmd/vtclient/cli/vtclient_test.go

@@ -91,7 +91,7 @@ func TestVtclient(t *testing.T) {
 			args: []string{"SELECT * FROM table1"},
 		},
 		{
-			args: []string{"--target", "@primary", "--bind_variables", `[ 1, 100 ]`,
+			args: []string{"--target", "@primary", "--bind-variables", `[ 1, 100 ]`,
 				"INSERT INTO table1 (id, i) VALUES (:v1, :v2)"},
 			rowsAffected: 1,
 		},
@@ -106,7 +106,7 @@ func TestVtclient(t *testing.T) {
 			rowsAffected: 1,
 		},
 		{
-			args: []string{"--target", "@primary", "--bind_variables", `[ 1 ]`,
+			args: []string{"--target", "@primary", "--bind-variables", `[ 1 ]`,
 				"DELETE FROM table1 WHERE id = :v1"},
 			rowsAffected: 1,
 		},

go/cmd/vtctlclient/main.go

@@ -32,6 +32,7 @@ import (
 	"vitess.io/vitess/go/vt/log"
 	"vitess.io/vitess/go/vt/logutil"
 	"vitess.io/vitess/go/vt/servenv"
+	"vitess.io/vitess/go/vt/utils"
 	"vitess.io/vitess/go/vt/vtctl/vtctlclient"
 
 	logutilpb "vitess.io/vitess/go/vt/proto/logutil"
@@ -47,7 +48,7 @@ var (
 
 func init() {
 	servenv.OnParse(func(fs *pflag.FlagSet) {
-		fs.DurationVar(&actionTimeout, "action_timeout", actionTimeout, "timeout for the total command")
+		utils.SetFlagDurationVar(fs, &actionTimeout, "action-timeout", actionTimeout, "timeout for the total command")
 		fs.StringVar(&server, "server", server, "server to use for connection")
 
 		acl.RegisterFlags(fs)

go/cmd/vtctldclient/command/root.go

@@ -32,6 +32,7 @@ import (
 	"vitess.io/vitess/go/vt/logutil"
 	"vitess.io/vitess/go/vt/servenv"
 	"vitess.io/vitess/go/vt/topo"
+	"vitess.io/vitess/go/vt/utils"
 	"vitess.io/vitess/go/vt/vtctl/grpcvtctldserver"
 	"vitess.io/vitess/go/vt/vtctl/localvtctldclient"
 	"vitess.io/vitess/go/vt/vtctl/vtctldclient"
@@ -223,7 +224,7 @@ func getClientForCommand(cmd *cobra.Command) (vtctldclient.VtctldClient, error)
 
 func init() {
 	Root.PersistentFlags().StringVar(&server, "server", "", "server to use for the connection (required)")
-	Root.PersistentFlags().DurationVar(&actionTimeout, "action_timeout", time.Hour, "timeout to use for the command")
+	utils.SetFlagDurationVar(Root.PersistentFlags(), &actionTimeout, "action-timeout", time.Hour, "timeout to use for the command")
 	Root.PersistentFlags().BoolVar(&compactOutput, "compact", false, "use compact format for otherwise verbose outputs")
 	Root.PersistentFlags().StringVar(&topoOptions.implementation, "topo-implementation", topoOptions.implementation, "the topology implementation to use")
 	Root.PersistentFlags().StringSliceVar(&topoOptions.globalServerAddresses, "topo-global-server-address", topoOptions.globalServerAddresses, "the address of the global topology server(s)")

go/cmd/vtgate/cli/plugin_auth_clientcert.go

@@ -20,13 +20,14 @@ package cli
 
 import (
 	"vitess.io/vitess/go/mysql"
+	"vitess.io/vitess/go/vt/utils"
 	"vitess.io/vitess/go/vt/vtgate"
 )
 
 var clientcertAuthMethod string
 
 func init() {
-	Main.Flags().StringVar(&clientcertAuthMethod, "mysql_clientcert_auth_method", string(mysql.MysqlClearPassword), "client-side authentication method to use. Supported values: mysql_clear_password, dialog.")
+	utils.SetFlagStringVar(Main.Flags(), &clientcertAuthMethod, "mysql-clientcert-auth-method", string(mysql.MysqlClearPassword), "client-side authentication method to use. Supported values: mysql_clear_password, dialog.")
 
 	vtgate.RegisterPluginInitializer(func() {
 		mysql.InitAuthServerClientCert(clientcertAuthMethod, vtgate.GetMysqlServerSSLCA())

go/cmd/vtgate/cli/plugin_auth_ldap.go

@@ -21,6 +21,7 @@ package cli
 import (
 	"vitess.io/vitess/go/mysql"
 	"vitess.io/vitess/go/mysql/ldapauthserver"
+	"vitess.io/vitess/go/vt/utils"
 	"vitess.io/vitess/go/vt/vtgate"
 )
 
@@ -31,9 +32,9 @@ var (
 )
 
 func init() {
-	Main.Flags().StringVar(&ldapAuthConfigFile, "mysql_ldap_auth_config_file", "", "JSON File from which to read LDAP server config.")
-	Main.Flags().StringVar(&ldapAuthConfigString, "mysql_ldap_auth_config_string", "", "JSON representation of LDAP server config.")
-	Main.Flags().StringVar(&ldapAuthMethod, "mysql_ldap_auth_method", string(mysql.MysqlClearPassword), "client-side authentication method to use. Supported values: mysql_clear_password, dialog.")
+	utils.SetFlagStringVar(Main.Flags(), &ldapAuthConfigFile, "mysql-ldap-auth-config-file", "", "JSON File from which to read LDAP server config.")
+	utils.SetFlagStringVar(Main.Flags(), &ldapAuthConfigString, "mysql-ldap-auth-config-string", "", "JSON representation of LDAP server config.")
+	utils.SetFlagStringVar(Main.Flags(), &ldapAuthMethod, "mysql-ldap-auth-method", string(mysql.MysqlClearPassword), "client-side authentication method to use. Supported values: mysql_clear_password, dialog.")
 
 	vtgate.RegisterPluginInitializer(func() { ldapauthserver.Init(ldapAuthConfigFile, ldapAuthConfigString, ldapAuthMethod) })
 }

go/cmd/vtgate/cli/plugin_auth_static.go

@@ -22,6 +22,7 @@ import (
 	"time"
 
 	"vitess.io/vitess/go/mysql"
+	"vitess.io/vitess/go/vt/utils"
 	"vitess.io/vitess/go/vt/vtgate"
 )
 
@@ -32,9 +33,9 @@ var (
 )
 
 func init() {
-	Main.Flags().StringVar(&mysqlAuthServerStaticFile, "mysql_auth_server_static_file", "", "JSON File to read the users/passwords from.")
-	Main.Flags().StringVar(&mysqlAuthServerStaticString, "mysql_auth_server_static_string", "", "JSON representation of the users/passwords config.")
-	Main.Flags().DurationVar(&mysqlAuthServerStaticReloadInterval, "mysql_auth_static_reload_interval", 0, "Ticker to reload credentials")
+	utils.SetFlagStringVar(Main.Flags(), &mysqlAuthServerStaticFile, "mysql-auth-server-static-file", "", "JSON File to read the users/passwords from.")
+	utils.SetFlagStringVar(Main.Flags(), &mysqlAuthServerStaticString, "mysql-auth-server-static-string", "", "JSON representation of the users/passwords config.")
+	utils.SetFlagDurationVar(Main.Flags(), &mysqlAuthServerStaticReloadInterval, "mysql-auth-static-reload-interval", 0, "Ticker to reload credentials")
 
 	vtgate.RegisterPluginInitializer(func() {
 		mysql.InitAuthServerStatic(mysqlAuthServerStaticFile, mysqlAuthServerStaticString, mysqlAuthServerStaticReloadInterval)