cmdutil

Documentation

Index

• Constants
• func BranchClusterSizesCompletionFunc(ch *Helper, cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective)
• func CheckAuthentication(cfg *config.Config) func(cmd *cobra.Command, args []string) error
• func ClusterSizesCompletionFunc(ch *Helper, cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective)
• func DatabaseCompletionFunc(ch *Helper, cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
• func DeployRequestBranchToNumber(ctx context.Context, client *ps.Client, organization string, database string, ...) (uint64, error)
• func ErrCode(err error) planetscale.ErrorCode
• func HandleError(err error) error
• func HandleNotFoundWithServiceTokenCheck(ctx context.Context, cmd *cobra.Command, cfg *config.Config, ...) error
• func HasHomebrew() bool
• func IsUnderHomebrew(binpath string) bool
• func MySQLClientPath() (string, mysql.AuthMethodDescription, error)
• func NewZapLogger(debug bool) *zap.Logger
• func OpenBrowser(goos, url string) *exec.Cmd
• func ParseSSLMode(sslMode string) ps.ExternalDataSourceSSLVerificationMode
• func RegionsCompletionFunc(ch *Helper, cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective)
• func RequiredArgs(reqArgs ...string) cobra.PositionalArgs
• func SnakeToSentenceCase(s string) string
• func TimeToMilliseconds(t time.Time) int64
• func ToClusterSizeSlug(c string) string
• func ValidateServiceTokenOnNotFound(ctx context.Context, cmd *cobra.Command, cfg *config.Config, ...) error
• type ByteFormat
  • func FormatParts(bytes int64) ByteFormat
  • func FormatPartsGB(bytes int64) ByteFormat
  • func (b ByteFormat) IntString() string
  • func (b ByteFormat) String() string
• type Error
  • func (e *Error) Error() string
• type Helper
  • func (h *Helper) Debug() bool
  • func (h *Helper) SetDebug(debug *bool)
• type PasswordRole
  • func RoleFromString(r string) (PasswordRole, error)
  • func (r PasswordRole) ToString() string

Constants

const (
	ActionRequestedExitCode = 1
	FatalErrExitCode        = 2
)

const ApplicationURL = "https://app.planetscale.com"

const WarnAuthMessage = "not authenticated yet. Please run 'pscale auth login'"

Functions

func BranchClusterSizesCompletionFunc

func BranchClusterSizesCompletionFunc(ch *Helper, cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective)

func CheckAuthentication

func CheckAuthentication(cfg *config.Config) func(cmd *cobra.Command, args []string) error

CheckAuthentication checks whether the user is authenticated and returns a actionable error message.

func ClusterSizesCompletionFunc

func ClusterSizesCompletionFunc(ch *Helper, cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective)

func DatabaseCompletionFunc

func DatabaseCompletionFunc(ch *Helper, cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

func DeployRequestBranchToNumber

func DeployRequestBranchToNumber(ctx context.Context, client *ps.Client, organization string, database string, branch string, state string) (uint64, error)

func ErrCode

func ErrCode(err error) planetscale.ErrorCode

ErrCode returns the code from a *planetscale.Error, if available. If the error is not of type *planetscale.Error or is nil, it returns an empty, undefined error code.

func HandleError

func HandleError(err error) error

HandleError checks whether the given err is an *planetscale.Error and returns a descriptive, human readable error if the error code matches a certain planetscale Error types. If the error doesn't match these requirements, err is returned unmodified.

func HandleNotFoundWithServiceTokenCheck

func HandleNotFoundWithServiceTokenCheck(ctx context.Context, cmd *cobra.Command, cfg *config.Config, clientFunc func() (*planetscale.Client, error), originalErr error, requiredPermission string, notFoundMsgFormat string, args ...interface{}) error

HandleNotFoundWithServiceTokenCheck is a convenience function that combines the common pattern of handling 404 errors with service token validation. It should be used in the ErrNotFound case of error handling switch statements.

The requiredPermission parameter is optional (can be empty string). When provided, it will be included in the error message to help users understand what permission their service token needs.

Usage example:

switch cmdutil.ErrCode(err) {
case planetscale.ErrNotFound:
    return cmdutil.HandleNotFoundWithServiceTokenCheck(
        ctx, cmd, ch.Config, ch.Client, err, "read_branch",
        "branch %s does not exist in database %s (organization: %s)",
        printer.BoldBlue(branch), printer.BoldBlue(database), printer.BoldBlue(ch.Config.Organization))
default:
    return cmdutil.HandleError(err)
}

func HasHomebrew

func HasHomebrew() bool

HasHomebrew check whether the user has installed brew

func IsUnderHomebrew

func IsUnderHomebrew(binpath string) bool

IsUnderHomebrew checks whether the given binary is under the homebrew path. copied from: https://github.com/cli/cli/blob/trunk/cmd/gh/main.go#L298

func MySQLClientPath

func MySQLClientPath() (string, mysql.AuthMethodDescription, error)

MySQLClientPath checks whether the 'mysql' client exists and returns the path to the binary. The returned error contains instructions to install the client.

func NewZapLogger

func NewZapLogger(debug bool) *zap.Logger

NewZapLogger returns a logger to be used with the sql-proxy. By default it only outputs error leveled messages, unless debug is true.

func OpenBrowser

func OpenBrowser(goos, url string) *exec.Cmd

OpenBrowser opens a web browser at the specified url.

func ParseSSLMode

func ParseSSLMode(sslMode string) ps.ExternalDataSourceSSLVerificationMode

func RegionsCompletionFunc

func RegionsCompletionFunc(ch *Helper, cmd *cobra.Command, args []string, toComplete string) ([]cobra.Completion, cobra.ShellCompDirective)

func RequiredArgs

func RequiredArgs(reqArgs ...string) cobra.PositionalArgs

required arguments are not available.

func SnakeToSentenceCase

func SnakeToSentenceCase(s string) string

func TimeToMilliseconds

func TimeToMilliseconds(t time.Time) int64

func ToClusterSizeSlug

func ToClusterSizeSlug(c string) string

func ValidateServiceTokenOnNotFound

func ValidateServiceTokenOnNotFound(ctx context.Context, cmd *cobra.Command, cfg *config.Config, clientFunc func() (*planetscale.Client, error), originalErr error) error

ValidateServiceTokenOnNotFound checks if a 404 error might be due to invalid service token authentication. It performs an additional authentication check when using service tokens to distinguish between a genuine "not found" error and an authentication failure.

This function should be called when: 1. The API returns a 404 error 2. The user is authenticated with a service token

Returns: - nil if the service token is valid (indicating a genuine 404) - An authentication error if the service token is invalid - The original error if not using service tokens or if the validation check fails

Types

type ByteFormat

type ByteFormat struct {
	// contains filtered or unexported fields
}

func FormatParts

func FormatParts(bytes int64) ByteFormat

func FormatPartsGB

func FormatPartsGB(bytes int64) ByteFormat

func (ByteFormat) IntString

func (b ByteFormat) IntString() string

func (ByteFormat) String

func (b ByteFormat) String() string

type Error

type Error struct {
	Msg string
	// Status
	ExitCode int
}

Error can be used by a command to change the exit status of the CLI.

func (*Error) Error

func (e *Error) Error() string

type Helper

type Helper struct {
	// Config contains globally sourced configuration
	Config *config.Config

	ConfigFS *config.ConfigFS

	// Client returns the PlanetScale API client
	Client func() (*ps.Client, error)

	// Printer is used to print output of a command to stdout.
	Printer *printer.Printer
	// contains filtered or unexported fields
}

Helper is passed to every single command and is used by individual subcommands.

func (*Helper) Debug

func (h *Helper) Debug() bool

func (*Helper) SetDebug

func (h *Helper) SetDebug(debug *bool)

type PasswordRole

type PasswordRole int

const (
	ReaderRole PasswordRole = iota
	WriterRole
	ReadWriterRole
	AdministratorRole
)

func RoleFromString

func RoleFromString(r string) (PasswordRole, error)

func (PasswordRole) ToString

func (r PasswordRole) ToString() string