shell

package

v1.10.2 Latest Latest Go to latest Published: Nov 10, 2021 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Option func(*options)

Option that can be used to tweak shell parameters.

func WithDialFunc(dial client.DialFunc) Option

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

func WithDriverName(name string) Option

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

func WithFormat(format string) Option

WithFormat specifies the output format.

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

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

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

New creates a new Shell connected to the given database.

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

Process a single input line.