handler

Documentation

Index

• Variables
• type Handler
  • func New(l rline.IO, user *user.User, wd string, nopw bool) *Handler
  • func (h *Handler) Buf() *stmt.Stmt
  • func (h *Handler) Close() error
  • func (h *Handler) DB() *sql.DB
  • func (h *Handler) Exec(w io.Writer, typ, sqlstr string) error
  • func (h *Handler) Execute(w io.Writer, prefix, sqlstr string) error
  • func (h *Handler) IO() rline.IO
  • func (h *Handler) Include(path string, relative bool) error
  • func (h *Handler) Last() string
  • func (h *Handler) Open(params ...string) error
  • func (h *Handler) OutputRows(w io.Writer, q *sql.Rows) error
  • func (h *Handler) Password(dsn string) (string, error)
  • func (h *Handler) Prompt() string
  • func (h *Handler) Query(w io.Writer, _, sqlstr string) error
  • func (h *Handler) Reset(r []rune)
  • func (h *Handler) Run() error
  • func (h *Handler) URL() *dburl.URL
  • func (h *Handler) User() *user.User
  • func (h *Handler) Version() error
• type OnOff
  • func (b OnOff) MarshalText() ([]byte, error)
  • func (b OnOff) String() string
  • func (b *OnOff) UnmarshalText(text []byte) error

Variables

var (
	// ErrNotConnected is the not connected error.
	ErrNotConnected = errors.New("not connected")

	// ErrNoSuchFileOrDirectory is the no such file or directory error.
	ErrNoSuchFileOrDirectory = errors.New("no such file or directory")

	// ErrCannotIncludeDirectories is the cannot include directories error.
	ErrCannotIncludeDirectories = errors.New("cannot include directories")

	// ErrMissingDSN is the missing dsn error.
	ErrMissingDSN = errors.New("missing dsn")
)

Types

type Handler

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

Handler is a input process handler.

func New

func New(l rline.IO, user *user.User, wd string, nopw bool) *Handler

New creates a new input handler.

func (*Handler) Buf

func (h *Handler) Buf() *stmt.Stmt

Buf returns the current statement buffer.

func (*Handler) Close

func (h *Handler) Close() error

Close closes the database connection if it is open.

func (*Handler) DB

func (h *Handler) DB() *sql.DB

DB returns the sql.DB for the handler.

func (*Handler) Exec

func (h *Handler) Exec(w io.Writer, typ, sqlstr string) error

Exec does a database exec.

func (*Handler) Execute

func (h *Handler) Execute(w io.Writer, prefix, sqlstr string) error

Execute executes a sql query against the connected database.

func (*Handler) IO

func (h *Handler) IO() rline.IO

IO returns the io for the handler.

func (*Handler) Include

func (h *Handler) Include(path string, relative bool) error

Include includes the specified path.

func (*Handler) Last

func (h *Handler) Last() string

Last returns the last executed statement.

func (*Handler) Open

func (h *Handler) Open(params ...string) error

Open handles opening a specified database URL, passing either a single string in the form of a URL, or more than one string, in which case the first string is treated as a driver name, and the remaining strings are joined (with a space) and passed as a DSN to sql.Open.

If there is only one parameter, and it is not a well formatted URL, but appears to be a file on disk, then an attempt will be made to open it with an appropriate driver (mysql, postgres, sqlite3) depending on the type (unix domain socket, directory, or regular file, respectively).

func (*Handler) OutputRows

func (h *Handler) OutputRows(w io.Writer, q *sql.Rows) error

OutputRows outputs the supplied SQL rows to the supplied writer.

func (*Handler) Password

func (h *Handler) Password(dsn string) (string, error)

Password collects a password from input, and returning a modified DSN including the collected password.

func (*Handler) Prompt

func (h *Handler) Prompt() string

Prompt creates the prompt text.

func (*Handler) Query

func (h *Handler) Query(w io.Writer, _, sqlstr string) error

Query executes a query against the database.

func (*Handler) Reset

func (h *Handler) Reset(r []rune)

Reset resets the handler's statement buffer.

func (*Handler) Run

func (h *Handler) Run() error

Run executes queries and commands.

func (*Handler) URL

func (h *Handler) URL() *dburl.URL

URL returns the URL for the handler.

func (*Handler) User

func (h *Handler) User() *user.User

User returns the user for the handler.

func (*Handler) Version

func (h *Handler) Version() error

Version prints the database version information after a successful connection.

type OnOff

type OnOff struct {
	Bool    bool
	Assumed bool
}

OnOff is a type that wraps a bool, for use in parsing/displaying command parameters.

func (OnOff) MarshalText

func (b OnOff) MarshalText() ([]byte, error)

MarshalText satisfies the TextMarhsaler interface.

func (OnOff) String

func (b OnOff) String() string

String satisifies stringer.

func (*OnOff) UnmarshalText

func (b *OnOff) UnmarshalText(text []byte) error

UnmarshalText satisfies the TextUnmarshaler interface.