shell

Documentation

Overview

Package shell is sqly-shell. shell control user input (it's SQL query or helper command) and request the usecase layer to process it.

Index

• Variables
• type CommandList
  • func NewCommands() CommandList
• type History
  • func NewHistory() *History
• type Interactive
  • func NewInteractive(h *History) *Interactive
• type Shell
  • func NewShell(arg *config.Arg, cmds CommandList, interactive *Interactive, ...) *Shell
  • func (s *Shell) Run() error

Variables

var (
	// Version is sqly command version. Version value is assigned by LDFLAGS.
	Version string
	// Stdout is new instance of Writer which handles escape sequence for stdout.
	Stdout = colorable.NewColorableStdout()
	// Stderr is new instance of Writer which handles escape sequence for stderr.
	Stderr = colorable.NewColorableStderr()
)

var (
	// ErrExitSqly is not error. developer must not print this error.
	ErrExitSqly = errors.New("this is not error. however, user want to exit sqly command")
)

Types

type CommandList

type CommandList map[string]command

CommandList is sqly helper command list. key is command name, value is command function pointer and command description.

func NewCommands

func NewCommands() CommandList

NewCommands return *CommandList that set sqly helper commands.

type History

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

History is user input history manager.

func NewHistory

func NewHistory() *History

NewHistory return *History.

type Interactive

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

Interactive is user interface that provide command prompt.

func NewInteractive

func NewInteractive(h *History) *Interactive

NewInteractive return *Interactive

type Shell

type Shell struct {
	Ctx context.Context

	CsvInteractor     *usecase.CSVInteractor
	Sqlite3Interactor *usecase.SQLite3Interactor
	// contains filtered or unexported fields
}

Shell is main class of the sqly command. Shell is the interface to the user and requests processing from the usecase layer.

func NewShell

func NewShell(arg *config.Arg, cmds CommandList, interactive *Interactive,
	csv *usecase.CSVInteractor, sqlite3 *usecase.SQLite3Interactor) *Shell

NewShell return *Shell.

func (*Shell) Run

func (s *Shell) Run() error

Run start sqly shell. After successful initialization, start the interactive shell.