psql

Documentation

Overview

Package psql implements the `kubectl cnpg psql` command

Index

• func NewCmd() *cobra.Command
• type Command
  • func NewCommand(ctx context.Context, options CommandOptions) (*Command, error)
  • func (psql *Command) Exec() error
  • func (psql *Command) Output() ([]byte, error)
  • func (psql *Command) Run() error
• type CommandOptions
• type ErrMissingPod
  • func (err *ErrMissingPod) Error() string

Functions

func NewCmd

func NewCmd() *cobra.Command

NewCmd creates the "psql" command

Types

type Command

type Command struct {
	CommandOptions
	// contains filtered or unexported fields
}

Command is the launcher of `psql` with `kubectl exec`

func NewCommand

func NewCommand(
	ctx context.Context,
	options CommandOptions,
) (*Command, error)

NewCommand creates a new psql command

func (*Command) Exec

func (psql *Command) Exec() error

Exec replaces the current process with a `kubectl Exec` invocation. This function won't return

func (*Command) Output

func (psql *Command) Output() ([]byte, error)

Output starts a psql process inside the target pod and returns its stdout

func (*Command) Run

func (psql *Command) Run() error

Run starts a psql process inside the target pod

type CommandOptions

type CommandOptions struct {
	// Require a connection to a Replica
	Replica bool

	// The cluster Name
	Name string

	// The Namespace where we're working in
	Namespace string

	// Whether we should we allocate a TTY for psql
	AllocateTTY bool

	// Whether we should we pass stdin to psql
	PassStdin bool

	// Arguments to pass to psql
	Args []string
}

CommandOptions are the options required to start psql

type ErrMissingPod

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

ErrMissingPod is raised when we can't find a Pod having the desired role

func (*ErrMissingPod) Error

func (err *ErrMissingPod) Error() string

Error implements the error interface