commands

Documentation

Overview

Package commands provides general resources for CLI.

Package commands provides general resources for CLI.

Index

• Constants
• func ActionErrorf(format string, args ...interface{}) error
• func BuildHostname(host, port string) string
• func BuildTunnel(cliCtx *cli.Context, remoteHost *url.URL) (*portfwd.SSHTunnel, error)
• func CheckForwardingServerURL(cliCtx *cli.Context) error
• func ClientByCLIContext(cliCtx *cli.Context) (*dblabapi.Client, error)
• func ToActionError(err error) error
• type ActionError
  • func NewActionError(msg string) ActionError
  • func (e ActionError) Error() string

Constants

const (
	EnvironmentIDKey  = "environment-id"
	URLKey            = "url"
	TokenKey          = "token"
	InsecureKey       = "insecure"
	RequestTimeoutKey = "request-timeout"
	FwServerURLKey    = "forwarding-server-url"
	FwLocalPortKey    = "forwarding-local-port"
	IdentityFileKey   = "identity-file"
)

CLI configuration keys.

Functions

func ActionErrorf

func ActionErrorf(format string, args ...interface{}) error

ActionErrorf formats according to a format specifier.

func BuildHostname

func BuildHostname(host, port string) string

BuildHostname builds a hostname string.

func BuildTunnel

func BuildTunnel(cliCtx *cli.Context, remoteHost *url.URL) (*portfwd.SSHTunnel, error)

BuildTunnel creates a new instance of SSH tunnel.

func CheckForwardingServerURL

func CheckForwardingServerURL(cliCtx *cli.Context) error

CheckForwardingServerURL checks if the forwarding server URL is set.

func ClientByCLIContext

func ClientByCLIContext(cliCtx *cli.Context) (*dblabapi.Client, error)

ClientByCLIContext creates a new Database Lab API client.

func ToActionError

func ToActionError(err error) error

ToActionError wraps the error to a new action error.

Types

type ActionError

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

ActionError defines a custom type of CLI action error.

func NewActionError

func NewActionError(msg string) ActionError

NewActionError constructs a new Action error.

func (ActionError) Error

func (e ActionError) Error() string

Error returns an output of the action error.