shell

Documentation

Index

• type Option
  • func WithDialFunc(dial client.DialFunc) Option
  • func WithDriverName(name string) Option
• type Shell
  • func New(database string, store client.NodeStore, options ...Option) (*Shell, error)
  • func (s *Shell) Process(ctx context.Context, line string) (string, error)

Types

type Option

type Option func(*options)

Option that can be used to tweak shell parameters.

func WithDialFunc

func WithDialFunc(dial client.DialFunc) Option

WithDialFunc sets a custom dial function for connecting to dqlite endpoints.

func WithDriverName

func WithDriverName(name string) Option

WithDriverName sets a custom name for the registered dqlite driver. The default is "dqlite".

type Shell

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

Shell can be used to implement interactive prompts for inspecting a dqlite database.

func New

func New(database string, store client.NodeStore, options ...Option) (*Shell, error)

New creates a new Shell connected to the given database.

func (*Shell) Process

func (s *Shell) Process(ctx context.Context, line string) (string, error)

Process a single input line.