cmdutil

Documentation

Index

• Constants
• func CheckAuthentication(cfg *config.Config) func(cmd *cobra.Command, args []string) error
• func ErrCode(err error) planetscale.ErrorCode
• func HandleError(err error) error
• func NewZapLogger(debug bool) *zap.Logger
• func OpenBrowser(goos, url string) *exec.Cmd
• func RequiredArgs(reqArgs ...string) cobra.PositionalArgs
• type Helper
  • func (h *Helper) Debug() bool
  • func (h *Helper) SetDebug(debug *bool)

Constants

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

Functions

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 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 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 RequiredArgs

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

required arguments are not available.

Types

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)