Add support for replicas in shell and connect commands (#846)

* Add replica flag to shell and connect commands

* Fix up args to only add primary if flag is false

* Dynamically set database name

* remove unnecessary space

* Only call @primary for primary cluster, load with no defaults for replicas

internal/cmd/connect/connect.go

@@ -33,6 +33,7 @@ func ConnectCmd(ch *cmdutil.Helper) *cobra.Command {
 		execCommandEnvURL   string
 		role                string
 		noRandom            bool
+		replica             bool
 	}
 
 	cmd := &cobra.Command{
@@ -82,12 +83,16 @@ argument:
 				}
 			}
 
+			replica := flags.replica
+
 			role := cmdutil.AdministratorRole
 			if flags.role != "" {
 				role, err = cmdutil.RoleFromString(flags.role)
 				if err != nil {
 					return err
 				}
+			} else if replica {
+				role = cmdutil.ReaderRole
 			}
 
 			// check whether database and branch exist
@@ -116,6 +121,7 @@ argument:
 				Role:         role,
 				Name:         passwordutil.GenerateName("pscale-cli-connect"),
 				TTL:          5 * time.Minute,
+				Replica:      replica,
 			})
 			if err != nil {
 				return cmdutil.HandleError(err)
@@ -207,7 +213,9 @@ argument:
 	cmd.PersistentFlags().StringVar(&flags.execCommandEnvURL, "execute-env-url", "DATABASE_URL",
 		"Environment variable name that contains the exposed Database URL.")
 	cmd.PersistentFlags().StringVar(&flags.role, "role",
-		"admin", "Role defines the access level, allowed values are : reader, writer, readwriter, admin. By default it is admin.")
+		"", "Role defines the access level, allowed values are: reader, writer, readwriter, admin. Defaults to 'reader' for replica passwords, otherwise defaults to 'admin'.")
+	cmd.Flags().BoolVar(&flags.replica, "replica", false, "When enabled, the password will route all reads to the branch's primary replicas and all read-only regions.")
+	cmd.Flags().MarkHidden("replica")
 
 	return cmd
 }

internal/cmd/password/create.go

@@ -85,7 +85,7 @@ func CreateCmd(ch *cmdutil.Helper) *cobra.Command {
 		},
 	}
 	cmd.PersistentFlags().StringVar(&flags.role, "role",
-		"", "Role defines the access level, allowed values are : reader, writer, readwriter, admin. Defaults to 'reader' for replica passwords, otherwise defaults to 'admin'.")
+		"", "Role defines the access level, allowed values are: reader, writer, readwriter, admin. Defaults to 'reader' for replica passwords, otherwise defaults to 'admin'.")
 	cmd.PersistentFlags().Var(&flags.ttl, "ttl", `TTL defines the time to live for the password. Durations such as "30m", "24h", or bare integers such as "3600" (seconds) are accepted. The default TTL is 0s, which means the password will never expire.`)
 	cmd.Flags().BoolVar(&flags.replica, "replica", false, "When enabled, the password will route all reads to the branch's primary replicas and all read-only regions.")
 	cmd.Flags().MarkHidden("replica")

internal/cmd/shell/shell.go

@@ -27,6 +27,7 @@ func ShellCmd(ch *cmdutil.Helper) *cobra.Command {
 		localAddr  string
 		remoteAddr string
 		role       string
+		replica    bool
 	}
 
 	cmd := &cobra.Command{
@@ -82,12 +83,16 @@ second argument:
 				}
 			}
 
+			replica := flags.replica
+
 			role := cmdutil.AdministratorRole
 			if flags.role != "" {
 				role, err = cmdutil.RoleFromString(flags.role)
 				if err != nil {
 					return err
 				}
+			} else if replica {
+				role = cmdutil.ReaderRole
 			}
 
 			// check whether database and branch exist
@@ -131,6 +136,7 @@ second argument:
 				Role:         role,
 				Name:         passwordutil.GenerateName("pscale-cli-shell"),
 				TTL:          5 * time.Minute,
+				Replica:      replica,
 			})
 			if err != nil {
 				return cmdutil.HandleError(err)
@@ -182,7 +188,11 @@ second argument:
 				"-t", // the -s (silent) flag disables tabular output, re-enable it.
 				"-h", host,
 				"-P", port,
-				"-D", "@primary",
+			}
+			if replica {
+				mysqlArgs = append([]string{"--no-defaults"}, mysqlArgs...)
+			} else {
+				mysqlArgs = append(mysqlArgs, "-D", "@primary")
 			}
 
 			historyFile := historyFilePath(ch.Config.Organization, database, branch)
@@ -227,7 +237,10 @@ second argument:
 	cmd.PersistentFlags().StringVar(&flags.remoteAddr, "remote-addr", "",
 		"PlanetScale Database remote network address. By default the remote address is populated automatically from the PlanetScale API. (format: `hostname:port`)")
 	cmd.PersistentFlags().StringVar(&flags.role, "role",
-		"admin", "Role defines the access level, allowed values are : reader, writer, readwriter, admin. By default it is admin.")
+		"", "Role defines the access level, allowed values are: reader, writer, readwriter, admin. Defaults to 'reader' for replica passwords, otherwise defaults to 'admin'.")
+	cmd.Flags().BoolVar(&flags.replica, "replica", false, "When enabled, the password will route all reads to the branch's primary replicas and all read-only regions.")
+	cmd.Flags().MarkHidden("replica")
+
 	cmd.MarkPersistentFlagRequired("org") // nolint:errcheck
 
 	return cmd

internal/passwordutil/password.go

@@ -23,6 +23,7 @@ type Options struct {
 	Role         cmdutil.PasswordRole
 	Name         string
 	TTL          time.Duration
+	Replica      bool
 }
 
 type Password struct {
@@ -78,6 +79,7 @@ func New(ctx context.Context, client *ps.Client, opt Options) (*Password, error)
 		Role:         opt.Role.ToString(),
 		Name:         opt.Name,
 		TTL:          int(opt.TTL.Seconds()),
+		Replica:      opt.Replica,
 	})
 	if err != nil {
 		return nil, err